JOC Cockpit - HTTPS Authentication

Scope

The connection of the user's browser to the JOC Cockpit can be secured by HTTPS.
The connection of the JOC Cockpit - REST Web Service to the JobScheduler Master can be secured by HTTPS.
This article describes the steps required to set up secure HTTPS communication with Jetty and with the JobScheduler Master.
- Consider the JOC Cockpit - Architecture for an overview of components and connections.
- Consider JobScheduler Universal Agent - HTTPS Agent and Master Authentication for securing the connections between a JobScheduler Master and Agents.

Prerequisites

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

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

JOC_HOME is the installation path which is specified during the JOC Cockpit 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 is specified during the JOC Cockpit 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 to Jetty

Run the following command and replace the JETTY_HOME and JETTY_BASE placeholders as specified above:
add 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.
  
  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.

Step 2: Create the Java Keystore for Jetty

Create the Java Keystore using the Keytools from your Java JRE.
- Generate the Java Keystore in JKS format with the private key and certificate for Jetty and export the certificate to the Keystore that is later on used by the browsers.
  - Example for JKS keystore format
    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 secret_key -keystore "JETTY_BASE/etc/joc.jks" -storepass secret_store
  - Example for PKCS12 keystore format
    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 secret_key -keystore "JETTY_BASE/etc/joc.jks" -storepass secret_store -storetype PKCS12
  - 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.

Step 3: Configure Jetty

Edit the following entries in the JETTY_BASE/start.ini configuration file corresponding to 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=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):
```
## 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:

# 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 for JKS keystore format
    Example 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 "SCHEDULER_DATA/config/private/private-https.jks" -storepass jobscheduler
  - Example for PKCS12 keystore format
    Example 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 "SCHEDULER_DATA/config/private/private-https.pk12" -storepass jobscheduler -storetype PKCS12
  - Explanations
    - Replace the SCHEDULER_DATA 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.
      - The Keystore file should be in reach of the JobScheduler Master, it is therefore recommended to create 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 -storepass 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 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" }
Export the JobScheduler Master public certificate for use with the JOC Cockpit Web Service
- Example for export with JKS keystore format
  Sample for export certicate
```
keytool -exportcert -rfc -noprompt -file "master-https.pem" -alias "master-https" -keystore "SCHEDULER_DATA/config/private/private-https.jks" -storepass jobscheduler
```
- Example for export with PKCS12 keystore format
  Sample for export certicate
```
keytool -exportcert -rfc -noprompt -file "master-https.pem" -alias "master-https" -keystore "SCHEDULER_DATA/config/private/private-https.p12" -storepass jobscheduler -storetype PKCS12
```
- 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.
- 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 an entry of the form:
```
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:
```
jobscheduler.master.auth.users {
  jobscheduler_prod = "plain: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:

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

Should you use a keystore in PKCS12 format then the Master until version 1.12.4 has to know the keystore password. This is not required for keystores in JKS format. Specify the type and password for a PKCS12 keystore with the SCHEDULER_DATA/config/factory.ini configuration file like this:
```
[java]
options = -Dlog4j.configuration="file:///${SCHEDULER_HOME}/lib/log4j.properties" -Djavax.xml.transform.TransformerFactory="net.sf.saxon.TransformerFactoryImpl" -Djavax.net.ssl.keyStoreType="PKCS12" -Djavax.net.ssl.keyStorePassword="jobscheduler"
```

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 for JKS keystore
  Sample 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
```
- Example for PKCS12 keystore
  Sample 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 -storetype PKCS12
```
- 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 then add the location of the Truststore to the JETTY_BASE/resources/joc/joc.properties configuration file like this:

Example for JKS keystore format

### Location of the Java trustore which contains the certificates of each 
### JobScheduler Master for HTTPS connections. Path can be absolute or relative
### to joc.properties
truststore_path = ../../etc/joc.jks

Example for PKCS12 keystore format

### Location of the Java trustore which contains the certificates of each 
### JobScheduler Master for HTTPS connections. Path can be absolute or relative
### to joc.properties
truststore_path = ../../etc/joc.jks 
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.

################################################################################
### Should hostname verification be carried out for https certificate. 
### Default false
https_with_hostname_verification = true

Space shortcuts

Page tree