Certificate Management

Private keys and public certificates should be distributed as follows:

...

The keystore and truststore shown in orange 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. If the certificate is self-signed then it has to be added to the Controller's truststore as well.
- 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.
The keystore and truststore shown in green are required if mutual authentication is in place for certificate based client authentication Client Authentication (default).

Secure Connection Setup

...

On the Agent server create the keystore using the keytool from your Java JRE or JKDJDK. 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:
- the Agent private key and certificate for Server Authentication
- the Root CA certificate
- Intermediate CA certificatescertificate(s)

For use with keytool create the keystore with the private key and certificate for Server Authentication from the command line. The The examples below show one possible approach for certificate management. However, there may be are other ways to achieve similar results.

Example for the 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 -srcstoretype JKS -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias agent-https

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

# concatenate the CA root certificate and the 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 the 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 server is 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's private key is "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 the use of a 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 "agent-https" and certificate 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

Example for the use of a 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 -storetype JKS

Explanation:
- The -dname option option specifies the certificate issuer, therefore use your own set of CN, O, OU, DC that specify the issuer's distinguished nameDistinguished 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 that you 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 set up specify the relevant 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

...

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

The JS7_AGENT_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 of a Controller ID that is specified during Controller installation.
The distinguished-names property allows the addition of a number of distinguished names as available from the subject of Client Authentication certificates that are used by Controller instances when connecting to the Agent.
- Except for whitespace between attributes the precise sequence and values as available from the certificate's subject has to match this property value.

...

On the Controller server create the truststore using the keytool from your Java JRE or JDK or a third party utility.

For use with a third party utility create a truststore, e.g. https-truststore.p12, in PKCS12 format and import:
- the Root CA certificate

For use with keytool create the truststore in PKCS12 or JKS format with the Root CA certificate. The The examples below show one possible approach for certificate management. However, there may be are other ways to achieve similar results.

Example for importing 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" -storetype PKCS12

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

Code Block

language	bash
title	Example for import of a self-signed Agent certificate to Controller 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 Agent certificate with a JKS truststore:

Code Block

language	bash
title	Example for import of a self-signed Agent certificate to Controller 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 -storetype JKS -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.

...

On the Agent server create the truststore using the keytool from your Java JRE or JDK or a third party utility.

For use with a third party utility create a truststore, e.g. https-truststore.p12, in PKCS12 format and import:
- the Root CA certificate

For use with keytool create the truststore in PKCS12 or JKS format with the Root CA certificate. The examples below The examples below show one possible approach for certificate management. However, there may be are other ways to achieve similar results.

Example for importing 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 the 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 exporting/importing a self-signed client authentication 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 the Controller server: export the Controller's certificate from the 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 the Agent server: import the 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 exporting/importing a self-signed client authentication 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 -storetype JKS

# 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

...

Space shortcuts

Page tree

Versions Compared

Old Version 16

New Version 17

Key

Certificate Management

Secure Connection Setup

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 16

New Version 17

Key

Certificate Management

Secure Connection Setup