...

Introduction

• The connection from a Controller Controllers to an Agent 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.

...

• Certificate stores can be managed from the command line and by use of tools that provide a GUI for this purpose:
  • the Java Keytool keytool is available from the Java JRE or JDK,
  • the Keystore Explorer is an open source utility to graphically manage certificate stores. 

...

• JS7_CONTROLLER_CONFIG_DIR is the Controller's configuration directory that is specified during Controller installation:
  
  • /var/sos-berlin.com/js7/controller/config (default on Linux)
  • 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 Linux)
  • 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 Linux)
  • C:\ProgramData\sos-berlin.com\js7\agent\config (default on Windows)

...

Secure Connections from Controller to Agent

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 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 (ca-bundle.crt) 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 of the Agent private key to be "agent-https" # keytool -importkeystore -srckeystore agent-https.p12 -srcstoretype 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 "JS7_AGENT_CONFIG_DIR/private/https-keystore.p12" -storepass jobscheduler -storetype PKCS12 # export the Agent's certificate 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

  • 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

...