Table of Contents

Introduction

The connection connections from Controllers to Agents can be secured by HTTPS.
This article describes the steps required to set up secure HTTPS communication from a Controller to an Agent. This includes to use a standalone Controller or a Controller cluster with a primary and standby instance.
- Consider the JS7 - System Architecture for an overview of components and connections.
- Consider to set up JS7 - JOC Cockpit HTTPS Connections for secure connections from clients (user browser / REST API client) to JOC Cockpit.
- Consider JS7 - Controller HTTPS Connections for securing the connections between JOC Cockpit and Controller instances.

...

Keystore and truststore in orange color are required for any connections of a Controller to an Agent.
- The Agent's private key and certificate for Server Authentication are added to the Agent's keystore. In case of a self-signed certificate the certificate is added to the Controller's truststore too.
- This step can be skipped if a CA-signed certificate is used as the Root Certificate in the Controller's truststore is sufficient to verify Agent certificates.
Keystore and truststore in green color are required if mutual authentication is in place for certificate based client authentication (default).

...

JS7_CONTROLLER_CONFIG_DIR is the Controller's configuration directory that is specified during installation:
- /var/sos-berlin.com/js7/controller/config (default on LinuxUnix)
- C:\ProgramData\sos-berlin.com\js7\controller\config (default on Windows)
JS7_AGENT_HOME is the installation path that is specified during the JobScheduler Agent installation:
- /opt/sos-berlin.com/js7/agent (default on LinuxUnix)
- C:\Program Files\sos-berlin.com\js7\agent (default on Windows)
JS7_AGENT_CONFIG_DIR is the Agent's configuration directory that is specified during Agent installation:
- /var/sos-berlin.com/js7/agent/config (default on LinuxUnix)
- C:\ProgramData\sos-berlin.com\js7\agent\config (default on Windows)

Secure Connections from Controller to Agent

Step 1: Create the Agent Keystore

This configuration is applied in order to secure the connection if the Controller and Agent are not operated on the same server and network interface.

Secure connections require authentication.

By default Controller and Agent use mutual authentication:
- The Controller verifies the Agent's certificate for Server Authentication.
- The Agent verifies the Controller's certificate for Client Authentication.
- For details JS7 - Configuration for mutual HTTPS Server Authentication and Client Authentication.
If mutual authentication cannot be applied, e.g. in case of use with wildcard certificates:
- Consider to use password based authentication.
- For details see JS7 - Configuration for HTTPS Server Authentication with Passwords.

For the complete list of related configuration items see JS7 - Agent Configuration Items

The following chapters assume mutual authentication to be in place.

Step 1: Create the Agent Keystore

On the Agent server create the keystore using the keytool from your Java JRE or JKD. Alternatively import a private key and certificate that you received from your certificate authority:

For use with a third party utility create a keystore, e.g. https-keystore.p12, in PKCS12 format and import:
- Agent private key and certificate for Server Authentication
- Root CA certificate
- Intermediate CA certificates

For use with keytool create the keystore with the private key and certificate for Server Authentication from the command line. 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 private key and CA-signed certificate with a PKCS12 store:

Code Block

language	bash
title	Example how to add a private key and CA-signed certificate to a PKCS12 keystore

# should your Agent's private key and certificate be 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 Agent private key is "agent-https"
# keytool -importkeystore -srckeystore keypair.jks -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias agent-https

# assuming your Agent's private key from a pkcs12 keystore (keystore.p12), store the Agent's private key to a .key file

On the Agent server create the keystore using the keytool from your Java JRE or JKD. Alternatively import a certificate that you received from your certificate authority:

Generate the keystore with the private key and public certificate for the Agent and export the certificate to a second keystore that is later on used by the Master or use the attached script keygen.sh to perform this task. 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 CA-signed certificate with a PKCS12 store:

Code Block

language	bash
title	Example for use of CA signed certificate: export Agent private key and Agent public certificate

# should your Agent 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 Agent private key is "agent-https"
# keytool -importkeystore -srckeystore keypair.jks -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias agent-https

# assuming your Agent private key from a pkcs12 keystore (keystore.p12), store the Agent private key to a .key file in PEM format (agent-https.key)
openssl pkcs12 -in keystore.p12 -nocerts -out agent-https.key

# concatenate CA root certificate and CA intermediate certificate to a single CA Bundle certificate file (ca-bundle.crt)
cat RootCACertificate.crt > ca-bundle.crt
cat CACertificate.crt >> ca-bundle.crt

# Export Agent private key (agent-https.key), Agent certificate (agent-https.crt) and CA Bundle in PEM format (caagent-bundlehttps.crtkey) to a new keystore (https-keystore.p12)
#   assume the fully qualified hostname (FQDN) of the Agent server to be agent.example.com
openssl pkcs12 -export -in agent-https.crt -inkey agent-https.key -chain -CAfile ca-bundle.crt -name agent.example.com -out JS7_AGENT_CONFIG_DIR/private/https-keystore.p12

# should you require use of a .jks keystore type then convert the pkcs12 keystore assuming the alias name
openssl pkcs12 -in keystore.p12 -nocerts -out agent-https.key

# concatenate CA root certificate and CA intermediate certificate to a single CA Bundle certificate file (ca-bundle.crt)
cat RootCACertificate.crt > ca-bundle.crt
cat CACertificate.crt >> ca-bundle.crt

# Export Agent's private key (agent-https.key), Agent's certificate (agent-https.crt) and CA Bundle (ca-bundle.crt) in PEM format to a new keystore (https-keystore.p12)
#   assume the fully qualified hostname (FQDN) of the Agent privateserver keybeing to be "agent-https"
# keytool -importkeystore -srckeystoreagent.example.com
openssl pkcs12 -export -in agent-https.p12crt -srcstoretypeinkey PKCS12 -destkeystore JS7_AGENT_CONFIG_DIR/private/https-keystore.jks -deststoretype JKS -srcalias agent-https

Example for use of self-signed certificate with a PKCS12 keystore:

Code Block

language	bash
title	Example for use of self-signed certificate: generate Agent private key and export Agent public certificate

# generate the Agent's private key with alias name "agent-https" in a keystore (https-keystore.p12)
#   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
keytool -genkey -alias "agent-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "agent-https.key -chain -CAfile ca-bundle.crt -name agent.example.com -out JS7_AGENT_CONFIG_DIR/private/https-keystore.p12

# should you require use of a .jks keystore type then convert the pkcs12 keystore assuming the alias name of the Agent's private key being "agent-https"
# keytool -importkeystore -srckeystore agent-https.p12 -srcstoretype PKCS12 -destkeystore JS7_AGENT_CONFIG_DIR/private/https-keystore.p12"jks -storepassdeststoretype jobschedulerJKS -storetype PKCS12

# export the Agent's certificate to a file in PEM format (agent-https.crt)
srcalias agent-https

Example for use of private key and self-signed certificate with a PKCS12 keystore:

Code Block

language	bash
title	Example how to generate a private key and self-signed certificate for import into a PKCS12 keystore
collapse	true

# generate the Agent's private key with alias name keytool -exportcert -rfc -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "JS7_AGENT_CONFIG_DIR/private/and certificate in a keystore (https-keystore.p12" -storepass jobscheduler -storetype PKCS12

if you choose an individual password for the Agent Keystore then adjust the following properties in the <agent_data>/config/private/private.conf configuration file:

Explanations
- jobscheduler.agent.webserver.https.keystore.file is used for the path to the Keystore
- jobscheduler.agent.webserver.https.keystore.password is used for the Keystore password
- jobscheduler.agent.webserver.https.keystore.key-password is used for the password of your private HTTPS certificate

Example

Code Block

language	text
title	Example for private.conf file with keystore specification

jobscheduler.agent.webserver.https.keystore {
  file = "C:/ProgramData/sos-berlin.com/jobscheduler/agent110/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"
}

For the Master the Truststore that contains the Agents' public certificate is expected with the password jobscheduler.

On the JobScheduler Agent server store the Keystore with the private key in the directory <agent_data>/config/private
- Default file name: private-https.jks

On the JobScheduler Master server store the Truststore with the public certificate of the Agent in the directory <master_data>/config

Default file name: agent-https.jks

 Display feature availability
StartingFromRelease 1.13.3

The location, type and password of the Master Truststore can be specified:

Code Block

title	Example for specification of Master Truststore with Agent public certificates

jobscheduler.master.agents.https.keystore {
  file = "/var/sos-berlin.com/jobscheduler/apmaccs_4444/config/agent-https.p12"
  # Backslashes are written twice (as in JSON notation):
  # file = "\\\\other-computer\\share\\my-keystore.jks"
  password = "jobscheduler"
  key-password = "jobscheduler"
}

Example for import of an Agent public certificate to a Master Truststore in pkcs12 format:

Code Block

title	Example for import of Agent public certificate to a pkcs12 Master Truststore

# import Agent public certificate to a truststore (agent-https.p12) by specifying the Agent public certificate file (agent-https.crt) and alias name (agent-https)
keytool -importcert -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "SCHEDULER_DATA/config/agent-https.p12" -storepass jobscheduler -storetype PKCS12 -trustcacerts

Example for import of an Agent public certificate to a Master Truststore in jks format (specifying the default values for location, type and password):

Code Block

title	Example for import of Agent public certificate to a jks Master Truststore

# import Agent public certificate to a truststore (agent-https.p12) by specifying the Agent public certificate file (agent-https.crt) and alias name (agent-https)
keytool -importcert -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "SCHEDULER_DATA/config/agent-https.jks" -storepass jobscheduler -trustcacerts

Step 2: Set up authentication between Master and Agent

On the JobScheduler Master server configure the Master password in a file on the Master in the <master_data>/config/private directory:
- File name: private.conf
- The file should contain the following entry that specifies a plain text password myjobscheduler4444 that is used by the Master to authenticate against Agents:
  Code Block
  language text
  title Example for Master private.conf file with Master password specification
  jobscheduler.master.credentials.password = "myjobscheduler4444"

On the JobScheduler Agent server specify the same Master password in a file in the directory <agent_data>/config/private

File name: private.conf

Specify the Master that will authenticate with the Agent by its JobScheduler ID and password. For example, for two Masters with JobScheduler ID scheduler_4444 and scheduler_5555 this file would look like this assuming that the Master password is myjobscheduler4444:

Code Block

language	text
title	Example for Agent private.conf file with specification of Master Scheduler ID and password

jobscheduler.agent.auth.users {
  scheduler_4444 = "plain:myjobscheduler4444"
  scheduler_5555 = "sha512:9184ddcaa87eb2f95c32f12741035c1e55cef93f7834905f926c4bc419fbc5613e2e141d39fb05d0ec7c66c9bd9e4c8b95b74598e0107f863b7f2bd942a9aea0"
}

For each entry the JobScheduler ID is used as key, the value (in double quotes) includes the hash algorithm followed by a colon and the hashed password.
- Using plain for the hash algorithm requires a plain text password to be specified. Use of plain text passwords is not recommended as they could be visible to jobs running on that Agent.
- Using sha512 for the hash algorithm requires a password that is hashed with the respective algorithm. A number of command line utilities to create an sha512 hash from a plain text password can easily be found.

Step 3: Start the Agent for HTTPS

...

)
#   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
keytool -genkey -alias "agent-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JS7_AGENT_CONFIG_DIR/private/https-keystore.p12" -storepass jobscheduler -storetype PKCS12

Example for use of private key and self-signed certificate with JKS keystore:

Code Block

language	bash
title	Example how to generate a private key and self-signed certificate for import into a JKS keystore
collapse	true

# generate Agent's private key with alias name "agent-https" and certificate in a keystore (https-keystore.jks)
#   use the fully qualified hostname (FQDN) and name of your organization for the distinguished name
keytool -genkey -alias "agent-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JS7_AGENT_CONFIG_DIR/private/https-keystore.jks" -storepass jobscheduler

Explanation:
- 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.
- The -keystore option specifies the location of the keystore file. The keystore file should be in reach of the Agent, it is recommended to use the sub-folder private in the JS7_AGENT_CONFIG_DIR directory.
- The -storepass option specifies the password for access to the keystore file.
- The -storetype option is used to specify the PKCS12 or JKS keystore format.

With the keystore being set up specify respective properties with the JS7_AGENT_CONFIG_DIR/private/private.conf configuration file:

Example

Code Block

language	text
title	Example for private.conf file specifying the Agent keystore

js7 {
    web {
        # keystore and truststore locations for https connections
        https {
            keystore {
                # Default: ${js7.config-directory}"/private/https-keystore.p12"
                file=${js7.config-directory}"/private/https-keystore.p12"
                key-password="jobscheduler"
                store-password="jobscheduler"
            }
        }
    }

Explanation:

js7.web.https.keystore.file is used for the path to the keystore.
js7.web.https.keystore.key-password is used for access to the private key.
js7.web.https.keystore.store-password is used for access to the keystore

Step 2: Set up Authentication for Agent

By default mutual authentication is in place.
- The Controller is challenged by the Agent to present its Client Authentication certificate that is verified by the Agent.
- If a Controller cluster is used then connections from both Controller instances are authenticated by the distinguished name of the instance's Client Authentication certificate.

The JS7_CONTROLLER_CONFIG_DIR/private/private.conf configuration file should include authentication details like this:

Code Block

title	Example for private.conf file specifying Controller authentication

js7 {
    auth {
        users {
            # Controller ID for connections by primary/standby Controller instance
            jobscheduler {
                distinguished-names=[
                    "DNQ=SOS CA, CN=apmacwin_primary_client, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
                    "DNQ=SOS CA, CN=apmacwin_secondary_client, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
                ]
            }
        }
    }
}

Explanation:

The jobscheduler user account is an example for a Controller ID that is specified during Controller installation.
For each Controller instance the distinguished name as available from its Client Authentication certificate's subject is used.

Step 3: Set up the Agent Instance Start Script for HTTPS

To make an Agent use HTTPS the respective port setting has to be specified with the Agent's Instance Start Script.

For Unix the Instance Start Script is available from JS7_AGENT_HOME/bin/agent_<port>.sh:

Code Block

language	xml
title	Example for HTTP and HTTPS port settings with Agent Instance Start Script for Linux

# Sets the http port for the JS7 Agent.
# Without this setting the default port 4445 is used.
# If just a port is specified then the JS7 Agent listens to all
# available network interfaces. This corresponds to 0.0.0.0:<port>.
# Use the form <ip address or hostname>:<port> to indicate
# a specific network interface the JS7 Agent should listen to.
# The command line option --http-port beats the environment
# variable JS7_AGENT_HTTP_PORT.

JS7_AGENT_HTTP_PORT=localhost:4445


# In addition to the http port an https port for the
# JS7 Agent can be specified. If just a port is specified
# then the JS7 Agent listens to all available network interfaces.
# This corresponds to using 0.0.0.0:<port>.
# Use the form <ip address or hostname>:<port> to indicate
# a specific network interface the JS7 Agent should listen to.
# The command line option --https-port beats the environment
# variable JS7_AGENT_HTTPS_PORT.

JS7_AGENT_HTTPS_PORT=apmacwin:4445

For Windows the Instance Start Script is available from JS7_AGENT_HOME\bin\agent_<port>.cmd:

Code Block

language	xml
title	Example for HTTP and HTTPS port settings with Agent Instance Start Script for Windows
collapse	true

rem # Sets the http port for the JS7 Agent.
rem # Without this setting the default port 4445 is used.
rem # If just a port is specified then the JS7 Agent listens to all
rem # available network interfaces. This corresponds to 0.0.0.0:<port>.
rem # Use the form <ip address or hostname>:<port> to indicate
rem # a specific network interface the JS7 Agent should listen to.
rem # The command line option --http-port beats the environment
rem # variable JS7_AGENT_HTTP_PORT.

set JS7_AGENT_HTTP_PORT=localhost:4445


rem # In addition to the http port an https port for the
rem # JS7 Agent can be specified. If just a port is specified
rem # then the JS7 Agent listens to all available network interfaces.
rem # This corresponds to using 0.0.0.0:<port>.
rem # Use the form <ip address or hostname>:<port> to indicate
rem # a specific network interface the JS7 Agent should listen to.
rem # The command line option --https-port beats the environment
rem # variable JS7_AGENT_HTTPS_PORT.

set JS7_AGENT_HTTPS_PORT=apmacwin:4445

Explanation:

The HTTP port is required but is limited to the localhost network interface with the localhost prefix.
The HTTPS port is specified with the hostname prefix that indicates the network interface.

Step 4: Configure the Controller Truststore

The Controller truststore is added the Root CA certificate. If self-signed certificates are used then each certificate is added to the Controller's truststore.

On the Controller server create the truststore using the keytool from your Java JRE or 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 one 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

language	bash
title	Example how to import a CA-signed certificate into a PKCS12 Truststore

# import Root CA certificate in PEM format to a PKCS12 truststore (https-truststore.p12)
keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12"

Example for use of a self-signed Controller certificate with a PKCS12 truststore:

Code Block

language	bash
title	Example for import of a self-signed Controller certificate the Master public certificate to JOC Cockpit PKCS12 Truststore
collapse	true

# on Agent server: export Agent's certificate from keystore (https-keystore.p12) identified by its alias name (agent-https) to a file in PEM format (agent-https.crt)
keytool -exportcert -rfc -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "JS7_AGENT_CONFIG_DIR/private/https-keystore.p12" -storepass jobscheduler -storetype PKCS12

# on Controller server: import the Agent's certificate from a file in PEM format (agent-https.crt) identified by its alias name (agent-https) to the Controller's PKCS12 truststore (https-truststore.p12)
keytool -importcert -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.p12" -storepass jobscheduler -storetype PKCS12 -trustcacerts

Example for use of a self-signed Controller certificate with a JKS truststore:

Code Block

language	bash
title	Example for import of a self-signed Controller certificate the Master public certificate to JOC Cockpit JKS Truststore
collapse	true

# on Agent server: export Agent's certificate from keystore (https-keystore.jks) identified by its alias name (agent-https) to a file in PEM format (agent-https.crt)
keytool -exportcert -rfc -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "JS7_AGENT_CONFIG_DIR/private/https-keystore.jks" -storepass jobscheduler -storetype JKS

# import the Agent's certificate from a file in PEM format (agent-https.crt) identified by its alias name (agent-https) to the Controller's JKS truststore (https-truststore.jks)
keytool -importcert -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-truststore.jks" -storepass jobscheduler -trustcacerts

On the Controller server specify the location of the truststore with the JS7_CONTROLLER_CONFIG_DIR/private/private.conf configuration file:

Example

Code Block

language	text
title	Example for private.conf file specifying the Controller truststore

js7 {
    web {
        # keystore and truststore locations for https connections
        https {
            truststores=[
                {
                    # Default: ${js7.config-directory}"/private/https-truststore.p12"
                    file=${js7.config-directory}"/private/https-truststore.p12"
                    store-password=jobscheduler
                }
            ]
        }
    }

Explanation:

js7.web.https.truststores.file is used for the path to the truststore.
js7.web.https.truststores.store-password is used for access to the truststore.

Mutual Authentication for Agent

This configuration is applied in order to enable mutual authentication

from the Controller to the Agent:
- the Controller verifies the Agent's certificate for Server Authentication
- the Agent verifies the Controller's certificate for Client Authentication
from pairing Controller instances.

Step 1: Create/Update Controller (Client) Keystore

For mutual authentication the Controller has to hold a Client Authentication private key and certificate in its keystore.

This can be simplified by use of a private key/certificate pair that is created for both extended key usages Server Authentication and Client Authentication. In this case a single private key and certificate is stored with the Controller's keystore as indicated with the JS7 - Controller HTTPS Connections article.
If separate private key/certificate pairs should be used for Server Authentication and Client Authentication purposes then use of separate certificate stores for the Controller is recommended:
- The keystore holds the private key/certificate for Server Authentication.
- The client keystore holds the private key/certificate for Client Authentication.

The following steps are applied if a separate client keystore is used with a Controller.

On the Controller server create the client keystore using the keytool from your Java JRE or JDK or some third party utility.
- For use with a third party utility create a client keystore, e.g. https-client-keystore.p12, in PKCS12 format and import:
  - Controller private key and certificate for Client Authentication
  - Root CA certificate
  - Intermediate CA certificates
- For use with keytool create the client keystore in PKCS12 or JKS format according to the steps indicated with JS7 - Controller HTTPS Connections: Step 1: Create Controller Keystore chapter.
  - Apply the indicated steps to the client keystore and use the private key/certificate pair for Client Authentication.

The location of the client keystore is added to the JS7_CONTROLLER_CONFIG_DIR/private/private.conf configuration file like this:

Example for PKCS12 client keystore:

Code Block

language	text
title	Example how to specify the client keystore location with private.conf file

js7 {
    web {
        # keystore and truststore location for https connections
        https {
            client-keystore {
                # Default: ${js7.config-directory}"/private/https-client-keystore.p12"
                file=${js7.config-directory}"/private/https-client-keystore.p12"
                key-password=jobscheduler
                store-password=jobscheduler
            }
    }
}

Step 2: Create Agent Truststore

On the Agent server create the truststore using the keytool from your Java JRE or 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 one 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

language	bash
title	Example how to import a CA-signed certificate into a PKCS12 truststore

# on Agent server: import Root CA certificate in PEM format to a PKCS12 truststore (https-truststore.p12)
keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JS7_AGENT_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12

Example for export/import of self-signed client authentication certificate to a PKCS12 keystore:

Code Block

language	bash
title	Example how to export/import a self-signed certificate to a PKCS12 truststore
collapse	true

# on Controller server: export Controller's certificate from client keystore (https-client-keystore.p12) identified by its alias name (controller-client-https) to a file in PEM format (controller-client-https.crt)
keytool -exportcert -rfc -noprompt -file "controller-client-https.crt" -alias "controller-client-https" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-client-keystore.p12" -storepass jobscheduler -storetype PKCS12

# on Agent server: import Controller's certificate in PEM format to a PKCS12 truststore (https-truststore.p12)
keytool -import -alias "controller-client-https" -file "controller-client-https.crt" -keystore "JS7_AGENT_CONFIG_DIR/private/https-truststore.p12" -storetype PKCS12

Example for export/import of self-signed client authentication certificate to a JKS keystore:

Code Block

language	bash
title	Example how to export/import a self-signed certificate to a JKS truststore
collapse	true

# on Controller server: export Controller's certificate from client keystore (https-client-keystore.jks) identified by its alias name (controller-client-https) to a file in PEM format (controller-client-https.crt)
keytool -exportcert -rfc -noprompt -file "controller-client-https.crt" -alias "controller-client-https" -keystore "JS7_CONTROLLER_CONFIG_DIR/private/https-client-keystore.jks" -storepass jobscheduler

# on Agent server: import Controller's certificate in PEM format to a JKS truststore (https-truststore.jks)
keytool -import -alias "controller-client-https" -file "controller-client-https.crt" -keystore "JS7_AGENT_CONFIG_DIR/private/https-truststore.jks" -storetype JKS

Show If

match	all
user	ap

Risk Mitigation

The above explanations indicate use of a Root CA certificate for verification of Client Authentication certificates when it comes to mutual authentication.

In fact use of a Root CA certificate allows any clients that dispose of a Client Authentication certificate signed by the same Root CA certificate or Intermediate CA to be authenticated. This implication might allow an unwanted number of clients to access a Controller. By design the only clients to access a Controller should be JOC Cockpit instances.
Coping strategies include
- to use a separate certificate authority to sign Client Authentication certificates for access to Controllers.
- to import individual Client Authentication certificates to the Controller truststore instead of using a Root CA certificate

...

- .

Notes

A restart of the respective component is required to apply modifications to .the JS7_AGENT_CONFIG_DIR/private/private.conf file of the Agent and JS7_CONTROLLER_CONFIG_DIR/private/private.conf file of the Controller respectively.

...

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version 6

Key

Introduction

Secure Connections from Controller to Agent

Step 1: Create the Agent Keystore

Step 1: Create the Agent Keystore

Step 2: Set up authentication between Master and Agent

Step 3: Start the Agent for HTTPS

Step 2: Set up Authentication for Agent

Step 3: Set up the Agent Instance Start Script for HTTPS

Step 4: Configure the Controller Truststore

Mutual Authentication for Agent

Step 1: Create/Update Controller (Client) Keystore

Step 2: Create Agent Truststore

Risk Mitigation

Notes

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 5

New Version 6

Key

Introduction

Secure Connections from Controller to Agent

Step 1: Create the Agent Keystore

Step 1: Create the Agent Keystore

Step 2: Set up authentication between Master and Agent

Step 3: Start the Agent for HTTPS

Step 2: Set up Authentication for Agent

Step 3: Set up the Agent Instance Start Script for HTTPS

Step 4: Configure the Controller Truststore

Mutual Authentication for Agent

Step 1: Create/Update Controller (Client) Keystore

Step 2: Create Agent Truststore

Risk Mitigation

Notes