Page History

...

Client [label="   Client   \n   User Browser / REST API Client   ",fillcolor="lightskyblue"]
JOC [label="   JOC Cockpit   \nStandalone / Primary",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="limegreen"]

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

...

• JOC_HOME is the installation path that is specified during JOC Cockpit installation:
  
  • /opt/sos-berlin.com/js7/joc (default on LinuxUnix)
  • 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 LinuxUnix)
  • C:\ProgramData\sos-berlin.com\js7\joc (default on Windows)

Secure Connections

...

from Clients to JOC Cockpit

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

...

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

• Having executed the above command you should find a new folder JETTY_BASE/etc
  

  • By default Jetty expects a Keystore in this folder keystore with the name "keystore" by default.
    

    warning

    keystore in this folder that is created from the above command.

  • Jetty doesn't start if it doesn't find a keystore

    corresponding

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

...

• 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
      language bash title Example how to add a private key and CA-signed certificate to a PKCS12 Keystorekeystore
      # 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
      language bash title Example how to generate a private key and self-signed certificate for import into a PKCS12 Keystorekeystore collapse true
      # 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 selfof 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 Keystorekeystore collapse true
      # 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:

      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 the keystore file.
      • The -storepass option specifies the password for access to the keystore file.
      • The -storetype option is used to specify the PKCS12 keystore format or JKS keystore format.
• Alternatively apply a private key and certificate that are issued by your certificate authority or a trusted authority.

Anchor
server_authentication_configure_jetty server_authentication_configure_jetty

Step 3: Configure Jetty

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

• Edit the following entries in the JETTY_BASE/start.ini configuration file use of the keystore:

  Code Block
  title Example hot to set the keystore location with the start.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

  
  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 is used for access to your private key. The same password as for the keyStorePassword setting has to be used for a PKCS12 keystore type.
    
    

• Specify the HTTPS port with the following entry of the JETTY_BASE/start.ini configuration file (default HTTPS port is 48446):

  Code Block
  title Example how to set the port for the HTTPS protocol with the start.ini file
  ## Connector port to listen on jetty.ssl.port=48446

...

To deactivate HTTP access add a comment to the following module directive in your JETTY_BASE/start.ini configuration file like this:

# Module: http
# --module=http

Mutual Authentication for Clients

...

and JOC Cockpit

This configuration is applied in order to enable mutual authentication:

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

...

• 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 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
      language bash title Example how to import a CA-signed certificate to a PKCS12 Truststoretruststore
      # 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
      language bash title Example how to import a CA-signed certificate to a JKS Truststoretruststore collapse true
      # 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
client_authentication_configure_jetty client_authentication_configure_jetty

Step 2: Configure Jetty

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

• Edit the following entries in the JETTY_BASE/start.ini configuration file use of for the keystoretruststore 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.

• 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
  ## force use of client authentication certificates jetty.sslContext.needClientAuth=false jetty.sslContext.wantClientAuth=true jetty.sslContext.endpointIdentificationAlgorithm=

  Explanation:

  • Find explanations from the JS7 - Authentication article.

...