Versions Compared

Key

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

...

Flowchart
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="limegreenorange"]

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

...

  • Keystore and truststore in orange color are required for any connections of clients to JOC Cockpit.
  • Keystore and truststore in green color are required if mutual authentication is in place, e.g. to allow certificate based authentication.
  • A JOC Cockpit truststore in green color is required should truststore is always required. Should secure connections be used to access a Controller or an LDAP server for authentication/authorization . It is therefore recommended to set up the JOC Cockpit truststorethe the truststore holds respective certificates.
  • Consider that similar distribution of private keys and certificates applies if a JOC Cockpit cluster with a number of instances is used.

...

  • 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 PKCS12 or JKS 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 private key and CA-signed certificate to a PKCS12 keystore:

        Code Block
        languagebash
        titleExample how to add a private key and 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 -srcstoretype 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 private key and self-signed certificate with a PKCS12 keystore:

        Code Block
        languagebash
        titleExample how to generate a private key and self-signed certificate for import into a PKCS12 keystore
        collapsetrue
        # generate JOC Cockpit's private key with alias name "joc-https" and certificate 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 private key and self-signed certificate with a JKS keystore:

        Code Block
        languagebash
        titleExample how to generate a private key and self-signed certificate for import into a JKS keystore
        collapsetrue
        # generate JOC Cockpit's private key with alias name "joc-https" and certificate 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:

        • 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.
  • 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 JOC Cockpit Server Authentication effectively no truststore is 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
        languagebash
        titleExample 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 -import -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
        languagebash
        titleExample how to import a CA-signed certificate to a JKS truststore
        collapsetrue
        # import Root CA certificate in PEM format to a JKS truststore (https-truststore.jks)
        keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS

Anchor
server_authentication_configure_jetty
server_authentication_configure_jetty
Step 4: Configure Jetty

See below chapter Mutual Authentication for Clients and JOC Cockpit Step 2: Configure Jetty for configuration of the truststore with JETTY_BASE/start.ini.

...

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

Step 1:

...

Update JOC Cockpit Truststore

  • On the JOC Cockpit server create update the truststore using the keytool from your Java JRE or JDK or some third party utility.
    • For use with a third party utility create update a truststore, e.g. https-truststore.p12, in PKCS12 format and import:
      • Root CA certificate
    • For use with keytool create 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
        languagebash
        titleExample 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 -import -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
        languagebash
        titleExample how to import a CA-signed certificate to a JKS truststore
        collapsetrue
        # import Root CA certificate in PEM format to a JKS truststore (https-truststore.jks)
        keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS

...

See above chapter Secure Connections from Clients to JOC Cockpit Step 34: Configure Jetty for configuration of the truststore with JETTY_BASE/start.ini.

...