JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 2

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 25

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

Introduction

  • Connections from the user 's browsers to the JOC Cockpit can be secured by HTTPS and with TLS/SSL certificates.
  • Connections from clients using the JS7 - REST Web Service API to the Controller  (that ships with the JOC Cockpit) can be secured by HTTPS with TLS/SSL certificates.
  • This article describes the steps required to set up secure HTTPS communication with the JOC Cockpit. This includes to set up a standalone JOC Cockpit and with the Controller.instance or a JOC Cockpit cluster with a number of instances.

Prerequisites

Prerequisites

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

Certificate Management

Certificate Management for secure connections of clients to JOC Cockpit

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

Certificate Management

To secure access to JOC Cockpit To secure the JOC Cockpit user interface for HTTPS access by clients (user browsers or REST API clients) the following private key keys and certificates should be in place:


Flowchart
Client [label="   Client   \nUser Browser / REST API Client   ",fillcolor="lightskyblue"]
JOC [label="   Client   \n   User Browser / REST API Client   ",fillcolor="lightskyblue"]
JOC [label="   JOC Cockpit   ",fillcolor="lightskyblue"]
 
Client_TruststoreKeystore [label="Client TruststoreKeystore\ntruststorenlocation location 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\n./jetty_base/resources/joc/httpsnhttps-keystore.p12\n\nCA Certificates\nJOC CockpitnPrivate Private Key / Certificate",fillcolor="orange"]

ClientJOC_Truststore_CA_RootCertificate [shapelabel="ellipse",shape="ellipse",label="CA Root CertificateJOC Cockpit Truststore\nhttps-truststore.p12\n\nCA Certificates",fillcolor="whiteorange"]
JOC
Client_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate\nCertificate",fillcolor="white"]
JOCClient_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate Certificate\nCertificate",fillcolor="white"]

JOCClient_PrivateKey [shape="ellipse",label="JOC Cockpit PrivateClient Authentication\nPrivate Key",fillcolor="white"]
JOCClient_Certificate [shape="ellipse",label="JOC Cockpit CertificateClient Authentication\nCertificate",fillcolor="white"]

Client -> JOC [_Truststore_CA_RootCertificate [shape="ellipse",label=" establish JOC Cockpit connection "]
Client -> Client_Truststore [label=" use certificate store "]
Client_Truststore -> ClientCA Root\nCertificate",fillcolor="white"]
JOC_Truststore_CA_RootCertificate [shape="ellipse",label=" add to truststore, e.g. by Group Policies "]

JOC -> JOC_Keystore
JOC_Keystore -> CA Root\nCertificate",fillcolor="white"]
JOC_Keystore_CA_RootCertificate -> [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
JOC_Keystore_CA_IntermediateCertificate [shape="ellipse",label=" add to keystore CA Intermediate\nCertificate",fillcolor="white"]

JOC_Keystore -> JOC_PrivateKeyPrivateKey [shape="ellipse",label="Server Authentication\nPrivate Key",fillcolor="white"]
JOC_Certificate [shape="ellipse",label="Server Authentication\nCertificate",fillcolor="white"]

Client -> JOC_Certificate [label=" addestablish to keystoreconnection "]

Then proceed with chapter Set up a secure connection of user browsers to the JOC Cockpit

Certificate Management for secure connections from JOC Cockpit to Controller

Should JOC Cockpit and Controller be operated on the same server and network interface then no HTTPS connection between both components is required.

Should JOC Cockpit and Controller be operated on different servers then this connection should be secured by HTTPS.

Private keys and certificates should be distributed as follows:

Flowchart
Client [label="   Client   \nUser Browser / REST Client",fillcolor="lightskyblue"]
Controller [label="   Controller   ",fillcolor="lightskyblue"]
JOC [label="   JOC Cockpit   ",fillcolor="lightskyblue"]
 
Client_Truststore [label="Client Truststore\ntruststore location is product dependent\n\nCA Certificates",fillcolor="orange"]
Controller_Keystore [label="Controller Keystore\n./config/private/https-keystore.p12\n\nCA Certificates\nController Private Key / Certificate",fillcolor="orange"]
JOC_Truststore [label="JOC Cockpit Truststore\n./jetty_base/resources/joc/https-truststore.p12\n\nCA certificates",fillcolor="orange"]
JOC_Keystore [label="JOC Cockpit Keystore\n./jetty_base/resources/joc/https-keystore.p12\n\nCA Certificates\nJOC Cockpit Private Key / Certificate",fillcolor="orange"]

Client_Truststore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate",fillcolor="white"]
JOC_Truststore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate",fillcolor="white"]
JOC_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate",fillcolor="white"]
JOC_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate Certificate",fillcolor="white"]

Controller_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate",fillcolor="white"]
Controller_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate Certificate",fillcolor="white"]
Controller_PrivateKey [shape="ellipse",label="Controller Private Key",fillcolor="white"]
Controller_Keystore_Certificate [shape="ellipse",label="Controller Certificate",fillcolor="white"]

JOC_PrivateKey [shape="ellipse",label="JOC Cockpit Private Key",fillcolor="white"]
JOC_Certificate [shape="ellipse",label="JOC Cockpit Certificate",fillcolor="white"]

Controller -> Controller_Keystore 
Controller_Keystore -> Controller_Keystore_CA_RootCertificate -> Controller_Keystore_CA_IntermediateCertificate [label=" add to keystore "]
Controller_Keystore -> Controller_PrivateKey -> Controller_Keystore_Certificate [label=" add to keystore "]

Client -> JOC [label=" establish JOC Cockpit connection "]
Client -> Client_Truststore [label=" use certificate store "]
Client_Truststore -> Client_Truststore_CA_RootCertificate [label=" add to truststore, e.g. by Group Policies "]

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

The Controller's private key and certificate are added to the Controller's keystore. In case of a self-signed certificate the certificate is added to the JOC Cockpit truststore as well. This step can be skipped if a CA-signed certificate is used as the Root Certificate in the JOC Cockpit truststore is sufficient to verify Controller certificates.

Secure Connection Setup

...

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

In the following the placeholders JOC_HOME, JETTY_HOME and JETTY_BASE are used which locate three directories. If you install Jetty with the JOC installer then

  • JOC_HOME is the installation path which is specified during the JOC Cockpit installation:
    • /opt/sos-berlin.com/js7/joc (default on Linux)
    • C:\Program Files\sos-berlin.com\js7\joc (default on Windows)
  • JETTY_HOME = JOC_HOME/jetty
  • JETTY_BASE is Jetty's base directory which is specified during the JOC Cockpit installation:
    • /home/<setup-user>/sos-berlin.com/js7/joc (default on Linux)
    • C:\ProgramData\sos-berlin.com\js7\joc (default on Windows)

Step 1: Add the HTTPS module to Jetty

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

    • You can copy the JETTY_HOME/etc/keystore file to JETTY_BASE/etc/keystore as a workaround, however, you should use your own Keystore for later on (see step 2). It is not recommended to use the default Keystore as in particular, the Keystore from JETTY_HOME/etc/keystore expires after a short lifetime.

      Warning

      Jetty doesn't start if it doesn't find a keystore corresponding its settings.

  • In addition some entries in the JETTY_BASE/start.ini configuration file for SSL settings such as the HTTPS port are added.

Step 2: Create the Java Keystore for Jetty

  • On the JOC Cockpit server create the Java Keystore using the Keytools from your Java JRE or JDK.
    • Generate the Java Keystore in JKS or PKCS12 format with the private key and public certificate for Jetty. The below examples suggest one possible approach for certificate management, however, there may be other ways how to achieve similar results.

      • Example for use of self-signed certificate with JKS keystore format

        Code Block
        languagebash
        titleExample how to generate a JKS Keystore with private key and public certificate
        # generate JOC Cockpit private key with alias name "joc-https" in a keystore (joc-https.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/etc/joc-https.jks" -storepass jobscheduler

      • Example for use of self-signed certificate with PKCS12 keystore format

        Code Block
        languagebash
        titleExample how to generate a PKCS12 Keystore with private key and public certificate
        # generate JOC Cockpit private key with alias name "joc-https" in a keystore (joc-https.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/etc/joc-https.p12" -storepass jobscheduler -storetype PKCS12

      • Example for use of CA signed certificate with PKCS12 keystore format:

        Code Block
        languagebash
        titleExample how to add a CA signed private key and public certificate to a PKCS12 Keystore
        # should your JOC Cockpit private key and certificate by 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 is "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 public certificate in PEM format (joc-https.crt) and CA Bundle in PEM format (ca-bundle.crt) to a new keystore (joc-https.p12)
#   assume the fully qualified hostname (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 joc-https.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 to be "joc-https"
# keytool -importkeystore -srckeystore joc-https.p12 -srcstoretype PKCS12 -destkeystore joc-https.jks -deststoretype JKS -srcalias joc-https

      • Explanations

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

Step 3: Configure Jetty

Edit the following entries in the JETTY_BASE/start.ini configuration file corresponding to the Java Keystore:

Code Block
## Keystore file path (relative to $jetty.base)
jetty.sslContext.keyStorePath=etc/joc-https.jks

## Truststore file path (relative to $jetty.base)
jetty.sslContext.trustStorePath=etc/joc-https.jks

## Keystore password
jetty.sslContext.keyStorePassword=jobscheduler

## KeyManager password (same as keystore password for pkcs12 keystore type)
jetty.sslContext.keyManagerPassword=jobscheduler

## Truststore password
jetty.sslContext.trustStorePassword=jobscheduler

...

Client -> Client_Truststore
Client_Truststore -> Client_Truststore_CA_RootCertificate [label="&nbsp;add to truststore&nbsp;\n&nbsp;e.g. by Group Policies&nbsp;"]

Client -> Client_Keystore
Client_Keystore -> Client_Keystore_CA_RootCertificate -> Client_Keystore_CA_IntermediateCertificate [label="&nbsp;add to keystore&nbsp;"]
Client_Keystore -> Client_PrivateKey -> Client_Certificate [label="&nbsp;add to keystore&nbsp;"]

JOC -> JOC_Keystore
JOC_Keystore -> JOC_Keystore_CA_RootCertificate -> JOC_Keystore_CA_IntermediateCertificate [label="&nbsp;add to keystore&nbsp;"]
JOC_Keystore -> JOC_PrivateKey -> JOC_Certificate [label="&nbsp;add to keystore&nbsp;"]

JOC -> JOC_Truststore
JOC_Truststore -> JOC_Truststore_CA_RootCertificate [label="&nbsp;add to truststore&nbsp;"]


Explanation:

  • 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 always 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 and certificates applies if a JOC Cockpit cluster with a number of instances is used.

Secure Connection Setup

In the following, JOC_HOME, JETTY_HOME and JETTY_BASE placeholders are used which locate three directories. If you install Jetty with the JOC Cockpit installer then:

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

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 using HTTPS.

Step 1: Add HTTPS module to Jetty

  • 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=ssl,https
  • Having executed the above command you should find a new folder JETTY_BASE/etc

    • By default Jetty expects a keystore with the name keystore in this folder that has been created from the above command.

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

Anchor
server_authentication_create_keystore
server_authentication_create_keystore
Step 2: Create JOC Cockpit Keystore

  • 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 certificate(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 examples below describe one possible approach for certificate management, however, there are other ways 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
        # 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.example.com"
# keytool -importkeystore -srckeystore keypair.jks -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc.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 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 private key 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 and self-signed certificate with a PKCS12 keystore:

...

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

Code Block
## Connector port to listen on
jetty.ssl.port=48446

Step 4: Deactivate HTTP Access

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

Code Block
# Module: http
# --module=http

...

This configuration is applied in order to secure the connection if JOC Cockpit and JobScheduler Master are not operated on the same server. If not otherwise stated then the steps for HTTPS configuration are performed on the server that hosts the JobScheduler Master.

Step 1: Create the Java Keystore

  • On the JobScheduler Master server create the Java Keystore using the Keytools from your Java JRE or JDK. The below examples suggest one possible approach for certificate management, however, there may be other ways how to achieve similar results.
    • Generate the Java Keystore with the private key and the public certificate for the JobScheduler Master and export the certificate to a second Keystore that is later on used by the JOC Cockpit.

      • Example for use of self-signed certificate with JKS keystore format

        Code Block
        languagebash
        titleExample how to generate a JKS Keystore with private key and public certificate
        # generate Master private key with alias name "master-https" in a keystore (private-https.jks)
#   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
keytool -genkey -alias "master-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "SCHEDULER_DATA/config/private/private-https.jks" -storepass jobscheduler

      • Example for use of self-signed certificate with PKCS12 keystore format

        Code Block
        languagebash
        titleExample how to generate a PKCS12 Keystore with private key and public certificate
        # generate Master private key with alias name "master-https" in a keystore (private-https.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 "master-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "SCHEDULER_DATA/config/private/private-https.pk12" -storepass jobscheduler -storetype PKCS12
      • Example for use of CA signed certificate with PKCS12 keystore format

        Code Block
        languagebash
        titleExample how to add generate a CA signed private key and public certificate to self-signed certificate for import into a PKCS12 Keystore
        # should your Master private key and certificate by 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 Master private key is "master-https"
# keytool -importkeystore -srckeystore keypair.jks -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias master-https

# assuming your Master private key from a pkcs12 keystore (keystore.p12), store the Master private key to a .key file in PEM format (master-https.key)
openssl pkcs12 -in keystore.p12 -nocerts -out master-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 Master private key (master-https.key), Master public certificate in PEM format (master-https.crt) and CA Bundle in PEM format (ca-bundle.crt) to a new keystore (private-https.p12)
#   assume the fully qualified hostname (FQDN) of the Master server to be "master.example.com"
openssl pkcs12 -export -in master-https.crt -inkey master-https.key -chain -CAfile ca-bundle.crt -name master.example.com -out private-https.p12

# should you require use of a .jks keystore type then convert the pkcs12 keystore assuming the alias name of the Master private key to be "master-https"
# keytool -importkeystore -srckeystore private-https.p12 -srcstoretype PKCS12 -destkeystore private-https.jks -deststoretype JKS -srcalias master-https
        keystore
        collapsetrue
        # Generate the JOC Cockpit's private key with the "joc.example.com" alias name and certificate 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

      • Example for creating a 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 the JOC Cockpit's private key with the "joc.example.com" alias name and certificate in a keystore (https-keystore.jks)
#   use the fully qualified domain name (FQDN) assumed to be joc.example.com and name of your organization for the distinguished name
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.jks" -storepass jobscheduler -storetype JKS

      • Explanation:

        • The -dname option

        Explanations

        • Replace the SCHEDULER_DATA placeholder as specified above.
        • The -dname option specifies the certificate issuer, therefore use your own set of CN, O, 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. With the default password being used no further settings are required as explained below.
        • The -keystore option specifies the location of your Keystore file. 
          • The Keystore file should be in reach of the JobScheduler Master, it is therefore recommended to use a sub-folder private in the ./config directory.
          • Using the default file name "private-https.jks" will save the effort of adding further settings as explained above.
        • 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 The -storepass option specifies the password for access to your Keystore file. For the handling of the default password the same applies as stated with the -keypass optionthe keystore file.
        • The -storetype option is used for the PKCS12 keystore format, this option is not required for the JKS keystore format.
    • If not otherwise configured then the JobScheduler Master by default uses the password jobscheduler for the respective Keystore.
    • If you choose an individual password for the JobScheduler Master Keystore then adjust the following properties in the SCHEDULER_DATA/config/private/private.conf configuration file:
      • Explanations
        • jobscheduler.master.webserver.https.keystore.file is used for the path to the Keystore
        • jobscheduler.master.webserver.https.keystore.password is used for the Keystore password
        • jobscheduler.master.webserver.https.keystore.key-password is used for the password of your private key

      • Example

        Code Block
        languagetext
        titleExample for private.conf file specifying the Master Keystore
        jobscheduler.master.webserver.https.keystore {
  file = "C:/ProgramData/sos-berlin.com/jobscheduler/master110/config/private/private-https.jks"
  # Backslashes are written twice (as in JSON notation):
  # file = "\\\\other-computer\\share\\my-keystore.jks"
  password = "jobscheduler"
  key-password = "jobscheduler"
}
    Export the JobScheduler Master public certificate for use with
        • 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 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, 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 -importcert -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:

    the JOC Cockpit Web Service
    • Example for export with JKS keystore format

      • Code Block
        languagebash
        titleExample how to
      export the Master public certificate from a JKS Keystore
      • import a CA-signed certificate to a JKS truststore
        collapsetrue
        # import Root CA certificate in PEM format to a JKS truststore (https-truststore.jks
      # export Master public certificate from keystore (private-https.jks) identified by its alias name (master-https) to a file in PEM format (master-https.crt
      • )
keytool -
      exportcert
      • importcert -
      rfc
      • alias "root-
      noprompt
      • ca" -file "
      master-https
      • RootCACertificate.crt
      " -alias 
      • "
      master-https"
      •  -keystore "
      SCHEDULER
      • JETTY_
      DATA
      • BASE/
      config
      • resources/
      private
      • joc/
      private
      • https-
      https
      • truststore.jks" -
      storepass jobscheduler

    • Example for export with PKCS12 keystore format

      Code Block
      languagebash
      titleExample how to export the Master public certificate from a PKCS12 Keystore
      # export Master public certificate from keystore (private-https.p12) identified by its alias name (master-https) to a file in PEM format (master-https.crt)
keytool -exportcert -rfc -noprompt -file "master-https.crt" -alias "master-https" -keystore "SCHEDULER_DATA/config/private/private-https.p12" -storepass jobscheduler -storetype PKCS12
    • The exported public certificate of each JobScheduler Master has to be imported to the Java Truststore that is used by the JOC Cockpit.

Step 2: Set up Authentication to JobScheduler Master

  • The JobScheduler Master HTTPS web service is only accessible to authenticated users that are identified by the JobScheduler ID.
    • The JobScheduler ID is specified on installation of a JobScheduler Master and is a unique string.
    • Should you operate a JobScheduler cluster then the same JobScheduler ID is used that has been assigned to all Masters during setup. Do not mix up the JobScheduler ID and the suffix -backup that is applied to a Backup Master installation directory.
  • The JobScheduler Master expects HTTP Basic Authentication.

  • The credentials are used from SCHEDULER_DATA/config/private/private.conf configuration file that offers an entry like this:

    Code Block
    jobscheduler.master.auth.users {
  JOBSCHEDULER_ID = "HASH_SCHEME:HASHED_PASSWORD"
}

  • The HASH_SCHEME is specified by the prefix "plain" and is followed by the password:

    Code Block
    jobscheduler.master.auth.users {
  jobscheduler_prod = "plain:secret"
}

Step 3: Set up the JobScheduler Master for HTTPS

  • Specify the ports with the <config> element in the SCHEDULER_DATA/config/scheduler.xml configuration file like this:

    • the HTTP port is required but is limited to the localhost network interface with the http_port attribute

    • the HTTPS port with the https_port attribute of like this:

      Code Block
      languagexml
      <spooler>
        <config http_port="localhost:40444" https_port="48444" mail_xslt_stylesheet="config/scheduler_mail.xsl">
                <!-- other elements -->
        </config>
</spooler>

Step 4: Configure the JOC Cockpit Web Service Truststore

On the JOC Cockpit server perform the following steps:

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

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

    Code Block
    titleExample 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
    titleExample how to set the port for the HTTPS protocol with the start.ini file
    ## Connector port to listen on
jetty.ssl.port=48446

Step 4: Deactivate HTTP Access

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

Code Block
titleExample how to deactivate the HTTP protocol with the start.ini file
# 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

Step 1: Update JOC Cockpit Truststore

  • On the JOC Cockpit server update the truststore using the keytool from your Java JRE, 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:

    The JOC Cockpit Keystore can also be used as a Truststore where the certificates of a number of JobScheduler Masters are imported. 
    • Example for JKS Keystore

      • Code Block
        languagebash
        titleExample how to import
      the Master public certificate to JOC Cockpit JKS Keystore# import Master public certificate from a file in
      • a CA-signed certificate to a PKCS12 truststore
        # import Root CA certificate in PEM format to a PKCS12 truststore (https-truststore.p12
      PEM format (master-https.crt) identified by its alias name (master-https) to the JOC Cockpit JKS keystore (joc-https.jks
      • )
keytool -importcert -
      noprompt -file
      • alias "
      master
      • root-
      https.crt
      • ca" -
      alias
      • file "
      master-https
      • RootCACertificate.crt" -keystore "JETTY_BASE/
      etc
      • resources/joc/https-
      https
      • truststore.
      jks

      Example for PKCS12 Keystore

      • p12" -
      storepass jobscheduler -trustcacerts
      • storetype PKCS12

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

      • Code Block
        languagebash
        titleExample how to import
      the Master public certificate to JOC Cockpit PKCS12 Keystore
      • a CA-signed certificate to a JKS truststore
        collapsetrue
        # import
      Master
      • Root
      public
      • CA certificate
      from a file
      •  in PEM format
      (master-https.crt) identified by its alias name (master-https) to the JOC Cockpit PKCS12 keystore (joc-https.p12
      • to a JKS truststore (https-truststore.jks)
keytool -importcert -alias "root-
      noprompt
      • ca" -file "
      master-https.crt" -alias "master-https" -keystore "JETTY_BASE/etc/joc-https.p12" -storepass jobscheduler -storetype PKCS12 -trustcacerts

    • Explanations

      •  The alias of each certificate has to be unique for the target Keystore.
    • Alternatively, you can import the JobScheduler Master certificates into the default Java Truststore (JAVA_HOME/lib/security/cacerts) of the Java installation which is used by Jetty, however, this setting will be lost if you switch the Java version.

  • If you use the Keystore of your JOC Cockpit Web Service in Jetty as the Truststore of the JobScheduler Master certificates then add the location of the Truststore to  the JETTY_BASE/resources/joc/joc.properties configuration file like this:

    • Example for JKS keystore format

      Code Block
      languagetext
      ### Location of the Java truststore that contains the certificates of each 
###   JobScheduler Master for HTTPS connections. The path can be absolute or relative
###   to joc.properties
truststore_path = ../../etc/joc-https.jks
truststore_password = jobscheduler

    • Example for PKCS12 keystore format

      Code Block
      languagetext
      ### Location of the Java truststore that contains the certificates of each 
###   JobScheduler Master for HTTPS connections. The path can be absolute or relative
###   to joc.properties
truststore_path = ../../etc/joc-https.p12 
truststore_type = PKCS12
truststore_password = jobscheduler
  • Explanations
    • The relative path from the above example looks up the Keystore in the JETTY_BASE/etc directory.

  • The hostname verification can be added optionally in the JETTY_BASE/resources/joc/joc.properties configuration file.

    Code Block
    ################################################################################
### Should hostname verification be carried out for https certificate. 
### Default false
https_with_hostname_verification = true

Caveat

      • 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 Secure Connections from Clients to JOC Cockpit Step 4: Configure Jetty for configuration of the truststore with JETTY_BASE/start.ini.

  • Edit the following entries in the JETTY_BASE/start.ini configuration file for the truststore location:

    Code Block
    titleExample 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.
  • Option
    • Should certificate based authentication be enforced then Jetty can be configured to automatically challenge clients to present a Client Authentication certificate. Be aware that with this option being in place it is no longer possible to login with account/password only as a Client Authentication certificate is required..

    • Specify the settings to enforce client authentication with the following entries in the JETTY_BASE/start.ini configuration file: 

      Code Block
      titleExample how to enforce client authentication with the start.ini file
      ## enable use of client authentication certificates
jetty.sslContext.needClientAuth=false
jetty.sslContext.wantClientAuth=true
jetty.sslContext.endpointIdentificationAlgorithm=

      Explanation:

Risk Mitigation

The above explanations indicate use of a Root CA certificate for verification of Client Authentication Certificates when it comes to mutual authentication.

  • In fact use of a Root CA certificate allows any clients that dispose of a Client Authentication Certificate signed by the same Root CA Certificate or Intermediate CA Certificates to be authenticated. This implication might allow an unwanted number of clients to access JOC Cockpit.
  • Coping strategies include
    • to use a separate Certificate Authority to sign Client Authentication Certificates for access to JOC Cockpit.
    • to import individual Client Authentication Certificates to the JOC Cockpit truststore instead of using a Root CA Certificate.

Notes

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

Further Resources