Page History

...

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

...

• 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 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 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 describe one possible approach for certificate management, however, there may be are other ways 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
      # 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-https.example.com" # keytool -importkeystore -srckeystore keypair.jks -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc-https.example.com # 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 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 hostnamename (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-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 the JOC Cockpit's private key with the "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 # Note 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
      # Generate the JOC Cockpit's private key with the "joc-https.example.com" alias name and certificate in a keystore (https-keystore.jks) # use the fully qualified hostnamedomain 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.

...

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

...