Page History
...
To secure access to JOC Cockpit by clients (user browsers or REST API clients) the following keys and certificates should be in place:
Flowchart |
---|
Client [label=" Client \nUser Client \n User Browser / REST API Client Client ",fillcolor="lightskyblue"] JOC [label=" JOC Cockpit ",fillcolor="lightskyblue"] Client_TruststoreKeystore [label="Client TruststoreKeystore\ntruststorenkeystore location is product dependent\n\nCA Certificates",\nClient Private Key / Certificate",fillcolor="limegreen"] Client_Truststore [label="Client Truststore\ntruststore location is product dependent\n\nCA Certificates",fillcolor="orange"] JOC_Keystore [label="JOC Cockpit Keystore\n./jetty_basenJETTY_BASE/resources/joc/https-keystore.p12\n\nCA Certificates\nJOC Cockpit Private Key / Certificate",fillcolor="orange"] ClientJOC_Truststore_CA_RootCertificate [shape="ellipse",shape="ellipse", [label="CA Root CertificateJOC Cockpit Truststore\nJETTY_BASE/resources/joc/https-truststore.p12\n\nCA Certificates",fillcolor="whitelimegreen"] JOCClient_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate",fillcolor="white"] JOCClient_Keystore_CA_IntermediateCertificate [shape="ellipse",label="CA Intermediate Certificate",fillcolor="white"] JOCClient_PrivateKey [shape="ellipse",label="JOCClient CockpitAuthentication Private Key",fillcolor="white"] JOCClient_Certificate [shape="ellipse",label="JOCClient CockpitAuthentication Certificate",fillcolor="white"] Client -> JOC [label=" establish JOC Cockpit connection "] Client -> Client_Truststore [label=" use certificate store "] Client_Truststore -> Client_Truststore_Truststore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate",fillcolor="white"] JOC_Truststore_CA_RootCertificate [shape="ellipse",shape="ellipse",label="CA Root Certificate",fillcolor="white"] JOC_Keystore_CA_RootCertificate [shape="ellipse",shape="ellipse",label=" add to truststore, e.g. by Group Policies CA Root Certificate",fillcolor="white"] JOC -> JOC_Keystore JOC_Keystore -> JOC_Keystore_CA_RootCertificate -> JOC_Keystore_CA_IntermediateCertificate [shape="ellipse",label=" addCA to keystore Intermediate Certificate",fillcolor="white"] JOC_Keystore -> JOC_PrivateKey -> PrivateKey [shape="ellipse",label="Server Authentication Private Key",fillcolor="white"] JOC_Certificate [shape="ellipse",label="Server Authentication Certificate",fillcolor="white"] Client -> JOC [label=" addestablish to keystoreconnection "] |
Secure Connection Setup
This configuration is applied in order to enable clients (user browser, REST API client) to access the JOC Cockpit by use of HTTPS.
In the following the placeholders JOC_HOME
, JETTY_HOME
and JETTY_BASE
are used which locate three directories. If you install Jetty with the JOC installer then
JOC_HOME
is the installation path which is specified during the JOC Cockpit installation:/opt/sos-berlin.com/js7/joc
(default on Linux)C:\Program Files\sos-berlin.com\js7\joc
(default on Windows)
JETTY_HOME
=JOC_HOME
/jetty
JETTY_BASE
is Jetty's base directory which is specified during the JOC Cockpit installation:/home/<setup-user>/sos-berlin.com/js7/joc
(default on Linux)C:\ProgramData\sos-berlin.com\js7\joc
(default on Windows)
Step 1: Add the HTTPS module to Jetty
...
On the JOC Cockpit server run the following command and replace the JETTY_HOME
and JETTY_BASE
placeholders as specified above:
Code Block | ||||
---|---|---|---|---|
| ||||
java -jar "JETTY_HOME/start.jar" -Djetty.home="JETTY_HOME" -Djetty.base="JETTY_BASE" --add-to-start=https |
...
Client -> Client_Truststore
Client_Truststore -> Client_Truststore_CA_RootCertificate [label=" add to truststore, e.g. by Group Policies "]
Client -> Client_Keystore
Client_Keystore -> Client_Keystore_CA_RootCertificate -> Client_Keystore_CA_IntermediateCertificate [label=" add to keystore "]
Client_Keystore -> Client_PrivateKey -> Client_Certificate [label=" add to keystore "]
JOC -> JOC_Keystore
JOC_Keystore -> JOC_Keystore_CA_RootCertificate -> JOC_Keystore_CA_IntermediateCertificate [label=" add to keystore "]
JOC_Keystore -> JOC_PrivateKey -> JOC_Certificate [label=" add to keystore "]
JOC -> JOC_Truststore
JOC_Truststore -> JOC_Truststore_CA_RootCertificate [label=" add to truststore "]
|
Explanation:
- Keystore and truststore in orange color are required for any connections of clients to JOC Cockpit.
- Keystore and truststore in green color are required only if mutual authentication is in place, e.g. to allow certificate based authentication.
- A JOC Cockpit truststore in green color is required should secure LDAP connections be used for authentication/authorization.
- It is therefore recommended to set up the JOC Cockpit truststore.
Secure Connection Setup
In the following the placeholders JOC_HOME
, JETTY_HOME
and JETTY_BASE
are used which locate three directories. If you install Jetty with the JOC Cockpit installer then
JOC_HOME
is the installation path that is specified during JOC Cockpit installation:/opt/sos-berlin.com/js7/joc
(default on Linux)C:\Program Files\sos-berlin.com\js7\joc
(default on Windows)
JETTY_HOME
=JOC_HOME
/jetty
JETTY_BASE
is Jetty's base directory that is specified during JOC Cockpit installation:/home/<setup-user>/sos-berlin.com/js7/joc
(default on Linux)C:\ProgramData\sos-berlin.com\js7\joc
(default on Windows)
Secure Connections for Clients to JOC Cockpit
This configuration is applied in order to enable clients (user browser, REST API client) to access the JOC Cockpit by use of HTTPS.
Step 1: Add the HTTPS module to Jetty
On the JOC Cockpit server run the following command and replace the
JETTY_HOME
andJETTY_BASE
placeholders as specified above:Code Block language bash title Add HTTPS module to Jetty java -jar "JETTY_HOME/start.jar" -Djetty.home="JETTY_HOME" -Djetty.base="JETTY_BASE" --add-to-start=https
- Having executed the above command you should find a new folder
JETTY_BASE/etc
Jetty expects a Keystore in this folder with the name "keystore" by default.
Warning Jetty doesn't start if it doesn't find a keystore corresponding its settings.
- In addition a number of entries in the
JETTY_BASE/start.ini
configuration file for TLS/SSL settings such as the HTTPS port are added.
Step 2: Create the Keystore for Jetty
- On the JOC Cockpit server create the keystore using the
keytool
from your Java JRE or JDK or some third party utility.- For use with a third party utility create a keystore, e.g.
https-keystore.p12,
in PKCS12 format and import:- JOC Cockpit private key and certificate for Server Authentication
- Root CA certificate
- Intermediate CA certificates
- For use with
keytool
generate the keystore in JKS or PKCS12 format with the private key and certificate for JOC Cockpit Server Authentication. The below examples suggest one possible approach for certificate management, however, there may be other ways how to achieve similar results.Example for import of CA signed certificate to a PKCS12 keystore:
Code Block language bash title Example how to add a CA signed certificate to a PKCS12 Keystore # should the JOC Cockpit'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 JOC Cockpit private key being "joc-https" # keytool -importkeystore -srckeystore keypair.jks -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc-https # assuming your JOC Cockpit private key from a pkcs12 keystore (keystore.p12), store the JOC Cockpit private key to a .key file in PEM format (joc-https.key) openssl pkcs12 -in keystore.p12 -nocerts -out joc-https.key # concatenate CA Root certificate and CA Intermediate certificates to a single CA Bundle certificate file (ca-bundle.crt) cat RootCACertificate.crt > ca-bundle.crt cat CACertificate.crt >> ca-bundle.crt # Export JOC Cockpit private key (joc-https.key), JOC Cockpit certificate (joc-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 JOC Cockpit server being "joc.example.com" openssl pkcs12 -export -in joc-https.crt -inkey joc-https.key -chain -CAfile ca-bundle.crt -name joc.example.com -out "JETTY_BASE/resources/joc/https-keystore.p12" # should you require use of a .jks keystore type then convert the pkcs12 keystore assuming the alias name of the JOC Cockpit private key being "joc-https" # keytool -importkeystore -srckeystore https-keystore.p12 -srcstoretype PKCS12 -destkeystore https-keystore.jks -deststoretype JKS -srcalias joc-https
Example for use of self-signed certificate with a PKCS12 keystore
Code Block language bash title Example how to generate a self-signed certificate for import into a PKCS12 Keystore # generate JOC Cockpit private key with alias name "joc-https" in a keystore (https-keystore.p12) # use the fully qualified hostname (FQDN) and name of your organization for the distinguished name # consider that PKCS12 keystores require to use the same key password and store password keytool -genkey -alias "joc-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.p12" -storepass jobscheduler -storetype PKCS12
Example for use of self-signed certificate with a JKS
- For use with a third party utility create a keystore, e.g.
...
Warning |
---|
Jetty doesn't start if it doesn't find a keystore corresponding its settings. |
...
Step 2: Create the Keystore and Truststore for Jetty
- On the JOC Cockpit server create the Java Keystore using the Keytool from your Java JRE or JDK or some third party utility.
- For use with a third party tool
- create a Keystore, e.g.
https-keystore.p12,
in PKCS12 format and import:- JOC Cockpit private key and certificate
- Root CA certificate
- Intermediate CA certificates
- create a Truststore, e.g.
https-truststore.p12,
in PKCS12 format and import:- Root CA certificate
- create a Keystore, e.g.
- For use with Keytool generate the Java Keystore in JKS or PKCS12 format with the private key and public certificate for Jetty. The below examples suggest one possible approach for certificate management, however, there may be other ways how to achieve similar results.
Example for import of CA signed certificate to a PKCS12 keystore:
Code Block language bash title Example how to add a CA signed certificate to a PKCS12 Keystore # should the JOC Cockpit'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 JOC Cockpit private key being "joc-https" # keytool -importkeystore -srckeystore keypair.jks -destkeystore keystore.p12 -deststoretype PKCS12 -srcalias joc-https # assuming your JOC Cockpit private key from a pkcs12 keystore (keystore.p12), store the JOC Cockpit private key to a .key file in PEM format (joc-https.key) openssl pkcs12 -in keystore.p12 -nocerts -out joc-https.key # concatenate CA Root certificate and CA Intermediate certificates to a single CA Bundle certificate file (ca-bundle.crt) cat RootCACertificate.crt > ca-bundle.crt cat CACertificate.crt >> ca-bundle.crt # Export JOC Cockpit private key (joc-https.key), JOC Cockpit certificate (joc-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 JOC Cockpit server being "joc.example.com" openssl pkcs12 -export -in joc-https.crt -inkey joc-https.key -chain -CAfile ca-bundle.crt -name joc.example.com -out "JETTY_BASE/resources/joc/https-keystore.p12" # should you require use of a .jks keystore type then convert the pkcs12 keystore assuming the alias name of the JOC Cockpit private key being "joc-https" # keytool -importkeystore -srckeystore https-keystore.p12 -srcstoretype PKCS12 -destkeystore https-keystore.jks -deststoretype JKS -srcalias joc-https
Example for use of self-signed certificate with a PKCS12 keystore
Code Block language bash title Example how to generate a self-signed certificate for import into a PKCS12 JKS Keystore # generate JOC Cockpit private key with alias name "joc-https" in a keystore (https-keystore.p12jks) # use the fully qualified hostname (FQDN) and name of your organization for the distinguished name #keytool -genkey consider that PKCS12 keystores require to use the same key password and store password keytool -genkey -alias "joc-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.p12" -storepass jobscheduler -storetype PKCS12
Example for use of self-signed certificate with a JKS keystore
Code Block language bash title Example how to generate a self-signed certificate for import into a JKS Keystore # generate JOC Cockpit private key with alias name "joc-https" in a keystore (https-keystore.jks) # use the fully qualified hostname (FQDN) and name of your organization for the distinguished name keytool -genkey -alias "joc-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.jks" -storepass jobscheduler -storetype JKS
Example for import of a Root CA certificate to a PKCS12 truststoreExplanation:
- Replace the
JETTY_BASE
placeholder as specified above. - The
-dname
option specifies the certificate issuer, therefore use your own set of CN, 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 your Keystore file. - The
-storepass
option specifies the password for access to your Keystore file. - The
-storepass
option is used for the PKCS12 keystore format, this option is not required for the JKS keystore format.
- Replace the
Code Block language bash title Example how to generate a self-signed certificate for import into a PKCS12 Keystore # import Root CA certificate in PEM format to a a PKCS12 truststore (https-truststore.p12) keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12"
- For use with a third party tool
- Alternatively apply a private key and certificate that are issued by your certificate authority or a trusted authority.
Step 3: Configure Jetty
-alias "joc-https" -dname "CN=hostname,O=organization" -validity 1461 -keyalg RSA -keysize 2048 -keypass jobscheduler -keystore "JETTY_BASE/resources/joc/https-keystore.jks" -storepass jobscheduler -storetype JKS
Explanation:
- Replace the
JETTY_BASE
placeholder as specified above. - The
-dname
option specifies the certificate issuer, therefore use your own set of CN, 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 your Keystore file. - The
-storepass
option specifies the password for access to your Keystore file. - The
-storepass
option is used for the PKCS12 keystore format, this option is not required for the JKS keystore format.
- Replace the
- Alternatively apply a private key and certificate that are issued by your certificate authority or a trusted authority.
Anchor | ||||
---|---|---|---|---|
|
See below chapter Step 2: Configure Jetty for configuration of the truststore with JETTY_BASE/start.ini
.
Edit the following entries in the
JETTY_BASE/start.ini
configuration file use of the keystore:Code Block ## Keystore file path (relative to $jetty.base) jetty.sslContext.keyStorePath=resources/joc/https.keystore.p12 ## Keystore password jetty.sslContext.keyStorePassword=jobscheduler ## KeyManager password (same as keystore password for pkcs12 keystore type) jetty.sslContext.keyManagerPassword=jobscheduler
Explanation:- Specify the location of the keystore with the
keyStorePath
setting. A location relative to theJETTY_BASE
directory can be specified. - Specify the password for your keystore with the
keyStorePassword
setting. - The password specified with the
keyManagerPassword
setting is used for access to your private key. The same password as for thekeyStorePassword
setting has to be used for a PKCS12 keystore type.
- Specify the location of the keystore with the
Specify the HTTPS port with the following entry of the
JETTY_BASE/start.ini
configuration file (default HTTPS port is 48446):Code Block ## Connector port to listen on jetty.ssl.port=48446
Step 4: Deactivate HTTP Access
To deactivate HTTP access add a comment to the following module directive in your JETTY_BASE/start.ini
configuration file like this:
Code Block |
---|
# Module: http
# --module=http |
Mutual Authentication for Clients to JOC Cockpit
This configuration is applied in order to enable mutual authentication:
- the client verifies the JOC Cockpit certificate for Server Authentication
- JOC Cockpit verifies the client certificate for Client Authentication
Step 1: Add the Truststore to Jetty
- On the JOC Cockpit server create the truststore using the
keytool
from your Java JRE or JDK or some third party utility.- For use with a third party utility create a truststore, e.g.
https-truststore.p12,
in PKCS12 format and import:- Root CA certificate
- For use with
keytool
create the truststore in JKS or PKCS12 format with the Root CA certificate. The below examples suggest one possible approach for certificate management, however, there may be other ways how to achieve similar results.Example for import 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 # import Root CA certificate in PEM format to a a PKCS12 truststore (https-truststore.p12) keytool -import -alias "root-ca" -file "RootCACertificate.crt" -keystore "JETTY_BASE/resources/joc/https-truststore.p12"
- For use with a third party utility create a truststore, e.g.
Anchor client_authentication_configure_jetty client_authentication_configure_jetty
Step 2: Configure Jetty
client_authentication_configure_jetty | |
client_authentication_configure_jetty |
See above chapter Step 3: Configure Jetty for configuration of the keystore with JETTY_BASE/start.ini
.
Edit the following entries in the
JETTY_BASE/start.ini
configuration file use of the keystore:Code Block ## Truststore file path (relative to $jetty.base) jetty.sslContext.trustStorePath=resources/joc/https-truststore.p12
Edit the following entries in the
JETTY_BASE/start.ini
configuration file corresponding to the Java Keystore:Code Block ## Keystore file path (relative to $jetty.base) jetty.sslContext.keyStorePath=resources/joc/https.keystore.p12 ## Truststore file path (relative to $jetty.base) jetty.sslContext.trustStorePath=resources/joc/https-truststore.p12 ## Keystore password jetty.sslContext.keyStorePassword=jobscheduler ## KeyManager password (same as keystore password for pkcs12 keystore type) jetty.sslContext.keyManagerPassword=jobscheduler ## Truststore password jetty.sslContext.trustStorePassword=jobscheduler
ExplanationsExplanation:- Specify the location of the Keystore with the
keyStorePath
setting and optionally of the Truststore the location of the truststore with thetrustStorePath
setting. A location relative to theJETTY_BASE
directory can be specified. - Specify the password for your Keystore with the
keyStorePassword
setting. If a Truststore is used then specify its password accordingly with thetrustStorePassword
setting.The password specified with thekeyManagerPassword
setting is used for access to your private key. The same password as for thekeyStorePassword
setting has to be used for a PKCS12 keystore type.
password for access to the truststore with thetrustStorePassword
setting.
- Specify the location of the Keystore with the
Specify the settings to enforce client authentication with the following entries in Specify the HTTPS port with the following entry of the
JETTY_BASE/start.ini
configuration file (default HTTPS port is 48446):Code Block ## Connector port to listen on jetty.ssl.port=48446
Step 4: Deactivate HTTP Access
To deactivate HTTP access add a comment to the following module directive in your JETTY_BASE/start.ini
configuration file like this:
Code Block |
---|
# Module: http
# --module=http |
Caveat
force use of client authentication certificates jetty.sslContext.needClientAuth=false jetty.sslContext.wantClientAuth=true jetty.sslContext.endpointIdentificationAlgorithm=
Explanation:
- Find explanations from
Notes
- A restart of JOC Cockpit is required to apply modifications to the JOC Cockpit
JETTY_BASE/start.ini
andJETTY_BASE/resources/joc/joc.properties
configuration files .
Further Resources
- JS7 - Controller HTTPS Connections
- JS7 - Agent HTTPS Connections
- JS7 - Configuration Templates
- JS7 - Configuration for mutual HTTPS Server Authentication and Client Authentication
- JS7 - Configuration for HTTP Basic Authentication with Passwords
- JS7 - Configuration for HTTPS Server Authentication with Passwords
JETTY_BASE/start.ini
andJETTY_BASE/resources/joc/joc.properties
configuration files a restart of JOC Cockpit is required.