...

• The following explanations assume Private CA-signed certificates Certificates or selfPublic CA-signed certificates Certificates to be used.
  • Private CA-signed Certificates are created by users who operate their own CA, see the JS7 - How to create X.509 SSL TLS Certificates.
  • Public CA-signed Certificates certificates are provided from known and trusted Certificate Authorities (CA) that validate 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.
  • There is no difference in using a Private CA or Public CA concerning functionality of X.509 certificates, usage for Server Authentication / Client Authentication, or security of connections. The only difference is that users trust the Private CA that they set up on their ownUse 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.
• 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.

...

To secure access to JOC Cockpit by clients (user browsers or REST API clients) the following keys Private Keys and certificates 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_Keystore [label="Client Keystore\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_Keystore [label="JOC Cockpit Keystore\nhttps-keystore.p12\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="orange"]
JOC_Keystore [label="JOC Cockpit Keystore\nhttps-keystore.p12\n\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",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",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"]

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 "]

...

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

...

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

...

• On the JOC Cockpit server create the keystore using openssl and the keytool from your Java JRE, JDK or other third 3rd-party utility.
  • For use with a third 3rd-party utility create a keystore, e.g. https-keystore.p12, in PKCS12 format and import:
    • the JOC Cockpit private key and certificate for Server Private Key and Certificate for Server Authentication
    • the Root CA Certificate
    • Intermediate CA Certificate(s)
  • The examples below describe a possible approach for certificate management, however, there are other ways to achieve similar results.

    • Example for importing an existing private key Private Key and CA-signed certificate Certificate to a keystore:

      Code Block
      language bash title Example how to add a private key Private Key and CA-signed certificate Certificate to a PKCS12 keystore
      # Assume the fully qualified domain name (FQDN) of the JOC Cockpit server to be "joc.example.com" # If the JOC Cockpit CA-signed certificateCertificate is provided from a pkcs12 keystore (certificate.p12), extract the JOC Cockpit certificateCertificate to a .crt file in PEM format (joc.example.com.crt) # openssl pkcs12 -in certificate.p12 -nokeys -out joc.example.com.crt # Import the JOC Cockpit privatePrivate keyKey (joc.example.com.key) and JOC Cockpit certificateCertificate (joc.example.com.crt) from PEM format to a new keystore (joc.example.com.p12) openssl pkcs12 -export -in joc.example.com.crt -inkey joc.example.com.key --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 Private Key and CA-signed certificate Certificate to a PKCS12 keystore # If the JOC Cockpit's privatePrivate keyKey and certificateCertificate 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 privatePrivate keyKey being "joc.example.com" # keytool -importkeystore -srckeystore keypair.jks -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc.example.com # Assuming the JOC Cockpit privatePrivate keyKey from a pkcs12 keystore (keystore.p12), store the JOC Cockpit privatePrivate keyKey to a .key file in PEM format (joc-https.key) openssl pkcs12 -in keystore.p12 -nocerts -out joc-https.key # Concatenate the CA Root certificateCertificate and optionally CA Intermediate certificatesCertificates 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 privatePrivate keyKey (joc-https.key), JOC Cockpit certificateCertificate (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 privatePrivate keyKey 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 Private Key and selfCA-signed certificate Certificate and importing to a keystore

      • Refer to examples available from JS7 - How to create self-signed X.509 SSL TLS Certificates, chapter Creating a SSL/TLS Server CertificateCertificates.

        Code Block
        language bash title Example how to create a private key Private Key and selfCA-signed certificateCertificate
        # Creating the privatePrivate keyKey and selfCA-signed certificateCertificate for the given validity period ./create_server_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 Private Key and certificate Certificate to a PKCS12 keystore
        # Adding the privatePrivate keyKey and certificateCertificate to a keystore ./js7_create_certificate_store.sh \ --keystore=JETTY_BASE/resources/joc/https-keystore.p12 \ --key=joc.example.com.key \ --cert=joc.example.com.crt \ --alias=joc.example.com \ --password="jobscheduler"

        
        When using additional arguments for creation of a truststore then users can skip the later step 3:

        Code Block
        title Example how to add a private key Private Key and certificate Certificate to a PKCS12 keystore and the Root CA Certificate to a truststore
        # Adding the privatePrivate keyKey and certificateCertificate to a keystore and Root CA Certificate to a truststore ./js7_create_certificate_store.sh \ --keystore=JETTY_BASE/resources/joc/https-keystore.p12 \ --truststore=JETTY_BASE/resources/joc/https-keystore.p12 \    --key=joc.example.com.key \ --cert=joc.example.com.crt \ --alias=joc.example.com \ --password="jobscheduler" \ --ca-root=root-ca.crt

        Hide If
        endDateTime 2024-08-20T00:00:00 currentSpace JS7
        Code Block language bash title Example how to generate a private key Private Key and selfCA-signed certificate Certificate for import into a PKCS12 keystore collapse true # Generate the JOC Cockpit's privatePrivate keyKey with the "joc.example.com" alias name and certificateCertificate 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

...

• For JOC Cockpit Server Authentication a truststore technically is not needed. However, the Jetty servlet container requires a truststore to be in place. An empty truststore should not be used, instead create a truststore with the Root CA Certificate.
• Users who create the truststore with above step 2 can skip this step.
• On the JOC Cockpit server create the truststore using the keytool from your Java JRE, JDK or some third 3rd-party utility.
  • For use with a 3rd-party utility create a truststore, e.g. https-truststore.p12, in PKCS12 format and import:
    • 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 Root CA Certificate to a PKCS12 truststore
      # import Root CA certificateCertificate 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

    • Example for import of a Root CA Certificate to a JKS truststore:

      Code Block
      language bash title Example how to import a Root CA 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 "root-ca.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS

...

• Edit the following entries in the JETTY_BASE/start.d./ssl.ini configuration file for use of the keystore and truststore:

  Code Block
  title Example how to use the keystore/truststore settings 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 ## Truststore file path (relative to $jetty.base) jetty.sslContext.trustStorePath=resources/joc/https-truststore.p12 ## Truststore password jetty.sslContext.trustStorePassword=jobscheduler ## TrustStore type. jetty.sslContext.trustStoreType=PKCS12

  
  Explanation:

  • Specify the location of the keystore with the keyStorePath setting. A location relative to the JETTY_BASE directory can be specified.
  • Specify the password for your keystore with the keyStorePassword setting.
  • The password specified with the keyManagerPassword setting setting is used for access to your private keythe Private Key. The same password as for the keyStorePassword 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 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.
  • Specify the truststore type to be one of PKCS12 or JKS.
    
    

• 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=joc.example.com ## 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.
  • The jetty.ssl.port setting specifies the port for Jetty. Consider to allow incoming connections to this port from your firewall.

...

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

...

Resources

• JS7 - Controller HTTPS Connections
• JS7 - Agent HTTPS Connections
• JS7 - Configuration Templates
  • JS7 - Configuration for mutual HTTPS Server Authentication and Client Authentication
  • JS7 - Configuration for HTTP Basic Authentication with Passwords
  • JS7 - Configuration for HTTPS Server Authentication with Passwords
• JS7 - How to create self-signed X.509 SSL TLS Certificates
• JS7 - How to add SSL TLS Certificates to Keystore and Truststore

...