Page History

...

Connections from the JOC Cockpit to Controllers use the JS7 - REST Web Service API and can be secured by HTTPS with TLS/SSL certificates.
- If the JOC Cockpit and Controller are operated on the same server and network interface then no HTTPS connection between components is required.
- If the JOC Cockpit and Controller are 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 the JOC Cockpit to a Controller. This includes to use a standalone Controller or a Controller Cluster with an active instance and a standby instancesinstance.
- See the JS7 - System Architecture article for an overview of components and connections.
- Follow the instructions in the JS7 - JOC Cockpit HTTPS Connections article to set up secure connections from clients (user browser / REST API client) to the JOC Cockpit.
- See the JS7 - Agent HTTPS Connections article for information about securing the connections between Controller instances and Agents.

...

Flowchart

Controller [label="&nbsp;&nbsp;&nbsp;Controller&nbsp;&nbsp;&nbsp;\nStandalone / Cluster",fillcolor="lightskyblue"]
JOC [label="&nbsp;&nbsp;&nbsp;JOC Cockpit&nbsp;&nbsp;&nbsp;\nPrimary",fillcolor="lightskyblue"]
JOC2 [label="&nbsp;&nbsp;&nbsp;JOC Cockpit&nbsp;&nbsp;&nbsp;\nStandbynSecondary",fillcolor="lightskyblue"]
 
Controller_Truststore [label="Controller Truststore\nhttps-truststore.p12\n\nCA certificates",fillcolor="limegreen"]
Controller_Keystore [label="Controller Keystore\nhttps-keystore.p12\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="orange"]
JOC_Truststore [label="JOC Cockpit Truststore\nhttps-truststore.p12\n\nCA certificates",fillcolor="orange"]
JOC_Keystore [label="JOC Cockpit Keystore\nhttps-keystore.p12\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="limegreen"]

Controller_Truststore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
JOC_Truststore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
#JOC_Keystore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
#JOC_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate\nCertificate",fillcolor="white"]

#Controller_Keystore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
#Controller_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate\nCertificate",fillcolor="white"]
Controller_PrivateKey [shape="ellipse",label="Server Authentication\nPrivate Key",fillcolor="white"]
Controller_Keystore_Certificate [shape="ellipse",label="Server Authentication\nCertificate",fillcolor="white"]

JOC_PrivateKey [shape="ellipse",label="Client Authentication\nPrivate Key",fillcolor="white"]
JOC_Certificate [shape="ellipse",label="Client Authentication\nCertificate",fillcolor="white"]

Controller -> Controller_Keystore 
#Controller_Keystore -> Controller_Keystore_CA_RootCertificate -> Controller_Keystore_CA_IntermediateCertificate [label="&nbsp;add to keystore&nbsp;"]
Controller_Keystore -> Controller_PrivateKey -> Controller_Keystore_Certificate [label="&nbsp;add to keystore&nbsp;"]

Controller -> Controller_Truststore 
Controller_Truststore -> Controller_Truststore_CA_RootCertificate [label="&nbsp;add to truststore&nbsp;"]

JOC -> JOC_Keystore 
#JOC_Keystore -> JOC_Keystore_CA_RootCertificate -> JOC_Keystore_CA_IntermediateCertificate [label="&nbsp;add to keystore&nbsp;"]
JOC_Keystore -> JOC_PrivateKey -> JOC_Certificate [label="&nbsp;add to keystore&nbsp;"]

JOC -> JOC_Truststore
JOC_Truststore -> JOC_Truststore_CA_RootCertificate [label="&nbsp;add to truststore&nbsp;"] 

JOC -> Controller [label="&nbsp;establish connection&nbsp;"]
JOC2 -> Controller [label="&nbsp;establish connection&nbsp;"]

...

Keystore and truststore shown in orange are required for any connections of JOC Cockpit to a Controller.
- The Controller's private key and certificate for Server Authentication are added to the Controller's keystore.
- The Root CA certificate Certificate is added to the AgentController's truststore.
The keystore and truststore shown in green are required if mutual authentication is in place for certificate based client authentication (default).
The Controller's truststore shown in green is required should secure connections be used by a Controller to access Agents. It is therefore recommended the Controller's truststore is set up.
Similar certificate management applies for any additional standby JOC Cockpit instances acting in a cluster.

...

On the Controller instance's server create the keystore using openssl and 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

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

Example for importing a private key and CA-signed certificate to a PKCS12 keystore:

Code Block

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

# Assume the fully qualified domain name (FQDN) of the Controller server to be "controller.example.com"

# If the Controller's CA-signed certificate is provided from a pkcs12 keystore (certificate.p12), extract the certificate to a .crt file in PEM format (controller.example.com.crt)
# openssl pkcs12 -in certificate.p12 -nokeys -out controller.example.com.crt

# Import the Controller's private key (controller.example.com.key) and certificate (controller.example.com.crt) from PEM format to a new keystore (controller.example.com.p12)
openssl pkcs12 -export -in controller.example.com.crt -inkey controller.example.com.key --name controller.example.com -out "JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12"

Example for creating a private key and self-signed certificate and importing import to a keystore

Refer to examples available from JS7 - How to create self-signed Certificates, chapter Creating a Server Certificate.

Code Block

language	bash
title	Example how to create a private key and self-signed certificate

# Creating the private key and self-signed certificate for the given validity period
./create_certificate.sh --dns=controller.example.com --days=365

Refer to examples available from JS7 - How to add SSL TLS Certificates to Keystore and Truststore.

Code Block

title	Example how to add a private key and self-signed certificate to a PKCS12 keystore

# Adding the private key and certificate to a keystore
./js7_create_certificate_store.sh \
    --keystore=JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12 \
    --key=controller.example.com.key \
    --cert=controller.example.com.crt \
    --alias=controller.example.com \
    --password=jobscheduler

When using additional arguments for creation of a truststore then users have the truststore available for the later step 4:

Code Block

title	Example how to add a private key and self-signed certificate to a PKCS12 keystore and the Root CA Certificate to a truststore

# Adding the private key and certificate to a keystore
./js7_create_certificate_store.sh \
    --keystore=JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12 \
    --truststore=JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12 \ 
    --key=controller.example.com.key \
    --cert=controller.example.com.crt \
    --alias=controller.example.com \
    --password=jobscheduler \
    --ca-root=root-ca.crt

With the keystore being 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 is used for access to the keystore. Passwords for private key and keystore have to match when using PKCS12 keystores.

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 truststore, e.g. https-truststore.p12, in PKCS12 format and import:
- Root CA Certificate

The examples below show a possible approach for certificate management - however, there are other ways of achieving similar results.

Example for importing a Root CA Certificate to a PKCS12 keystore:

Code Block

language	bash
title	Example how to import a Root CA Certificate to a PKCS12 keystore

# Import Root CA Certificate in PEM format to a PKCS12 truststore (https-truststore.p12)
keytool -importcert -alias "root-ca" -file "root-ca.crt" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12

...

By default mutual authentication is in place.
- JOC Cockpit makes use of two connections to the Controller: one for the JS7 - History Service and one for the JOC Cockpit GUI. Both connections by default use mutual authentication.
- 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 . An additional password setting has to be present but can be empty as in password="plain:". JOC Cockpit ships with the below default passwords. If a password is used to identify the JOC Cockpit instancechanged in the Controller configuration then it has to be changed in the JS7 - Settings too.
  - Note that any number of clustered JOC Cockpit instances can connect to a Controller.
- If a Controller cluster 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 forto releasingrelease 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 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.
  - If more than one Distinguished Name is used then they are separated by comma.
- The password is used for authentication of the History and JOC service accounts with the Controller. Both accounts are typically 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 in the joc section 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 the use of the 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 the 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 a possible approach for certificate management - however, there are other ways how to achieve similar results.
Example showing how to import a Root CA Certificate to a PKCS12 truststore:
Code Block
language bash
title Example how to import a Root CA 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 "root-ca.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12" -storetype PKCS12

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 forwith 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 forwith 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 47

New Version 48

Key