JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 8

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

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

  • 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.
  • 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="   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
Flowchart
Client [label="   Client   \n   User Browser / REST API Client   ",fillcolor="lightskyblue"]
JOC [label="   JOC Cockpit   ",fillcolor="lightskyblue"]
 
Client_Keystore [label="Client Keystore\nkeystore location is product dependent\n\nCA Certificates\nClient Private Key / Certificate",fillcolor="limegreen"]
Client_Truststore [label="Client Truststore\ntruststore location is product dependent\n\nCA Certificates",fillcolor="orange"]
JOC_Keystore [label="JOC Cockpit Keystore\nJETTY_BASE/resources/joc/https-keystore.p12\n\nCA Certificates\nJOC Cockpit Private Key / Certificate",fillcolor="orange"]
JOC_Truststore [label="JOC Cockpit Truststore\nJETTY_BASE/resources/joc/https-truststore.p12\n\nCA Certificates",fillcolor="limegreen"]

Client_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Rootlabel="Client Keystore\nlocation is product dependent\n\nPrivate Key / Certificate",fillcolor="whitelimegreen"] 
Client_Keystore_CA_IntermediateCertificateTruststore [shape="ellipse",label="CA Intermediate CertificateClient Truststore\nlocation is product dependent\n\nCA Certificates",fillcolor="whiteorange"]

Client#JOC_PrivateKeyKeystore [shapelabel="ellipse",label="Client Authentication Private KeyJOC Cockpit Keystore\nhttps-keystore.p12\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="whiteorange"]
ClientJOC_CertificateKeystore [shape="ellipse",label="Client AuthenticationJOC Cockpit Keystore\nhttps-keystore.p12\n\nPrivate Key / Certificate",fillcolor="whiteorange"]

ClientJOC_Truststore_CA_RootCertificate [shape="ellipse",shape="ellipse", [label="CA Root CertificateJOC Cockpit Truststore\nhttps-truststore.p12\n\nCA Certificates",fillcolor="whiteorange"]
JOC
#Client_TruststoreKeystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate\nCertificate",fillcolor="white"]
JOC#Client_Keystore_CA_RootCertificateIntermediateCertificate [shape="ellipse",shape="ellipse",label="CA Root CertificateIntermediate\nCertificate",fillcolor="white"]
JOC_Keystore_CA_IntermediateCertificateClient_PrivateKey [shape="ellipse",label="CAClient IntermediateAuthentication\nPrivate CertificateKey",fillcolor="white"]

JOCClient_PrivateKeyCertificate [shape="ellipse",label="ServerClient Authentication Private Key\nCertificate",fillcolor="white"]

JOC_CertificateClient_Truststore_CA_RootCertificate [shape="ellipse",label="Server Authentication CertificateCA Root\nCertificate",fillcolor="white"]

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

Client -> Client_Keystore
Client_Keystore -> Client_Keystore_CA_RootCertificate -> Client_Keystore_CA_IntermediateCertificateJOC_Truststore_CA_RootCertificate [shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
#JOC_Keystore_CA_RootCertificate [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=" addestablish to keystoreconnection "]
Client_Keystore -> Client_Truststore
Client_PrivateKeyTruststore -> Client_CertificateTruststore_CA_RootCertificate [label=" add to keystoretruststore "]

JOC\n e.g. by Group Policies "]

Client -> JOCClient_Keystore
JOC#Client_Keystore -> JOCClient_Keystore_CA_RootCertificate -> JOCClient_Keystore_CA_IntermediateCertificate [label=" add to keystore "]
JOCClient_Keystore -> JOCClient_PrivateKey -> JOCClient_Certificate [label=" add to keystore "]

JOC -> JOC_Truststore
JOC_TruststoreKeystore
#JOC_Keystore -> JOC_Keystore_CA_RootCertificate -> JOC_TruststoreKeystore_CA_RootCertificateIntermediateCertificate [label=" add to truststorekeystore "]

Explanation:

  • Keystore and truststore in orange color are required for any connections of clients to JOC Cockpit.
  • Keystore and truststore in green color are required only if mutual authentication is in place, e.g. to allow certificate based authentication.
    • A JOC Cockpit truststore in green color is 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 truststore.

Secure Connection Setup

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 Cockpit installer then

JOC_Keystore -> JOC_PrivateKey -> JOC_Certificate [label=" add to keystore "]

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


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 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 to each JOC Cockpit instance 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
  • JOC_HOME is the installation path that is specified during JOC Cockpit installation:
  • JETTY_HOME = JOC_HOME/jetty
  • JETTY_BASE is Jetty's base directory that is specified during JOC Cockpit installation:
    • /home/<setup-user>/opt/sos-berlin.com/js7/joc  (default on LinuxUnix)
    • C:\ProgramDataProgram Files\sos-berlin.com\js7\joc (default on Windows)

Secure Connections for Clients to JOC Cockpit

  • 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

The following steps are applied to enable clients (user This configuration is applied in order to enable clients (user browser, REST API client) to access the JOC Cockpit by use of 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-startmodule=ssl,https
  • Having executed the above command you users should find a new folder JETTY_BASE/etc

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

    • Warning

      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.d/https.ini configuration file for TLS/SSL settings such as the HTTPS port are added.

...

  • 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 or , JDK or some 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 certificateCertificate
      • Intermediate CA certificatesCertificate(s)
    • The examples below describe a For use with keytool generate the keystore in JKS or PKCS12 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 are other ways how to achieve similar results.

      • Example for import of CA importing an existing 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 Keystorekeystore
        # shouldAssume the JOCfully Cockpit'squalified privatedomain keyname and(FQDN) 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 -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc-https

# assuming yourof 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 from a pkcs12 keystore (keystore.p12), store the (joc.example.com.key) and JOC Cockpit private key to a .key file in PEM format (joc-https.keycertificate (joc.example.com.crt) from PEM format to a new keystore (joc.example.com.p12)
openssl pkcs12 -export -in keystore.p12joc.example.com.crt -nocertsinkey -out joc-httpsjoc.example.com.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--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)
#
        assume
        for
        the
        later
        fully
        use
        qualified
        with
        hostname (FQDN) of
        openssl, assuming the alias name of the JOC Cockpit private
        server
        key being "joc.example.com"
        openssl
        #
        pkcs12
        keytool -
        export
        importkeystore -
        in
        srckeystore
        joc-https
        keypair.
        crt
        jks -
        inkey
        srcstoretype JKS
        joc
        -
        https
        destkeystore keystore.
        key
        p12 -
        chain
        deststoretype
        -CAfile
        PKCS12
        ca-bundle.crt -name
        -srcalias joc.example.com
        -out "JETTY_BASE/resources/joc/https-keystore.p12"
        

#
        should you require use of
        Assuming the JOC Cockpit private key from a
        .jks
        pkcs12 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 self-signed certificate with a PKCS12 keystore

        Code Block
        languagebash
        titleExample how to generate a self-signed certificate for import into a PKCS12 Keystore
        # generate
        (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
        with alias name "joc-https" in a 
        (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)
#
        use
        assume the fully qualified
        hostname
        domain name (FQDN)
        and name
         of
        your
        organization for 
        the
        distinguished
        JOC
        name #
        Cockpit server to
        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
        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"

#
        -storepass
        If
        jobscheduler
        you
        -storetype PKCS12

        Example for use of self-signed certificate with a JKS keystore

        Code Block
        languagebash
        titleExample how to generate a self-signed certificate for import into a JKS Keystore
        # generate
        require use of a .jks keystore type then convert the pkcs12 keystore, assuming the alias name of the JOC Cockpit private key
        with
        to
        alias name
        be "joc
        -https" in a keystore (
        .example.com"
# keytool -importkeystore -srckeystore 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 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 certificate authority or a trusted authority.

...

See below chapter 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
## 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

...

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 add a comment to the following module directive in your JETTY_BASE/start.ini configuration file like this:

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

Mutual Authentication for Clients to JOC Cockpit

This configuration is applied in order to enable mutual authentication:

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

Step 1: Add the Truststore to Jetty

...

  • Root CA certificate

...

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

Step 3: Creating the JOC Cockpit Truststore

  • For JOC Cockpit Server Authentication a truststore technically is 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 Root 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, JDK or some third party utility.
    • For use with a 3rd-party utility create a truststore, e.g. https-truststore.p12, in PKCS12 format and import:
      • Root CA Certificate
    • The below examples suggest 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 to a PKCS12 truststore:

        Code Block
        languagebash
        titleExample how to import a Root CA 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 "root-ca.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 Root CA Certificate to a JKS truststore
        collapsetrue
        # import Root CA Certificate in PEM format to a JKS truststore (https-truststore.jks)
keytool -importcert -alias "root-ca" -file "root-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 file path (relative to $jetty.base)
jetty.sslContext.trustStorePath=resources/joc/https-truststore.p12

## Truststore password
jetty.sslContext.trustStorePassword=jobscheduler

## TrustStore type.
jetty.sslContext.trustStoreType=PKCS12


    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.
    • 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 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.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.
    • 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 a comment to the following module directive in the JETTY_BASE/start.d/http.ini configuration file like this:

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

...

Code Block
languagebash
titleExample how to import a CA signed certificate into a PKCS12 Truststore
# import Root CA certificate in PEM format to a a PKCS12 truststore (https-truststore.p12)
keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12"

...

See above chapter Step 3: Configure Jetty for configuration of the keystore with JETTY_BASE/start.ini.

  • Edit

    • the following entries in the JETTY_BASE/start.d/ssl.ini configuration file

    use of the keystore

    • : 

      Code Block
      titleExample how to enforce client authentication with the start.ini file
      ##
    Truststore
    • enable
    file
    • use
    path
    • of
    (relative
    • client
    to $jetty.base)
    • authentication certificates
jetty.sslContext.needClientAuth=false
jetty.sslContext.
    trustStorePath=resources/joc/https-truststore.p12 ## Truststore password 
    • wantClientAuth=true
jetty.sslContext.
    trustStorePassword
    • endpointIdentificationAlgorithm=
    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
    ## force 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 or Intermediate CA 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's truststore instead of using a Root CA Certificate.Find explanations from 
Notes
  • 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