Page History

...

Connections from JOC Cockpit to the Controller Controllers use the JS7 - REST Web Service API and can be secured by HTTPS 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.

...

Certificate stores can be managed from the command line and by use of tools that provide a GUI for this purpose:
- the Java Keytool keytool is available from the Java JRE or JDK,
- the Keystore Explorer is an open source utility to graphically manage certificate stores.

...

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

Generate the keystore with the private key and the certificate for Controller Server Authentication. 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 CA-signed certificate with PKCS12 keystore format

Code Block

language	bash
title	Example how to add a CA-signed private key and 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 self-signed certificate with PKCS12 keystore format

Code Block

language	bash
title	Example how to generate a self-signed certificate for import into a PKCS12 Keystore

# 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 self-signed certificate with JKS keystore format

Code Block

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

# 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

Explanation:
- Replace the JS7_CONTROLLER_CONFIG_DIR placeholder as specified above.
- 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. With the default password being used no further settings are required as explained below.
- 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. For the handling of the default password the same applies as stated with the -keypass option.
- The -storetype option is used to specify the PKCS12 keystore format 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.

...

By default mutual authentication is in place.
- JOC Cockpit is challenged by the Controller to present its Client Authentication certificate that is 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.
  - Consider 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 distinguished namecertificate.

The JS7_CONTROLLER_CONFIG_DIR/private/private.conf configuration file is should include authentication details like this:

Code Block

title	Example for private.conf file specifying JOC Cockpit authentication

js7 {
    auth {
        users {
            # History account (used for release events)
            History {
                distinguished-names=[
                    "DNQ=SOS CA, CN=apmacwin_joc_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=apmacwin_joc_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=apmacwin_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 offers to add a number of distinguished names available from the subject of the respective Client Authentication certificatecertificates.
- The password is not used for authentication but for identification of the History and JOC user accounts as both accounts typically are running in the same JOC Cockpit instance and use the same Client Authentication certificate. When used with HTTP connections then the password is used for authentication.
The jobscheduler user account is an example for a Controller ID as 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.

...

To make a Controller use HTTPS the respective port setting has to be specified with the Controller's Instance Start Script.

For Linux the Instance Start Script is available from JS7_CONTROLLER_HOME/bin/controller_instance

Instance Start Script like this

.sh:

Code Block

language	xml
title	Example for HTTP and HTTPS port settings with Controller Instance Start Script for Linux

# Sets the http port for the JS7 Controller.
# Without this setting the default port 4444 is used.
# If just a port is specified then the JS7 Controller listens to all
# available network interfaces. This corresponds to 0.0.0.0:<port>.
# Use the form <ip address or hostname>:<port> to indicate
# a specific network interface the JS7 Controller should listen to.
# The command line option --http-port beats the environment
# variable JS7_CONTROLLER_HTTP_PORT.

JS7_CONTROLLER_HTTP_PORT=localhost:4444


# In addition to the http port an https port for the
# JS7 Controller can be specified. If just a port is specified
# then the JS7 Controller listens to all available network interfaces.
# This corresponds to using 0.0.0.0:<port>.
# Use the form <ip address or hostname>:<port> to indicate
# a specific network interface the JS7 Controller should listen to.
# The command line option --https-port beats the environment
# variable JS7_CONTROLLER_HTTPS_PORT.

JS7_CONTROLLER_HTTPS_PORT=apmacwin:4444

For Windows the Instance Start Script is available from JS7_CONTROLLER_HOME\bin\controller_instance.cmd:

Code Block

language	xml
title	Example for HTTP and HTTPS port settings with Controller Instance Start Script for Windows

rem # Sets the http port for the JS7 Controller.
rem # Without this setting the default port 4444 is used.
rem # If just a port is specified then the JS7 Controller listens to all
rem # available network interfaces. This corresponds to 0.0.0.0:<port>.
rem # Use the form <ip address or hostname>:<port> to indicate
rem # a specific network interface the JS7 Controller should listen to.
rem # The command line option --http-port beats the environment
rem # variable JS7_CONTROLLER_HTTP_PORT.

set JS7_CONTROLLER_HTTP_PORT=localhost:4444


rem # In addition to the http port an https port for the
rem # JS7 Controller can be specified. If just a port is specified
rem # then the JS7 Controller listens to all available network interfaces.
rem # This corresponds to using 0.0.0.0:<port>.
rem # Use the form <ip address or hostname>:<port> to indicate
rem # a specific network interface the JS7 Controller should listen to.
rem # The command line option --https-port beats the environment
rem # variable JS7_CONTROLLER_HTTPS_PORT.

set JS7_CONTROLLER_HTTPS_PORT=apmacwin:4444

Explanation:

The HTTP port is required but is limited to the localhost network interface with the localhost prefix.
The HTTPS port is specified with the hostname prefix that indicates the network interface.

Step 4: Configure the JOC Cockpit Truststore

...

This can be simplified by use of a private key/certificate pair that is created for both extended key usages Server Authentication and Client Authentication. In this case a single private key and certificate is stored with the JOC Cockpit keystore as indicated with the JS7 - JOC Cockpit HTTPS Connections article.
If separate private key/certificate pairs should be used for Server Authentication and Client Authentication purposes then use of separate certificate stores for JOC Cockpit is recommended:
- The keystore holds the private key/certificate for Server Authentication.
- The client keystore holds the private key/certificate for Client Authentication.

...

On the JOC Cockpit server create the client keystore using the keytool from your Java JRE or JDK or some third party utility.
- For use with a third party utility create a client keystore, e.g. https-client-keystore.p12, in PKCS12 format and import:
  - JOC Cockpit private key and certificate for Client Authentication
  - Root CA certificate
  - Intermediate CA certificates
- For use with keytool create the client keystore in PKCS12 or JKS format according to the steps indicated with JS7 - JOC Cockpit HTTPS Connections: Step 2: Create JOC Cockpit Keystore chapter.
  - Apply the indicated steps to the client keystore and use the private key/certificate pair for Client Authentication.

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

Example for PKCS12 client keystore:

Code Block

language	text

### Location of the client keystore that contains the private key and 
###   certificate for JOC Cockpit client authentication relative to
###   joc.properties

client_keystore_path = ../../resources/joc/https-client-truststorekeystore.p12 
client_keystore_type = PKCS12
client_keystore_password = jobscheduler

Example for JKS client keystore:

Code Block

language	text

### Location of the client keystore that contains the private key and 
###   certificate for JOC Cockpit client authentication relative to
###   joc.properties

client_keystore_path = ../../resources/joc/https-client-truststorekeystore.jks
client_keystore_type = JKS
client_keystore_password = jobscheduler

...

On the Controller 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 JKS or PKCS12 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

# on JOC Cockpit server: 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/JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12

Example for export/import of self-signed certificate to a PKCS12 keystore:

Code Block

language	bash
title	Example how to export the Master public certificate from a PKCS12 Keystore

# 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 Controller certificate in PEM format to a PKCS12 truststore (https-truststore.p12)
keytool -import -alias "controller-https" -file "controller-https.crt" -keystore "JETTY_BASE/resources/joc/JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12

Example for export/import of self-signed certificate to a JKS keystore:

Code Block

language	bash
title	Example how to export the Master public certificate from a JKS Keystore

# 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

# on JOC Cockpit server: import Controller certificate in PEM format to a JKS truststore (https-truststore.jks)
keytool -import -alias "controller-https" -file "controller-https.crt" -keystore "JETTY_BASE/resources/joc/JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.jks" -storetype JKS

...

In fact use of a Root CA certificate allows any clients that dispose of a Client Authentication certificate signed by the same Root CA certificate or Intermediate CA certificates to be authenticated. This implication might allow an unwanted number of clients to access a Controller. By design the only clients to access a Controller should be JOC Cockpit instances.
Coping strategies include
- to use a separate certificate authority to sign Client Authentication certificates for access to Controllers.
- to import individual Client Authentication certificates to the Controller truststore instead of using a Root CA certificate.

...

Space shortcuts

Page tree

Versions Compared

Old Version 17

New Version 18

Key

Step 4: Configure the JOC Cockpit Truststore