JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 26

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 27

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

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

...

  • 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 certificateCertificate
      • Intermediate CA certificateCertificate(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 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 for import into a PKCS12 keystore
          # 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 \
          Hide If
          currentSpaceJS7

          When using additional arguments for creation of a truststore then users can skip the later step 3:
           generate  self-signed certificate for import into true
           Code Block
           Code Block
          languagebash
          titleExample how to 
          add a private key and 
          certificate to a PKCS12 keystore 
          		collapse
          and the Root CA Certificate to a truststore
          # 
          Generate
          Adding the 
          JOC Cockpit's 
          private key 
          with the "joc.example.com" alias name and certificate in a keystore (
          and certificate to a keystore
./js7_create_certificate_store.sh \
    --keystore=JETTY_BASE/resources/joc/https-keystore.p12
          )
           \

          #
             
          use the fully qualified domain name (FQDN) assumed to be "
           --truststore=JETTY_BASE/resources/joc/https-keystore.p12 \ 
    --key=joc.example.com.key \
    --cert=joc.example.com
          "
          .crt 
          and
          \
 
          name
           
          of
           
          your organization for the distinguished name
#
           --alias=joc.example.com \
   
          Note
           --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 thethat 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/alias name and certificate in a keystore (https-keystore.p12")
# -storepass jobscheduler -storetype PKCS12
Step 3: Creating the JOC Cockpit Truststore
        • 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
    • For use with keytool create the truststore in PKCS12 or JKS format with the Root CA Certificate. The below examples suggest a possible approach for certificate management - however, there may be other ways how to achieve similar results.
  • For 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 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 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 Certificate to a JKS PKCS12 truststore:
         Code Block
        languagebash
        titleExample how to import a certificate Root CA Certificate to a JKS PKCS12 truststore
        collapsetrue
        # import Root CA certificate in PEM format to a JKSPKCS12 truststore (https-truststore.jksp12)
keytool -importcert -alias "root-ca" -file "RootCACertificateroot-ca.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jksp12" -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/
...
See below chapter Mutual Authentication for Clients and JOC Cockpit Step 2: Configure Jetty for configuration of the truststore with JETTY_BASE/start.d/ssl.ini.
  • Edit the following entries in the JETTY_BASE/start.d./ssl.ini configuration file use of the keystore:
     Code Block
    titleExample hot to set the keystore location 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=PKCS12Explanation:
  • 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 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=0.0.0.0

## 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 access.
    • The jetty.ssl.port setting specifies the port for Jetty.
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.
...
      • 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=
...
  • 0.0.0.0

## 
...
  • Connector port 
...
  • to 
...
  • listen on
...
  • 
jetty.
...
  • ssl.port=
...
  • 48446
 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.
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 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 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:
         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 -importcert -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.jks" -storetype JKS
...

  • Explanation    :
    • The jetty.ssl.host setting optionally can be used to limit port access to the specified host/network interface access.
    • The jetty.ssl.port setting specifies the port for Jetty.
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
...
See above chapter Secure Connections from Clients to JOC Cockpit Step 4: Configure Jetty for configuration of the truststore with JETTY_BASE/start.d/ssl.ini.
...
 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 
    /ssl.ini file
    ## 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 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.
    Option
    • Should certificate based authentication be allowed as a single or as a second factor for authentication then Jetty can be configured to automatically challenge clients to present a Client Authentication certificate.
    • Specify the settings to allow 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:
...