Introduction

This article explains configuration items available for Standalone Controllers and Controller instances in a JS7 - Controller Cluster.

• Controllers make use of two configuration files:
  • the general configuration file controller.conf that is available at the following locations:
    • Windows: C:\ProgramData\sos-berlin.com\js7\controller\var\config\controller.conf
    • Unix /var/sos-berlin.com/js7/controller/var/config/controller.conf
  • the security configuration from private.conf that is available at the following locations:
    • Windows: C:\ProgramData\sos-berlin.com\js7\controller\var\config\private.conf
    • Unix: /var/sos-berlin.com/js7/controller/var/config/private/private.conf
  • The configuration format makes use of Typesafe Config, see JS7 - Configuration Format
  • Controller instances have to be restarted in order to apply changes to configuration files.
• For HTTPS configuration please refer to the JS7 - Configuration Templates article.

Default Configuration

General Configuration File: controller.conf

HTTP Connections

By default the Controller configuration ships with HTTP connections enabled. It is recommended that public/private keys and certificates for secure HTTPS connections are used and that HTTP connections are disabled.

# Allow HTTP connections without authentication
js7.web.server.auth.public = true

• This setting specifies public access to a Controller if incoming HTTP connections are to be used. If used with a value true then authentication is not applied.
• Default: true

Controller Cluster Configuration

If a JS7 Controller cluster is used then the following configuration has to be applied:

Primary Controller Configuration

# Cluster configuration: not required

• A Primary Controller instance does not require any configuration items for cluster operation.

Secondary Controller Configuration

# Cluster configuration
js7.journal.cluster {
    node {
        is-backup = yes
    }
}

• A Secondary Controller instance specifies this setting to indicate that this instance starts as a standby node (Backup). When this setting is not in place, both instances of a Controller Cluster will start as standalone instances.
• This setting is relevant for initial operation only. It is independent of which Controller instance later on will be the active one and which instance will be the standby one.
• This setting has to be added before starting a Secondary Controller.

• This setting is used for Controller instances in cluster mode only, it is not used for standalone Controller instances.
• The registration of Primary and Secondary Controller instances is performed by the JOC Cockpit during initial operation.
  • Therefore the only setting required for cluster operation is:
    • js7.journal.cluster.node.is-backup=yes: For a Secondary Controller instance this setting specifies that during initial operation the given instance will be the inactive standby node.
  • Additional settings can be applied. However, we recommend that the JOC Cockpit is used instead.
    • nodes
      • Primary, Backup: For a Primary Controller instance this setting specifies the URLs of the Primary and Backup (Secondary) instance. The URL includes specification of the http/https protocol, the hostname and port.

Security Configuration File: private.conf

Directory for Trusted Certificates used to verify Signed Workflow Signatures

The Controller requires X.509 certificates and/or PGP public keys to be in place. These are used to verify the signatures of signed workflows. Unsigned workflows will not be accepted by a Controller and will not be forwarded to Agents. Therefore a minimum of one X.509 certificate file or PGP public key file has to be present in the directories that are specified with the following configuration item:

# Security configuration
js7 {
    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"
        }
    }

Explanation:

• The Controller verifies signatures of scheduling objects such as workflows during deployment. This can be performed using PGP and X.509 signatures. 
• The trusted-signature-keys setting specifies the location of PGP public keys and X.509 certificates.
• If no PGP public keys are used or if no X.509 certificates are used then this setting should not be used as it is expected that the indicated directory is populated with public keys or certificates respectively.

Secure Configuration

It is essential to secure the connections between Controller, Agents and JOC Cockpit. This includes:

• using HTTPS connections which are secured by private keys and certificates,
• using authentication between JS7 products:
  • Option 1 (recommended):
    • applying TLS mutual authentication between JOC Cockpit and Controller
    • applying TLS mutual authentication between Controller instances and Agents.
  • Option 2:
    • applying password authentication between JS7 products should mutual authentication not be in place.

Find examples of private.conf files for Controller configuration for download:

• Standalone Controller
  • Standalone Controller: private.conf-example-standalone-controller
• Controller Cluster
  • Primary Controller instance: private.conf-example-primary-controller
  • Secondary Controller instance: private.conf-example-secondary-controller

Standalone Controller Configuration

Client Authentication

JOC Cockpit Connections

js7 {
    auth {
        # User accounts for https connections
        users {
            # History account of JOC Cockpit (used to release events)
            History {
                # for use with TLS mutual authentication
                distinguished-names=[
                    "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"
                ]

                # for use with password authentication (default password stored with JOC Cockpit Settings)
                password="sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08"
                # for use of an empty password
                # password="plain:"
            }

            # JOC account of JOC Cockpit (requires UpdateItem permission for deployment)
            JOC {
                # for use with TLS mutual authentication
                distinguished-names=[
                    "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"
                ]

                # for use with password authentication (default password stored with JOC Cockpit Settings)
                password="sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE"
                # for use of an empty password
                # password="plain:"

                permissions=[
                    UpdateItem
                ]
            }
        }
    }
}

Explanation:

• History
  • Settings in this section are used for the History Service of JOC Cockpit instances that access the given Controller.
  • distinguished-names
    • Specifies the distinguished name as given with the subject of the Client Authentication Certificate for incoming HTTPS connections of JOC Cockpit instances.
    • Any number of distinguished names can be specified allowing a number of incoming HTTPS connections from different JOC Cockpit instances.
    • Except for whitespace between attributes the precise sequence and values as available from the certificate's subject have to match this property value.
    • Note that the common name (CN) element in the distinguished name has to match the fully qualified domain name (FQDN) of a JOC Cockpit instance's host.

    • The following command can be used to read the distinguished name from a certificate file:

      
      

      Example for OpenSSL command to read a certificate's distinguished name

      # read distinguished name from the JOC Cockpit instance's certificate file (.crt)
      openssl x509 -in joc-primary.crt -noout -nameopt RFC2253 -subject
      
      # output is returned with a prefix "subject= " or similar that is not part of the distinguished name
      # subject= DNQ=SOS CA,CN=joc-2-0-primary,OU=IT,O=SOS,L=Berlin,ST=Berlin,C=DE

  • password
    • A default password is specified with the section joc of the JS7 - Settings page of JOC Cockpit and in the private.conf file. The password is used for authentication of the History service account with the Controller, for details see next chapter about password authentication.
    • The password setting cannot be omitted, however, an empty password can be specified like this:
      • password="plain:"
    • At the same time the password setting in JOC Cockpit has to be assigned an empty value.
• JOC
  • Settings in this section are used for services running in JOC Cockpit instances that access the given Controller.
  • distinguished-names:  The same applies as for the History setting described above.
  • permissions: JOC Cockpit requires the UpdateItem permission to enable users to deploy objects such as workflows.
  • password: The same applies as for the History setting described above.

Agent Connections

No settings are required when using mutual authentication with Agents.

Consider the below chapter HTTPS Keystore and Truststore Access for explanations:

• The Controller instance's keystore has to hold the Client Authentication private key and certificate.
• The Controller instance's truststore has to hold the Root CA Certificate used when signing the Agent's Server Authentication Certificate.

Password Authentication

JOC Cockpit Connections

js7 {
    auth {
        # User accounts for https connections
        users {
            # History account of JOC Cockpit (used to release events)
            History {
                # for use with password authentication (default password stored with JOC Cockpit Settings)
                password="sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08"
            }

            # JOC account of JOC Cockpit (requires UpdateItem permission for deployment)
            JOC {
                # for use with password authentication (default password stored with JOC Cockpit Settings)
                password="sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE"

                permissions=[
                    UpdateItem
                ]
            }
        }
    }
}

Explanation:

• History
  • Settings in this section are used for the History Service of JOC Cockpit instances that access the given Controller.
• JOC
  • Settings in this section are used for services running in JOC Cockpit instances that access the given Controller.
  • permissions: JOC Cockpit requires the UpdateItem permission to enable users to deploy objects such as workflows.
• The password is used for authentication of the History and JOC service accounts with the Controller. Both accounts are typically running in the same JOC Cockpit instance. 
  
  • If HTTP connections are used then the password is the only means for authentication.
  • The password is specified with the section joc of the JS7 - Settings page of JOC Cockpit and in the private.conf file.
    • User Input to the Settings page of JOC Cockpit can look like this:
      
      
      
      Input to the GUI simply accepts the password and does not require to use the prefixes sha512: or plain:.
    • In the private.conf file a hashed value or a plain text value can be specified like this:
      • password="sha512:B793649879D6..."
      • password="plain:JS7-History"
  • If the password is modified in the private.conf file then it also has to be modified in the JOC Cockpit settings too in order to make passwords match.
  • The password setting cannot be omitted, however, an empty password can be specified, for example with mutual authentication HTTPS connections, like this:
    • password="plain:"
  • From the private.conf file that ships by default the plain text value and the hashed values are:
    • History: 
      • Plain Text: JS7-History
      • Hash: sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08
    • JOC:
      • Plain Text: JS7-JOC
      • Hash: sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE
  • There are a number of ways to create sha512 hash values from passwords.
    • One possible solution includes using:
    • echo -n "JS7-JOC" | openssl dgst -sha512

Agent Connections

js7 {
    auth {
        # Controller ID for connections by primary/secondary Controller instance
        agents {
            agent-001="plain:secret-agent-001"
            agent-002="plain:secret-agent-002"
            agent-003="plain:secret-agent-003"
        }
    }
}

Explanation:

• The Agent ID for each Agent is specified from the examples agent-001, agent-002 etc. An Agent is assigned a unique Agent ID during initial operation with JOC Cockpit. The Agent ID cannot be changed unless an Agent's journal is dropped.
• A plain text password is specified that is preceded with plain:. Passwords should be quoted.

Controller Cluster Configuration

Client Authentication

Controller Connections

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-secondary, OU=IT, O=SOS, L=Berlin, ST=Berlin, C=DE"
                ]
            }
        }
    }
}

Explanation:

• Note that the Controller element name is an example that has to be replaced by the Controller ID which is specified with identical values during installation of both Controller instances in a cluster.
• The distinguished-names setting indicates the subject of the pairing Controller's Client Authentication certificate. The certificate and subject authenticate the pairing Controller without use of passwords.
  • Note that the private.conf file of a Primary Controller instance holds the distinguished name of the Secondary Controller instances' certificate and vice versa. 
  • Except for whitespace between attributes the precise sequence and values as available from the certificate's subject have to match this property value.
  • Note that the common name (CN) element in the distinguished name has to match the fully qualified domain name (FQDN) of a Controller instance's host.

  • The following command can be used to read the distinguished name from a certificate file:
    
    

    Example for OpenSSL command to read a certificate's distinguished name

    # read distinguished name from the pairing Controller instance's certificate file (.crt)
    openssl x509 -in controller-secondary.crt -noout -nameopt RFC2253 -subject
    
    # output is returned with a prefix "subject= " or similar that is not part of the distinguished name
    # subject= DNQ=SOS CA,CN=controller-2-0-secondary,OU=IT,O=SOS,L=Berlin,ST=Berlin,C=DE

JOC Cockpit Connections

The configuration is the same as for a Standalone Controller, see JOC Cockpit Connections

Password Authentication

Controller Connections

js7 {
    auth {
        # User accounts for https connections
        users {
            # Controller ID for connections by primary/secondary Controller instance
            Controller {
                password = "plain:secret"
            }
        }
    }
}

Explanation:

• Note that the Controller element name is an example that has to be replaced by the Controller ID which is specified with identical values during installation of both Controller instances in a cluster.
• If the password is modified in the private.conf file of a Primary Controller instance then it also has to be modified for the Secondary Controller instance to make passwords match.
• A plain-text password has to be specified that is preceded with plain:: Passwords should be quoted.

JOC Cockpit Connections

The configuration is the same as for a Standalone Controller, see JOC Cockpit Connections.

Keystore and Truststore

Settings in this section apply to both Standalone Controller and Controller Cluster instances.

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 keystore 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.
  • The keystore holds the Controller instance's private key and certificate. This information is used:
    • for Server Authentication with the JOC Cockpit and
    • for Client Authentication with Agents.
  • The truststore holds the certificate(s) used to verify:
    • Client Authentication certificates presented by the JOC Cockpit and
    • Server Authentication certificates presented by Agents.
  • A number of truststores can be specified
• Optionally a separate HTTPS client keystore can be used:
  • The client keystore is used for TLS mutual authentication and holds a private key and certificate created for Client Auth extended key usage. 
  • When using TLS mutual authentication then:
    • a single certificate can be used that is generated for both Server Auth and Client Auth extended key use. 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 with the HTTPS keystore and the certificate for Client Auth key use being stored with the HTTPS client keystore.
  • For details see  JS-1959 - Getting issue details... STATUS
• 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
  • for the truststore 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 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.
• The alias setting can be used for example with a keystore that holds a number of private keys from which the relevant private key is selected by its alias name.

Summary of Configuration Items

General Configuration File: controller.conf

js7.web.server: Authentication Settings

• This setting specifies public access to a Controller if insecure HTTP connections are to be used. If used with the value true then HTTP Server Authentication is not applied.
• Default: true

Security Configuration File: private.conf

js7.auth.users: HTTPS Authentication and Authorization

• An additional authentication mechanism is applied when using HTTPS Server Authentication certificates or public keys for incoming connections. See below: the client of the incoming connection, e.g. JOC Cockpit, is required to provide a Client Authentication certificate. This includes two certificates which are in place for a secure HTTPS connection: the given Controller's Server Authentication certificate and the JOC Cockpit's Client Authentication certificate. As an alternative to Client Authentication a password can be used.
  • The fact that a given certificate is to be used for Server Authentication and/or Client Authentication is specified with the key usage when the certificate is created and signed.
  • The distinguished name that is specified with the Controller's configuration has to match the Client Authentication Certificate's or Client public key's subject attribute. This attribute specifies the hostname and additional information that is created when the certificate or public key is generated.
• <controller-id>
  • This element holds the Controller ID that has been specified during installation of a Standalone Controller or Controller Cluster.
  • Settings in this section are used for connections from a pairing Controller instance.
  • distinguished-names
    • Specifies the distinguished name as given with the subject of the Client Authentication Certificate for incoming HTTPS connections of a pairing Controller instance.
    • One or two distinguished names can be specified allowing incoming HTTPS connections from a Standalone Controller or Controller Cluster.
• History
  • distinguished-names:  the same applies as for the <controller-id> setting described above. The JOC Cockpit Client Authentication certificate is used.
  • password: a symmetric password that is used for authentication of the History Service to the Controller for both HTTP and HTTPS connections, see below.
• JOC
  • distinguished-names:  the same applies as for the <controller-id> setting described above. The JOC Cockpit Client Authentication certificate is used.
  • password: a symmetric password is used for authentication of the History Service to the Controller for both HTTP and HTTPS connections, see below.
  • permissions: JOC Cockpit requires the UpdateItem permission to enable users to deploy objects such as workflows.
• The password is used for authentication of the History and JOC service accounts with the Controller. Both accounts are typically running in the same JOC Cockpit instance. 
  
  • If the password is modified in the private.conf file then it also has to be modified in the JOC Cockpit settings to make the passwords match.
  • The password setting cannot be omitted, however, an empty password can be specified, for example with mutual authentication HTTPS connections, like this:
    • password="plain:"
  • From the private.conf file that ships by default the plain text value and the hashed values are:
    • History: 
      • Plain Text: JS7-History
      • Hash: sha512:B793649879D61613FD3F711B68F7FF3DB19F2FE2D2C136E8523ABC87612219D5AECB4A09035AD88D544E227400A0A56F02BC990CF0D4CB348F8413DE00BCBF08
    • JOC:
      • Plain Text: JS7-JOC
      • Hash: sha512:3662FD6BF84C6B8385FC15F66A137AB75C755147A81CC7AE64092BFE8A18723A7C049D459AB35C059B78FD6028BB61DCFC55801AE3894D2B52401643F17A07FE

js7.auth.agents: HTTPS Authentication and Authorization

• By default both Server Authentication Certificates and Client Authentication Certificates are used for HTTPS connections. If no Client Authentication Certificates are to be used then the Controller has to use a password to authenticate with an Agent.
• For each Agent the <Agent ID> a plain-text password is required that can be specified using the prefix plain:. Passwords should be quoted The same password has to be specified with the Agents private.conf configuration file.

js7.web.https: HTTPS Certificates

• This setting is used to specify the location of a keystore and any truststores used for HTTPS connections.
• Keystore and truststore files are expected in PKCS12 format or in PEM format.
• keystore
  • The keystore includes the private key for the Controller's Server Authentication Certificate.
  • Private key types RSA and ECDSA are supported. 
  • file:  the path to the location of the keystore file is expected.
  • key-password: Any keys included with the keystore are protected with a password. The same password has to be used for all private keys in the given keystore.
  • store-password: The keystore file is protected by a password.
  • alias: can be used for example with a keystore that holds a number of private keys from which the relevant private key is selected by its alias name.
• client-keystore
  • Use of this setting is optional. It can be used if separate certificates for Server Authentication and Client Authentication are used.
  • The Client Authentication private key and certificate can be added to this keystore.
  • Included configuration items correspond to the keystore setting.
• truststores
  
  • A truststore contains the certificates or public keys to verify the Controller's incoming HTTPS connections.
    • Certificates are signed by a Certificate Authority (CA), alternatively a self-signed certificate can be used.
    • It is recommended that certificates are used instead of public keys.
    • Certificates of type X.509 are supported.
  • file:  the path to the location of the truststore file is expected.
  • store-password: A truststore file is protected by a password.
  • alias: can be used for example with a truststore that holds a number of certificates from which the relevant certificate is selected by its alias name.
  • A number of truststores can be specified by repeating the file, store-password and optionally alias settings.

js7.web.server: HTTPS Authentication

• This setting is used to specify the authentication type for HTTPS connections to a Controller.
• https-client-authentication
  
  • The value on (default) specifies that mutual authentication with certificates for Server Authentication and Client Authentication is used.
  • The value off specifies that HTTP Basic Authentication only is used.
• By default JS7 makes use of mutual authentication including both Server and Client Authentication Certificates. This setting can be switched off to use Server Authentication Certificates only.

js7.configuration: Trusted Signature Keys

• The Controller receives signatures for any deployed objects such as workflows. Such signatures are created with a private key and are verified by the Controller based on the available certificates. Agents perform similar signature verification and are configured accordingly.
• When deploying objects with JOC Cockpit:
  • for a low Security Level JOC Cockpit creates the signature from a single private key that is used for any JOC Cockpit user accounts allowed to deploy objects.
  • for a medium Security Level JOC Cockpit creates the signature from the private key of the JOC Cockpit user account that deploys objects.
  • for a high Security Level the user creates the signature outside of JOC Cockpit and uploads the signed objects.
• The Controller supports PGP public keys and X.509 certificates. This setting expects a directory that holds a number of public key files or certificate files.
• trusted-signature-keys
  • PGP: specifies the directory from which PGP public keys are used to verify the signatures of deployed objects.
  • X509: specifies the directory from which X.509 certificates are used to verify the signatures of deployed objects.

js7.journal: Journal Release Permissions

• The Controller writes a journal of events that, for example, result from order state transitions such as an order starting, failing, completing etc.
• The journal file will grow indefinitely if events are not released. Typically events are consumed by the JOC Cockpit and are added to the order and task history. Events are released from the Controller's journal once they have been stored persistently in the JOC Cockpit database. The Controller will then free the space consumed by its journal files.
• users-allowed-to-release-events:  specifies the list of accounts that are allowed to send a command to the Controller to release events.
  • Typically the "History" account is specified, this account is used by JOC Cockpit.
  • If more than one account is specified then events are released only after all accounts have sent the command to release events to the Controller.