Page History
...
- The following explanations assume CA-signed certificates or self-signed certificates to be used.
- CA-signed certificates are provided from known and trusted Certificate Authorities (CA) that validates the domain owner.
- Self-signed certificates are created by users who operate their own CA, see the JS7 - How to create self-signed Certificates.
- Use of Intermediate CA certificates is optional.
- Certificate stores can be managed from the command line and by use of tools that provide a GUI for this purpose:
- the Java
keytool
is available from the Java JRE or JDK, - the Keystore Explorer is an open source utility to graphically manage certificate stores.
- the Java
- Starting from Java 9 the PKCS12 keystore type is default and is not required to be specified with
keytool
. - The following sections assume a PKCS12 keystore/truststore format. For Unix OS the .p12 file extension frequently is used, for Windows OS the .pfx extension is preferably used. Both file extensions indicate the same PKCS12 format and can be used interchangeably.
...
- 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 is added to the Agent'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.
...
The following sections assume mutual authentication to be in place.
Anchor | ||||
---|---|---|---|---|
|
- 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 one 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 with 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 JOC Cockpit 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 "JETTY_BASE/resources/joc/JS7_CONTROLLER_CONFIG_DIR/private/https-keystore.p12"
Example for creating a private key and self-signed certificate and importing 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 certificate to a PKCS12 keystore # Adding the private key and certificate to a keystore ./js7_create_certificate_store.sh \ --keystore=JS7_CONTROLLER_DATA/configCONFIG_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 can skip have the truststore available for the later step 34:Code Block title Example how to add a private key and 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_DATACONFIG_DIR/config/private/https-keystore.p12 \ --truststore=JS7_CONTROLLER_DATACONFIG_DIR/config/private/https-keystoretruststore.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.
- For use with a third party utility create a keystore, e.g.
Step 2: Setting up Authentication with the Controller
- 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 "
- For use with a third party utility create a truststore, e.g.
- 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 JOC Cockpit is challenged by the Controller to present its Client Authentication certificate that is then verified by the Controller.
- The
JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12
Step 2: Setting up Authentication with the Controller
- 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 JOC Cockpit is challenged by the Controller to present its Client Authentication certificate that is then verified by the Controller.
The
JS7_CONTROLLER_CONFIG_DIR
/private/private.conf
configuration file should include authentication details such as:
private.conf configuration file should include authentication details such as:Code Block title Example for private.conf file specifying JOC Cockpit authentication js7 { auth {
Explanation:TheCode Block title Example for private.conf file specifying JOC Cockpit authentication js7 { auth { users { # History account (used for releasing events) History { distinguished-names=[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 controllerController 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" ] } } } }
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.
The - 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
- 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
- Plain Text:
- JOC:
- Plain Text:
JS7-JOC
- Hash:
sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE
- Plain Text:
- History:
- 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.
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. 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.Step 3: Setting up the Controller Instance Start Script for HTTPS
"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
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.
- The
password
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, 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
- Plain Text:
- JOC:
- Plain Text:
JS7-JOC
- Hash:
sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE
- Plain Text:
- History:
- The
- 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.
- The
Step 3: Setting up the Controller Instance Start Script for HTTPS
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. #
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
:
Explanation: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
- The HTTP port is required but is limited to the localhost network interface using the
localhost
prefix. - The HTTPS port is specified with the hostname prefix that indicates the network interface.
- The HTTP port is required but is limited to the localhost network interface using the
Step 4: Configuring the JOC Cockpit Truststore
The Root CA Certificate is added to the JOC Cockpit 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 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 "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12" -storetype PKCS12
- For use with a third party utility create a truststore, e.g.
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
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.
If mutual authentication cannot be used then refer to explanations in the JS7 - Configuration for HTTPS Server Authentication with Passwords article.
Step 1: Creating/Updating JOC Cockpit Client Keystore
For mutual authentication JOC Cockpit has to hold a Client Authentication private key and certificate in its keystore.
- This can be simplified by the 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's keystore as described in the JS7 - JOC Cockpit HTTPS Connections article.
- If separate private key/certificate pairs are be used for Server Authentication and Client Authentication purposes then use of separate certificate stores for the JOC Cockpit is recommended:
- The keystore holds the private key/certificate for Server Authentication. The location of the keystore is configured with
JETTY_BASE/start.ini
. - The client keystore holds the private key/certificate for Client Authentication. The location of the client keystore is configured with
JETTY_BASE/resources/joc/joc.properties
.
- The keystore holds the private key/certificate for Server Authentication. The location of the keystore is configured with
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 using the
localhost
prefix. - The HTTPS port is specified with the hostname prefix that indicates the network interface.
- The HTTP port is required but is limited to the localhost network interface using the
Step 4: Configuring the JOC Cockpit Truststore
The Root CA Certificate is added to the JOC Cockpit truststore. This step can be skipped if the JOC Cockpit truststore is available, see JS7 - JOC Cockpit HTTPS ConnectionsThe following steps are applied if a separate client keystore is used with the JOC Cockpit.
- On the JOC Cockpit server create the client keystore truststore using the
keytool
from your Java JRE or JDK or a third party utility.- For use with a 3rd-party utility create a client keystore, e.g.
https-client-keystore.p12,
in PKCS12 format and import:- the JOC Cockpit private key and certificate for Client Authentication
- 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 steps indicated to the client keystore and use the private key/certificate pair for Client Authentication.
- 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
- For use with a 3rd-party utility create a client keystore, e.g.
The location of the truststore The location of the client keystore is added to the
JETTY_BASE/resources/joc/joc.properties
configuration file like this:Example for a PKCS12 client keystore:truststore
Code Block language text title Example how to specify the a PKCS12 client keystore truststore location with the joc.properties file ### Location of the clienttruststore keystore that contains the privatecertificates keyof and all ### Controllers certificateused for HTTPS connections. JOCThe Cockpitpath clientcan authenticationbe relativeabsolute toor ### relative to joc.properties keystoretruststore_path = https-client-keystoretruststore.p12 keystoretruststore_type = PKCS12 keystoretruststore_password = jobscheduler
Example for a JKS client keystore:truststore
Code Block language text title Example how to specify the a JKS client keystore truststore location with the joc.properties file collapse true ### Location of the client keystoretruststore that contains the privatecertificates keyof and all ### certificateControllers used for JOCHTTPS Cockpitconnections. clientThe authenticationpath relativecan to ###be absolute or joc.properties keystore_path = https-client-keystore.jks keystore_type = JKS keystore_password = jobscheduler
Step 2: Creating the Controller Truststore
### 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
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.
If mutual authentication cannot be used then refer to explanations in the JS7 - Configuration for HTTPS Server Authentication with Passwords article.
Creating/Updating the JOC Cockpit Client Keystore
For mutual authentication JOC Cockpit has to hold a Client Authentication private key and certificate in its keystore.
- This can be simplified by the 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's keystore as described in the JS7 - JOC Cockpit HTTPS Connections article.
- If separate private key/certificate pairs for Server Authentication and Client Authentication purposes are used then use of separate certificate stores for the JOC Cockpit is recommended:
- The keystore holds the private key/certificate for Server Authentication. The location of the keystore is configured with
JETTY_BASE/start.ini
. - The client keystore holds the private key/certificate for Client Authentication. The location of the client keystore is configured with
JETTY_BASE/resources/joc/joc.properties
.
- The keystore holds the private key/certificate for Server Authentication. The location of the keystore is configured with
The following steps are applied if a separate client keystore is used with the JOC Cockpit.
- On the JOC Cockpit server create the client keystore using the
keytool
from your Java JRE or JDK or a third party utility.- For use with a 3rd-party utility create a client keystore, e.g.
https-client-keystore.p12,
in PKCS12 format and import:- the JOC Cockpit private key and certificate for Client Authentication
- 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 steps indicated to the client keystore and use the private key/certificate pair for Client Authentication.
- For use with a 3rd-party utility create a client keystore, e.g.
The location of the client keystore is added to the
JETTY_BASE/resources/joc/joc.properties
configuration file like this:Example for a PKCS12 client keystore:
Code Block language text title Example how to specify the PKCS12 client keystore location with joc.properties file ### Location of the client keystore that contains the private key and ### certificate for JOC Cockpit client authentication relative to ### joc.properties keystore_path = https-client-keystore.p12 keystore_type = PKCS12 keystore_password = jobscheduler
Example for a JKS client keystore:
Code Block language text title Example how to specify the JKS client keystore location with joc.properties file collapse true ### Location of the client keystore that contains the private key and ### certificate for JOC Cockpit client authentication relative to ### joc.properties keystore_path = https-client-keystore.jks keystore_type = JKS keystore_password = jobscheduler
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 provide one possible approach for certificate management. 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 Root CA- 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 "root-ca.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 # 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 JKSlanguage bash title Example how to export/import a self-signed certificate to a JKS truststore collapse true
Show If | ||||
---|---|---|---|---|
| ||||
Risk MitigationThe descriptions above indicate use of a Root CA certificate for verification of Client Authentication certificates when it comes to mutual authentication.
|
...