Page History

...

browser [label="   User Browser   ",fillcolor="lightskyblue"]
Master [label="   JobScheduler Master   ",fillcolor="lightskyblue"]
JOC [label="   JOC Cockpit   ",fillcolor="lightskyblue"]
 
browser_Truststore [label="User Browser Truststore\ntruststore location is product dependent\nCA Certificates",fillcolor="orange"]
Master_Keystore [label="Master Keystore\n./config/private/private-https.jks\nMaster Private Key",fillcolor="orange"]
JOC_Truststore [label="JOC Cockpit Truststore\n./jetty_base/etc/joc-https.jks\nCA certificates\nMaster certificates",fillcolor="orange"]
JOC_Keystore [label="JOC Cockpit Keystore\n./jetty_base/etc/joc-https.jks\nCA Certificates\nJOC Cockpit Private Key\nJOC Cockpit Certificates",fillcolor="orange"]

browser_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_Truststore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate 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"]

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

Master -> Master_Keystore 
Master -> Master_Truststore_Certificate [label=" transfer to JOC Cockpit            "] 
Master_Keystore-> Master_PrivateKey -> Master_Keystore_Certificate [label=" add to keystore "]

browser -> JOC [label=" establish JOC Cockpit connection "]
browser -> browser_Truststore [label=" use certificate repository "]
browser_Truststore -> browser_Truststore_CA_RootCertificate [label=" added to truststore by Group Policies "]

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

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

Then proceed with chapter Set up a secure connection of the JOC Cockpit to the JobScheduler Master

Anchor
#browser #browser

Set up a secure connection of user browsers to the JOC Cockpit

...

• 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 and export the certificate to the Keystore that is later on used by the user browsers. 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
      language bash title Example 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=organizaionorganization" -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
      language bash title Example 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=organizaionorganization" -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
      language bash title Example 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-htpshttps.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.

...

• 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

  
  Explanations

  • Specify the location of the Keystore with the keyStorePath setting and optionally of the Truststore with the trustStorePath setting. A location relative to the JETTY_BASE directory can be specified.
  • Specify the password for your Keystore with the keyStorePassword setting. If a Truststore is used then specify its password accordingly with the trustStorePassword setting.
  • The password specified with the keyManagerPassword setting is used for acces 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
  ## Connector port to listen on jetty.ssl.port=48446

...

• 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
      language bash title Example 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
      language bash title Example 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
      language bash title Example how to add a CA signed private key and public certificate to 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-htpshttps.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

    • 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 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 create 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 -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 option.
      • The -storepassstoretype 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 HTTPS certificatekey

    • Example

      Code Block
      language text title Example 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 the JOC Cockpit Web Service

  • Example for export with JKS keystore format

    Code Block
    language bash title Example how to export the Master public certificate from a JKS Keystore
    # 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 -rfc -noprompt -file "master-https.crt" -alias "master-https" -keystore "SCHEDULER_DATA/config/private/private-https.jks" -storepass jobscheduler

  • Example for export with PKCS12 keystore format

    Code Block
    language bash title Example 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.

...

• 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 has offers an entry of the formlike 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 4: Configure the JOC Cockpit Web Service Truststore

The following steps are performed on the server that hosts the JOC Cockpit.On the JOC Cockpit server perform the following steps:

• 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
    language bash title Example how to import the Master public certificate to JOC Cockpit JKS Keystore
    # import Master public certificate from a file in 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 "master-https.crt" -alias "master-https" -keystore "JETTY_BASE/etc/joc-https.jks" -storepass jobscheduler -trustcacerts

  • Example for PKCS12 Keystore

    Code Block
    language bash title Example how to import the Master public certificate to JOC Cockpit PKCS12 Keystore
    # import Master public 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) keytool -importcert -noprompt -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
    language text
    ### 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
    language text
    ### 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

...