Table of Contents

Introduction

Users benefit from the certificate authority The JS7 - Certificate Authority included with the JOC Cockpit benefits users by allowing them to create and to roll-out rollout private keys and certificates.
- This includes simplified roll-out rollout to the Controller and Agent instances to establish secure HTTPS connectionsfor establishing JS7 - Secure Connections.
- The buildbuilt-in certificate authority Certificate Authority is applicable when operating JOC Cockpit in a low or medium security level, see Security Level Low or Medium, see the JS7 - Security Architecture. and JS7 - Secure Operation articles for more information.
The built-in Certificate Authority:The built-in certificate authority
- creates X.509 certificates for HTTPS Mutual Authentication
  - between JOC Cockpit and Controller instances,
  - between Primary and Secondary Controller instances,
  - between Controller instances and Agents.
- is not used to create server authentication certificates Server Authentication Certificates for access to JOC Cockpit. Access is performed by user browsers , and therefore it is preferable to use a server authentication certificate that is Server Authentication Certificate which has been signed by a known certificate authority for which user browsers include the root certificateCertificate Authority and whose Root CA certificate is recognized by user's browsers.
Users benefit from the simplified rollout of private keys and certificates when using the built-in certificate authorityin Certificate Authority.

JS7 provides a Command Line Client available with Controller and Agents instances to create and to roll-Certificate Rollout Client as part of the Controller and Agent instance's Start Scripts. This client creates and rolls out private keys and certificates using the built-in certificate authorityCertificate Authority. Rollout of private keys and certificates created with an external certificate authority Certificate Authority are not in scope of the Command Line Certificate Rollout Client. The functionality includesCertificate Rollout Client provides the following functions:

use of a security token to authenticate with the JOC Cockpit by use of a security token, see JS7 - Certificate Authority - Manage Certificates with JOC Cockpit, for more information.
requesting to request a private key and certificate to be created by the JOC Cockpit on-the-fly,
to update updating a Controller or Agent instance's configuration for use of the private key and certificate with HTTPS mutual authentication.

Prerequisites

The following conditions have to be met before the Command Line Client can be used to roll-out private keys and certificates.

The JOC Cockpit certificate authority has to be available and the root private key and certificate have been created.
Valid security tokens have been generated with JOC Cockpit for the desired Controller and Agent instances.
For details see JS7 - Certificate Authority - Manage Certificates with JOC Cockpit

configuration for use of the private key and certificate with HTTPS mutual authentication.

Certificate Certificate Rollout

Rollout of certificates includes to perform performing the following steps:

JOC Cockpit
- The JOC Cockpit certificate authority has to be available Cockpit Certificate Authority is set up and the Root CA private key and certificate have been createdare made available.
- Valid security tokens have been are generated with the JOC Cockpit for the Controller and Agent instances that require a certificate.
- For details see JS7 - Certificate Authority - Manage Certificates with JOC Cockpit
Controller/Agent Instance
- Both components include the Certificate Rollout Client that which is available from the Controller/Agent Instance Start Script.
- The Certificate Rollout Client connects to the JOC Cockpit. Authentication is performed by use of using the one-time security token generated with in the previous step.
- The JOC Cockpit certificate authority Certificate Authority is requested to create a private key and server/client certificate Server/Client Authentication Certificate for the specified host. Private The private key and certificate are created on-the-fly and are returned to the Certificate Rollout Client. In addition, the JOC Cockpit stores the certificate with its database. in the JS7 - Database.
  The Certificate Rollout Client:
  - stores the private key in a keystore file,
  - stores the server/client certificate Server/Client Authentication Certificate in a truststore file,
  - updates the configuration in the ./config/private/private.conf file.

...

The Controller/Agent Instance Start Script for Unix and Windows includes the Certificate Rollout Client and is available from the following locations:

for a Controller instance: ./bin/controller_instance.sh|cmd
- For details see see the JS7 - Controller - Command Line Operation article.
for an Agent instance: ./bin/agent_<port>.sh|cmd
- For details see see the JS7 - Agent Command Line Operation article.

Standard Arguments

The following arguments are used independently from an HTTP or HTTPS of whether the connection to JOC Cockpitthe JOC Cockpit is made with HTTP or HTTPS:

Expand

title	List of Standard Arguments

Argument	Required	Description	Example
`--joc-uri`	Yes	URI of the JOC Cockpit instance from which to receive the private key and certificate.	`--joc-uri=http://myhost.example.com:4446`
`--token`	Yes	UUID of the security token for one-time authentication with the JOC Cockpit.	`--token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b`
`--dn-only`	No	Flag to receive relevant Distinguished Names (DN) to update the `private.conf` file, without generating certificates.	`--dn-only`
`--subject-dn`	Yes	The subject of the requested certificate includes the Distinguished Name (DN) consisting of CN, OU, O, L, S, C attributes. The hostname of the requesting client is specified as CN.	`--subject-dn="CN=myhost, OU=IT Operations, O=SOS, L=Berlin, S=Berlin, C=DE"`
`--san`	Yes	The Subject Alternative Name (SAN) specifies the hostname of the requesting client and optionally variations of the hostname, e.g. the domain part (FQDN). Alternative hostnames are separated by comma.	`--san="myhost, myhost.example.com"`
`--key-alias`	Yes	Alias name used when storing the requested private key and certificate to in the target keystore.	`--key-alias="MyKeyAlias"`
`--ca-alias`	Yes	Alias name used when storing the requested CA certificate in both , the target keystore and truststore.	`--ca-alias="MyTrustedCertificateAlias"`

`--target-keystore`	Yes	Path to the keystore to in which the requested private key and certificate should be stored.	`--target-keystore=/var/sos-berlin.com/js7/controller/var/config/private/https-keystore.p12`
`--target-keystore-type`	No	Type of the keystore used. Supported values include: `PKCS12` (default), `JKS` (deprecated).	`--target-keystore-type=PKCS12`
`--target-keystore-pass`	No	Password for access to the keystore.	`--target-keystore-pass="YourKeystorePassword"`
`--target-keystore-entry-pass`	No	Password for the requested private key that should be added to the keystore.	`--target-keystore-entry-pass="YourKeystoreEntryPassword"`

`--target-truststore`	Yes	Path to the truststore to which the trusted CA certificate should be stored.	`--target-truststore=/var/sos-berlin.com/js7/controller/var/config/private/https-truststore.p12`
`--target-truststore-type`	No	Type of the truststore used. Supported values include: `PKCS12` (default), `JKS` (deprecated).	`--target-truststore-type=PKCS12`
`--target-truststore-pass`	No	Password for access to the truststore.	`--target-truststore-pass="YourTruststorePassword"`
`--help`	No	Displays usage information, this option has to be specified as the only command line option and has no value.

Explanation:

Arguments qualified as required have to be used with any request made to the JOC Cockpit to create a private key and certificate.
The --joc-uri argument specifies the URL for JOC Cockpit. When used with the HTTPS protocol then check the next section for additional arguments.
The --target-keystore is located in the Controller or Agent instance's ./config/private directory.
The --dn-only argument if present adds related DNs to the private.conf file in the Controller or Agent instances' ./config/private directory. No certificates/keys are generated.

...

The following arguments are used in addition to standard arguments in case that if the JOC Cockpit is has been set up for HTTPS connections:

Expand

title	List of Arguments for use with JOC Cockpit HTTPS Connections

Argument	Required	Description	Example
`--source-truststore`	No	Path to the truststore holding the trusted certificate(s) to connect to JOC Cockpit by HTTPS.	`--source-truststore=/home/sos/public/js7-truststore.p12`
`--source-truststore-type`	No	Type of the truststore used. Supported values include: `PKCS12` (default), `JKS` (deprecated).	`--source-truststore-type=PKCS12`
`--source-truststore-pass`	No	Password for access to the truststore.	`--source-truststore-pass="YourTruststorePassword"`
`--source-certificate`	No	Path to a certificate file holding the JOC Cockpit server authentication certificate.	`--source-certificate=/home/sos/public/js7-joc-cockpit.crt`
`--source-ca-cert`	No	Path to the CA certificate file(s) that are used to verify the JOC Cockpit server authentication certificate. A number of paths can be specified, separated by comma.	`--source-ca-cert="/home/sos/public/intermediate_ca.crt, /home/sos/public/root_ca.crt"`

Explanation:

An HTTPS connection to JOC Cockpit requires to verify verification of the JOC Cockpit server authentication certificateServer Authentication Certificate.
The --source-truststore-* arguments are used to specify a truststore that holds the root Root CA certificate Certificate and optionally any intermediate Intermediate CA certificates Certificates involved in signing the JOC Cockpit server authentication certificateServer Authentication Certificate.
The --source-certificate and --source-ca-cert arguments are used as an alternative to --source-truststore-* arguments in case that JOC Cockpit server authentication certificates Server Authentication Certificates are available from individual files instead of being available from a common truststore. Supported certificate formats include PEM.

...

The following arguments are used in addition to HTTPS connection arguments in case that if the JOC Cockpit is setup for set up for JOC Cockpit - HTTPS Mutual Authentication.

Expand

title	List of Arguments for use with JOC Cockpit HTTPS Connections using Mutual Authentication

Argument	Required	Description	Example
`--source-keystore`	No	Path of the keystore holding the client's private key and certificate for client authentication.	`--source-keystore=/home/sos/private/js7-keystore.p12`
`--source-keystore-type`	No	Type of keystore used. Supported values include: `PKCS12` (default), `JKS` (deprecated).	`--source-keystore-type=PKCS12`
`--source-keystore-pass`	No	Password for access to the keystore holding the private key for client authentication.	`--source-keystore-pass="YourKeystorePassword"`
`--source-keystore-entry-pass`	No	Password for the private key entry in the keystore.	`--source-keystore-entry-pass="YourKeystoreEntryPassword"`
`--source-private-key`	No	Path to the private key file holding the client authentication private key.	`--source-private-key=/home/sos/private/client.key`

Explanation:

An HTTPS connection to JOC Cockpit with mutual authentication requires:
- to verify verification of the JOC Cockpit server authentication certificate Server Authentication Certificate by the requesting client and
- to verify the client authentication certificate verification of the Client Authentication Certificate of the requesting client by the JOC Cockpit.
The --source-keystore-* arguments are used to specify a keystore that holds the client's private key and certificate for client authentication.
The --source-private-key argument is used as an alternative to --source-keystore-* arguments in case that if the private key is available from an individual file instead of a keystore.

Examples

Standard Examples

Example for use with the Controller/Agent Instance Start Script and default values

Code Block

language	bash
title	with instance startscript and default values

# use with a Controller instance
./bin/controller_instance.sh cert --token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b --joc-uri=https://myhost.example.com:4446

# use with an Agent instance
./bin/agent_<port>.sh cert --token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b --joc-uri=https://myhost.example.com:4446

...

the cert argument for the Instance Start Script is used to build the Java classpath and to start the Java executable.
The --token argument specifies the one-time token to connect to JOC Cockpit.
The --joc-uri argument specifies the URL for JOC Cockpit.
If no additional arguments are used then the Command Line Client determines default values for the Keystore and Truststore from the instances' ./config/private/private.conf configuration file, including defaults for the DN and for the SAN of the certificate.

Example for use with the Controller/Agent Instance Start Script to update relevant DN entries

Code Block

language	bash
title	with instance startscript and default values

# use with a Controller instance
./bin/controller_instance.sh cert --dn-only --token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b --joc-uri=https://myhost.example.com:4446

# use with an Agent instance
./bin/agent_<port>.sh cert --dn-only --token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b --joc-uri=https://myhost.example.com:4446

...

With the --dn-only argument only relevant Distinguished Names (DNs) will be updated to the ./config/private/private.conf configuration file.

Advanced Examples

Example for use with an HTTP Connection to JOC Cockpit

Code Block

language	bash
title	HTTP Connection to JOC Cockpit
collapse	true

./bin/controller_instance.sh cert \
    --token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b \
    --joc-uri=http://somehost.example.com:4446 \
    --san="myhost.example.com, myhost" \
    --subject-dn="CN=myhost, OU=IT Operations, O=SOS, C=DE, L=Berlin, ST=Berlin" \
    --key-alias=myhost \
    --ca-alias="Root CA" \
    --target-keystore=/var/sos-berlin.com/js7/controller/var/config/private/https-keystore.p12 \
    --target-keystore-pass=jobscheduler \
    --target-keystore-entry-pass=jobscheduler \
    --target-truststore=/var/sos-berlin.com/js7/controller/var/config/private/https-truststore.p12 \
    --target-truststore-pass=jobscheduler

Explanation:

...

Example for use with an HTTPS Connection to JOC Cockpit and Mutual Authentication from a Client

...

Keystore

Code Block

language	bash
title	HTTPS Connection to JOC Cockpit with Mutual Authentication from a Client Truststore
collapse	true

./bin/controller_instance.sh cert \
     --token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b \
     --joc-uri=https://somehost.example.com:4446 \
     --san="myhost.example.com, myhost" \
     --subject-dn="CN=myhost, OU=IT Operations, O=SOS, C=DE, L=Berlin, ST=Berlin" \
     --key-alias=myhost \
     --ca-alias="Root CA" \
     --source-keystore=/home/sos/private/js7-keystore.p12 \
     --source-keystore-pass="" \
     --source-keystore-entry-pass="" \
     --source-truststore=/home/sos/private/js7-truststore.p12 \
     --source-truststore-pass="" \
     --target-keystore=/var/sos-berlin.com/js7/controller/var/config/private/https-keystore.p12 \
     --target-keystore-pass=jobscheduler \
     --target-keystore-entry-pass=jobscheduler \
     --target-truststore=/var/sos-berlin.com/js7/controller/var/config/private/https-truststore.p12 \
     --target-truststore-pass=jobscheduler

Explanation:

...

Example for use with an HTTPS Connection to JOC Cockpit and Mutual Authentication from a Client Key File

Code Block

language	bash
title	HTTPS Connection to JOC Cockpit with Mutual Authentication from a Client Key File
collapse	true

./bin/controller_instance.sh cert \
     --token=73bfc4b8-3f15-44b9-a75b-cdb44aec8f4b \
     --joc-uri=https://myhost.example.com:4446 \
     --san="myhost.example.com, myhost" \
     --subject-dn="CN=myhost, OU=IT Operations, O=SOS, C=DE, L=Berlin, ST=Berlin" \
     --key-alias=myhost \
     --ca-alias="Root CA" \
     --source-private-key=/home/sos/private/myhost.key \
     --source-certificate=/home/sos/public/myhost.pem \
     --source-ca-cert="/home/sos/public/intermediate_ca.pem, /home/sos/public/root_ca.pem" \
     --target-keystore=var/sos-berlin.com/js7/controller/var/config/private/https-keystore.p12 \
     --target-keystore-pass=jobscheduler \
     --target-keystore-entry-pass=jobscheduler \
     --target-truststore=var/sos-berlin.com/js7/controller/var/config/private/https-truststore.p12 \
     --target-truststore-pass=jobscheduler

Explanation:

...

Space shortcuts

Page tree

Versions Compared

Old Version 29

New Version Current

Key

Introduction

Prerequisites

Certificate Certificate Rollout

Standard Arguments

Examples

Standard Examples

Example for use with the Controller/Agent Instance Start Script and default values

Example for use with the Controller/Agent Instance Start Script to update relevant DN entries

Advanced Examples

Example for use with an HTTP Connection to JOC Cockpit

Example for use with an HTTPS Connection to JOC Cockpit and Mutual Authentication from a Client

Keystore

Example for use with an HTTPS Connection to JOC Cockpit and Mutual Authentication from a Client Key File

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 29

New Version Current

Key

Introduction

Prerequisites

Certificate Certificate Rollout

Standard Arguments

Examples

Standard Examples

Example for use with the Controller/Agent Instance Start Script and default values

Example for use with the Controller/Agent Instance Start Script to update relevant DN entries

Advanced Examples

Example for use with an HTTP Connection to JOC Cockpit

Example for use with an HTTPS Connection to JOC Cockpit and Mutual Authentication from a Client

Keystore

Example for use with an HTTPS Connection to JOC Cockpit and Mutual Authentication from a Client Key File