Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • On the JOC Cockpit server run the following command and replace the JETTY_HOME and JETTY_BASE placeholders as specified above:

    Code Block
    languagebash
    titleAdd HTTPS module to Jetty
    java -jar "JETTY_HOME/start.jar" -Djetty.home="JETTY_HOME" -Djetty.base="JETTY_BASE" --add-to-start=https
  • Having executed the above command you should find a new folder JETTY_BASE/etc
    • Jetty expects a Keystore in this folder with the name "keystore" by default.

      Warning

      Jetty doesn't start if it doesn't find a keystore corresponding 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 added.

Step 2: Create the JOC Cockpit Keystore

...

  • On the JOC Cockpit server create the keystore using the keytool from your Java JRE or JDK or some third party utility.
    • For use with a third party utility create a keystore, e.g. https-keystore.p12, in PKCS12 format and import:
      • JOC Cockpit private key and certificate for Server Authentication
      • Root CA certificate
      • Intermediate CA certificates
    • For use with keytool generate the keystore in JKS or PKCS12 format with the private key and certificate for JOC Cockpit Server Authentication. 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 CA signed certificate to a PKCS12 keystore:

        Code Block
        languagebash
        titleExample how to add a CA signed certificate to a PKCS12 Keystore
        # should the JOC Cockpit's private key and certificate be 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-https"
        # keytool -importkeystore -srckeystore keypair.jks -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc-https
        
        # assuming 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 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 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 hostname (FQDN) of the JOC Cockpit server being "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"
        
        # should you require use of a .jks keystore type then convert the pkcs12 keystore assuming the alias name of the JOC Cockpit private key being "joc-https"
        # keytool -importkeystore -srckeystore https-keystore.p12 -srcstoretype PKCS12 -destkeystore https-keystore.jks -deststoretype JKS -srcalias joc-https
      • Example for use of self-signed certificate with a PKCS12 keystore

        Code Block
        languagebash
        titleExample how to generate a self-signed certificate for import into a PKCS12 Keystore
        # generate JOC Cockpit private key with alias name "joc-https" in a keystore (https-keystore.p12)
        #   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
        #   consider that PKCS12 keystores require to use the same key password and store password
        keytool -genkey -alias "joc-https" -dname "CN=hostname,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 self-signed certificate with a JKS keystore

        Code Block
        languagebash
        titleExample how to generate a self-signed certificate for import into a JKS Keystore
        # generate JOC Cockpit private key with alias name "joc-https" in a keystore (https-keystore.jks)
        #   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
        keytool -genkey -alias "joc-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.jks" -storepass jobscheduler -storetype JKS
      • Explanation:

        • Replace the JETTY_BASE placeholder as specified above.
        • 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 your Keystore the keystore file.
        • The -storepass option specifies the password for access to your Keystore the keystore file.
        • The -storepassstoretype option is used for to specify the PKCS12 keystore format , this option is not required for the or JKS keystore format.
  • Alternatively apply a private key and certificate that are issued by your certificate authority or a trusted authority.

...

  • the client verifies the JOC Cockpit certificate for Server Authentication
  • JOC Cockpit verifies the client certificate for Client Authentication

Step 1:

...

Create the JOC Cockpit Truststore

...

  • 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 JKS or PKCS12 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
        languagebash
        titleExample how to import a CA signed certificate into a PKCS12 Truststore
        # import Root CA certificate in PEM format to a PKCS12 truststore (https-truststore.p12)
        keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12"

...