...

JS7_CONTROLLER_HOME points to the Controller instance's installation directory
- <extraction-directory>/controller (default on Unix/Windows for JS7 - Controller - Headless Installation on Linux /and Windows)
- C:\Program Files\sos-berlin.com\js7\controller (default on Windows for JS7 - Controller - Installation Using the Windows Graphical Installer)
JS7_CONTROLLER_CONFIG_DIR is the Controller's configuration directory that is specified during installation:
- <extraction-directory/controller/var/config (default on Unix/Windows for JS7 - Controller - Headless Installation on Linux /and Windows)
- C:\ProgramData\sos-berlin.com\js7\controller\config (default on Windows for JS7 - Controller - Installation Using the Windows Graphical Installer)

...

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=joc_primary_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=joc_primary_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=controller_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 subjects 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 run 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 in the joc 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 the use of the prefixes sha512: or plain: prefixes.
  - 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.

...

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

For Unix the Instance Start Script is available from JS7_CONTROLLER_HOME/bin/controller_instance.sh:

Code Block

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

# 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=controller.example.com: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
collapse	true

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=controller.example.com: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

The Root CA certificate is added to the JOC Cockpit truststore is added the Root CA certificate. If self-signed certificates are used then each certificate is added to the JOC Cockpit's truststore.

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 are other ways how to achieve similar results.
Example showing the 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 -importcert -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.example.com) to a file in PEM format (controller-https.crt) keytool -exportcert -rfc -noprompt -file "controller-https.crt" -alias "controller.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.example.com) to the JOC Cockpit PKCS12 truststore (https-truststore.p12) keytool -importcert -noprompt -file "controller-https.crt" -alias "controller.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.example.com) to a file in PEM format (controller-https.crt) keytool -exportcert -rfc -noprompt -file "controller-https.crt" -alias "controller.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.example.com) to the JOC Cockpit JKS truststore (https-truststore.jks) keytool -importcert -noprompt -file "controller-https.crt" -alias "controller.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

...

If mutual authentication cannot be used then consider refer to explanations from in the JS7 - Configuration for HTTPS Server Authentication with Passwords article.

...

On the Controller 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 examples suggest provide one possible approach for certificate management, however. However, there are 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 Controller server: import Root CA certificate in PEM format to a PKCS12 truststore (https-truststore.p12) keytool -importcert -alias "root-ca" -file "RootCACertificate.crt" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12
Example for export/import of a self-signed Client Authentication certificate to a PKCS12 keystore:
Code Block
language bash
title Example how to export/import a self-signed certificate to a PKCS12 truststore
collapse true
# on JOC Cockpit server: export JOC Cockpit's certificate from client keystore (https-client-keystore.p12) identified by its alias name (joc-client-https) to a file in PEM format (joc-client-https.crt) keytool -exportcert -rfc -noprompt -file "joc-client-https.crt" -alias "joc-client-https" -keystore "JETTY_BASE/resources/joc/https-client-keystore.p12" -storepass jobscheduler -storetype PKCS12 # on Controller server: import JOC Cockpit's certificate in PEM format to a PKCS12 truststore (https-truststore.p12) keytool -importcert -alias "joc-client-https" -file "joc-clent-https.crt" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12
Example for export/import of a self-signed Client Authentication certificate to a JKS keystore:
Code Block
language bash
title Example how to export/import a self-signed certificate to a JKS truststore
collapse true
# on JOC Cockpit server: export JOC Cockpit's certificate from client keystore (https-client-keystore.jks) identified by its alias name (joc-client-https) to a file in PEM format (joc-client-https.crt) keytool -exportcert -rfc -noprompt -file "joc-client-https.crt" -alias "joc-client-https" -keystore "JETTY_BASE/resources/joc/https-client-keystore.jks" -storepass jobscheduler # on Controller server: import JOC Cockpit's certificate in PEM format to a JKS truststore (https-truststore.jks) keytool -importcert -alias "joc-client-https" -file "joc-client-https.crt" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.jks" -storetype JKS

Show If

match	all
user	ap

Risk Mitigation

The descriptions above indicate use of a Root CA certificate for verification of Client Authentication certificates when it comes to mutual authentication.

In fact use of a Root CA certificate allows any clients that dispose of with a Client Authentication certificate signed by the same Root CA certificate or Intermediate CA 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:
- using a separate certificate authority to sign Client Authentication certificates for access to Controllers.
- importing individual Client Authentication certificates to the Controller truststore instead of using a Root CA certificate.

...

A restart of the relevant component is required to apply modifications to the either the the Controller JS7_CONFIG_DIR/private/private.conf file of the Controller or to JOC Cockpit configuration files of the JOC Cockpit .

Further Resources

...

Space shortcuts

Page tree

Versions Compared

Old Version 42

New Version 43

Key

Step 4: Configure the JOC Cockpit Truststore

Risk Mitigation

Further Resources

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 42

New Version 43

Key

Step 4: Configure the JOC Cockpit Truststore

Risk Mitigation

Further Resources