Introduction
SSL/TLS Certificates are used to secure HTTP connections between JS7 products, for example JS7 - JOC Cockpit HTTPS Connections.
...
Examples in the article make use of JS7 Release 2.7.2, OpenSSL 1.1.1k FIPS 25 Mar 2021 for Unix and OpenSSL 3.1.4 24 Oct 2023 for Windows. OpenSSL ships with Linux & other Unix OS and is available for Windows.
Setting up the Private CA
Anchor |
---|
| creating_private_key_and_csr |
---|
| creating_private_key_and_csr |
---|
|
Creating the Private Key and Certificate Signing RequestUsers have the option to use ECDSA or RSA for the encryption type applied to the Private Key.
Users can run the following commands from the shell and replace the value of the ca_key_name
environment variable with a name of their choice that is used when creating related files.
Anchor |
---|
| using_ca_private_key_ecdsa |
---|
| using_ca_private_key_ecdsa |
---|
|
Using ECDSA Encryption Code Block |
---|
language | bash |
---|
title | Example how to create Private Key and Certificate Signing Request using ECDSA encryption (Unix) |
---|
linenumbers | true |
---|
|
# Specify key name used for file names
ca_key_name=root-ca
# Create Private Key
openssl ecparam -genkey -name secp384r1 -out ${ca_key_name}.key
# Create Certificate Signing Request
openssl req -new -sha512 -nodes \
-key ${ca_key_name}.key \
-out ${ca_key_name}.csr \
-subj "/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=${ca_key_name}" |
...
Expand |
---|
|
- Users should adjust the
ca_key_name environment variable specifying a value that matches the purpose such as root-ca for a Root CA Certificate. - Private Key
- Choice of algorithm such as
secp256k1 , secp384r1 depends on support by the Java version used with JS7.
- Certificare Signing Request
- The hash algorithm such as
-sha256, -sha512 can be freely chosen. - The
-subj option specifies the Distinguished Name used for the subject of the CSR and resulting Certificate.- The Distinguished Name is a unique identifier frequently using the hierarchy of Country
C , State ST , Location L , Organization O , Organizational Unit OU and Common Name CN . - For the Private Root CA Certificate the subject and issuer properties of the CSR/Certificate are the same. The minimum requirement is to specify the Common Name
CN=<name> where <name> can freely be chosen. - For Private CA-signed Certificates the subject property holds the Certificate's Distinguished Name and the issuer property holds the Private CA Certificate's Distinguished Name using different values.
- The following files will be created with this step:
- The
root-ca.key file will hold the Private Key. - The
root-ca.csr file will hold the Certificate Signing Request.
|
Anchor |
---|
| using_ca_private_key_rsa |
---|
| using_ca_private_key_rsa |
---|
|
Using RSA Encryption Expand |
---|
title | Click to expand/collapse... |
---|
|
Code Block |
---|
language | bash |
---|
title | Example how to create Private Key and Certificate Signing Request using RSA encryption (Unix) |
---|
linenumbers | true |
---|
| # Specify key name used for file names
ca_key_name=root-ca
# Create Private Key and Certificate Signing Request
openssl req -new -newkey rsa:4096 -sha256 -nodes \
-keyout ${ca_key_name}.key \
-out ${ca_key_name}.csr \
-subj "/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=${ca_key_name}" |
Expand |
---|
| Code Block |
---|
language | text |
---|
title | Example how to create Private Key and Certificate Signing Request using RSA encryption (Windows) |
---|
linenumbers | true |
---|
| @rem Specify key name used for file names
set ca_key_name=root-ca
@rem Create Private Key and Certificate Signing Request
openssl req -new -newkey rsa:4096 -sha256 -nodes ^
-keyout %ca_key_name%.key ^
-out %ca_key_name%.csr ^
-subj "/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=%ca_key_name%" |
|
Expand |
---|
| - In the example the Private Key is created using the specified key size
4096 . - For use of the
-sha256 hash algorithm and -subj option see Using ECDSA Encryption. - The following files will be created with this step:
- The
root-ca.key file will hold the Private Key. - The
root-ca.csr file will hold the Certificate Signing Request.
|
|
Anchor |
---|
| creating_ca_certificate |
---|
| creating_ca_certificate |
---|
|
Creating the CA CertificateSteps include to create the root-ca.crt
Private CA-signed Certificate file in PEM format.
...
Expand |
---|
|
- The SHA option such as
-sha256, -sha384, -sha512 can be freely chosen. - The
-days option specifies the validity period of the CA Certificate that should be longer than the validity period of individual certificates signed by the CA later on. - The
-signkey option specifies the location of the Private Key file created from the previous step. - The
-in option specifies the location of the Certificate Signing Request file created from the previous step. - The
-out option specifies the location of the resulting Certificate file. - The
-extfile option specifies the Basic Constraint CA:TRUE which is required for a CA Certificate. Key Usage is limited to signing certificates. - The following files will be created with this step:
- The
root-ca.crt file will hold the CA Certificate.
|
Creating SSL/TLS Server Certificates
For a given server next steps includes to create the Private Key and Certificate Signing Request (CSR). The resulting Server Certificate will be signed by the Private CA.
...
Users can run the following commands from the shell and replace the value of the server_name
environment variable with a name of their choice that is used when creating related files.
Creating the Private Key and Certificate Signing Request
Anchor |
---|
| using_server_private_key_ecdsa |
---|
| using_server_private_key_ecdsa |
---|
|
Using ECDSA Encryption Code Block |
---|
language | bash |
---|
title | Example how to create Private Key and Certificate Signing Request using ECDSA encryption (Unix) |
---|
linenumbers | true |
---|
|
# Specify key name used for file names
server_name=myhost
# Create Private Key
openssl ecparam -genkey -name secp384r1 -out ${server_name}.key
# Create Certificate Signing Request
openssl req -new -sha512 -nodes \
-key ${server_name}.key \
-out ${server_name}.csr \
-subj "/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=${server_name}" |
...
Anchor |
---|
| using_server_private_key_rsa |
---|
| using_server_private_key_rsa |
---|
|
Using RSA Encryption Expand |
---|
title | Click to expand/collapse... |
---|
|
Code Block |
---|
language | bash |
---|
title | Example how to create Private Key and Certificate Signing Request using RSA encryption (Unix) |
---|
linenumbers | true |
---|
| # Specify key name used for file names
server_name=myhost
# Create Private Key and Certificate Signing Request
openssl req -new -newkey rsa:4096 -sha256 -nodes \
-keyout ${server_name}.key \
-out ${server_name}.csr \
-subj "/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=${server_name}" |
Expand |
---|
| Code Block |
---|
language | text |
---|
title | Example how to create Private Key and Certificate Signing Request using RSA encryption (Windows) |
---|
linenumbers | true |
---|
| @rem Specify key name used for file names
set server_name=myhost
@rem Create Private Key and Certificate Signing Request
openssl req -new -newkey rsa:4096 -sha256 -nodes ^
-keyout %server_name%.key ^
-out %server_name%.csr ^
-subj "/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=%server_name%" |
|
|
Creating the Server Certificate
Code Block |
---|
language | bash |
---|
title | Example how to create and sign Server Certificate (Unix) |
---|
linenumbers | true |
---|
|
# Specify server for which the certificate should be created
server_name=myhost
# Create and sign Server Certificate
openssl x509 -req -sha512 -days 3652 \
-in ${server_name}.csr \
-CA root-ca.crt \
-CAkey root-ca.key \
-CAcreateserial \
-out ${server_name}.crt \
-extfile <(printf 'subjectAltName=DNS:%s\nkeyUsage=critical,keyEncipherment,digitalSignature\nextendedKeyUsage=serverAuth,clientAuth\n' "${server_name}") |
...
Expand |
---|
|
- The following files will be created for the given server:
myhost .crt : the Server Certificate
- For operation with JS7 JOC Cockpit, Controller and Agents users can add
|
Resources
...