Page History

...

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

For use with keytool create the keystore with the private key and certificate for Server Authentication from the command line. 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 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 from a pkcs12 keystore (keystore.p12), store the Agent's 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'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 being 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 being "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 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 use of 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 specifies the certificate issuer, therefore use your own set of CN, O, OU, DC that specify the issuer's distinguished 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 to 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 being set up specify respective 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

...

Space shortcuts

Page tree

Versions Compared

Old Version 7

New Version 8

Key