Product Knowledge Base

Space shortcuts

Page tree

Versions Compared

Old Version 10

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 11

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

Set up a secure connection to JOC Cockpit as a web application in Jetty

This configuration is applied in order to enable users to access the JOC Cockpit by use of HTTPS with their browser.

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

...

  • Run the following command and replace the JETTY_HOME and JETTY_BASE placeholders as specified above:

    Code Block
    languagebash
    titleadd https module
    java -jar "JETTY_HOME/start.jar" -Djetty.home="JETTY_HOME" -Djetty.base="JETTY_BASE" --add-to-start=https
  • Having executed the above command you should find a new folder JETTY_BASE/etc
    • Jetty expects a Keystore in this folder with the name "keystore" by default.

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

      Warning

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

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

...

  • Create the Java Keystore using the Keytools from your Java JRE.
    • Generate the Java Keystore with the private key and certificate for Jetty and export the certificate to the Keystore that is later on used by the browsers.

      • Example

        Code Block
        titleSample for generate Keystore with private key and certificate
        keytool -genkey -alias "joc" -dname "CN=jocHost,O=myCompany" -validity 1461 -keyalg RSA -keysize 1024 -keypass secret_key -keystore "JETTY_BASE/etc/joc.jks" -storepass secret_store

        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.
    • This Keystore can also be used as a Truststore where the certificates of a number of JobScheduler Masters are imported. The alias of each certificate has to be unique during the import.

      • Example

        Code Block
        titleSample for import master certificate
        keytool -importcert -noprompt -file "master-https.pem" -alias "master-host-port" -keystore "JETTY_BASE/etc/joc.jks" -storepass secret_store -trustcacerts
    • 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.

 

Step 3: Configure Jetty

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

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

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

## Keystore password
jetty.sslContext.keyStorePassword=secret_store

## KeyManager password
jetty.sslContext.keyManagerPassword=secret_key

## Truststore password
jetty.sslContext.trustStorePassword=secret_store


    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 to your private key.

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

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

Step 4: Deactivate HTTP Access

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

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

Set up a secure connection from the JOC Cockpit Web Service to the JobScheduler Master

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

Step 1: Create the Java Keystore

  • Create the Java Keystore using the Keytools from your Java JRE.
    • Generate the Java Keystore with the private key and the certificate for the JobScheduler Master and export the certificate to a second Keystore that is later on used by the JOC Cockpit.

      • Example

        Code Block
        titleExample how to generate a Keystore with private key and certificate
        keytool -genkey -alias "master-https" -dname "CN=jobSchedulerHost,O=myCompany" -validity 1461 -keyalg RSA -keysize 1024 -keypass jobscheduler -keystore "private-https.jks" -storepass jobscheduler
         

        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.  With the default password being used no further settings are required as explained below.
        • The -keystore option specifies the location of your Keystore file. Using the default value "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. 
           
         Code Block
        titleSample for export certicate
        keytool -exportcert -rfc -noprompt -file "master-https.pem" -alias "master-https" -keystore "private-https.jks" -storepass jobscheduler
        • For the handling of the default password the same applies as stated with the -keypass option.
    • 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 certificate
      • Example
         Code Block
        languagetext
        titleSample private.conf file
        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 = "secret"
  key-password = "secret"
}
  • Export the JobScheduler Master public certificate for use with the JOC Cockpit Web Service
    •  Code Block
      titleSample for export certicate
      keytool -exportcert -rfc -noprompt -file "master-https.pem" -alias "master-https" -keystore "private-https.jks" -storepass jobscheduler
    • The exported certificate of each JobScheduler Master has to be imported to the Java Keystore (rather Truststore) which is used by the JOC Cockpit.
Step 2: Set up 
...
Authentication to JobScheduler Master
  • The JobScheduler Master HTTPS web service is only accessible to authenticated users that are identified by the JobScheduler ID.
    • The JobScheduler ID is specified on installation of a JobScheduler Master and is a unique string.
  • The JobScheduler Master expects HTTP Basic Authentication.
  • The credentials are used from SCHEDULER_DATA/config/private/private.conf configuration file where each user has an entry of the form:
     Code Block
    jobscheduler.master.auth.users {
  USERNAMEJOBSCHEDULER_ID = "HASHSCHEME:HASHEDPASSWORD"
  ...HASH_SCHEME:HASHED_PASSWORD"
}
  • The HASHSCHEME can be "plain" or "sha512", e.g.HASH_SCHEME is specified by the prefix "plain" and is followed by the password:
     Code Block
    jobscheduler.master.auth.users {
  evejobscheduler_prod = "plain:PASSWORD"
  joe = "sha512:911b0a07a8cacfebc5f1f45596d67017136c950499fa5b4ff6faffa031f3cec7f197853d1660712c154e1f59c60f682e34ea9b5cbd2d8d5adb0c834f963f30de"  # "PASSWORD"
}
     Info
    The JOC Cockpit user has to be specified with the JobScheduler ID and must have a password in plain text.
    secret"
}
Step 3: Set up the JobScheduler Master for HTTPS
  • Specify the HTTPS port with the https_port attribute of the <config> element in the SCHEDULER_DATA/config/scheduler.xml configuration file like this:
     Code Block
    languagexml
    <spooler>
        <config http_port="40444" https_port="48444" mail_xslt_stylesheet="config/scheduler_mail.xsl" port="4444">
                <!-- other elements -->
        </config>
</spooler>
Step 4: Configure the JOC Cockpit Web Service Truststore
The following steps are performed on the server that hosts the JOC Cockpit.
  • The JOC Cockpit Keystore can also be used as a Truststore where the certificates of a number of JobScheduler Masters are imported. 
    • Example
       Code Block
      titleSample for import master certificate
      keytool -importcert -noprompt -file "master-https.pem" -alias "master-host-port" -keystore "JETTY_BASE/etc/joc.jks" -storepass secret_store -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 Truststore of the JobScheduler Master certificates (see next chapter) then certificates then add the location of the Truststore to the  the JETTY_BASE/resources/joc/joc.properties configuration file like this:
     Code Block
    ### Location of the Java trustore which contains the certificates of each 
### JobScehduler Master for HTTPS connections. Path can be absolute or relative
### to joc.properties
truststore_path = ../../etc/joc.jks 
...