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 products 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 instance.
- See the JS7 - System Architecture article for an overview of components products 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.
...
- On the Controller instance's server create the keystore using
openssl
and thekeytool
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
andkeytool
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.comhttps-keystore.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 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 and Root CA Certificate to a truststore ./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 used for access to the keystore. Passwords for private key and keystore have to match when using PKCS12 keystores.
- For use with a third party utility create a keystore, e.g.
- On the Controller instance's server create the keystore 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
- 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 keystoretruststore:
Code Block language bash title Example how to import a Root CA Certificate to a PKCS12 keystoretruststore # 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
- For use with a third party utility create a truststore, e.g.
...
- 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. 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 changed 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.
- In addition the Distinguished Name of the JOC Cockpit Client Authentication certificate is checked. An additional password setting has to be present but can be empty as in
- 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 to release 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" ] password="plain:" } } } }
Explanation:- The
History
andJOC
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.
- Distinguished Names can be displayed in different flavors. JS7 makes use of RFC2253 compliant Distinguished Names. The following command can be executed to verify the Distinguished Name from a given certificate file:
openssl x509 -in <joc-cert.pem> -noout -nameopt RFC2253 -subject
- The output that you receive - except for a
subject:
orsubject=
prefix - should be used as the JOC Cockpit's Distinguished Name - Sample Output:
subject= ST=Berlin,OU=JS7,O=SOS,L=Berlin,C=DE,CN=centostest-primary
- The prefix
subject=
has to be omitted from the Distinguished Name.
- The
password
is used for Thepassword
is used for authentication of theHistory
andJOC
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 thesha512:
orplain:
prefixes.
- User Input to the Settings page of the JOC Cockpit can look like this:
- 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:
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
- Plain Text:
- JOC:
- Plain Text:
JS7-JOC
- Hash:
sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE
- Plain Text:
- History:
- The
- The
jobscheduler
account is an example of 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.
- The
...
Show If | ||||
---|---|---|---|---|
| ||||
Risk MitigationThe descriptions above indicate use of a Root CA certificate Certificate for verification of Client Authentication certificates when it comes to mutual authentication.
|
Notes
- A restart of the relevant component product is required to apply modifications to either the the Controller
JS7_CONFIG_DIR/private/private.conf
file or to JOC Cockpit configuration files.
...