PKCS#11-asetus¶

Asennus¶

Voit joko hankkia NetHSM PKCS#11 -moduulin valmiiksi käännettynä binäärinä tai kääntää sen lähdekoodista.

Esikäännetyt binäärit¶

Lataa järjestelmääsi vastaava moduulitiedosto arkiston releases-sivulta.
Kopioi moduulitiedosto hakemistoon, josta PKCS#11-sovelluksesi odottavat löytävänsä sen.

Käännä lähdekoodista¶

Asenna Rust-työkaluketju.
Lataa ja poimi lähdekoodi julkaisusivulta tai kloonaa arkisto.
Suorita cargo build --release lähdekansioon.

Konfigurointi¶

Oletusarvoisesti moduuli etsii konfiguraatiotiedostoja osoitteesta:

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

Jos tiedostoja on useita, konfiguraatiot yhdistetään niin, että moduuli käyttää kaikkien konfiguraatiotiedostojen lähtö- ja saapumisaikoja.

Voit asettaa manuaalisesti konfigurointitiedoston sijainnin (vain tämä luetaan) muuttujalla P11NETHSM_CONFIG_FILE (esim. P11NETHSM_CONFIG_FILE=./p11nethsm.conf).

Konfiguraatiotiedoston muoto¶

Konfiguraatio on yaml-muotoinen:

# 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

Instanssit¶

Jos useita NetHSM-instansseja on lueteltu samassa korttipaikassa, nämä instanssit on määritettävä klusteriksi. Käyttäjien tunnistetietojen ja avainten on oltava samat kaikissa instansseissa.

Moduuli käyttää instansseja vuorotellen ja kokeilee toista instanssia, jos yksi epäonnistuu.

Verkon luotettavuus¶

PKCS#11-moduulin luotettavuuden parantamiseksi on mahdollista määrittää aikakatkaisuja, uusintayrityksiä, instanssin redundanssia ja TCP:n keepalivejä.

Uusintayritykset¶

Jos NetHSM-instanssia ei tavoiteta, PKCS#11-moduuli voi yrittää lähettää pyynnön uudelleen muille instansseille tai samalle instanssille (jos muutkin instanssit eivät ole tavoitettavissa). Uusintayritysten välille voidaan asettaa viive.

Epäonnistuvat instanssit merkitään tavoittamattomiksi ja niitä yritetään uudelleen taustasäikeessä, joten niitä ei yritetä, elleivät kaikki instanssit ole tavoittamattomia.
Jos taustasäiettä ei voida luoda (CKF_LIBRARY_CANT_CREATE_OS_THREADS), epäonnistuneita instansseja yritetään luoda normaalin toiminnan aikana, mikä hidastaa pyyntöjä. Tämän minimoimiseksi tällaiset ”inline”-terveystarkastukset on rajoitettu yhden sekunnin aikakatkaisuihin, ja vain 3 terveystarkastusta voidaan yrittää yhtä pyyntöä kohti (tämä on pahin mahdollinen tilanne, joka voidaan saavuttaa vain, jos suuri määrä instansseja epäonnistuu).

Siksi:

Yhden API-kutsun yhteydessä lähetettävien pyyntöjen enimmäismäärä on: retries.count + 1 + 3
Yhden API-kutsun aikakatkaisun saavuttamisen enimmäiskesto (pahimmassa tapauksessa) on: (retries.count + 1) * timeout_seconds + 3).
Yhden PKCS#11-toimintokutsun enimmäisaika vaihtelee, koska jotkin toiminnot johtavat useisiin API-kutsuihin NetHSM:ssä.

TCP keepalive¶

Suorituskyvyn parantamiseksi yhteydet NetHSM-instansseihin pidetään auki, jotta niitä ei tarvitse avata uudelleen. On mahdollista, että verkossa, jossa on palomuuri, nämä käyttämättömät yhteydet suljetaan, jolloin seuraava yhteysyritys keskeytyy. Hitaiden aikakatkaisujen estämiseksi ja niiden havaitsemiseksi aikaisemmin on mahdollista määrittää TCP keepalive -asetukset.

Käyttäjät¶

Operaattori- ja järjestelmänvalvojakäyttäjät ovat molemmat valinnaisia, mutta moduuli ei käynnisty, jos käyttäjää ei ole määritetty. Näin voit määrittää moduulin vain järjestelmänvalvojan käyttäjäksi, vain operaattorikäyttäjäksi tai molemmille samanaikaisesti.

Kun nämä kaksi käyttäjää on määritetty, moduuli käyttää oletusarvoisesti operaattoria ja käyttää ylläpitäjän käyttäjää vain silloin, kun toiminto sitä tarvitsee.

Tavallinen PKCS#11-käyttäjä on yhdistetty NetHSM-operaattoriin ja PKCS#11 SO on yhdistetty NetHSM-ylläpitäjään.

Salasanat¶

Salasana voidaan antaa usealla eri tavalla:

Selkokielellä kokoonpanossa password: "mypassword"
Ympäristömuuttujassa, jonka moduuli lukee etuliitteellä env:: env:ENV_STORING_THE_PASSWORD
pkcs11:n kirjautumistoiminnon kautta, esimerkki pcks11-tool: pkcs11-tool --module libnethsm_pkcs11.so -p opPassphrase Jos haluat antaa ylläpitäjän salasanan, sinun on käytettävä sen sijaan --so-pin: pkcs11-tool --module libnethsm_pkcs11.so --login --login-type so --so-pin Administrator

Jos käyttäjän salasanaa ei ole määritetty asetustiedostossa, salasanan antaminen edellyttää kirjautumista (3. menetelmä).

NetHSM, joka ei ole toiminnassa, katsotaan korttipaikaksi, jossa ei ole merkkiä.