10. SSL Certificate HowTo

10.1. SSL Certificate Guide

For Production use it is highly recommended that you use ssl certs for db communication. If you have your own certificate facility use those to generate the necessary certs and keys.

Or use the code (signcerts.sh) below and configuration file (openssl.cnf) supplied below. To create your own signed certificates.

10.1.1. Example using signcerts.sh

• Create a Certificate Authority and sign certs for tool use

  # create CA
  CREATE_ONTP_CA=1 signcerts.sh
  # sign cert for data node1
  SIGN_ONTP_DNODES=dn1 signcerts.sh
  # sign cert for data node2
  SIGN_ONTP_DNODES=dn2 signcerts.sh
  # sign cert for access node
  SIGN_ONTP_ANODE_CERT=1 signcerts.sh

- Dont forget to chmod,chown the keys produced to the userid of the database process
  sudo chown 0:70 whatever.key
  sudo chmod 640 whatever.key
  Have the keys in a (shared) file-system location where they can be mapped to the container

10.1.2. Example output after signcerts.sh execution

$>ls certsx/
auth.key                              ontp_tsdb-ca.crt         ontp_tsdb-dnode-dn2.crt
CA                                    ontp_tsdb-ca.key         ontp_tsdb-dnode-dn2.key
e8a48653851e28c69d0506508fb27fc5.crt  ontp_tsdb-ca.pem         root.pem
e8a48653851e28c69d0506508fb27fc5.key  ontp_tsdb-dnode-dn1.crt
e8a48653851e28c69d0506508fb27fc5.pem  ontp_tsdb-dnode-dn1.key

$> ls certsx/CA/
auth.key  crl        index.txt.attr      index.txt.old  private
certs     index.txt  index.txt.attr.old  newcerts       root.pem

- You should end up with a certsx directory structure such as the above

10.1.3. signcerts.sh script

#!/bin/bash
#  signcerts.sh
#
CERT_DIR=${CERT_DIR:-"certsx/"}
ONTP_AUTH_KEY=${ONTP_AUTH_KEY:-"auth.key"}
ONTP_ROOT_CRT=${ONTP_ROOT_CRT:-"root.crt"}
CREATE_ONTP_CA=${CREATE_ONTP_CA:-""}
POSTGRES_USER=${POSTGRES_USER:-"postgres"}
ONTP_CA_KEYNAME=${ONTP_CA_KEYNAME:-"ontp_tsdb-ca"}
ONTP_AN_KEYNAME=${ONTP_AN_KEYNAME:-"ontp_tsdb-access_node"}
DNODE_PREFIX=${DNODE_PFIX:-"ontp_tsdb-dnode"}
CBUS_PREFIX=${CBUS_PREXIX:-"ontp_cbus"}
SIGN_ONTP_CBUS_CERT=${SIGN_ONTP_CBUS_CERT:-"node1"}
CAP_PREFIX=${CAP_PREFIX:-"ontp_capture"}
SIGN_ONTP_CAP_CERT=${SIGN_ONTP_CAP_CERT:-"foo.bar.web"}
#
#
pguser=${POSTGRES_USER} #change value for a different user name
base=`echo -n $pguser | md5sum | cut -c1-32`
SUBJ=${SUBJ:-"/C=US/ST=New York/L=New York/O=ONTP Software/OU=Engineering/CN=$pguser"}
DATA_H_SUBJ=${DATA_H_SUBJ:-"/C=US/ST=New York/L=New York/O=ONTP Software/OU=Engineering/CN="}


# create the target dir
if [ ! -e "${CERT_DIR}" ]; then
     mkdir "${CERT_DIR}"
fi

#
if [ ! -z "${CREATE_ONTP_CA:-}" ]; then
     if [ -e "${CERT_DIR}/CA" ]; then
          echo "CA already exits , clean dir re-initialize"
          exit 0
     fi
     # Create the root CA (Certificate Authority)
     for x in "CA" "CA/certs" "CA/crl" "CA/newcerts" "CA/private" ; do
         echo "create dir ${CERT_DIR}${x}"
         mkdir -p "${CERT_DIR}${x}"
     done
     touch "${CERT_DIR}/CA/index.txt"
     echo "auth key name: ${ONTP_AUTH_KEY}"
     echo "auth subj: ${SUBJ}"
     # create the ca auth key
     openssl genpkey -algorithm rsa -out "${CERT_DIR}/${ONTP_CA_KEYNAME}.key"
     ln -s "${ONTP_CA_KEYNAME}.key" "${CERT_DIR}/auth.key"
     ln -s "../${ONTP_CA_KEYNAME}.key" "${CERT_DIR}/CA/auth.key"
     # Certificate signing request for root CA
     openssl req -x509 -new -key "${CERT_DIR}/${ONTP_CA_KEYNAME}.key" -sha256 -days 3560 \
             -subj "$SUBJ" -out "${CERT_DIR}/${ONTP_CA_KEYNAME}.crt"
     openssl x509 -outform PEM -in "${CERT_DIR}/${ONTP_CA_KEYNAME}.crt" \
             -out "${CERT_DIR}/${ONTP_CA_KEYNAME}.pem"
     ln -s "${ONTP_CA_KEYNAME}.pem" "${CERT_DIR}/root.pem"
     ln -s "../${ONTP_CA_KEYNAME}.pem" "${CERT_DIR}/CA/root.pem"
     exit 0
fi

# create the access node certificate
if [ ! -z "${SIGN_ONTP_ANODE_CERT:-}" ]; then
     echo "creating csrs for the access nodes: ${SIGN_ONTP_ANODE_CERT}"
     #
     key_file="${CERT_DIR}/$base.key"
     crt_file="${CERT_DIR}/$base.crt"
     pem_file="${CERT_DIR}/$base.pem"
     openssl genpkey -algorithm RSA -out "$key_file"
     openssl req -new -sha256 -key $key_file -out "$base.csr" -subj "$SUBJ"
     #
     openssl ca -batch -keyfile "${CERT_DIR}/auth.key" -extensions v3_intermediate_ca \
          -days 3650 -notext -md sha256 -in "$base.csr" -out "$crt_file" \
          -config openssl.cnf
     rm $base.csr
     #
     openssl x509 -outform PEM -in "$crt_file" -out "$pem_file"
     #
     cat >>$crt_file <"${CERT_DIR}/${ONTP_CA_KEYNAME}.crt"
     exit 0
fi

# create the data node certificate
if [ ! -z "${SIGN_ONTP_DNODES:-}" ]; then
     echo "creating csrs for the data nodes: ${SIGN_ONTP_DNODES}"
     DATA_H_SUBJ="${DATA_H_SUBJ}${SIGN_ONTP_DNODES}"
     # create the csr
     openssl req -out "${CERT_DIR}/${DNODE_PREFIX}-${SIGN_ONTP_DNODES}.csr" \
             -new -newkey rsa:2048 -nodes -subj "${DATA_H_SUBJ}" \
             -keyout "${CERT_DIR}/${DNODE_PREFIX}-${SIGN_ONTP_DNODES}.key"
     # sign the csr
     openssl ca -extensions v3_intermediate_ca -days 3650 -notext -md sha256 \
             -in "${CERT_DIR}/${DNODE_PREFIX}-${SIGN_ONTP_DNODES}.csr" \
             -out "${CERT_DIR}/${DNODE_PREFIX}-${SIGN_ONTP_DNODES}.crt" -config openssl.cnf
     rm "${CERT_DIR}/${DNODE_PREFIX}-${SIGN_ONTP_DNODES}.csr"

     exit 0
fi


# create certificate for the msg bus (ontp-cbus)
if [ ! -z "${SIGN_ONTP_CBUS_CERT:-}" ]; then
     echo "creating csrs for the access nodes: ${SIGN_ONTP_CBUS_CERT}"
     #
     key_file="${CERT_DIR}/${CBUS_PREFX}-${SIGN_ONTP_CBUS_CERT}.key"
     crt_file="${CERT_DIR}/${CBUS_PREFX}-${SIGN_ONTP_CBUS_CERT}.crt"
     pem_file="${CERT_DIR}/${CBUS_PREFX}-${SIGN_ONTP_CBUS_CERT}.pem"
     base_csr="${CERT_DIR}/${CBUS_PREFX}-${SIGN_ONTP_CBUS_CERT}.csr"
     DATA_H_SUBJ="${DATA_H_SUBJ}${SIGN_ONTP_CBUS_CERT}"
     openssl genpkey -algorithm RSA -out "$key_file"
     openssl req -new -sha256 -key $key_file -out "$base_csr" -subj "$DATA_H_SUBJ"
     #
     openssl ca -batch -keyfile "${CERT_DIR}/auth.key" -extensions v3_intermediate_ca \
          -days 3650 -notext -md sha256 -in "$base_csr" -out "$crt_file" \
          -config openssl.cnf
     rm $base_csr
     #
     openssl x509 -outform PEM -in "$crt_file" -out "$pem_file"
     #
     #cat >>$crt_file <"${CERT_DIR}/${ONTP_CA_KEYNAME}.crt"
     exit 0
fi

# create certificate for the capture agent (ontp-capture)
if [ ! -z "${SIGN_ONTP_CAP_CERT:-}" ]; then
     echo "creating csrs for the access nodes: ${SIGN_ONTP_CAP_CERT}"
     #
     key_file="${CERT_DIR}/${CAP_PREFX}-${SIGN_ONTP_CAP_CERT}.key"
     crt_file="${CERT_DIR}/${CAP_PREFX}-${SIGN_ONTP_CAP_CERT}.crt"
     pem_file="${CERT_DIR}/${CAP_PREFX}-${SIGN_ONTP_CAP_CERT}.pem"
     base_csr="${CERT_DIR}/${CAP_PREFX}-${SIGN_ONTP_CAP_CERT}.csr"
     DATA_H_SUBJ="${DATA_H_SUBJ}${SIGN_ONTP_CAP_CERT}"
     openssl genpkey -algorithm RSA -out "$key_file"
     openssl req -new -sha256 -key $key_file -out "$base_csr" -subj "$DATA_H_SUBJ"
     #
     openssl ca -batch -keyfile "${CERT_DIR}/auth.key" -extensions v3_intermediate_ca \
          -days 3650 -notext -md sha256 -in "$base_csr" -out "$crt_file" \
          -config openssl.cnf
     rm $base_csr
     #
     openssl x509 -outform PEM -in "$crt_file" -out "$pem_file"
     #
     #cat >>$crt_file <"${CERT_DIR}/${ONTP_CA_KEYNAME}.crt"
     exit 0
fi

10.1.4. OpenSSL example configuration file

Example Openssl Configuration - Please Modify for your env

#
# OpenSSL example configuration file.
# This is mostly being used for generation of certificate requests.
#

# Note that you can include other files from the main configuration
# file using the .include directive.
#.include filename

# This definition stops the following lines choking if HOME isn't
# defined.
HOME			= .

# Extra OBJECT IDENTIFIER info:
#oid_file		= $ENV::HOME/.oid
oid_section		= new_oids

# To use this configuration file with the "-extfile" option of the
# "openssl x509" utility, name here the section containing the
# X.509v3 extensions to use:
# extensions		=
# (Alternatively, use a configuration file that has only
# X.509v3 extensions in its main [= default] section.)

# Load default TLS policy configuration

openssl_conf = default_modules

[ default_modules ]

ssl_conf = ssl_module

[ ssl_module ]

system_default = crypto_policy

[ crypto_policy ]

.include = /etc/crypto-policies/back-ends/opensslcnf.config

[ new_oids ]

# We can add new OIDs in here for use by 'ca', 'req' and 'ts'.
# Add a simple OID like this:
# testoid1=1.2.3.4
# Or use config file substitution like this:
# testoid2=${testoid1}.5.6

# Policies used by the TSA examples.
tsa_policy1 = 1.2.3.4.1
tsa_policy2 = 1.2.3.4.5.6
tsa_policy3 = 1.2.3.4.5.7

####################################################################
[ ca ]
default_ca	= CA_default		# The default ca section

####################################################################
[ CA_default ]

dir		= certsx/CA		# Where everything is kept
certs		= $dir/certs		# Where the issued certs are kept
crl_dir		= $dir/crl		# Where the issued crl are kept
database	= $dir/index.txt	# database index file.
#unique_subject	= no			# Set to 'no' to allow creation of
					# several certs with same subject.
new_certs_dir	= $dir/newcerts		# default place for new certs.

certificate	= $dir/root.pem 	# The CA certificate
serial		= $dir/serial 		# The current serial number
crlnumber	= $dir/crlnumber	# the current crl number
					# must be commented out to leave a V1 CRL
crl		= $dir/crl.pem 		# The current CRL
private_key	= $dir/auth.key # The private key

x509_extensions	= usr_cert		# The extensions to add to the cert

# Comment out the following two lines for the "traditional"
# (and highly broken) format.
name_opt 	= ca_default		# Subject Name options
cert_opt 	= ca_default		# Certificate field options

# Extension copying option: use with caution.
# copy_extensions = copy

# Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs
# so this is commented out by default to leave a V1 CRL.
# crlnumber must also be commented out to leave a V1 CRL.
# crl_extensions	= crl_ext

default_days	= 365			# how long to certify for
default_crl_days= 30			# how long before next CRL
default_md	= sha256		# use SHA-256 by default
preserve	= no			# keep passed DN ordering

# A few difference way of specifying how similar the request should look
# For type CA, the listed attributes must be the same, and the optional
# and supplied fields are just that :-)
policy		= policy_match

email_in_dn = no            # Don't concat the email in the DN
rand_serial = yes
# For the CA policy
[ policy_match ]
countryName		= match
stateOrProvinceName	= match
organizationName	= match
organizationalUnitName	= optional
commonName		= supplied
emailAddress		= optional

# For the 'anything' policy
# At this point in time, you must list all acceptable 'object'
# types.
[ policy_anything ]
countryName		= optional
stateOrProvinceName	= optional
localityName		= optional
organizationName	= optional
organizationalUnitName	= optional
commonName		= supplied
emailAddress		= optional

####################################################################
[ req ]
default_bits		= 2048
default_md		= sha256
default_keyfile 	= privkey.pem
distinguished_name	= req_distinguished_name
attributes		= req_attributes
x509_extensions	= v3_ca	# The extensions to add to the self signed cert

# Passwords for private keys if not present they will be prompted for
# input_password = secret
# output_password = secret

# This sets a mask for permitted string types. There are several options.
# default: PrintableString, T61String, BMPString.
# pkix	 : PrintableString, BMPString (PKIX recommendation before 2004)
# utf8only: only UTF8Strings (PKIX recommendation after 2004).
# nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings).
# MASK:XXXX a literal mask value.
# WARNING: ancient versions of Netscape crash on BMPStrings or UTF8Strings.
string_mask = utf8only

# req_extensions = v3_req # The extensions to add to a certificate request

[ req_distinguished_name ]
countryName			= Country Name (2 letter code)
countryName_default		= US
countryName_min			= 2
countryName_max			= 2

stateOrProvinceName		= State or Province Name (full name)
stateOrProvinceName_default	= New York

localityName			= Locality Name (eg, city)
localityName_default		= NY

0.organizationName		= Organization Name (eg, company)
0.organizationName_default	= ONTP Software

# we can do this but it is not needed normally :-)
#1.organizationName		= Second Organization Name (eg, company)
#1.organizationName_default	= World Wide Web Pty Ltd

organizationalUnitName		= Organizational Unit Name (eg, section)
organizationalUnitName_default	= Tech

commonName			= Common Name (eg, your name or your server\'s hostname)
commonName_max			= 64

emailAddress			= Email Address
emailAddress_max		= 64

# SET-ex3			= SET extension number 3

[ req_attributes ]
challengePassword		= A challenge password
challengePassword_min		= 4
challengePassword_max		= 20

unstructuredName		= An optional company name

[ usr_cert ]

# These extensions are added when 'ca' signs a request.

# This goes against PKIX guidelines but some CAs do it and some software
# requires this to avoid interpreting an end user certificate as a CA.

basicConstraints=CA:FALSE

# Here are some examples of the usage of nsCertType. If it is omitted
# the certificate can be used for anything *except* object signing.

# This is OK for an SSL server.
# nsCertType			= server

# For an object signing certificate this would be used.
# nsCertType = objsign

# For normal client use this is typical
# nsCertType = client, email

# and for everything including object signing:
# nsCertType = client, email, objsign

# This is typical in keyUsage for a client certificate.
# keyUsage = nonRepudiation, digitalSignature, keyEncipherment

# This will be displayed in Netscape's comment listbox.
nsComment			= "ONTP OpenSSL Generated Certificate"

# PKIX recommendations harmless if included in all certificates.
subjectKeyIdentifier=hash
authorityKeyIdentifier=keyid,issuer

# This stuff is for subjectAltName and issuerAltname.
# Import the email address.
# subjectAltName=email:copy
# An alternative to produce certificates that aren't
# deprecated according to PKIX.
# subjectAltName=email:move

# Copy subject details
# issuerAltName=issuer:copy

#nsCaRevocationUrl		= http://www.domain.dom/ca-crl.pem
#nsBaseUrl
#nsRevocationUrl
#nsRenewalUrl
#nsCaPolicyUrl
#nsSslServerName

# This is required for TSA certificates.
# extendedKeyUsage = critical,timeStamping

[ v3_req ]

# Extensions to add to a certificate request

basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment

[ v3_ca ]


# Extensions for a typical CA


# PKIX recommendation.

subjectKeyIdentifier=hash

authorityKeyIdentifier=keyid:always,issuer

basicConstraints = critical,CA:true

# Key usage: this is typical for a CA certificate. However since it will
# prevent it being used as an test self-signed certificate it is best
# left out by default.
# keyUsage = cRLSign, keyCertSign

# Some might want this also
# nsCertType = sslCA, emailCA

# Include email address in subject alt name: another PKIX recommendation
# subjectAltName=email:copy
# Copy issuer details
# issuerAltName=issuer:copy

# DER hex encoding of an extension: beware experts only!
# obj=DER:02:03
# Where 'obj' is a standard or added object
# You can even override a supported extension:
# basicConstraints= critical, DER:30:03:01:01:FF


[ v3_intermediate_ca ]
# Extensions for a typical intermediate CA (`man x509v3_config`).
subjectKeyIdentifier = hash
authorityKeyIdentifier = keyid:always,issuer
basicConstraints = critical, CA:true, pathlen:0
keyUsage = critical, digitalSignature, cRLSign, keyCertSign
crlDistributionPoints = @crl_info
authorityInfoAccess = @ocsp_info
#
[crl_info]
URI.0 = http://crl.grilledcheese.us/whoremovedmycheese.crl

[ocsp_info]
caIssuers;URI.0 = http://ocsp.grilledcheese.us/cheddarcheeseroot.crt
OCSP;URI.0 = http://ocsp.grilledcheese.us/
#

[ crl_ext ]

# CRL extensions.
# Only issuerAltName and authorityKeyIdentifier make any sense in a CRL.

# issuerAltName=issuer:copy
authorityKeyIdentifier=keyid:always

[ proxy_cert_ext ]
# These extensions should be added when creating a proxy certificate

# This goes against PKIX guidelines but some CAs do it and some software
# requires this to avoid interpreting an end user certificate as a CA.

basicConstraints=CA:FALSE

# Here are some examples of the usage of nsCertType. If it is omitted
# the certificate can be used for anything *except* object signing.

# This is OK for an SSL server.
# nsCertType			= server

# For an object signing certificate this would be used.
# nsCertType = objsign

# For normal client use this is typical
# nsCertType = client, email

# and for everything including object signing:
# nsCertType = client, email, objsign

# This is typical in keyUsage for a client certificate.
# keyUsage = nonRepudiation, digitalSignature, keyEncipherment

# This will be displayed in Netscape's comment listbox.
nsComment			= "ONTP OpenSSL Generated Certificate"

# PKIX recommendations harmless if included in all certificates.
subjectKeyIdentifier=hash
authorityKeyIdentifier=keyid,issuer

# This stuff is for subjectAltName and issuerAltname.
# Import the email address.
# subjectAltName=email:copy
# An alternative to produce certificates that aren't
# deprecated according to PKIX.
# subjectAltName=email:move

# Copy subject details
# issuerAltName=issuer:copy

#nsCaRevocationUrl		= http://www.domain.dom/ca-crl.pem
#nsBaseUrl
#nsRevocationUrl
#nsRenewalUrl
#nsCaPolicyUrl
#nsSslServerName

# This really needs to be in place for it to be a proxy certificate.
proxyCertInfo=critical,language:id-ppl-anyLanguage,pathlen:3,policy:foo

####################################################################
[ tsa ]

default_tsa = tsa_config1	# the default TSA section

[ tsa_config1 ]

# These are used by the TSA reply generation only.
#dir		= /etc/pki/CA		# TSA root directory
dir		= CA/		# TSA root directory
serial		= $dir/tsaserial	# The current serial number (mandatory)
crypto_device	= builtin		# OpenSSL engine to use for signing
signer_cert	= $dir/tsacert.pem 	# The TSA signing certificate
					# (optional)
certs		= $dir/cacert.pem	# Certificate chain to include in reply
					# (optional)
signer_key	= $dir/private/tsakey.pem # The TSA private key (optional)
signer_digest  = sha256			# Signing digest to use. (Optional)
default_policy	= tsa_policy1		# Policy if request did not specify it
					# (optional)
other_policies	= tsa_policy2, tsa_policy3	# acceptable policies (optional)
digests     = sha1, sha256, sha384, sha512  # Acceptable message digests (mandatory)
accuracy	= secs:1, millisecs:500, microsecs:100	# (optional)
clock_precision_digits  = 0	# number of digits after dot. (optional)
ordering		= yes	# Is ordering defined for timestamps?
				# (optional, default: no)
tsa_name		= yes	# Must the TSA name be included in the reply?
				# (optional, default: no)
ess_cert_id_chain	= no	# Must the ESS cert id chain be included?
				# (optional, default: no)
ess_cert_id_alg		= sha1	# algorithm to compute certificate
				# identifier (optional, default: sha1)