...

• 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.
  • Consider Refer to the JS7 - System Architecture article for an overview of components and connections.
  • Consider Refer to the JS7 - Controller HTTPS Connections article for information about securing the connections between the JOC Cockpit and Controllers.
  • Consider Refer to the JS7 - Agent HTTPS Connections for  article for information about securing the connections between Controller instances and Agents.

...

• 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:

...

Client [label="   Client   \n   User Browser / REST API Client   ",fillcolor="lightskyblue"]
JOC [label="   JOC Cockpit   ",fillcolor="lightskyblue"]
 
Client_Keystore [label="Client Keystore\nlocation is product dependent\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="limegreen"]
Client_Truststore [label="Client Truststore\nlocation is product dependent\n\nCA Certificates",fillcolor="orange"]
JOC_Keystore [label="JOC Cockpit 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"]

Client_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
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",shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
JOC_Truststore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
JOC_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
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_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_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 "]

Explanation:

• Keystore Keystores and truststore truststores shown in orange colorare required for any connections of clients to JOC Cockpit.
• Keystore Keystores and truststore truststores shown in green colorare required if mutual authentication is in place, e.g. to allow certificate based authentication.
• A JOC Cockpit truststore is always required. Should secure connections be used to access a Controller or an LDAP server for authentication/authorization then the the truststore holds respective truststore will hold the necessary certificates.
• Consider that similar distribution of private keys and certificates applies if a JOC Cockpit cluster with a number of instances is used.

Secure Connection Setup

In the following the placeholders , JOC_HOME, JETTY_HOME and JETTY_BASE are placeholders are used which locate three directories. If you install Jetty with the JOC Cockpit installer then:

• JOC_HOME is the installation path that is specified during JOC Cockpit installation:
  
  • /opt/sos-berlin.com/js7/joc (default on Unix)
  • C:\Program Files\sos-berlin.com\js7\joc (default on Windows)
• JETTY_HOME = JOC_HOME/jetty
• JETTY_BASE is Jetty's base directory that is specified during JOC Cockpit installation:
  
  • /home/<setup-user>/sos-berlin.com/js7/joc (default on Unix)
  • C:\ProgramData\sos-berlin.com\js7\joc (default on Windows)

...

This configuration is applied in order to enable clients (user browser, REST API client) to access the JOC Cockpit by use of using HTTPS.

Step 1: Add HTTPS module to Jetty

• On the JOC Cockpit server, run the following command and replace the JETTY_HOME and JETTY_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 should find a new folder JETTY_BASE/etc
  

  • By default Jetty expects a keystore with the name keystore in this folder that is 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 JETTY_BASE/start.ini configuration file for TLS/SSL settings such as the HTTPS port are will be added.

Anchor
server_authentication_create_keystore server_authentication_create_keystore

Step 2: Create JOC Cockpit Keystore

• On the JOC Cockpit server create the keystore using the keytool from your Java JRE or , JDK or some 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 certificatescertificate(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 The examples below examples suggest describe one possible approach for certificate management, however, there may be are other ways how to achieve similar results.

    • Example for import of 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
      # shouldIf the JOC Cockpit's private key and certificate beare 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-httpsjoc.example.com" # keytool -importkeystore -srckeystore keypair.jks -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc-https.example.com # assumingAssuming your 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 concatenatethe 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 hostnamedomain name (FQDN) of the JOC Cockpit server to beingbe "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" # shouldIf you require use of a .jks keystore type then convert the pkcs12 keystore, assuming the alias name of the JOC Cockpit private key to beingbe "joc-https.example.com" # keytool -importkeystore -srckeystore https-keystore.p12 -srcstoretype PKCS12 -destkeystore https-keystore.jks -deststoretype JKS -srcalias joc-https.example.com

    • Example for use of creating a private key and self-signed certificate with a PKCS12 keystore:

      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 generatethe JOC Cockpit's private key with aliasthe name "joc-https".example.com" alias name and certificate in a keystore (https-keystore.p12) # use the fully qualified domain hostnamename (FQDN) assumed to be "joc.example.com" and name of your organization for the distinguished name # considerNote that PKCS12 keystores require to use the same key password and store password keytool -genkey -alias "joc-https.example.com" -dname "CN=hostnamejoc.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 use of creating a private key and self-signed certificate with a JKS keystore:

      Code Block
      language bash title Example how to generate a private key and self-signed certificate for import into a JKS keystore collapse true
      # generateGenerate the JOC Cockpit's private key with aliasthe name "joc-https" .example.com" alias name and certificate in a keystore (https-keystore.jks) # use the fully qualified hostname (FQDN)domain name (FQDN) assumed to be joc.example.com and name of your organization for the distinguished name keytool -genkey -alias "joc-https.example.com" -dname "CN=hostnamejoc.example.com,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.jks" -storepass jobscheduler -storetype JKS

    • Explanation:

      • The -dname option specifies the certificate issuer, therefore use your own set of CN, OU, DC that specify the issuer's distinguished nameDistinguished 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.
• 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 effectively no a truststore is effectively not needed, however. 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 or , 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 -importimportcert -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 -importimportcert -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS

...

• On the JOC Cockpit server update the truststore using the keytool from your Java JRE or , 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 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 -importimportcert -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 -importimportcert -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS

...

• Edit the following entries in the JETTY_BASE/start.ini configuration file for the truststore location:

  Code Block
  title Example how to configure the truststore location with the start.ini file
  ## Truststore file path (relative to $jetty.base) jetty.sslContext.trustStorePath=resources/joc/https-truststore.p12 ## Truststore password jetty.sslContext.trustStorePassword=jobscheduler

  
  Explanation:

  • Specify the location of the truststore with the trustStorePath setting. A location relative to the JETTY_BASE directory can be specified.
  • Specify the password for access to the truststore with the trustStorePassword setting.
• Option
  • Should certificate based authentication be enforced 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 client authentication with the following entries in the JETTY_BASE/start.ini configuration file: 

    Code Block
    title Example how to enforce client authentication with the start.ini file
    ## forceenable use of client authentication certificates jetty.sslContext.needClientAuth=false jetty.sslContext.wantClientAuth=true jetty.sslContext.endpointIdentificationAlgorithm=

    Explanation:

    • Find explanations from the JS7 - Authentication article.

...

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

• In fact use of a Root CA certificate allows any clients that dispose of a Client Authentication certificate Certificate signed by the same Root CA certificate Certificate or Intermediate CA certificates Certificates to be authenticated. This implication might allow an unwanted number of clients to access JOC Cockpit.
• Coping strategies include
  • to use a separate certificate authority Certificate Authority to sign Client Authentication certificates Certificates for access to JOC Cockpit.
  • to import individual Client Authentication certificates Certificates to the JOC Cockpit truststore instead of using a Root CA certificateCertificate.

Notes

• A restart of JOC Cockpit is required to apply modifications to the JOC Cockpit JETTY_BASE/start.ini and JETTY_BASE/resources/joc/joc.properties configuration files .

...