Thales TCT Luna integration in Kubernetes

ENTERPRISE

The Thales TCT Luna HSM sidecar container enables integrating the application container to a network attached Thales Luna. The following covers how to set up the integration in Kubernetes.

• Prerequisites

• HSM driver container deployment parameters

  • Environment variables

  • Volume mounts

• Prepare HSM configuration

• Configure Deployment

• Create and verify HSM crypto token

• Advanced deployments

For more general information on the HSM integration with PKCS#11, see HSM Integration.

Prerequisites

Before using this container, you need the following:

• Luna TCT HSM with fully configured secured network access. The EJBCA deployment will be configured with:

  • The IP address/hostname of the HSM

  • server.pem certificate

• Administrative access on the HSM for registering a client and assigning partitions to the client.

• The P11 Proxy must have network access to the HSM service (security groups, network ACLs, etc)

• An existing key pair credential for the client, i.e. the HSM driver container, to communicate with the HSM.

HSM driver container deployment parameters

The following lists parameters for the HSM sidecar container.

Environment variables

The following environment variables configure the HSM sidecar container with the Helm chart in the hsm.lunatct section.

Volume mounts

The volume mount parameters are mandatory and need only be configured in the HSM sidecar container. These mounts are defined via the Helm chart under the hsm.lunatct section, using a combination of ConfigMap and Secret resources.

You can verify the configuration by checking the corresponding files inside the container after deployment.

Prepare HSM configuration

The following assumes that the server certificate and client credentials are already available.

Configure the server certificate and client credentials:

1. Create a Kubernetes secret with the client private key to communicate with the HSM.

   • The file name inside the secret must be dockerlunaclientKey.pem.

   • Replace <namespace> with your deployment's namespace.

   • The name of this secret must be referenced later in the Helm values.yaml.

     CODE

     kubectl create secret generic hsm-luna-tct-secret-client-key \
          -n cadeploymentnamespace --from-file=dockerlunaclientKey.pem=dockerlunaclientKey.pem

2. Create a Kubernetes ConfigMap to configure the HSM server certificate and client certificate.

   • The HSM server certificate and client certificate values in the values.yaml may be adjusted in the next section.

Example (certificate contents truncated):

apiVersion: v1
kind: ConfigMap
metadata:
  name: hsm-luna-tct-configmap
data:
  server.pem: |
    -----BEGIN CERTIFICATE-----
    MIIDOTCCAiGgAwIBAgIBADANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJDQTEQ
    .....truncated.....
    OaIJWeLzCzXw4bzKbl5VvfwXmrTyCh0wHgN+E1VOhv8s2HhA3/Mzujb1VhPDCT0Z
    LP1EfFulatVU0dtbQg==
    -----END CERTIFICATE-----
  dockerlunaclient.pem: |
    -----BEGIN CERTIFICATE-----
    MIIDMzCCAhugAwIBAgIBADANBgkqhkiG9w0BAQsFADBdMQswCQYDVQQGEwJDQTEQ
    .....truncated.....
    xP96D2AMJN/9/rPHLHEJqETdYBvZYwdzyqB9GinxwuxlCfkrolx+ETyk16wK63m1
    dABXXPaeLg==
    -----END CERTIFICATE-----

3. Optional: Create a Secret for Chrystoki.conf
   If you need to connect to multiple HSMs or use a clustered configuration, you must supply a custom Chrystoki.conf. For an example using a single HSM, see example-chrystoki.conf, and for an example using multiple HSMs, see example-chrystoki-ha.conf.
   This is the only supported way to configure multiple HSMs as a cluster.

   CODE

   kubectl create secret generic -n cadeploymentnamespace \
         hsm-luna-tct-chrystokisecret \
       --from-file=Chrystoki.conf=production-chrystoki.conf

Configure Deployment

The following provides an example of customizing the deployment using Helm. Note that the Helm chart values file values.yaml describes an example test deployment and does not include:

• Database connection.

• Configured imagePullSecrets that may be required.

• EJBCA license as secret in ejbca.license

• TLS connection required after the deployment and creation of the CAs.

Ensure that the deployment is allowed an Egress to the physical HSM.

Example: Configuration Using server_name

Make sure to adjust the values for the HSM server environment variable (server_name) and any required secrets.

#imagePullSecrets: []
ejbca:
  license: ejbca-license-secret
  env:
    TLS_SETUP_ENABLED: "later"
    LOG_AUDIT_TO_DB: true
#################### HSM configuration - start ####################
hsm:
  enabled: true
  lunatct:
    enabled: true
    server_name: "192.168.30.106"
    credentials:
      certificates:
        configMap: "hsm-luna-tct-configmap"
      privateKey:
        secret: "hsm-luna-tct-secret-client-key"
#################### HSM configuration - end ####################
podSecurityContext:
  fsGroup: 10001
# Ingress or LoadBalancer configuration skipped

Example: Configuration Using Chrystoki.conf

Alternatively, mount Chrystoki.conf with hsm.lunatct.custom_chrystoki_conf_secret attribute. Note that the secret is created in the last step.

If Chrystoki.conf is mounted, the hsm.lunatct.server_name does not need to be specified.

#imagePullSecrets: []
ejbca:
  license: ejbca-license-secret
  env:
    TLS_SETUP_ENABLED: "later"
    LOG_AUDIT_TO_DB: true
#################### HSM configuration - start ####################
hsm:
  enabled: true
  lunatct:
    enabled: true
    custom_chrystoki_conf_secret: "hsm-luna-tct-chrystokisecret"
    credentials:
      certificates:
        configMap: "hsm-luna-tct-configmap"
      privateKey:
        secret: "hsm-luna-tct-secret-client-key"
#####
#### ....... truncated ....... ####

Create and verify HSM crypto token

To create a crypto token and then test the HSM key, do the following:

1. In the EJBCA menu, click CA Functions > Crypto Tokens.

2. Click Create new and specify the following on the New Crypto Token page:

   • Name: Specify a name for the crypto token.

   • Type: Select PKCS#11 NG.

   • Auto-activation: Select use to allow EJBCA to save the password and reapply it after a restart so that the CA is always available.

   • For PKCS#11 : Reference Type, select Slot/Token Label.

   • For PKCS#11 : Reference, select one of the listed slots available in the HSM.

   • Authentication Code: Enter a password for auto-activation, the same as provided for the slot or token in the HSM.

   • Click Save to create the crypto token.

3. Once created, you can generate new key pairs or view any existing key pairs on the HSM.

4. To verify that the HSM key is operational, click Test.

Advanced deployments

The EJBCA Enterprise configuration export/import tool EJBCA ConfigDump allows you to deploy EJBCA with automation. For information on deploying EJBCA with automation, using a soft HSM integration suitable for testing, see Deploy EJBCA as CA with automation with SoftHSM2.

Thales TCT Luna HSM installations can also be automated using the EJBCA ConfigDump tool. For information on how to configure the tool in Kubernetes, see EJBCA Configdump in Kubernetes.