Production Image#

The production image is provided for production environments with high security demands. It requires an external etcd key-value store which is connected through an encrypted connection. The NetHSM process can be executed with hardware-based separation (KVM) and device-specific encryption. The image is distributed as OCI image and can be run locally with a compatible executor such as Docker and Podman.

与 NetHSM 硬件相比，软件容器的 REST API 没有实现以下功能：

  • Network configuration

  • Factory reset

  • Reboot

  • Software update

The NetHSM production container is a product for paying customers only and can be purchased here. The image can be obtained from Nitrokey NetHSM registry using the credentials provided after purchase.

警告

The security of the NetHSM software container strongly depends on the platform’s security. A compromised platform could easily compromise a NetHSM software container it executes. In addition the TRNG is not existent so that the entropy used and provided by the NetHSM depends on the platform’s entropy.

Tagging Policy#

The images in the repository are tagged with the Git commit hash and the version of the release. The latest image is tagged with latest.

Modes of Operation#

The image can be run in two modes of operation, i.e. Unix process or unikernel.

The Unix process mode runs NetHSM as a process on top of the operating system.

The unikernel mode runs NetHSM as a guest in a KVM based virtual machine and provides strong separation from the host operating system. This mode is only available on Linux and requires access to the /dev/tun and /dev/kvm device nodes and the NET_ADMIN capability.

重要

For security choose to run the container in the unikernel mode.

The mode can be set with the environment variable MODE (see next chapter Configuration).

配置#

The container can be configured with the following environment variables.

Environment variable

描述

DEBUG_LOG

Enables extended logging for NetHSM.

UNLOCKPW

A set unlock passphrase automatically unlocks the container during start.

MODE

The mode accepts the values unix or unikernel, defaults to unix.

ETCD_HOST

The URL/IP address of the host running the etcd service.

ETCD_PORT

The port running the etcd service, defaults to 2379.

ETCD_CA_CERT

The path to the certificate of the CA (Certificate Authority) which signed the client certificate.

ETCD_CLIENT_CERT

The path to the certificate for the client authentication.

ETCD_CLIENT_KEY

The path to the secret key for the client authentication.

The container runtime secrets such as certificates and private keys need to be set with the secrets feature of Docker or Podman.

Secret variable

描述

ca_cert

CA certificate which signed the client certificate and server certificate.

client_cert

Client certificate for authentication of the NetHSM process with the key-value store.

client_key

Client key for authentication of the NetHSM process with the key-value store.

server_cert

Server certificate for the API of the key-value store.

server_key

Server key for the API of the key-value store.

device_key

Device key of the NetHSM process. To learn more about the device key refer to chapter Terminology and Conventions in the system design.

使用方法#

The production container supports two modes of operation. The following chapters describe how to run the container with the provided compose files or with the _run_ command.

Unix Mode#

You can obtain a provided compose file here. Make sure you have the necessary files for the secrets, mentioned in the compose file, available.

To run the container without the compose file you need to provide an external etcd yourself. Here you find the recommended container image for etcd. Make sure to pass the configuration options, as described in chapter Configuration.

容器可以按以下方式执行。

$ docker run -ti --rm -p 8443:8443 registry.git.nitrokey.com/distribution/nethsm:latest

这将在容器内以 Unix 进程的形式运行 NetHSM，并通过 HTTPS 协议在端口 8443 上公开 REST API。

重要

容器使用一个自签的TLS证书。请确保使用正确的连接设置来建立连接。请参考`NetHSM介绍<index.html>`__一章，了解更多信息。

Unikernel Mode#

You can obtain a provided compose file here. Make sure you have the necessary files for the secrets, mentioned in the compose file, available.

To run the container without the compose file you need to provide an external etcd yourself. Here you find the recommended container image for etcd. Make sure to pass the configuration options, as described in chapter Configuration.

容器可以按以下方式执行。

$ docker run -ti --rm -p 8443:8443 --device /dev/net/tun --device /dev/kvm --cap-add=NET_ADMIN -e "MODE=unikernel" registry.git.nitrokey.com/distribution/nethsm:latest

这将在 KVM 虚拟机中以单内核方式运行 NetHSM。容器将通过 HTTPS 协议，在 IP 地址为 192.168.1.100、端口为 8443 的接口 “tap200 “上公开 REST API。

重要

容器使用一个自签的TLS证书。请确保使用正确的连接设置来建立连接。请参考`NetHSM介绍<index.html>`__一章，了解更多信息。