Page History

...

Connections from JOC Cockpit to Controllers use the JS7 - REST Web Service API and can be secured by HTTPS with TLS/SSL certificates.
- Should JOC Cockpit and Controller be operated on the same server and network interface then no HTTPS connection between components is required.
- Should JOC Cockpit and Controller be operated on different servers or network interfaces then this connection should be secured by HTTPS.
This article describes the steps required to set up secure HTTPS communication from JOC Cockpit to a Controller. This includes to use a standalone Controller or a Controller cluster with a primary and standby instance.
- Consider the JS7 - System Architecture for an overview of components and connections.
- Consider to set up JS7 - JOC Cockpit HTTPS Connections for secure connections from clients (user browser / REST API client) to JOC Cockpit.
- Consider JS7 - Agent HTTPS Connections for securing the connections between Controller instances and Agents.

...

On the Controller instance's server create the keystore using the keytool from your Java JRE or JDK or some 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 certificates

For use with keytool create the keystore with the private key and certificate for Server Authentication from the command line. The below examples suggest one possible approach for certificate management, however, there may be other ways how to achieve similar results.

Example for 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

# should the Controller's private key and certificate 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 being "controller-https"
# keytool -importkeystore -srckeystore keypair.jks -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias controller-https

# assuming the Controller's private key from a pkcs12 keystore (keystore.p12), store the Controller's private key to 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 to a single CA Bundle certificate file (ca-bundle.crt)
cat RootCACertificate.crt > ca-bundle.crt
cat CACertificate.crt >> ca-bundle.crt

# Export 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)
#   assume the fully qualified hostname (FQDN) of the Controller server being "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

# should 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 for 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 Controller's private key with alias name "controller-https" in a keystore (https-keystore.p12)
#   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
#   consider that PKCS12 keystores require to use the same key password and store password
keytool -genkey -alias "controller-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.pk12" -storepass jobscheduler -storetype PKCS12

Example for 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 Controller's private key with alias name "controller-https" in a keystore (https-keystore.jks)
#   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
keytool -genkey -alias "controller-https" -dname "CN=hostname,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 to use the sub-folder private 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 being set up specify respective 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.

...

On the JOC Cockpit server create the truststore using the keytool from your Java JRE or JDK or some 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 below examples suggest one possible approach for certificate management, however, there may be other ways how to achieve similar results.

Example for import of 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 for 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 Controller server: export Controller's certificate from keystore (https-keystore.p12) identified by its alias name (controller-https) to a file in PEM format (controller-https.crt)
keytool -exportcert -rfc -noprompt -file "controller-https.crt" -alias "controller-https" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12" -storepass jobscheduler -storetype PKCS12

# on JOC Cockpit server: import the Controller's certificate from a file in PEM format (controller-https.crt) identified by its alias name (controller-https) to the JOC Cockpit PKCS12 truststore (https-truststore.p12)
keytool -importcert -noprompt -file "controller-https.crt" -alias "controller-https" -keystore "JETTY_BASE/resources/joc/https-truststore.p12" -storepass jobscheduler -storetype PKCS12 -trustcacerts

Example for 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 Controller server: export Controller's certificate from keystore (https-keystore.jks) identified by its alias name (controller-https) to a file in PEM format (controller-https.crt)
keytool -exportcert -rfc -noprompt -file "controller-https.crt" -alias "controller-https" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.jks" -storepass jobscheduler -storetype JKS

# on JOC Cockpit server: import the Controller's certificate from a file in PEM format (controller-https.crt) identified by its alias name (controller-https) to the JOC Cockpit JKS truststore (https-truststore.jks)
keytool -importcert -noprompt -file "controller-https.crt" -alias "controller-https" -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 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 = ../../resources/joc/https-truststore.p12 
truststore_type = PKCS12
truststore_password = jobscheduler

Example for 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 = ../../resources/joc/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

Mutual Authentication for JOC Cockpit and Controller

This configuration is applied in order to enable mutual authentication

from JOC Cockpit to the Controller:
- the JOC Cockpit verifies the Controller's certificate for Server Authentication
- the Controller verifies the JOC Cockpit's certificate for Client Authentication
from pairing Controller instances.

Step 1: Create/Update JOC Cockpit

...

Client

...

Keystore

For mutual authentication JOC Cockpit has to hold a Client Authentication private key and certificate in its keystore.

...

Space shortcuts

Page tree

Versions Compared

Old Version 23

New Version 24

Key

Mutual Authentication for JOC Cockpit and Controller

Step 1: Create/Update JOC Cockpit

Client

Keystore