PKCS#11 beállítása¶

Telepítés¶

A NetHSM PKCS#11 modult vagy előfordított bináris formában szerezheti be, vagy lefordíthatja a forrásból.

Előre lefordított binárisok¶

Töltse le a rendszerének megfelelő modulfájlt a releases oldalról az adattárból.
Másolja a modulfájlt abba a könyvtárba, ahol a PKCS#11 alkalmazások várják.

Fordítás forrásból¶

Telepítse a Rust toolchain.
Töltse le és töltse ki a forrást a releases oldalról vagy klónozza a repository-t.
Futtassa a cargo build --release a forráskönyvtárban.

Konfiguráció¶

Alapértelmezés szerint a modul a következő helyen keresi a konfigurációs fájlokat:

„/etc/nitrokey/p11nethsm.conf
„/usr/local/etc/nitrokey/p11nethsm.conf
„$HOME/.config/nitrokey/p11nethsm.conf

Ha több fájl van jelen, a konfigurációkat egyesíti, így a modul az összes konfigurációs fájl slotjait fogja használni.

A konfigurációs fájl helyét manuálisan is beállíthatod (csak ez lesz olvasva) az env változóval P11NETHSM_CONFIG_FILE (pl. P11NETHSM_CONFIG_FILE=./p11nethsm.conf).

Konfigurációs fájl formátuma¶

A konfiguráció yaml-formátumú:

# Set this option to true to enable the compatibility option for the C_SetAttributeValue() function.
# This allows the applications using the Java Sun PKCS11 module (like EJBCA) to generate keys.
# When using this, the names given to the keys will be ignored and the keys will have random names.
# Under the hood it will store in memory the name given to the key when calling C_SetAttributeValue(). When a certificate is uploaded it will check if the name was previously passed to C_SetAttributeValue() and translate it to the real name on the NetHSM.
enable_set_attribute_value: false

# Optional log level, acceptable  values are Trace, Debug, Info, Warn and Error
log_level: Debug

# By default, the module logs to both syslog and stderr, trying the sockets /dev/log, /var/run/syslog and finally /var/run/log
# A custom socket can be configured:
syslog_socket: /var/nethsm/log
# Instead of a socket, a custom UDP or TCP syslog can be configured:
# syslog_udp:
#    to_addr: 127.0.0:1:514
#    from_addr: 127.0.0:1:4789
# syslog_tcp: 127.0.0.1:601
# Only one option among "syslog_socket", "syslog_udp", "syslog_tcp" can be configured at the same time

# You can configure the syslog facility ( "kern", "user", "mail", "daemon", "auth", "syslog", "lpr", "news", "uucp", "cron", "authpriv", "ftp", "local0", "local1", "local2", "local3", "local4", "local5", "local6" or "local7"):
syslog_facility: "user"
# You can set the hostname (for use only with syslog_udp or syslog_tcp)
# syslog_hostname: "localhsm-pkcs11"
# You can set the process name (defaults to the process name obtained from the OS)
# syslog_process: "NetHSM Pkcs11"
# You can set the pid used in logs (defaults to the process id obtained from the OS)
# syslog_pid: 0
# You can also configure a custom file, or "-" for stderr.
# log_file: /tmp/p11nethsm.log

# Each "slot" represents a HSM cluster of server that share the same user and keys.
slots:
  - label: LocalHSM                        # Name your NetHSM however you want
    description: Local HSM (docker)        # Optional description

    # Users connecting to the NetHSM server
    operator:
      username: "operator"
      # If the password starts with `env:`, it will obtain the password from an environment variable:
      # password: "env:LOCALHSMPASS"
      # password: "localpass"
      #
      # If the field is not provided, it is expected to be given through `C_Login` function with the
      # `CKU_USER` userType
    administrator:
      username: "admin"
      # If the password starts with `env:`, it will obtain the password from an environment variable:
      # password: "env:LOCALADMINHSMPASS"
      # password: "adminpass"
      #
      # If the field is not provided, it is expected to be given through `C_Login` function with the
      # `CKU_SO` userType

    # List the NetHSM instances
    instances:
      - url: "https://keyfender:8443/api/v1"   # URL to reach the server
        # To avoid having to re-open connections on each requests, the module keeps a connection pool to each instance. If the module is used by a multithreaded application, multiple connections can be opened at the same time.
        # This configures the maximum number of connections in the pool at the same time.
        # Note that this does not limit the total number of open connections.
        # Having a degree of parallelism that is higher than the max number of idle connection can lead overhead as those connections will be closed an re-opened frenquently
        max_idle_connections: 10
        # By default, the certificate of the HSM will be validated using the system's root certificate authority.
        # When the NetHSM uses a self-signed certificate, it can be verified against an allowed list of sha256 fingerprint of the NetHSM's certificate:
        sha256_fingerprints:
          - "31:92:8E:A4:5E:16:5C:A7:33:44:E8:E9:8E:64:C4:AE:7B:2A:57:E5:77:43:49:F3:69:C9:8F:C4:2F:3A:3B:6E"
        # Alternatively certificate checks can be skipped entirely with danger_insecure_cert option.
        # This should be avoided if possible and certainly not used with a productive NetHSM.
        # danger_insecure_cert: true
    # Configure whether the certificates stored in the nethsm are stored in PEM or DER
    # The nethsm itself supports both, but some tooling may only support one of the encodings.
    # Valid values are PEM or DER. Defaults to PEM
    #
    # Values exchanged over the PKCS#11 interface will always be DER encoded.
    # This config only changes the format they are stored in on the Nethsm itself for compatibility with other tooling.
    certificate_format: PEM
    # Configure the network retry mechanism. If absent, no retries are attempted on a network error
    retries:
      # The number of retries after a network error
      count: 3
      # The delay between retries, in integer seconds
      delay_seconds: 1
    # it is possible to configure idle connections to make use of TCP keepalives, preventing the closing of connections by a firewall or detecting such cases
    tcp_keepalive:
      # the number of seconds before keepalives packets start being sent
      # Corresponds to `TCP_KEEPIDLE` on Linux, `TCP_KEEPALIVE` on macOS, and the field keepalivetime of tcp_keepalive on Windows
      time_seconds: 600
      # the number of seconds between each keepalive packet
      # Corresponds to `TCP_KEEPINTVL` on Linux and macOS, and the field keepaliveinterval of tcp_keepalive on Windows
      interval_seconds: 60
      # the number of keepalive packets being sent without a response before the connection
      # is considered closed
      # Corresponds to `TCP_KEEPCNT` on Linux and macOS, and is not used on Windows
      retries: 3
    # Time a connection can spend idle before being closed
    connections_max_idle_duration: 1800

    # Configurable timeout for network operations. If a network operation takes more than, `timeout_seconds`, consider it failed. If `retries` is configured, it will be retried.
    # Defaults to infinite
    timeout_seconds: 10

Instances¶

Ha több NetHSM példány szerepel ugyanabban a foglalatban, akkor ezeket a példányokat fürtben kell konfigurálni. A felhasználók hitelesítő adatainak és a kulcsoknak minden példányban azonosnak kell lenniük.

A modul a példányokat körkörösen használja, és ha az egyik meghibásodik, egy másik példányt próbál meg.

A hálózat megbízhatósága¶

A PKCS#11 modul megbízhatóságának javítása érdekében lehetőség van időkorlátok, újbóli próbálkozások, példányredundancia és TCP keepalive-ok beállítására.

Megpróbálkozások¶

Ha egy NetHSM-példány nem érhető el, a PKCS#11 modul képes megismételni a kérés más példányoknak vagy ugyanannak a példánynak történő elküldését (ha más példányok szintén elérhetetlenek). Az újbóli próbálkozások között késleltetést lehet bevezetni.

A sikertelen példányok elérhetetlennek vannak jelölve, és egy háttérszálban próbálkoznak újra, így csak akkor próbálkoznak, ha az összes példány elérhetetlen.
If no background thread can be spawned (CKF_LIBRARY_CANT_CREATE_OS_THREADS), failed instances will be tried during normal operations, slowing down the requests. To minimise this, such „inline” health checks are limited to one second timeouts, and only three health checks can be attempted per request (this is a worst case situation that can only be reached if a large number of instances failed).

Ezért:

Az egy API-híváshoz küldött kérések maximális száma: retries.count + 1 + 3
A maximális (legrosszabb esetben) időtartam egy API-hívás esetén az időkorlát elérése előtt: (retries.count + 1) * timeout_seconds + 3
The maximum timeout for one PKCS#11 function call will vary because some functions will lead to multiple API calls in the NetHSM.

TCP keepalive¶

A teljesítmény javítása érdekében a NetHSM-példányokkal a kapcsolatokat nyitva tartjuk, hogy elkerüljük az újbóli megnyitást. Lehetséges, hogy egy tűzfallal rendelkező hálózatban ezek az üresjárati kapcsolatok lezárulnak, ami a következő kapcsolati kísérlet időzavarához vezet. A lassú időtúllépések megelőzése érdekében, illetve annak korábbi észlelése érdekében, ha ez megtörténik, lehetőség van TCP keepalive-ok beállítására.

Felhasználók¶

Az operátor és a rendszergazda felhasználó nem kötelező, de a modul nem indul el, ha nincs felhasználó beállítva. Ez azért van így, hogy a modult csak rendszergazdai, csak üzemeltetői vagy mindkettő felhasználóval egyszerre konfigurálhassa.

Ha a két felhasználó be van állítva, a modul alapértelmezés szerint az operátort használja, és csak akkor használja a rendszergazda felhasználót, ha a műveletnek szüksége van rá.

A hagyományos PKCS#11 felhasználó a NetHSM operátorhoz, a PKCS#11 SO pedig a NetHSM rendszergazdához van hozzárendelve.

Jelszavak¶

A jelszó többféle módon is megadható:

Egyszerű szövegben a konfigurációban password: "mypassword"
A modul által a env: előtaggal olvasott környezeti változóban: env:ENV_STORING_THE_PASSWORD
A pkcs11 bejelentkezési funkcióján keresztül, például a pcks11-tool esetében: pkcs11-tool --module libnethsm_pkcs11.so -p opPassphrase Az admin jelszó megadásához a --so-pin helyett a ` ` jelszót kell használni: pkcs11-tool --module libnethsm_pkcs11.so --login --login-type so --so-pin Administrator

Ha a felhasználó jelszava nincs megadva a konfigurációs fájlban, akkor a jelszó megadásához bejelentkezésre van szükség (3. módszer).

A nem működő NetHSM olyan slotnak minősül, amelyben nincs jelen a token.