Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Signing Certificate file does not require to be deployed to Controller and Agent instances. Instead, the CA Certificate file is deployed to Controller and Agent instances.

...

Resources

Shell Scripts

As an alternative to running OpenSSL commands in an interactive shell, scripts are provided that perform this task.

The below scripts assume the following directory layout:

  • <ca>  The directory <ca> is a placeholder. Any directory can be used.
    • create_root_ca.sh
    • create_certificate.sh
    • certs
    • csr
    • private

The sub-directories certs, csr and private will be created should they not exist.

Creating the Private Root CA Certificate

Download: create_root_ca.sh

The following files will be created when executing the script:

  • <ca>/certs/root-ca.crt
  • <ca>/csr/root-ca.csr
  • <ca>/private/root-ca.key

This step is performed just once. In case of renewal of the Root CA Certificate any Server Certificates will have to be renewed.

Code Block
titleRun .create_root_ca.sh shell script
linenumberstrue
# Description
# create_root_ca.sh --key-name=<basename> --subject=<distinguished-name> --days=<number-of-days>

# Example for use with defaults
./create_root_ca.sh

# Example for use with basename
./create_root_ca.sh --key-name=ca-root

# Example applying specific distinguished name and lifetime
./create_root_ca.sh --subject="/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=JS7 CA" --days=7660


The shell script is optionally executed with the following arguments:

  • --key-name
    • The basename of the key without extension. Default: root-ca
  • --subject
    • The distinguished name that is used as the subject of the CA Certificate. Default: /C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=Root CA
  • --days
    • The lifetime of the certificate is specified by the number of days. Default: 7305
    • Consider that Server Certificates have to be renewed if the Root CA Certificate expires.

Creating a Signing Certificate

Download: create_server_certificate.sh

The following files will be created with <server> being a placeholder for the hostname for which a certificate should be created.

  • <ca>/certs/<server>.crt
  • <ca>/csr/<server>.csr
  • <ca>/private/<server>.key

This step is performed for each Server Certificate that should be created.

Code Block
titleRun .create_certificate.sh shell script
linenumberstrue
# Description
# create_server_certificate.sh --dns=<hostname>[,<hostname>] --key-name=<basename> --subject=<distinguished-name> --days=<number-of-days>

# Example for use with DNS and lifetime
./create_server_certificate.sh --dns=centostest-primary --days=365

# Example for use with DNS, key name and lifetime
./create_server_certificate.sh --dns=centostest-primary,centostest-primary.sos --key-name=centostest-primary --days=4017

# Example for use with DNS, subject and lifetime
./create_server_certificate.sh --dns=centostest-primary,centostest-primary.sos --subject="/C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=centostest-primary.sos" --days=4017 


The shell script is executed with the following arguments:

  • --dns (required)
    • The DNS hostname of the server that should be assigned the certificate. A server can be assigned more than one DNS hostname, for example the FQDN can extend the hostname. Only DNS hostnames that are added to the certificate can be used later on to establish secure HTTPS connections.
  • --key-name
    • The basename of the key without extension. Default: root-ca
  • --subject
    • The distinguished name that is used as the subject of the Server Certificate. Default: /C=DE/ST=Berlin/L=Berlin/O=SOS/OU=IT/CN=<dns>
    • The CN attribute must specify the server's hostname. By default the first hostname specified with the --dns option is used.
  • --days
    • The lifetime of the certificate is specified by the number of days. Default: 3652

...