...

Controller[label="   Controller   \nStandalone / Cluster",fillcolor="lightskyblue"]
Agent_A [label="   Agent 1   ",fillcolor="lightskyblue"]
Agent_B [label="   Agent 2   ",fillcolor="lightskyblue"]
 
Controller_Truststore [label="Controller Truststore\nhttps-truststore.p12\n\nCA certificates",fillcolor="orange"]
Agent_A_Keystore [label="Agent 1 Keystore\nhttps-keystore.p12\n\nCA certificates\nPrivate Key / Certificate",fillcolor="orange"]
Agent_B_Keystore [label="Agent 2 Keystore\nhttps-keystore.p12\n\nCA Certificates\nPrivate Key / Certificate",fillcolor="orange"]

CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root\nCertificate",fillcolor="white"]
CA_IntermediateCertificate
Agent_A_RootCertificate [shape="ellipse",shape="ellipse",label="CA IntermediateRoot\nCertificate",fillcolor="white"]

Agent_A_PrivateKeyIntermediateCertificate [shape="ellipse",label="ServerCA AuthenciationIntermediate\nPrivate KeynCertificate",fillcolor="white"]
Agent_AB_Keystore_CertificateRootCertificate [shape="ellipse",shape="ellipse",label="ServerCA AuthenticationRoot\nCertificate",fillcolor="white"]
# Agent_AB_Truststore_CertificateIntermediateCertificate [shape="ellipse",label="ServerCA AuthenticationIntermediate\nCertificate\n(self-signed)",fillcolor="chartreusewhite"]

Agent_BA_PrivateKey [shape="ellipse",label="Server AuthenticationAuthenciation\nPrivate Key",fillcolor="white"]
Agent_BA_Keystore_Certificate [shape="ellipse",label="Server Authentication\nCertificate",fillcolor="white"]
# Agent_B_PrivateKey [shape="ellipse",label="Server Authentication\nPrivate Key",fillcolor="white"]
Agent_B_TruststoreKeystore_Certificate [shape="ellipse",label="Server Authentication\nCertificate\n(self-signed)",fillcolor="chartreusewhite"]

Agent_A -> Agent_A_Keystore 
#Agent_A_Keystore -> Agent_A_PrivateKey -> Agent_A_TruststoreKeystore_Certificate [label=" transferadd to Controller           keystore "] 
Agent_A_Keystore -> Agent_A_PrivateKeyRootCertificate -> Agent_A_Keystore_CertificateIntermediateCertificate [label=" add add to keystore keystore "]

Controller -> Agent_A [label=" establish connection "]
Controller -> Agent_B [label=" establish connection "]
Controller -> Controller_Truststore
Controller_Truststore -> CA_RootCertificate -> CA_IntermediateCertificate [label=" add to truststore "]

CAAgent_IntermediateCertificateB -> Agent_A_Truststore_Certificate [label=" add to truststore "]
CA_IntermediateCertificateB_Keystore 
Agent_B_Keystore -> Agent_B_PrivateKey -> Agent_B_TruststoreKeystore_Certificate [label=" add to truststorekeystore "]

Agent_B_Keystore -> Agent_B_Keystore 
# Agent_BRootCertificate -> Agent_B_Truststore_Certificate IntermediateCertificate [label=" transfer to Controller      "]
Agent_B_Keystore -> Agent_B_PrivateKey -> Agent_B_Keystore_Certificate [label=" add to keystore  add to keystore "]

The Agent's private key and certificate are added to the Agent's keystore. In case of a self-signed certificate the certificate is added to the Master's truststore as well. This step can be skipped if a CA-signed certificate is used as the Root Certificate and Intermediate Certificate in a Master's truststore are sufficient to verify any Agent certificates.

Secure Connection Setup

Set Set up a secure connection to the Agent

In the following the placeholders SCHEDULER_HOME, SCHEDULER_DATA specify the directories where JobScheduler Master is installed and configured on the JobScheduler Master's server. The placeholders AGENT_HOME, AGENT_DATA specify the directories where JobScheduler Agent is installed and configured on the JobScheduler Agent's server.

• SCHEDULERJS7_CONTROLLER_HOME is the installation path which that is specified during the JobScheduler Master installation:Controller installation:
  
  • /opt/sos-berlin.com/js7/controller (default on Linux)
  • C:\Program Files\sos-berlin.com\jobschedulerjs7\schedulercontroller (default on Windows)
• JS7_CONTROLLER_CONFIG_DIR is the Controller's configuration directory that is specified during Controller installation:
  
  • /optvar/sos-berlin.com/jjobscheduler/schedulerjs7/controller/config (default on Linux)
  SCHEDULER_DATA is the JobScheduler Master's configuration directory which is specified during the JobScheduler Master installation:
  • C:\ProgramData\sos-berlin.com\js7\controller\jocconfig (default on Windows)
  • /home/<setup-user>/sos-berlin.com/joc (default on Linux)
• JS7_AGENT_HOME is the installation path which that is specified during the JobScheduler Agent installation:
  
  • C:\Program Files\/opt/sos-berlin.com\jobscheduler\jobscheduler_agent /js7/agent (default on WindowsLinux)
  • /opt/C:\Program Files\sos-berlin.com/jjobscheduler/jobscheduler_\js7\agent (default on LinuxWindows)
• JS7_AGENT_CONFIG_DATADIR is the JobScheduler Agent's configuration directory which that is specified during the JobScheduler Agent installation:
  
  • C:\ProgramData\/var/sos-berlin.com\jobscheduler\jobscheduler_agent/js7/agent/config (default on WindowsLinux)
  • /home/<setup-user>/C:\ProgramData\sos-berlin.com/jobscheduler_agent\js7\agent\config (default on LinuxWindows)

Step 1: Create the Java Keystore

• On the JobScheduler Agent server create the Java Keystore keystore using the Keytools keytool from your Java JRE or JKD. Alternatively import a certificate that your received from your certificate authority:
  • Generate the Java Keystore 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 self-signed certificate

      Code Block
      language bash title Example for use of self-signed certificate: generate Agent private key and export Agent public certificate
      # generate Agent private key with alias name "agent-https" in a keystore (private-https.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_DATA/config/private/private-https.p12" -storepass jobscheduler -storetype PKCS12 # export the Agent public certificate to a file in PEM format (agent-https.crt) keytool -exportcert -rfc -noprompt -file "agent-https.crt" -alias "agent-https" -keystore "AGENT_DATA/config/private/private-https.p12" -storepass jobscheduler -storetype PKCS12

    • Example for use of CA signed certificate

      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 public certificate in PEM format (agent-https.crt) and CA Bundle in PEM format (ca-bundle.crt) to a new keystore (agent-https.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 agent-https.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 agent-https.jks -deststoretype JKS -srcalias agent-https

  • If not otherwise configured then JobScheduler Agent and Master by default use the password jobscheduler for the respective Keystore.
  • 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

...

• On the JobScheduler Master server create a Process Class for a job chain or a job.
  • Add the Agent URL to the process class using the HTTPS protocol.
  • Assign the process class to the job chain or job.

  • Example:

    Code Block
    language xml title Example of process class specification for use with Agents
    <?xml version="1.0" encoding="ISO-8859-1"?> <process_class max_processes="30" remote_scheduler="https://my_agent:44445"/>

...

Notes

• In order to apply modifications to ./config/private/private.conf files of the Master or the Agent a restart of the respective component is required.
• Modifications to a Master Truststore are applied without a restart for 

  Display feature availability
  StartingFromRelease 1.13.3

  , see 

  Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1874

• For releases before 

  Display feature availability
  StartingFromRelease 1.10.7

   the problem

  Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1675

   occurs. Consider to apply the workaround as specified from the issue.

Change Management References

...

Further Resources

• JS7 - JOC Cockpit HTTPS Connections
• JS7 - Controller HTTPS Connections
• JS7 - Configuration Templates
  • JS7 - Configuration for mutual HTTPS Server Authentication and Client Authentication
  • JS7 - Configuration for HTTP Basic Authentication with Passwords
  • JS7 - Configuration for HTTPS Server Authentication with Passwords

...