Page History

...

On the Controller instance's server create the keystore using the keytool from your Java JRE or JDK or a third party utility.

For use with a third party utility create a keystore, e.g. https-keystore.p12, in PKCS12 format and import:
- Controller private key and certificate for Server Authentication
- Root CA certificate
- Intermediate CA certificate(s)

For use with keytool create the keystore with the private key and certificate for Server Authentication from the command line. The examples below show one possible approach for certificate management - however, there are other ways of achieving similar results.

Example for the use of private key and CA-signed certificate with PKCS12 keystore:

Code Block

language	bash
title	Example how to add a private key and CA-signed certificate to a PKCS12 keystore

# If the Controller's private key and certificate are to be provided with a .jks keystore (keypair.jks) then temporarily convert the keystore to pkcs12 (keystore.p12)
#   for later use with openssl, assuming the alias name of the Controller's private key to be "controller-https"
# keytool -importkeystore -srckeystore keypair.jks -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias controller-https.example.com

# assuming the Controller's private key from a pkcs12 keystore (keystore.p12), store the Controller's private key in a .key file in PEM format (controller-https.key)
openssl pkcs12 -in keystore.p12 -nocerts -out controller-https.key

# concatenate CA Root certificate and CA Intermediate certificate(s) to a single CA Bundle certificate file (ca-bundle.crt)
cat RootCACertificate.crt > ca-bundle.crt
cat CACertificate.crt >> ca-bundle.crt

# Export the Controller's private key (controller-https.key), Controller's certificate (controller-https.crt) and CA Bundle (ca-bundle.crt) in PEM format to a new keystore (https-keystore.p12)
#   assuming the fully qualified domain name (FQDN) of the Controller server is "controller.example.com"
openssl pkcs12 -export -in controller-https.crt -inkey controller-https.key -chain -CAfile ca-bundle.crt -name controller.example.com -out JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12

# IF you require use of a .jks keystore type then convert the pkcs12 keystore, assuming the alias name of the Controller private key being "controller-https"
# keytool -importkeystore -srckeystore https-keystore.p12 -srcstoretype PKCS12 -destkeystore JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.jks -deststoretype JKS -srcalias controller-https.example.com

Example for the use of private key and self-signed certificate with PKCS12 keystore:

Code Block

language	bash
title	Example how to generate a private key and self-signed certificate for import into a PKCS12 keystore
collapse	true

# generate the Controller's private key with alias name "controller-https.example.com" in a keystore (https-keystore.p12)
#   use the fully qualified domain name (FQDN) assumed to be "controller.example.com" and name of your organization for the distinguished name
#   consider that PKCS12 keystores require the use of the same key password and store password
keytool -genkey -alias "controller-https.example.com" -dname "CN=controller.example.com,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12" -storepass jobscheduler -storetype PKCS12

Example for the use of private key and self-signed certificate with JKS keystore:

Code Block

language	bash
title	Example how to generate a private key and self-signed certificate for import into a JKS keystore
collapse	true

# generate the Controller's private key with the alias name "controller-https.example.com" in a keystore (https-keystore.jks)
#   use the fully qualified domain name (FQDN) assumed to be "controller.example.com" and name of your organization for the distinguished name
keytool -genkey -alias "controller-https.example.com" -dname "CN=controller.example.com,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.jks" -storepass jobscheduler -storetype JKS

Explanation:
- The -dname option specifies the certificate issuer, therefore use your own set of CN, O, OU, DC that specify the issuer's Distinguished Name. The O setting is required for the issuer.
- The -keypass option accepts the password that you will need later on to manage your private key.
- The -keystore option specifies the location of the keystore file. The keystore file should be in reach of the Controller, it is recommended using the private sub-folder in the JS7_CONTROLLER_CONFIG_DIR directory.
- The -storepass option specifies the password for access to the keystore file.
- The -storetype option is used to specify the PKCS12 or JKS keystore format.

With the keystore set up, specify the relevant properties with the JS7_CONTROLLER_CONFIG_DIR/private/private.conf configuration file:

Example

Code Block

language	text
title	Example for private.conf file specifying the Controller keystore

js7 {
    web {
        # keystore location for https connections
        https {
            keystore {
                # Default: ${js7.config-directory}"/private/https-keystore.p12"
                file=${js7.config-directory}"/private/https-keystore.p12"
                key-password="jobscheduler"
                store-password="jobscheduler"
            }
        }
    }
}

Explanation:

js7.web.https.keystore.file is used for the path to the keystore.
js7.web.https.keystore.key-password is used for access to the private key.
js7.web.https.keystore.store-password is used for access to the keystore.

...

By default mutual authentication is in place.
- The JOC Cockpit is challenged by the Controller to present its Client Authentication certificate that is then verified by the Controller.
  - In addition the Distinguished Name of the JOC Cockpit Client Authentication certificate is checked and a password is used to identify the JOC Cockpit instance.
  - Note that any number of clustered JOC Cockpit instances can connect to a Controller.
- If a Controller cluster is used then connections from the partnering Controller instance are authenticated by the Distinguished Name of the instance's Client Authentication certificate.

The JS7_CONTROLLER_CONFIG_DIR/private/private.conf configuration file should include authentication details such as:

Code Block

title	Example for private.conf file specifying JOC Cockpit authentication

js7 {
    auth {
        users {
            # History account (used for releasing events)
            History {
                distinguished-names=[
                    "DNQ=SOS CA, CN=apmacwinjoc_jocprimary_client, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
                ]
                password="sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08"
            }
            # JOC account (needs UpdateItem permission for deployment)
            JOC {
                distinguished-names=[
                    "DNQ=SOS CA, CN=apmacwinjoc_jocprimary_client, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
                ]
                password="sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE"
                permissions=[
                    UpdateItem
                ]
            }
            # Controller ID for connections by primary/secondary controller instance
            jobscheduler {
                distinguished-names=[
                     "DNQ=SOS CA, CN=apmacwincontroller_primary_client, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
                     "DNQ=SOS CA, CN=controller_secondary_client, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
                ]
            }
        }
    }
}

Explanation:

The History and JOC user accounts are used by the JS7 - History Service and by the JS7 - REST Web Service API.
- The distinguished-names property allows the addition of a number of Distinguished Names as available from the subject of the Client Authentication certificates which are used by JOC Cockpit instances when connecting to the Controller.
  - Except for whitespace between attributes, the precise sequence and values as available from the certificate's subject has to match this property value.
- The password is used for authentication of the History and JOC service accounts with the Controller. Both accounts are typically running in the same JOC Cockpit instance.
  - If HTTP connections are used then the password is the only means for authentication. If HTTPS connections with mutual authentication are used then the password is not relevant as certificate based authentication is in place.
  - The symmetric password is specified with the section joc of the JS7 - Settingspage of the JOC Cockpit and in the private.conf file.
    User Input to the Settings page of the JOC Cockpit can look like this:
    
    Input to the GUI simply accepts the password and does not require to use the prefixes sha512: or plain:.
  - In the private.conf file a hashed value or a plain text value can be specified like this:
    password="sha512:B793649879D6..."
    password="plain:JS7-History"
  - If the password is modified in the private.conf file then it has to be modified in the JOC Cockpit settings as well, so that the passwords match.
  - The password setting cannot be omitted. However, an empty password can be specified, for example, with mutual authentication HTTPS connections such as:
    password="plain:"
  - From the private.conf file that ships by default the plain text value and the hashed values are:
    History:
    Plain Text: JS7-History
    Hash: sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08
    JOC:
    Plain Text: JS7-JOC
    Hash: sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE
The jobscheduler user account is an example of a Controller ID that is used by a partnering Controller instance.
This setting is not required if a Standalone Controller is used.
For a Controller Cluster the Controller ID is specified during installation.

...

On the JOC Cockpit server create the truststore using the keytool from your Java JRE or JDK or a third party utility.
For use with a third party utility create a truststore, e.g. https-truststore.p12, in PKCS12 format and import:
Root CA certificate
For use with keytool create the truststore in PKCS12 or JKS format with the Root CA certificate. The examples below show one possible approach for certificate management - however, there may be are other ways how to achieve similar results.
Example showing the import a Root CA certificate to a PKCS12 truststore:
Code Block
language bash
title Example how to import a CA-signed certificate into a PKCS12 truststore
# import Root CA certificate in PEM format to a PKCS12 truststore (https-truststore.p12) keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12" -storetype PKCS12
Example showing the use of a self-signed Controller certificate with a PKCS12 truststore:
Code Block
language bash
title Example for import of a self-signed Controller certificate to a PKCS12 truststore
collapse true
# on the Controller server: export Controller's certificate from keystore (https-keystore.p12) identified by its alias name (controller-https.example.com) to a file in PEM format (controller-https.crt) keytool -exportcert -rfc -noprompt -file "controller-https.crt" -alias "controller-https.example.com" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12" -storepass jobscheduler -storetype PKCS12 # on the JOC Cockpit server: import the Controller's certificate from a file in PEM format (controller-https.crt) identified by its alias name (controller-https.example.com) to the JOC Cockpit PKCS12 truststore (https-truststore.p12) keytool -importcert -noprompt -file "controller-https.crt" -alias "controller-https.example.com" -keystore "JETTY_BASE/resources/joc/https-truststore.p12" -storepass jobscheduler -storetype PKCS12 -trustcacerts
Example showing the use of a self-signed Controller certificate with a JKS truststore:
Code Block
language bash
title Example for import of a self-signed Controller certificate to a JKS truststore
collapse true
# on the Controller server: export Controller's certificate from keystore (https-keystore.jks) identified by its alias name (controller-https.example.com) to a file in PEM format (controller-https.crt) keytool -exportcert -rfc -noprompt -file "controller-https.crt" -alias "controller-https.example.com" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.jks" -storepass jobscheduler -storetype JKS # on the JOC Cockpit server: import the Controller's certificate from a file in PEM format (controller-https.crt) identified by its alias name (controller-https.example.com) to the JOC Cockpit JKS truststore (https-truststore.jks) keytool -importcert -noprompt -file "controller-https.crt" -alias "controller-https.example.com" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storepass jobscheduler -trustcacerts -storetype JKS

The location of the truststore is added to the JETTY_BASE/resources/joc/joc.properties configuration file like this:

Example for a PKCS12 truststore

Code Block

language	text
title	Example how to specify a PKCS12 truststore location with the joc.properties file

### Location of the truststore that contains the certificates of all
###   Controllers used for HTTPS connections. The path can be absolute or
###   relative to joc.properties

truststore_path = https-truststore.p12 
truststore_type = PKCS12
truststore_password = jobscheduler

Example for a JKS truststore

Code Block

language	text
title	Example how to specify a JKS truststore location with the joc.properties file
collapse	true

### Location of the truststore that contains the certificates of all
###   Controllers used for HTTPS connections. The path can be absolute or 
###   relative to joc.properties

truststore_path = https-truststore.jks
truststore_type = JKS
truststore_password = jobscheduler

Hostname verification by default is in place with the JETTY_BASE/resources/joc/joc.properties configuration file.

Code Block

title	Example how to specify hostname verification with the joc.properties file

################################################################################
### Specifies if hostname verification should be carried out for HTTPS connections.
### Default true

https_with_hostname_verification = true

...

Space shortcuts

Page tree

Versions Compared

Old Version 37

New Version 38

Key