Nastavitev PKCS#11#

Namestitev#

Modul NetHSM PKCS#11 lahko dobite kot predkompilirano binarno datoteko ali pa ga sestavite iz izvorne kode.

Predkompilirane binarne datoteke#

  1. Datoteko modula, ki ustreza vašemu sistemu, prenesite s strani releases repozitorija.

  2. Datoteko modula kopirajte v imenik, kjer jo aplikacije PKCS#11 pričakujejo.

Sestavljanje iz vira#

  1. Namestite verigo orodij Rust.

  2. Izvorno kodo prenesite in izločite s strani releases page ali klonirate repozitorij ` <https://github.com/Nitrokey/nethsm-pkcs11>`__.

  3. Zaženite cargo build --release v izvornem imeniku.

Konfiguracija#

Privzeto modul išče konfiguracijske datoteke v:

  • /etc/nitrokey/p11nethsm.conf

  • /usr/local/etc/nitrokey/p11nethsm.conf

  • $HOME/.config/nitrokey/p11nethsm.conf

Če je na voljo več datotek, se konfiguracije združijo, tako da modul uporabi reže vseh konfiguracijskih datotek.

Lokacijo konfiguracijske datoteke (prebrana bo samo ta) lahko nastavite ročno s spremenljivko okolja P11NETHSM_CONFIG_FILE (npr. P11NETHSM_CONFIG_FILE=./p11nethsm.conf).

Oblika konfiguracijske datoteke#

Konfiguracija je oblikovana v formatu yaml:

# 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"
    administrator:
      username: "admin"

    # 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 parrallelism 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 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

Primerki#

Če je v isti reži navedenih več primerkov NetHSM, morajo biti ti primerki konfigurirani v gruči. Pooblastila uporabnikov in ključi morajo biti enaki na vseh primerkih.

Modul bo instance uporabljal na krožni način, pri čemer bo v primeru neuspeha poskusil z drugo instanco.

Zanesljivost omrežja#

Za izboljšanje zanesljivosti modula PKCS#11 je mogoče konfigurirati časovne omejitve, ponovne poskuse, redundanco instanc in ohranitvena sporočila TCP.

Retries#

Če instanca NetHSM ni dosegljiva, lahko modul PKCS#11 zahtevo ponovno pošlje drugim instancam ali isti instanci (če tudi druge instance niso dosegljive). Možno je uvesti zamik med ponovitvami.

  • Neuspešni primerki so označeni kot nedosegljivi in se ponovno preizkušajo v niti v ozadju, tako da se ne preizkušajo, razen če so vsi primerki nedosegljivi.

  • Če ni mogoče ustvariti niti v ozadju (CKF_LIBRARY_CANT_CREATE_OS_THREADS), se neuspešni primerki poskusijo med običajnim delovanjem, kar upočasni zahteve. Da bi to zmanjšali, so takšni „inline“ zdravstveni pregledi omejeni na 1 sekundo in na zahtevo se lahko poskusijo le 3 zdravstveni pregledi (to je najslabši možni primer, ki se lahko doseže le, če je odpovedalo veliko število instanc).

Zato:

  • Največje število poslanih zahtevkov za en klic API je: retries.count + 1 + 3

  • Najdaljše (najslabše možno) trajanje pred iztekom časa za en klic API je: (retries.count + 1) * timeout_seconds + 3

  • Najdaljši časovni rok za en klic funkcije PKCS#11 se razlikuje, ker nekatere funkcije povzročijo več klicev API v NetHSM.

Ohranjanje TCP#

Za izboljšanje delovanja so povezave z instancami NetHSM odprte, da jih ni treba ponovno odpirati. V omrežju s požarnim zidom je mogoče, da se te neaktivne povezave zaprejo, zaradi česar se naslednji poskus povezave prekine. Da bi preprečili, da bi prišlo do počasnih prekinitev, in da bi prej odkrili, če se to zgodi, je mogoče za te povezave konfigurirati ohranitvene signale TCP.

Uporabniki#

Uporabnika operater in administrator sta neobvezna, vendar se modul ne zažene, če ni konfiguriran noben uporabnik. To je zato, da lahko modul konfigurirate samo z uporabnikom administratorjem, samo z uporabnikom operaterjem ali z obema hkrati.

Ko sta uporabnika nastavljena, modul privzeto uporablja uporabnika operaterja in uporabnika administratorja uporabi le, kadar je to potrebno za akcijo.

The regular PKCS#11 user is mapped to the NetHSM operator and the PKCS#11 SO is mapped to the NetHSM administrator.

Gesla#

Geslo lahko zagotovite na več načinov:

  • V navadnem besedilu v konfiguraciji password: "mypassword"

  • V spremenljivki okolja, ki jo prebere modul s predpono env:: env:ENV_STORING_THE_PASSWORD

  • S funkcijo prijave v programu pkcs11, primer za pcks11-tool: pkcs11-tool –module libnethsm_pkcs11.so -p opPassphrase Za zagotovitev gesla upravitelja morate namesto tega uporabiti --so-pin: pkcs11-tool --module libnethsm_pkcs11.so --login --login-type so --so-pin Administrator

Če geslo uporabnika ni nastavljeno v konfiguracijski datoteki, bo za vpis gesla potrebna prijava (3. metoda).

NetHSM, ki ne deluje, se šteje za režo, v kateri žeton ni prisoten.