Page History
...
- Connections from user browsers to the JOC Cockpit can be secured by HTTPS with TLS/SSL certificates.
- Connections from clients using the JS7 - REST Web Service API (that ships with the JOC Cockpit) can be secured by HTTPS with TLS/SSL certificates.
- This article describes the steps required to set up secure HTTPS communication with the JOC Cockpit. This includes to set up a standalone JOC Cockpit instance or a JOC Cockpit cluster with a number of instances.
- Refer to the JS7 - System Architecture article for an overview of components and connections.
- Refer to the JS7 - Controller HTTPS Connections article for information about securing the connections between the JOC Cockpit and Controllers.
- Refer to the JS7 - Agent HTTPS Connections article for information about securing the connections between Controller instances and Agents.
Prerequisites
- The following explanations assume CA-signed certificates or self-signed certificates to be used.
- CA-signed certificates are provided from known Certificate Authorities (CA).
- 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.
- 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.
Certificate Management
To secure access to JOC Cockpit by clients (user browsers or REST API clients) the following keys and certificates should be in place:
- The following explanations assume JOC Cockpit starting from release 2.5 to be used. This release introduces Jetty 11. Earlier releases of JOC Cockpit ship with Jetty 9 and make use of a single configuration file
JETTY_BASE/start.ini
instead of separate configuration files JETTY_BASE/start.d/http.ini
,JETTY_BASE/start.d/https.ini
,JETTY_BASE/start.d/ssl.ini
.
Certificate Management
To secure access to JOC Cockpit by clients (user browsers or REST API clients) the following keys and certificates should be in place:
Flowchart |
---|
Client |
Flowchart |
Client [label=" Client \n User Browser / REST API Client ",fillcolor="lightskyblue"] JOC [label=" Client JOC Cockpit ",fillcolor=\n User Browser / REST API Client ",fillcolor="lightskyblue"] JOC [label=" JOC Cockpit ",fillcolor="lightskyblue"] Client#Client_Keystore [label="Client Keystore\nlocation is product dependent\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="limegreen"] Client_TruststoreKeystore [label="Client TruststoreKeystore\nlocation is product dependent\n\nPrivate Key / Certificate",fillcolor="limegreen"] Client_Truststore [label="Client Truststore\nlocation is product dependent\n\nCA Certificates",fillcolor="orange"] JOC #JOC_Keystore [label="JOC Cockpit Keystore\nhttps-keystore.p12\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="orange"] JOC_TruststoreKeystore [label="JOC Cockpit TruststoreKeystore\nhttps-truststorekeystore.p12\n\nCA CertificatesnPrivate Key / Certificate",fillcolor="orange"] Client_Keystore_CA_RootCertificate [shape="ellipse",label="JOC_Truststore [label="JOC Cockpit Truststore\nhttps-truststore.p12\n\nCA Certificates",fillcolor="orange"] #Client_Keystore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"] Client#Client_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate\nCertificate",fillcolor="white"] Client_PrivateKey [shape="ellipse",label="Client Authentication\nPrivate Key",fillcolor="white"] Client_Certificate [shape="ellipse",label="Client Authentication\nCertificate",fillcolor="white"] Client_Truststore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"] JOC_Truststore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"] JOC#JOC_Keystore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"] JOC#JOC_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate\nCertificate",fillcolor="white"] JOC_PrivateKey [shape="ellipse",label="Server Authentication\nPrivate Key",fillcolor="white"] JOC_Certificate [shape="ellipse",label="Server Authentication\nCertificate",fillcolor="white"] Client -> JOC [label=" establish connection "] Client -> Client_Truststore Client_Truststore -> Client_Truststore_CA_RootCertificate [label=" add to truststore \n e.g. by Group Policies "] Client -> Client_Keystore Client#Client_Keystore -> Client_Keystore_CA_RootCertificate -> Client_Keystore_CA_IntermediateCertificate [label=" add to keystore "] Client_Keystore -> Client_PrivateKey -> Client_Certificate [label=" add to keystore "] JOC -> JOC_Keystore JOC#JOC_Keystore -> JOC_Keystore_CA_RootCertificate -> JOC_Keystore_CA_IntermediateCertificate [label=" add to keystore "] JOC_Keystore -> JOC_PrivateKey -> JOC_Certificate [label=" add to keystore "] JOC -> JOC_Truststore JOC_Truststore -> JOC_Truststore_CA_RootCertificate [label=" add to truststore "] |
...
Secure Connections from Clients to JOC Cockpit
This configuration is applied in order The following steps are applied to enable clients (user browser, REST API client) to access the JOC Cockpit using HTTPS.
Step 1:
...
Adding the HTTPS and SSL modules to Jetty
On the JOC Cockpit server, run the following command and replace the
JETTY_HOME
andJETTY_BASE
placeholders as specified above:Code Block language bash title Add HTTPS module to Jetty java -jar "JETTY_HOME/start.jar" -Djetty.home="JETTY_HOME" -Djetty.base="JETTY_BASE" --add-to-start=ssl,https
- Having executed the above command you users should find a new folder
JETTY_BASE/etc
By default Jetty expects a keystore with the name
keystore
in this folder that has been created from the above command.Jetty doesn't start if it doesn't find a keystore that corresponds to its settings.
- In addition a number of entries in the the
JETTY_BASE/start.d/https.ini
andJETTY_BASE/start.ini
configuration file.d/ssl.ini
configuration files will be created and will be populated with a number of entries for TLS/SSL settings such as the HTTPS port will be added.
Anchor | ||||
---|---|---|---|---|
|
...
Creating the JOC Cockpit Keystore
- On the JOC Cockpit server create the keystore using the
keytool
from your Java JRE, JDK or other third party utility.- For use with a third party utility create a keystore, e.g.
https-keystore.p12,
in PKCS12 format and import:- the JOC Cockpit private key and certificate for Server Authentication
- the Root CA certificate
- Intermediate CA certificate(s)
- For use with the
keytool
generate the keystore in PKCS12 or JKS format with the private key and certificate for JOC Cockpit Server Authentication. The examples below describe one possible approach for certificate management, however, there are other ways to achieve similar results.Example for import of importing an existing private key and CA-signed certificate to a PKCS12 keystore:
Code Block language bash title Example how to add a private key and CA-signed certificate to a PKCS12 keystore # IfAssume the JOCfully Cockpit'squalified privatedomain keyname and(FQDN) certificate are 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 JOC Cockpit private key being "joc.example.com" # keytool -importkeystore -srckeystore keypair.jks -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcaliasof the JOC Cockpit server to be "joc.example.com" # If the JOC Cockpit CA-signed certificate is provided from a pkcs12 keystore (certificate.p12), extract the JOC Cockpit certificate to a .crt file in PEM format (joc.example.com.crt) # openssl pkcs12 -in certificate.p12 -nokeys -out joc.example.com.crt # AssumingImport yourthe JOC Cockpit private key from a pkcs12 keystore (keystore.p12), store the JOC Cockpit private key (joc.example.com.key) and JOC Cockpit certificate (joc.example.com.crt) from PEM format to a .key file in PEM formatnew keystore (joc-https.key.example.com.p12) openssl pkcs12 -export -in keystore.p12joc.example.com.crt -nocertsinkey -out joc-httpsjoc.example.com.key # Concatenate the CA Root certificate and CA Intermediate certificates to a single CA Bundle certificate file (ca-bundle.crt) cat RootCACertificate.crt > ca-bundle.crt cat CACertificate.crt >> ca-bundle.crt # Export the JOC Cockpit private key (joc-https.key), JOC Cockpit certificate (joc-https.crt) and CA Bundle (ca-bundle.crt) in PEM format to a new keystore (https-keystore.p12) # assume the fully qualified domain name (FQDN) of the JOC Cockpit server to be "joc.example.com" openssl pkcs12 -export -in joc-https.crt -inkey joc-https.key -chain -CAfile ca-bundle.crt -name joc.example.com -out "JETTY_BASE/resources/joc/https-keystore.p12" # If you require use of a .jks keystore type then convert the pkcs12 keystore, assuming the alias name of the JOC Cockpit private key to be "joc.example.com" # keytool -importkeystore -srckeystore https-keystore.p12 -srcstoretype PKCS12 -destkeystore https-keystore.jks -deststoretype JKS -srcalias joc.example.com
Example for creating a private key and self-signed certificate with a PKCS12 keystore:
--name joc.example.com -out "JETTY_BASE/resources/joc/https-keystore.p12"
Hide If currentSpace JS7 Code Block language bash title Example how to add a private key and CA-signed certificate to a PKCS12 keystore # If the JOC Cockpit's private key and certificate are 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 JOC Cockpit private key being "joc.example.com" # keytool -importkeystore -srckeystore keypair.jks -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc.example.com # Assuming the JOC Cockpit private key from a pkcs12 keystore (keystore.p12), store the JOC Cockpit private key to a .key file in PEM format (joc-https.key) openssl pkcs12 -in keystore.p12 -nocerts -out joc-https.key # Concatenate the CA Root certificate and optionally CA Intermediate certificates to a single CA Bundle certificate file (ca-bundle.crt) cat RootCACertificate.crt > ca-bundle.crt cat CACertificate.crt >> ca-bundle.crt # Export the JOC Cockpit private key (joc-https.key), JOC Cockpit certificate (joc-https.crt) and CA Bundle (ca-bundle.crt) in PEM format to a new keystore (https-keystore.p12) # assume the fully qualified domain name (FQDN) of the JOC Cockpit server to be "joc.example.com" openssl pkcs12 -export -in joc-https.crt -inkey joc-https.key -chain -CAfile ca-bundle.crt -name joc.example.com -out "JETTY_BASE/resources/joc/https-keystore.p12" # If you require use of a .jks keystore type then convert the pkcs12 keystore, assuming the alias name of the JOC Cockpit private key to be "joc.example.com" # keytool -importkeystore -srckeystore https-keystore.p12 -srcstoretype PKCS12 -destkeystore https-keystore.jks -deststoretype JKS -srcalias joc.example.com
Code Block language bash title Example how to generate a private key and self-signed certificate for import into a PKCS12 keystore collapse true # Generate the JOC Cockpit's private key with the "joc.example.com" alias name and certificate in a keystore (https-keystore.p12) # use the fully qualified domain name (FQDN) assumed to be "joc.example.com" and name of your organization for the distinguished name # Note that PKCS12 keystores require to use the same key password and store password keytool -genkey -alias "joc.example.com" -dname "CN=joc.example.com,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.p12" -storepass jobscheduler -storetype PKCS12 Example for creating a private key and self-signed certificate with and importing to a JKS keystore: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 for import into a
PKCS12 keystore
collapse true #
Creating the
private key
and self-signed certificate for the given validity period ./create_certificate.sh --dns=joc.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=JETTY_BASE/resources/joc/https-keystore.
Explanation:
- The
-dname
option specifies the certificate issuer, therefore use your own set of CN, 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. - The
-keystore
option specifies the location of the keystore file. - The
-storepass
option specifies the password for access to the keystore file. - The
-storetype
option is used to specify the PKCS12 or JKS keystore format.
- The
- For use with a third party utility create a keystore, e.g.
- Alternatively apply a private key and certificate that are issued by your certificate authority or a trusted authority.
Step 3: Create JOC Cockpit Truststore
- For the JOC Cockpit Server Authentication a truststore is effectively not needed. However, the Jetty servlet container requires a truststore to be in place. An empty truststore should not be used, instead create the truststore with a certificate.
- On the JOC Cockpit server create the truststore using the
keytool
from your Java JRE, 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 PKCS12 or JKS 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 to 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 for import of a Root CA certificate to a JKS truststore:
Code Block language bash title Example how to import a CA-signed certificate to a JKS truststore collapse true # import Root CA certificate in PEM format to a JKS truststore (https-truststore.jks) keytool -importcert -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS
- For use with a third party utility create a truststore, e.g.
...
See below chapter Mutual Authentication for Clients and JOC Cockpit Step 2: Configure Jetty for configuration of the truststore with JETTY_BASE/start.ini
.
Edit the following entries in the JETTY_BASE/start.ini
configuration file use of the keystore:
Code Block | ||
---|---|---|
| ||
## Keystore file path (relative to $jetty.base)
jetty.sslContext.keyStorePath=resources/joc/https-keystore.p12
## Keystore password
jetty.sslContext.keyStorePassword=jobscheduler
## KeyManager password (same as keystore password for pkcs12 keystore type)
jetty.sslContext.keyManagerPassword=jobscheduler |
...
p12 \ --key=joc.example.com.key \ --cert=joc.example.com.crt \ --alias=joc.example.com \ --password=jobscheduler \
Hide If currentSpace JS7 Code Block language bash title Example how to generate a private key and self-signed certificate for import into a PKCS12 keystore collapse true # Generate the JOC Cockpit's private key with the "joc.example.com" alias name and certificate in a keystore (https-keystore.p12) # use the fully qualified domain name (FQDN) assumed to be "joc.example.com" and name of your organization for the distinguished name # Note that PKCS12 keystores require to use the same key password and store password keytool -genkey -alias "joc.example.com" -dname "CN=joc.example.com,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.p12" -storepass jobscheduler -storetype PKCS12
Step 3: Creating the JOC Cockpit Truststore
- For JOC Cockpit Server Authentication a truststore is effectively not needed. However, the Jetty servlet container requires a truststore to be in place. An empty truststore should not be used, instead create the truststore with a certificate.
- On the JOC Cockpit server create the truststore using the
keytool
from your Java JRE, 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 PKCS12 or JKS format with the Root CA certificate. The below examples suggest a 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 certificate to 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 for import of a Root CA certificate to a JKS truststore:
Code Block language bash title Example how to import a certificate to a JKS truststore collapse true # import Root CA certificate in PEM format to a JKS truststore (https-truststore.jks) keytool -importcert -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS
- For use with a third party utility create a truststore, e.g.
Anchor | ||||
---|---|---|---|---|
|
See below chapter Mutual Authentication for Clients and JOC Cockpit Step 2: Configure Jetty for configuration of the truststore with JETTY_BASE/start.d/ssl.ini
.
Edit the following entries in the
JETTY_BASE/start.d./ssl.ini
configuration file use of the keystore:Code Block title Example hot to set the keystore location with the start.d/ssl.ini file ## Keystore file path (relative to $jetty.base) jetty.sslContext.keyStorePath=resources/joc/https-keystore.p12 ## Keystore password jetty.sslContext.keyStorePassword=jobscheduler ## KeyManager password (same as keystore password for pkcs12 keystore type) jetty.sslContext.keyManagerPassword=jobscheduler ## The Keystore type. jetty.sslContext.keyStoreType=PKCS12
Explanation:- Specify the location of the keystore with the
keyStorePath
setting. A location relative to theJETTY_BASE
directory can be specified. - Specify the password for your keystore with the
keyStorePassword
setting. - The password specified with the
keyManagerPassword
setting is used for access to your private key. The same password as for thekeyStorePassword
setting has to be used for a PKCS12 keystore type. - Optionally specify the keystore type with the
keyStoreType
setting. If this setting is missing then the JVM's default keystore type will be used.
- Specify the location of the keystore with the
Specify the HTTPS port with the following entries of the
JETTY_BASE/start.d/ssl.ini
configuration file (default HTTPS port is 48446):Code Block title Example how to set the port for the HTTPS protocol with the start.d/ssl.ini file ## The host/address to bind the connector to. # jetty.ssl.host=0.0.0.0 ## Connector port to listen on jetty.ssl.port=48446
Explanation:- The
jetty.ssl.host
setting optionally can be used to limit port access to the specified host/network interface access. - The
jetty.ssl.port
setting specifies the port for Jetty.
- The
Step 5: Deactivating HTTP Access
Users who intend to enforce HTTPS should deactivate HTTP access by adding a comment to the following module directive in the JETTY_BASE/start.d/http.ini
configuration file like this:
Code Block | ||
---|---|---|
| ||
# Module: http
# --module=http |
It is recommended to deactivate HTTP access to JOC Cockpit if HTTPS is enabled. Typically HTTPS is not an invite to users to fall back to a less secure HTTP protocol. Should both protocols be used then consider that separate ports or separate network interfaces using the same port are required.
The following example suggests that the host/network interfaces centostest-primary
should be used for HTTP and the host/network interface centostest-secondary
should be used for HTTPS: A single port 4446
is used.
Code Block | ||
---|---|---|
| ||
# Module: http
--module=http
## The host/address to bind the connector to.
jetty.http.host=centostest-primary
## The port the connector listens on.
jetty.http.port=4446 |
Code Block | ||
---|---|---|
| ||
### TLS (SSL) Connector Configuration
--module=ssl
## The host/address to bind the connector to.
jetty.ssl.host=centostest-secondary
## The port the connector listens on.
jetty.ssl.port=4446 |
...
Specify the HTTPS port with the following entry of the JETTY_BASE/start.ini
configuration file (default HTTPS port is 48446):
Code Block | ||
---|---|---|
| ||
## Connector port to listen on
jetty.ssl.port=48446 |
Step 4: Deactivate HTTP Access
To deactivate HTTP access add a comment to the following module directive in your JETTY_BASE/start.ini
configuration file like this:
Code Block | ||
---|---|---|
| ||
# Module: http
# --module=http |
Mutual Authentication for Clients and JOC Cockpit
...
- the client verifies the JOC Cockpit certificate for Server Authentication certificate,
- the JOC Cockpit verifies the client certificate for 's Client Authentication certificate.
Step 1: Update JOC Cockpit Truststore
- On the JOC Cockpit server update the truststore using the
keytool
from your Java JRE, JDK or some third party utility.- For use with a third party utility update a truststore, e.g.
https-truststore.p12,
in PKCS12 format and import:- Root CA certificate
- For use with
keytool
update the truststore in PKCS12 or JKS format with the Root CA certificate. The The below examples suggest one a 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 to 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 for import of a Root CA certificate to a JKS truststore:
Code Block language bash title Example how to import a CA-signed certificate to a JKS truststore collapse true # import Root CA certificate in PEM format to a JKS truststore (https-truststore.jks) keytool -importcert -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS
- For use with a third party utility update a truststore, e.g.
...
See above chapter Secure Connections from Clients to JOC Cockpit Step 4: Configure Jetty for configuration of the truststore with JETTY_BASE/start.d/ssl.ini
.
Edit the following entries in the
JETTY_BASE/start.d/ssl.ini
configuration file for the truststore location:Code Block title Example how to configure the truststore location with the start.d/ssl.ini file ## Truststore file path (relative to $jetty.base) jetty.sslContext.trustStorePath=resources/joc/https-truststore.p12 ## Truststore password password jetty.sslContext.trustStorePassword=jobscheduler ## TrustStore type. jetty.sslContext.trustStorePasswordtrustStoreType=jobschedulerPKCS12
Explanation:- Specify the location of the truststore with the
trustStorePath
setting. A location relative to theJETTY_BASE
directory can be specified. - Specify the password for access to the truststore with the
trustStorePassword
setting. - Specify the truststore type to be one of
PKCS12
orJKS
.
- Specify the location of the truststore with the
- Option
- Should certificate based authentication be enforced allowed as a single or as a second factor for authentication then Jetty can be configured to automatically challenge clients to present a Client Authentication certificate. Be aware that with this option being in place it is no longer possible to login with account/password only as a Client Authentication certificate is required..
Specify the settings to enforce allow client authentication with the following entries in the
JETTY_BASE/start.d/ssl.ini
configuration file:Code Block title Example how to enforce client authentication with the start.ini file ## enable use of client authentication certificates jetty.sslContext.needClientAuth=false jetty.sslContext.wantClientAuth=true jetty.sslContext.endpointIdentificationAlgorithm=
Explanation:
- Find explanations from the JS7 - Authentication article.
...
- A restart of JOC Cockpit is required to apply modifications to the JOC Cockpit
JETTY_BASE/start.d/*.ini
andJETTY_BASE/resources/joc/joc.properties
configuration files .
...