Nitropy-komentorivityökalu#

Tämä opetusohjelma näyttää, miten NetHMS:ää käytetään nitropy-komentorivityökalun avulla, joka sinun on ladattava ja asennettava.

Muista

Jos käytät NetHSM-demoinstanssia, jossa on itse allekirjoitettu varmenne, esimerkiksi Docker-kuvaa käyttäen, sinun on käytettävä --no-verify-tls-vaihtoehtoa nitropy ohittaaksesi varmenteen tarkistuksen.

Muista

Aseta ensin arvoksi $NETHSM_HOST NetHSM:n IP-osoite tai URL-osoite. Demopalvelimemme on osoitteessa https://nethsmdemo.nitrokey.com/.

Laitteen tiedot & Tila#

$ nitropy nethsm --host $NETHSM_HOST info

Host:    localhost:8443
Vendor:  Nitrokey GmbH
Product: NetHSM
$ nitropy nethsm --host $NETHSM_HOST state

NetHSM localhost:8443 is Unprovisioned

Provisioning#

Uuteen NetHSM:ään on ensin määritettävä salasanat ja nykyinen kellonaika. Admin Passphrase on järjestelmänvalvojan salasana, joka on NetHSM:n pääkäyttäjä. Unlock Passphrase -lauseketta käytetään NetHSM:n luottamuksellisen tietovaraston salaamiseen.

Muista

NetHSM-demoinstanssi osoitteessa nethsmdemo.nitrokey.com on jo otettu käyttöön.

$ nitropy nethsm --host $NETHSM_HOST provision

NetHSM localhost:8443 provisioned

NetHSM:ää voidaan käyttää Attended Boot -tilassa ja Unattended Boot -tilassa.

  • Attended Boot -tilassa Unlock Passphrase on syötettävä jokaisen käynnistyksen yhteydessä, ja sitä käytetään tietovaraston salaamiseen. Turvallisuussyistä tätä tilaa suositellaan.

  • Vartioimattomassa käynnistystilassa ei tarvita lukituksen avauslauseketta, joten NetHSM voi käynnistyä valvomatta ja tietovarasto tallennetaan salaamattomana. Käytä tätä tilaa, jos käytettävyysvaatimuksiasi ei voida täyttää Aattended Boot -tilassa.

Hae nykyinen tila:

$ nitropy nethsm --host $NETHSM_HOST get-config --unattended-boot

 Configuration for NetHSM localhost:8443:
 Unattended boot: off

Ota käyttöön valvomaton käynnistystila:

$ nitropy nethsm --host $NETHSM_HOST set-unattended-boot on

 Updated the unattended boot configuration for NetHSM localhost:8443

Käyttäjien hallinta#

Roolit#

Tehtävien erottaminen voidaan toteuttaa käyttämällä eri rooleja. Jokaiselle NetHSM:ään määritetylle käyttäjätilille on määritetty jokin seuraavista rooleista. Seuraavassa on yleiskuvaus kunkin roolin sallimista toiminnoista. Päätepistekohtaiset tiedot löytyvät REST API -dokumentaatiosta.

  • R-hallinnoija: Käyttäjätili, jolla on tämä rooli, voi käyttää kaikkia REST API:n tarjoamia toimintoja, lukuun ottamatta avainten käyttöoperaatioita, eli viestien allekirjoittamista ja purkamista.

  • R-operaattori: Käyttäjätilillä, jolla on tämä rooli, on pääsy kaikkiin avainten käyttöoperaatioihin, vain lukuoikeudet sisältävään osajoukkoon avainten hallintatoimintoja ja käyttäjähallintatoimintoihin, jotka sallivat muutokset vain omalle tilille.

  • R-Metrics: Käyttäjätilillä, jolla on tämä rooli, on vain lukuoikeudet metriikkatoimintoihin.

  • R-Backup: Käyttäjätilillä, jolla on tämä rooli, on oikeus käyttää vain järjestelmän varmuuskopioinnin käynnistämiseen tarvittavia toimintoja.

Huomautus: Tulevissa versioissa voidaan ottaa käyttöön uusia rooleja.

Käyttäjien luominen ja poistaminen

Luo nyt uusi käyttäjä, jolla on Operator-rooli ja jota voidaan käyttää tietojen allekirjoittamiseen ja purkamiseen. Huomaa, että NetHSM antaa satunnaisen käyttäjätunnuksen, jos emme määritä sitä.

$ nitropy nethsm --host $NETHSM_HOST  add-user --real-name "Jane User" --role Operator

User Operator added to NetHSM localhost:8443
$ nitropy nethsm --host $NETHSM_HOST delete-user "Jane User"

Avainten hallinta#

Luo avaimet#

Tässä osassa haluamme käyttää RSA-avainta tietojen salauksen purkamiseen PKCS#1:n avulla ja tietojen allekirjoittamiseen PSS:n avulla SHA256:n avulla. Luodaan siis uusi avain NetHSM:ssä. Varmista, että käytät RSA-algoritmia ja valitset avainmekanismit RSA_Signature_PSS_SHA256 ja RSA_Decryption_PKCS1. Jos et määritä avaintunnusta, NetHSM luo uudelle avaimelle satunnaisen tunnuksen.

$ nitropy nethsm --host $NETHSM_HOST  generate-key --type RSA --mechanism RSA_Signature_PSS_SHA256 --mechanism RSA_Decryption_PKCS1 --length 2048 --key-id myFirstKey

Key myFirstKey generated on NetHSM localhost:8443

Tuo avaimet#

Sen sijaan, että luot avaimen NetHSM:ssä, voit myös tuoda olemassa olevat yksityiset avaimet NetHSM:ään:

$ nitropy nethsm --host $NETHSM_HOST  add-key --type RSA --mechanism RSA_Signature_PSS_SHA256 --mechanism RSA_Decryption_PKCS1 --key-id mySecondKey --public-exponent AQAB --prime-p "AOnWFZ+JrI/xOXJU04uYCZOiPVUWd6CSbVseEYrYQYxc7dVroePshz29tc+VEOUP5T0O8lXMEkjFAwjW6C9QTAsPyl6jwyOQluMRIkdN4/7BAg3HAMuGd7VmkGyYrnZWW54sLWp1JD6XJG33kF+9OSar9ETPoVyBgK5punfiUFEL" \
    --prime-q "ANT1kWDdP9hZoFKT49dwdM/S+3ZDnxQa7kZk9p+JKU5RaU9e8pS2GOJljHwkES1FH6CUGeIaUi81tRKe2XZhe/163sEyMcxkaaRbBbTc1v6ZDKILFKKt4eX7LAQfhL/iFlgi6pcyUM8QDrm1QeFgGz11ChM0JuQw1WwkX06lg8iv"

Key mySecondKey added to NetHSM localhost:8443

Luetteloavaimet#

Varmistaaksemme, että avain on luotu ja että siinä on oikeat algoritmi- ja mekanismiasetukset, voimme kysyä kaikkia NetHSM:n avaimia:

$ nitropy nethsm --host $NETHSM_HOST list-keys
Keys on NetHSM localhost:8443:

Key ID          Algorithm       Mechanisms                                      Operations
----------      ---------       ----------------------------------------------  ----------
myFirstKey      RSA             RSA_Decryption_PKCS1, RSA_Signature_PSS_SHA256  0
mySecondKey     RSA             RSA_Decryption_PKCS1, RSA_Signature_PSS_SHA256  0

Näytä avaimen tiedot#

Voimme myös kysyä luotujen avainparien julkista avainta:

$ nitropy nethsm --host $NETHSM_HOST get-key myFirstKey

Jotta voimme käyttää avainta OpenSSL:n kanssa, viemme sen PEM-tiedostona ja tallennamme sen nimellä public.pem:

$ nitropy nethsm --host $NETHSM_HOST get-key myFirstKey --public-key > public.pem

Voimme tarkastaa avaimen OpenSSL:llä ja käyttää sitä salaukseen tai allekirjoituksen todentamiseen (kuten seuraavassa osassa kuvataan):

$ openssl rsa -in public.pem -pubin -text

RSA Public-Key: (2048 bit)
Modulus:
          00:c3:56:f5:09:cc:a9:3e:ca:16:2e:fb:d2:8b:9d:
          a9:33:5a:87:8f:3f:7a:bb:8a:3d:62:9b:5d:56:84:
          95:97:bb:97:f0:77:e2:c8:59:f2:b5:c6:b7:f5:b3:
          76:69:a3:e8:f6:b7:35:f4:3c:52:6d:3c:a0:b6:a1:
          e4:1a:32:05:1d:51:68:21:7d:fc:53:69:ec:bc:0b:
          a0:db:63:b2:0e:47:00:03:4d:98:1f:ab:c0:7b:2e:
          3c:8f:b6:36:ff:f0:db:80:26:f0:a6:af:30:2f:7b:
          16:fd:5c:db:0f:2c:54:8a:26:2b:db:3d:78:49:4b:
          7b:d1:60:ea:a7:f0:b4:5e:fc:33:ff:57:f8:83:fd:
          12:64:8f:29:d1:94:96:9a:15:18:5d:04:ca:1c:29:
          44:ad:42:31:c5:80:38:4c:eb:3b:b8:7e:17:27:5c:
          69:a8:88:44:ea:d1:82:64:fe:51:31:47:97:a7:a9:
          87:c3:13:c9:00:7a:b9:fb:6f:cc:66:4c:07:d7:68:
          fa:78:68:9a:e7:87:1e:94:c6:27:92:5f:f2:7d:11:
          44:11:b5:39:35:59:2c:cd:f9:4f:59:e3:56:93:1f:
          94:20:fd:6b:23:0d:15:e6:4e:bb:84:a8:a5:0d:9f:
          1c:90:ab:a8:10:04:50:12:c1:80:02:94:85:78:df:
          d6:b3
Exponent: 65537 (0x10001)
writing RSA key
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw1b1CcypPsoWLvvSi52p
M1qHjz96u4o9YptdVoSVl7uX8HfiyFnytca39bN2aaPo9rc19DxSbTygtqHkGjIF
HVFoIX38U2nsvAug22OyDkcAA02YH6vAey48j7Y2//DbgCbwpq8wL3sW/VzbDyxU
iiYr2z14SUt70WDqp/C0Xvwz/1f4g/0SZI8p0ZSWmhUYXQTKHClErUIxxYA4TOs7
uH4XJ1xpqIhE6tGCZP5RMUeXp6mHwxPJAHq5+2/MZkwH12j6eGia54celMYnkl/y
fRFEEbU5NVkszflPWeNWkx+UIP1rIw0V5k67hKilDZ8ckKuoEARQEsGAApSFeN/W
swIDAQAB
-----END PUBLIC KEY-----

Avainsertifikaatit#

NetHSM-instanssiin tallennettujen avainten varmenteita on mahdollista asettaa ja kysyä:

$ nitropy nethsm --host $NETHSM_HOST  set-certificate myFirstKey --mime-type application/x-pem-file /tmp/cert.pem

Updated the certificate for key myFirstKey on NetHSM localhost:8443
$ nitropy nethsm --host $NETHSM_HOST get-certificate myFirstKey > /tmp/cert.pem

Avainsertifikaatin allekirjoituspyynnöt#

NetHSM tukee tallennettujen avainten varmenteen allekirjoituspyyntöjen (CSR) luomista:

$ nitropy nethsm --host $NETHSM_HOST csr --key-id myFirstKey --country DE --state-or-province BE --locality Berlin --organization ACME --organizational-unit IT --common-name example.com --email-address it@example.com

Tärkeimmät toiminnot#

Voimme salata tietoja NetHSM:ään tallennetun avaimen osalta OpenSSL:n avulla. (public.pem on julkinen avaintiedosto, jonka loimme kohdassa Näytä avaimen tiedot).

$ echo 'NetHSM rulez!' | OpenSSL rsautl -encrypt -inkey public.pem -pubin | base64 > data.crypt
$ nitropy nethsm -h $NETHSM_HOST decrypt -k myFirstKey -d "$(cat data.crypt)" -m PKCS1 | base64 -d

NetHSM rulez!

Vastaavasti voimme allekirjoittaa tiedot NetHSM:ssä olevan avaimen avulla. RSA:n ja ECDSA:n osalta meidän on ensin laskettava digesti:

$ echo 'NetHSM rulez!' > data
$ openssl dgst -sha256 -binary data | base64 > data.digest

Sitten voimme luoda allekirjoituksen tästä digestistä NetHSM:n avulla:

$ nitropy nethsm -h $NETHSM_HOST sign -k myFirstKey -m PSS_SHA256 -d "$(cat data.digest)" | base64 -d > data.sig

Käytä sitten OpenSSL:ää allekirjoituksen tarkistamiseen:

$ openssl dgst -sha256 -verify public.pem -signature data.sig -sigopt rsa_padding_mode:pss -sigopt rsa_pss_saltlen:-1 data

Verified OK

Varmuuskopioiden luominen#

NetHSM:stä on mahdollista luoda varmuuskopio, joka sisältää sekä kokoonpanon että tallennetut avaimet. Varmuuskopion luomista varten on ensin määritettävä varmuuskopion salasana, jota käytetään varmuuskopiotiedoston salaamiseen:

$ nitropy nethsm -h $NETHSM_HOST -u admin set-backup-passphrase

Updated the backup passphrase for NetHSM localhost:8443

Nyt sinun on luotava käyttäjä, jolla on R-Backup-rooli:

$ nitropy nethsm -h $NETHSM_HOST -u admin add-user --user-id backup --real-name "Backup User" --role backup

User backup added to NetHSM localhost:8443

Sitten voit luoda varmuuskopion ja kirjoittaa sen tiedostoon:

$ nitropy nethsm -h $NETHSM_HOST backup /tmp/nethsm-backup

Backup for localhost:8443 written to /tmp/backup

Varmuuskopioiden palauttaminen#

Tämä varmuuskopiotiedosto voidaan palauttaa käyttämättömään NetHSM-instanssiin:

$ nitropy nethsm -h $NETHSM_HOST restore --backup-passphrase backup-passphrase backupencryptionkey /tmp/nethsm-backup

Backup restored on NetHSM localhost:8443

NetHSM:n päivittäminen#

Varoitus

Beta-päivityksen asentaminen voi aiheuttaa tietojen menetyksen!

$ nitropy nethsm --host $NETHSM_HOST  update /tmp/nethsm-update.img.cpio

Image /tmp/nethsm-update.img.cpio uploaded to NetHSM localhost:8443

Jos haluat jatkaa asennusta, voit nyt sitoutua päivitykseen:

$ nitropy nethsm --host $NETHSM_HOST     commit-update

Update successfully committed on NetHSM localhost:8443

Vaihtoehtoisesti voit peruuttaa päivityksen:

$ nitropy nethsm --host $NETHSM_HOST  cancel-update

Update successfully cancelled on NetHSM localhost:8443