Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Scope

  • The connection to the JOC Cockpit can be secured by HTTPS.
  • The connection to the JobScheduler Master can be secured by HTTPS.
  • This article describes the steps required to set up secure HTTPS communication in Jetty and in the JobScheduler Master.

Prerequisites

The only prerequisite is to have the Java keytools installed with your Java JRE

 

Set up a secure connection to 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 certificate for the JobScheduler Master and export the certificate to a second Keystore that is later on used by the JOC Cockpit.

      • Example

        Sample for generate 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
        Sample for export certicate
        keytool -exportcert -rfc -noprompt -file "master-https.pem" -alias "master-https" -keystore "private-https.jks" -storepass jobscheduler
    • If not otherwise configured then JobScheduler Master by default use the password jobscheduler for the respective Keystore.
    • If you choose an individual password for the 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

          Sample 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"
}
    • The exported certificate of each JobScheduler Master has to 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 services are only accessible to authenticated users.
  • The JobScheduler Master expects HTTP Basic Authentication.

  • The credentials are read from <scheduler_data>/config/private/private.conf where each user has an entry of the form

    jobscheduler.master.auth.users {
  USERNAME = "HASHSCHEME:HASHEDPASSWORD"
  ...
}

  • The HASHSCHEME can be "plain" or "sha512", e.g.

    jobscheduler.master.auth.users {
  eve = "plain:PASSWORD"
  joe = "sha512:911b0a07a8cacfebc5f1f45596d67017136c950499fa5b4ff6faffa031f3cec7f197853d1660712c154e1f59c60f682e34ea9b5cbd2d8d5adb0c834f963f30de"  # "PASSWORD"
}

  • The JOC Cockpit user has to be specified with the JobScheduler ID and must have a password in plain text.

Step 3: Start the Master for HTTPS

  • Specify the HTTPS port in https_port attribute of the config element in the <scheduler_data>/config/scheduler.xml file

    <spooler>
        <config http_port="40444" https_port="48444" mail_xslt_stylesheet="config/scheduler_mail.xsl" port="4444">
                <!-- other elements -->
        </config>
</spooler>

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

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

  • JOC_HOME is the installation path which was specified during the JOC installation
    • C:\Program Files\sos-berlin.com\joc (default on Windows)
    • /opt/sos-berlin.com/joc (default on Linux)
  • JETTY_HOME = JOC_HOME/jetty
  • JETTY_BASE is Jetty's base directory which was specified during the JOC installation
    • C:\ProgramData\sos-berlin.com\joc (default on Windows)
    • /home/<setup-user>/sos-berlin.com/joc (default on Linux)

Step 1: Add the https module in Jetty

  • add https module
    java -jar "JETTY_HOME/start.jar" -Djetty.home="JETTY_HOME" -Djetty.base="JETTY_BASE" --add-to-start=https
  • After above call you get a new folder JETTY_BASE/etc
    • Jetty expects in this folder a keystore with the name "keystore" as default.

    • You can copy the JETTY_HOME/etc/keystore to JETTY_BASE/etc/keystore as workaround but you should use your own keystore for later on (see step 2). In particular, the keystore from JETTY_HOME/etc/keystore expires after a short time.

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

  • Further some entries in the JETTY_BASE/start.ini for SSL setting such as the port are added.

Step 2: Create the Java Keystore for Jetty

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

      • Example

        Sample for generate Keystore with private key and certificate
         keytool -genkey -alias "joc" -dname "CN=jocHost, O=myCOmpany" -validity 1461 -keyalg RSA -keysize 1024 -keypass joccockpit -keystore "joc.jks" -storepass joccockpit
    • This Keystore can also be used as Truststore where the certificates of each JobScheduler Masters are imported. The alias of each certificate has to unique during the import.

      • Example

        Sample for import master certificate
         keytool -importcert -noprompt -file "master-https.pem" -alias "master-host-port" -keystore "joc.jks" -storepass joccockpit -trustcacerts
      • Start Jetty with
    • 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 but this setting get lost if you change the Java version.

Step 3: Configure Jetty

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

     

    ## 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=joccockpit

## KeyManager password
jetty.sslContext.keyManagerPassword=joccockpit

## Truststore password
jetty.sslContext.trustStorePassword=joccockpit

  • Specify the HTTPS port in the following entries of the JETTY_BASE/start.ini file

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

Step 4: Start Jetty for HTTPS

  • If you have used the Keystore in Jetty as Truststore of the JobScheduler Master certificates then add -Djavax.net.ssl.trustStore="JETTY_BASE/etc/joc.jks" to the Java options

 

  • No labels