JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 24

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version Current

changes.mady.by.user Uwe Risse

Saved on

Key

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

...

  • Connections from user browsers to the JOC Cockpit can be secured by HTTPS with TLS/SSL certificates.
  • Connections from clients using the JS7 - REST Web Service API (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 instance or a JOC Cockpit cluster with a number of instances.

Prerequisites

  • The following explanations assume CA-signed certificates or self-signed certificates to be used.
    • CA-signed certificates are provided from known and trusted Certificate Authorities (CA) that validate the domain owner.
    • Self-signed certificates are created by users who operate their own CA, see the JS7 - How to create self-signed Certificates.
    • Use of Intermediate CA Certificates is optional.
  • 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
    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 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 by clients (user browsers or REST API clients) the following keys and certificates should be in place:

  • The following explanations assume JOC Cockpit starting from release 2.5 to be used. This release introduces Jetty 11. Earlier releases of JOC Cockpit ship with Jetty 9 and make use of a single configuration file JETTY_BASE/start.ini instead of separate configuration files JETTY_BASE/start.d/http.ini, JETTY_BASE/start.d/https.ini, JETTY_BASE/start.d/ssl.ini.

Certificate Management

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


Flowchart
Client [label
Flowchart
Client [label="   Client   \n   User Browser / REST API Client   ",fillcolor="lightskyblue"]
JOC [label="   JOC Cockpit   ",fillcolor="lightskyblue"]
 
Client#Client_Keystore [label="Client Keystore\nlocation is product dependent\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="limegreen"]
Client_TruststoreKeystore [label="Client TruststoreKeystore\nlocation is product dependent\n\nCA CertificatesnPrivate Key / Certificate",fillcolor="orangelimegreen"] 
JOCClient_KeystoreTruststore [label="JOC Cockpit Keystore\nhttps-keystore.p12\Client Truststore\nlocation is product dependent\n\nCA Certificates\nPrivate Key / Certificate",",fillcolor="orange"]

JOC#JOC_TruststoreKeystore [label="JOC Cockpit TruststoreKeystore\nhttps-truststorekeystore.p12\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="orange"]

ClientJOC_Keystore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificateJOC Cockpit Keystore\nhttps-keystore.p12\n\nPrivate Key / Certificate",fillcolor="whiteorange"]
Client_Keystore_CA_IntermediateCertificate [JOC_Truststore [label="JOC Cockpit Truststore\nhttps-truststore.p12\n\nCA Certificates",fillcolor="orange"]

#Client_Keystore_CA_RootCertificate [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",label="CA Root\nCertificate",fillcolor="white"]
JOC_Truststore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
JOC#JOC_Keystore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
JOC#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#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#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 "]

...

  • 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 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 to each JOC Cockpit cluster with a number of instances is usedinstance in a cluster.

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 The following steps are applied to enable clients (user browser, REST API client) to access the JOC Cockpit using HTTPS.

Step 1:

...

Adding the HTTPS and SSL modules 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.

...

  • Add HTTPS module to Jetty
    java -jar "JETTY_HOME/start.jar" -Djetty.home="JETTY_HOME" -Djetty.base="JETTY_BASE" --add-module=ssl,https
  • Having executed the above command users 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 the JETTY_BASE/start.d/https.ini and JETTY_BASE/start.d/ssl.ini configuration files will be created and will be populated with a number of entries for TLS/SSL settings.

Anchor
server_authentication_create_keystore
server_authentication_create_keystore
Step 2: Creating the JOC Cockpit Keystore

  • On the JOC Cockpit server create the keystore using openssl and 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)
    • The examples below describe a possible approach for certificate management, however, there are other ways to achieve similar results.

      • Example for importing an existing private key and CA-signed certificate to a keystore:

        Code Block
        languagebash
        titleExample how to add a private key and CA-signed certificate to a PKCS12 keystore
        # Assume the fully qualified domain name (FQDN) of the JOC Cockpit server to be "joc.example.com"

# If the JOC Cockpit CA-signed certificate is provided from a pkcs12 keystore (certificate.p12), extract the JOC Cockpit certificate to a .crt file in PEM format (joc.example.com.crt)
# openssl pkcs12 -in certificate.p12 -nokeys -out joc.example.com.crt

# Import the JOC Cockpit private key (joc.example.com.key) and JOC Cockpit certificate (joc.example.com.crt) from PEM format to a new keystore (joc.example.com.p12)
openssl pkcs12 -export -in joc.example.com.crt -inkey joc.example.com.key -name joc.example.com -out "JETTY_BASE/resources/joc/https-keystore.p12"
        Hide If
        currentSpaceJS7
        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 the 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 optionally 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 and importing to a keystore

        • Refer to examples available from JS7 - How to create self-signed Certificates, chapter Creating a Server Certificate.

          Code Block
          languagebash
          titleExample how to create a private key and self-signed certificate
          # Creating the private key and self-signed certificate for the given validity period
./create_certificate.sh --dns=joc.example.com --days=365

        • Refer to examples available from JS7 - How to add SSL TLS Certificates to Keystore and Truststore.

          Code Block
          titleExample how to add a private key and certificate to a PKCS12 keystore
          # Adding the private key and certificate to a keystore
./js7_create_certificate_store.sh \
    --keystore=JETTY_BASE/resources/joc/https-keystore.p12 \
    --key=joc.example.com.key \
    --cert=joc.example.com.crt \
    --alias=joc.example.com \
    --password="jobscheduler"


          When using additional arguments for creation of a truststore then users can skip the later step 3:

          Code Block
          titleExample how to add a private key and certificate to a PKCS12 keystore and the Root CA Certificate to a truststore
          # Adding the private key and certificate to a keystore and Root CA Certificate to a truststore
./js7_create_certificate_store.sh \
    --keystore=JETTY_BASE/resources/joc/https-keystore.p12 \
    --truststore=JETTY_BASE/resources/joc/https-keystore.p12 \ 
    --key=joc.example.com.key \
    --cert=joc.example.com.crt \
    --alias=joc.example.com \
    --password="jobscheduler" \
    --ca-root=root-ca.crt
          Hide If
          currentSpaceJS7

...

  • 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 certificates
    • 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 may be 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-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 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 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 "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"
# 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 the JOC Cockpit's private key with the "joc-https" alias name and certificate in a keystore (https-keystore.p12)
#   use the fully qualified hostname (FQDN) 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" -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
        • PKCS12 keystore
          collapsetrue
          # Generate the JOC Cockpit's private key with the "joc
        -https
        • .example.com" alias name and certificate in a keystore (https-keystore.
        jks
        • p12)
#   use the fully qualified
        hostname
        • domain name (FQDN
        ) and name of your organization for the distinguished name
        • ) 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=
        hostname
        • joc.example.com,O=organization
        " -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.jks
        • " -
        storepass
        • validity
        jobscheduler
        • 1461 -
        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.

...

        • keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.p12" -storepass jobscheduler -storetype PKCS12

Step 3: Creating the JOC Cockpit Truststore

  • For the JOC Cockpit Server Authentication a truststore technically 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 a truststore with the truststore with a certificateRoot CA Certificate.
  • Users who create the truststore with above step 2 can skip this step.
  • 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 3rd-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 format and import:
      • Root CA Certificate
    • The or JKS format with the Root CA certificate. The below examples suggest one a possible approach for certificate management - however, there may be other ways how to achieve similar results.

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

        Code Block
        languagebash
        titleExample how to import a Root CA -signed certificate 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 "RootCACertificateroot-ca.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12" -storetype PKCS12

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

        Code Block
        languagebash
        titleExample how to import a Root CA -signed certificate Certificate to a JKS truststore
        collapsetrue
        # import Root CA certificateCertificate in PEM format to a JKS truststore (https-truststore.jks)
keytool -importimportcert -alias "root-ca" -file "RootCACertificateroot-ca.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS

Anchor
server_authentication_configure_jetty
server_authentication_configure_jetty
Step 4:

...

Configuring Jetty for use of Keystore and Truststore

  • Edit the following entries in the JETTY_BASE/start.d./ssl.ini configuration file for use of the keystore and truststore:

    Code Block
    titleExample how to use the keystore/truststore settings with the start.d/ssl.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

## The Keystore type.
jetty.sslContext.keyStoreType=PKCS12

## Truststore

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.keyStorePathtrustStorePath=resources/joc/https-keystoretruststore.p12

## KeystoreTruststore password
jetty.sslContext.keyStorePasswordtrustStorePassword=jobscheduler

## KeyManager password (same as keystore password for pkcs12 keystore type)TrustStore type.
jetty.sslContext.keyManagerPasswordtrustStoreType=jobschedulerPKCS12


    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 typesame password as for the keyStorePassword setting has to be used for a PKCS12 keystore type.
    • Optionally specify the keystore type with the keyStoreType setting. If this setting is missing then the JVM's default keystore type will be used.
    • 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 truststore type to be one of PKCS12 or JKS.

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

    Code Block
    titleExample how to set the port for the HTTPS protocol with the start.ini filestart.d/ssl.ini file
    ## The host/address to bind the connector to.
jetty.ssl.host=joc.example.com

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


    Explanation    :

    • The jetty.ssl.host setting optionally can be used to limit port access to the specified host/network interface.

Step 4: Deactivate HTTP Access

    • The jetty.ssl.port setting specifies the port for Jetty. Consider to allow incoming connections to this port from your firewall.

Step 5: Deactivating HTTP Access

Users who intend to enforce HTTPS should deactivate HTTP access by adding To deactivate HTTP access add a comment to the following module directive in your the JETTY_BASE/start.d/http.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 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
        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

...

d/http.ini file
# Module: http
# --module=http


It is recommended to deactivate HTTP access to JOC Cockpit if HTTPS is enabled. Typically HTTPS is not an invite to users to fall back to a less secure HTTP protocol. Should both protocols be used then consider that separate ports or separate network interfaces using the same port are required.

The following example suggests that the host/network interfaces centostest-primary should be used for HTTP and the host/network interface centostest-secondary should be used for HTTPS: A single port 4446 is used.

Code Block
titleExample how to specify the network interface with the start.d/http.ini file
# Module: http
--module=http

## The host/address to bind the connector to.
jetty.http.host=centostest-primary

## The port the connector listens on.
jetty.http.port=4446
Code Block
titleExample how to specify the network interface with the start.d/ssl.ini file
### TLS (SSL) Connector Configuration
--module=ssl

## The host/address to bind the connector to.
jetty.ssl.host=centostest-secondary

## The port the connector listens on.
jetty.ssl.port=4446

Mutual Authentication for Clients and JOC Cockpit

This configuration is applied in order to enable mutual authentication:

  • the client verifies the JOC Cockpit Server Authentication certificate,
  • the JOC Cockpit verifies the client's Client Authentication certificate.

Anchor
client_authentication_configure_jetty
client_authentication_configure_jetty
Configuring Jetty

See above chapter Secure Connections from Clients to JOC Cockpit for configuration of the keystore/truststore with JETTY_BASE/start.d/ssl.ini.

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

    • To enable certificates as a single or as a second factor for authentication Jetty can be configured to automatically challenge clients to present a Client Authentication certificate.

    • Specify the settings to allow

...

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.d/ssl.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:

...

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

  • In fact use of a Root CA certificate Certificate allows any clients that dispose of a Client Authentication Certificate 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 certificates for access to JOC Cockpit.
    • to import individual Client Authentication Certificates certificates to the JOC Cockpit's truststore instead of using a Root CA Certificate.

...

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

Further Resources