Introduction

The article is focused on configuration items used for HTTPS Server and Client Authentication. For a complete overview of settings see JS7 - Controller Configuration Items and JS7 - Agent Configuration Items,

• HTTPS Server Authentication is preferably used in combination with Client Authentication (mutual authentication) as this allows a secure configuration without the use of passwords.
  • The purpose of Server Authentication is to secure the identity of an http HTTP server and to encrypt the communication between client and server.
  • The purpose of Client Authentication is to prove the identity of a client. Without proof of identity any http HTTP client could perform a man-in-the-middle attack e.g. by by, for example, pretending to be a Controller that connects to an Agent.
• Consider the communication scheme between JS7 components products as explained from in the JS7 - System Architecture article:
  
  • User browsers acting as http HTTP clients establish connections to the JOC Cockpit as an http HTTP server.
  • The JOC Cockpit acting as an http HTTP client establishes connections to Controllers Controller instances acting as http HTTP servers.
  • Controllers Controller instances acting as http HTTP clients establish connections to Agents acting as http HTTP servers.

...

Location of Configuration

...

Configuration File: private.conf

Download: private.conf

Files

In the following the JS7_CONTROLLER_CONFIG_DIR placeholder specifies the configuration directory of the Controller. The JS7_AGENT_HOME, JS7_AGENT_CONFIG_DIR placeholders specify the directories where the Agent is installed and configured.

• JS7_CONTROLLER_CONFIG_DIR is the Controller's configuration directory that is specified during installation:
  
  • <extraction-directory/controller/var/config (default on Unix/Windows for JS7 - Controller - Headless Installation on Linux and Windows)
  • C:\ProgramData\sos-berlin.com\js7\controller\config (default on Windows for JS7 - Controller - Installation Using the Windows Graphical Installer)

• JS7_AGENT_HOME is the installation path that is specified during the JobScheduler Agent installation:
  
  • <extraction-directory>/agent (default on Unix/Windows for JS7 - Agent - Headless Installation on Unix and Windows)
  • C:\Program Files\sos-berlin.com\js7\agent (default on Windows for JS7 - Agent - Installation Using the Windows Graphical Installer)
• JS7_AGENT_CONFIG_DIR is the Agent's configuration directory that is specified during Agent installation:
  
  • <extraction-directory>/agent/var_<port>/config (default on Unix/Windows for JS7 - Agent - Headless Installation on Unix and Windows)
  • C:\ProgramData\sos-berlin.com\js7\agent\config (default on Windows for JS7 - Agent - Installation Using the Windows Graphical Installer)

Controller Configuration

Configuration File: JS7_CONTROLLER_CONFIG_DIR/private/private.conf

Find an example for Controller configuration for download:  private.conf

js7 {
    auth {
        # User accounts for HTTPS connections

js7 {
    auth {
        # User accounts for HTTPS connections
        users {
            # Controller account for connections by primary/secondary Controller instance
            Controller {
            }
            # History account (used to release events)
            History {
                password="sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08"
            }
            # JOC account (requires UpdateRepo permission for deployment)
            JOC {
                password="sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE"
                permissions=[
                  users  UpdateItem{
            # Controller ID for ]
connections by  primary/secondary controller instance
       }
     Controller   }{

        # for each Agent specify Agent ID and plain text password for authentication
 distinguished-names=[
          agents {
         "DNQ=SOS  agent-dev-001="secret"
   CA, CN=controller-2-0-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
         agent-dev-002="secret"       ]
        }
    }

    configuration {
        # directoryHistory foraccount trusted(used publicto keysrelease andevents)
 certificates used with signatures
        trusted-signature-keysHistory {
                PGP=${js7.config-directory}"/private/trusted-pgp-keys"
 distinguished-names=[
           X509=${js7.config-directory}"/private/trusted-x509-keys"
        }
 "DNQ=SOS CA,  }

    journal {CN=joc-2-0-primary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
        # allow History account to release unused journals
      "DNQ=SOS CA, usersCN=joc-allowed2-to-release-events=[
    0-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
        History
        ]
    }

    web {
        # keystore and truststore location for https connections
password="sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08"
            }

            # JOC account (requires UpdateRepo permission httpsfor {deployment)
            keystoreJOC {
                # Default: ${js7.config-directory}"/private/https-keystore.p12"distinguished-names=[
                file=${js7.config-directory}"/private/https-keystore.p12"
    "DNQ=SOS CA, CN=joc-2-0-primary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
      key-password=jobscheduler
              "DNQ=SOS  store-password=jobscheduler
CA, CN=joc-2-0-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
              }
  ]
                truststores=[password="sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE"
                {permissions=[
                    UpdateItem
     # Default: ${js7.config-directory}"/private/https-truststore.p12"
          ]
            file=${js7.config-directory}"/private/https-truststore.p12"
        }
    }

    configuration {
   store-password=jobscheduler
     # directory for trusted public keys and certificates used with  }signatures
        trusted-signature-keys {
   ]
         PGP=${js7.config-directory}

"/private/trusted-pgp-keys"
         # disable use of client authentication certificates
 X509=${js7.config-directory}"/private/trusted-x509-keys"
        }
   server {}

    journal {
       auth {
# allow History account to release unused journals
         https-client-authentication=offusers-allowed-to-release-events=[
            }History
        ]
    }

    }
}

Explanation:

• The configuration file is located with the sos-berlin.com/js7/controller/config/private folder.
• Consider that the above configuration has to be deployed to both Controller instances should a Controller Cluster be used.
• Find below explanations about configuration items from the above example relevant to Server Authentication with passwords.

Specify Agent ID and Password

js7 {
    authweb {
        # keystore and truststore location for https connections
        https {
        # for each Agent specifykeystore {
  Agent ID and plain text password for authentication
       # agentsDefault: ${js7.config-directory}"/private/https-keystore.p12"
             agent-dev-001="secret"
   file=${js7.config-directory}"/private/https-keystore.p12"
            agent-dev-002="secret"
    key-password="jobscheduler"
                store-password="jobscheduler"
          }
       # alias
            }
}

Explanation:

• For each Agent the Agent ID is specified as e.g. with agent-dev-001. An Agent is assigned a unique Agent ID during initial operation with JOC Cockpit that cannot be changed unless an Agent's journal would be reset.
• The plain text password secret is specified.

Disable Client Authentication

js7 {            truststores=[
    web {
        #  disable use{
 of client authentication certificates
        server {
       # Default: ${js7.config-directory}"/private/https-truststore.p12"
   auth {
                https-client-authentication=offfile=${js7.config-directory}"/private/https-truststore.p12"
            }
        }
}

Explanation:

• By default Client Authentication is required if Server Authentication is in place.
• The above setting disables Client Authentication.

Agent Configuration

Configuration File: private.conf

Download: private.conf

js7 {
store-password="jobscheduler"
     auth {
        # User accounts for https connections
       # users {alias=
            # Controller account for connections by primary/secondary Controller instance }
            js7_dev {]
        }
         password="plain:secret"
               # password="sha512:$JhbM9ClpBpH2oB2O$qmWRbhOAfNHbmz3bp1AV.ATV0WIKVdZp3ceVXJZc.GHX4L7/iWJB7RGpzjZ2JzvbdPBtlpCFy8CLvYpKoBBKP/"
           }
}

Explanation:

• The configuration file is located in the  JS7_CONTROLLER_CONFIG_DIR/private folder.
• Note that the above configuration has to be deployed to both Controller instances if a Controller Cluster is being used.
• The configuration items relevant to mutual authentication from the example above are described below.

Authentication with pairing Controller instances and JOC Cockpit instances

Controller Connections

js7 {
    auth {
    }
     # User accounts }
for HTTPS   }connections
    
    configurationusers {
        # Locations of certificates and public# keysController usedID for signatureconnections verification
    by primary/secondary controller instance
    trusted-signature-keys {
       Controller {
    PGP=${js7.config-directory}"/private/trusted-pgp-keys"
            X509=${js7.config-directory}"/private/trusted-x509-keys"distinguished-names=[
        }
    }
    
    job {
        # Enable script execution from signed workflows
"DNQ=SOS CA, CN=controller-2-0-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
               execution {]
            signed-script-injection-allowed = yes}
        }
    }
}

Explanation:

• The setting listed above applies for a Controller Cluster. In this situation a Primary Controller requires the setting to allow access from a Secondary Controller and vice versa.
• Note that the Controller element name is an example that has to be replaced by the Controller ID that is specified with the same value during installation of both Controller instances in a cluster.
• This setting specifies the distinguished-names indicated with the partner Controllers' Client Authentication certificate. The distinguished name is given with the subject attribute of a Client Authentication certificate. The distinguished name is considered a replacement for a password.
  • A Primary Controller configuration specifies the distinguished name of the Secondary Controller's Client Authentication certificate.
  • A Secondary Controller configuration specifies the distinguished name of the Primary Controller's Client Authentication certificate.
  • Note that the common name (CN) attribute of the distinguished name has to match the fully qualified domain name (FQDN) of the partner Controller's host.

JOC Cockpit Connections

js7 {
    auth {
    
    web {
        # Locations of keystore and truststore files 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
 # User accounts for HTTPS connections
      }
  users {
         truststores=[
   # History account (used to release events)
       {
     History {
              # Default: ${js7.config-directory}"/private/https-truststore.p12"
 distinguished-names=[
                     file=${js7.config-directory}"/private/https-truststore.p12"
     "DNQ=SOS CA, CN=joc-2-0-primary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
               store-password=jobscheduler
     "DNQ=SOS CA, CN=joc-2-0-secondary, OU=IT, O=SOS,   L=Berlin, ST=Berlin, C=DE"
    }
            ]
                }

password="sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08"
            }

    # Disable use of client authentication certificates
  # JOC account (requires UpdateItem permission serverfor {deployment)
            authJOC {
                httpsdistinguished-client-authenticationnames=off[
            }
        }
    }
}

Explanation:

• The configuration file is located with the sos-berlin.com/js7/agent/config_<port>/private folder.
• Consider that the above configuration has to be deployed to any Agent instances.
• Find below explanations about above configuration items relevant to Server Authentication with passwords.

Specify Controller ID and Password

js7 {
    auth {
        # User accounts for https connections
"DNQ=SOS CA, CN=joc-2-0-primary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
                    "DNQ=SOS CA, CN=joc-2-0-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
               users {]
            # Controller account for connections by primary/secondary Controller instance
 password="sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE"
               js7_dev { permissions=[
                 password="plain:secret"   UpdateItem
               # password="sha512:$JhbM9ClpBpH2oB2O$qmWRbhOAfNHbmz3bp1AV.ATV0WIKVdZp3ceVXJZc.GHX4L7/iWJB7RGpzjZ2JzvbdPBtlpCFy8CLvYpKoBBKP/" ]
            }
        }
    }
}

Explanation:

• In this example js7_dev is the Controller ID used by a solo Controller or by a Controller Cluster. A Controller is assigned a unique Controller ID during initial operation. The Controller ID cannot be changed unless the Controller's journal is reset.
• The password for the Controller ID in the Agent configuration is the same as stated with the Controller configuration.
  • The password has to be preceded with "plain:" if a plain text password is used.
  • The password has to be preceded with "sha512" if a password hashed with this algorithm is used
    • There are a number of ways how to create sha512 hash values from passwords.
    • A possible solution includes to use: openssl passwd -6

Disable Client Authentication

• The setting listed above applies for the connection established from one or more JOC Cockpit instances to a Controller. The JOC Cockpit can be used as a cluster comprising two or more instances.
• This setting specifies the distinguished-names indicated with the relevant JOC Cockpit's Client Authentication certificate. The certificate is considered a replacement for a password. For each JOC Cockpit instance, the distinguished name is specified which is stated in the JOC Cockpit's certificate.
• Two entries are available for js7.auth.users.History and js7.auth.users.JOC:
  • History represents the JS7 - History Service that receives state transition events for orders and log output of jobs and adds them to the JS7 database.
  • JOC represents the JOC Cockpit Proxy Service that establishes the connection to a Controller and which is used to provide current information about orders to the JOC Cockpit GUI, in addition to, for example the deployment of workflows and submission of orders.
  • For both History and JOC services a hashed password is specified by the JOC Cockpit. The password has no relevance for the security of the connection. Instead it is used to distinguish the services that both are running with the same JOC Cockpit instance and therefore use the same Client Authentication certificate.
• In addition permissions are specified for JOC Cockpit services that indicate with the UpdateItem setting that the JOC Cockpit service is allowed to add/update/delete deployable objects such as workflows.

Locations of Public Keys and Certificates for Signature Verification

js7 {
    configuration {
        # directory for trusted public keys and certificates used with signatures
        trusted-signature-keys {
            PGP=${js7.config-directory}"/private/trusted-pgp-keys"
            X509=${js7.config-directory}"/private/trusted-x509-keys"
        }
    }
}

Explanation:

• The Controller verifies the signature of deployable objects such as workflows. This can be performed for PGP signatures and X.509 signatures. 
• The trusted-signature-keys setting specifies the locations for PGP public keys and for X.509 certificates.
• If either PGP public keys or X.509 certificates are not used then the relevant setting should not be specified as it implies that the indicated directory will be populated with public keys or certificates accordingly.

Services entitled to release events from the Controller journal

js7 {
    journal {
        # allow History account to release unused journals
        users-allowed-to-release-events=[
            History
        ]
    }
}

Explanation:

• The journal holds e.g. information about order state transitions. This information is consumed by the JS7 - History Service that updates the JS7 database from this information.
• The Controller's journal would grow if entries that have been consumed by the History Service could not be released. The users-allowed-to-release-events setting specifies the names, e.g. History, of the accounts for which authentication settings are indicated from the js7.auth.users section.
• A single History account is used with any number of JOC Cockpit instances. If more than one consumer account was to be specified then all consumers would have to confirm having received order transition events before such events could be removed from the journal.

HTTPS Keystore and Truststore Access

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"
            }
            keystore {
                # Default: ${js7.config-directory}"/private/https-keystore.p12"
                file=${js7.config-directory}"/private/https-keystore.p12"
                key-password="jobscheduler"
                store-password="jobscheduler"
                # alias=
            }
            truststores=[
                {
                    # Default: ${js7.config-directory}"/private/https-truststore.p12"
                    file=${js7.config-directory}"/private/https-truststore.p12"
                    store-password="jobscheduler"
                    # alias=
                }
            ]
        }
    }
}

Explanation:

• HTTPS keystores and truststores are used to hold private keys and certificates
  • Keystore and truststore settings accept the path to a file in PKCS12 format or in PEM format.
  • A keystore holds the Controller instance's private key and certificate. This information is used for:
    • Server Authentication with JOC Cockpit and for
    • Client Authentication with Agents.
  • A truststore holds the certificate(s) used to verify:
    • Client Authentication certificates presented by JOC Cockpit and
    • Server Authentication certificates presented by Agents.
  • Any number of truststores can be used.
• Optionally a separate HTTPS client keystore can be used:
  • The client keystore is used for HTTPS mutual authentication and holds a private key and certificate created for the Client Auth extended key usage.
  • When using HTTPS mutual authentication then:
    • a single certificate can be used that is generated for both Server Auth and Client Auth extended key usages. In this case do not use the HTTPS client keystore but use the HTTPS keystore to hold the certificate.
    • separate certificates can be used with the certificate for Server Auth key usage being stored in the HTTPS keystore and the certificate for Client Auth key usage being stored in the HTTPS client keystore.
  • For details 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-1959

• Keystore and Truststore locations are specified. In addition:
  • a password for the private keys included in the keystore and a password for access to the keystore can be specified,
  • a password for access to the truststore can be specified.
• Passwords for keystore and truststore are not intended for security of the configuration, they are used to verify the integrity of certificate stores as the password used for creating and reading the certificate store must be the same.
  • The key-password setting is used for access to a private key in a keystore.
  • The store-password setting is used for access to a keystore or to a truststore.
  • For PKCS12 keystores both settings have to use the same value. The settings can be omitted if no passwords are used.

Agent Configuration

Configuration File: JS7_AGENT_CONFIG_DIR/private/private.conf

Find an example for Agent configuration for download: private.conf

js7 {
    auth {
        # User accounts for https connections
        users {
            # Controller ID for connections by primary/secondary Controller instance
            Controller {
                distinguished-names=[
                    "DNQ=SOS CA, CN=controller-2-0-primary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
                    "DNQ=SOS CA, CN=controller-2-0-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
                ]
            }
        }
    }

    configuration {
        # Locations of certificates and public keys used for signature verification
        trusted-signature-keys {
            PGP=${js7.config-directory}"/private/trusted-pgp-keys"
            X509=${js7.config-directory}"/private/trusted-x509-keys"
        }
    }

    job {
        # Enable script execution from signed workflows
        execution {
            signed-script-injection-allowed = yes
        }
    }

    web {
        # Locations of keystore and truststore files 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"
                # alias=
            }
            truststores=[
                {
                    # Default: ${js7.config-directory}"/private/https-truststore.p12"
                    file=${js7.config-directory}"/private/https-truststore.p12"
                    store-password="jobscheduler"
                    # alias=
                }
            ]
        }
    }
}

Explanation:

• The configuration file is located in the JS7_AGENT_CONFIG_DIR/private folder.
• Note that the Controller element name is an example that has to be replaced by the Controller ID which is specified with the same value during installation of both Controller instances in a cluster.
• Note that the above configuration has to be deployed to all Agent instances.
• The configuration items relevant to mutual authentication from the example above are described below.

Client Authentication

Controller Connections

For explanations see the JS7 - Agent Configuration Items#js7-auth-users-Controller article.

js7 {
    auth {
        # User accounts for https connections
        users {
            # Controller ID for connections by primary/secondary Controller instance
            Controller {
                distinguished-names=[
                    "DNQ=SOS CA, CN=controller-2-0-primary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE",
                    "DNQ=SOS CA, CN=controller-2-0-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
                ]
            }
        }
    }
}

Server Authentication

HTTPS Keystore and Truststore Locations

See the JS7 - Agent Configuration Items#js7-web-https-keystore article for an explanation of the setting.

js7 {
    web {
        # keystore and truststore location 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"
                # alias=
            }
            truststores=[
                {
                    # Default: ${js7.config-directory}"/private/https-truststore.p12"
                    file=${js7.config-directory}"/private/https-truststore.p12"
                    store-password="jobscheduler"
                    # alias=
                }
            ]
        }
    }
}

Signed Scheduling Objects

Locations of Public Keys and Certificates for Signature Verification

See the JS7 - Agent Configuration Items#js7-configuration-trusted-signature-keys article for an explanation of the setting.

# Security configuration
js7 {
    configuration {
        # Locations of certificates and public keys used for signature verification
        trusted-signature-keys

js7 {
    web {
        # disable use of client authentication certificates PGP=${js7.config-directory}"/private/trusted-pgp-keys"
        server {
    X509=${js7.config-directory}"/private/trusted-x509-keys"
        auth {}
                https-client-authentication=off
            }
        }
}

Explanation:

...

}

Script Execution from Signed Workflows

See the JS7 - Agent Configuration Items#js7-job-execution-signed-script-injection-allowed article for an explanation of the setting.

# Allow http connections without authentication
js7.job.execution.signed-script-injection-allowed = yes

...