Nitropy Narzędzie wiersza poleceń#

Informacje o urządzeniu & Stan
Provisioning
Zarządzanie użytkownikami
- Role
Zarządzanie kluczami
Kluczowe certyfikaty
- Żądania podpisania certyfikatu klucza
Kluczowe operacje
Tworzenie kopii zapasowych
Przywracanie kopii zapasowych
Aktualizowanie NetHSM

W tym poradniku pokazano, jak uzyskać dostęp do NetHMS za pomocą nitropy narzędzia wiersza poleceń, które należy pobrać i zainstalować.

Informacja

Jeśli używasz instancji demonstracyjnej NetHSM z samopodpisanym certyfikatem, na przykład przy użyciu obrazu Docker, będziesz musiał użyć opcji --no-verify-tls dla nitropy, aby pominąć sprawdzanie certyfikatu.

Informacja

Najpierw ustaw wartość $NETHSM_HOST na adres IP lub adres URL NetHSM. Nasz serwer demonstracyjny jest dostępny pod adresem https://nethsmdemo.nitrokey.com/.

Informacje o urządzeniu & Stan #

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

W pierwszej kolejności należy zaopatrzyć nowy NetHSM w hasło i aktualny czas. Admin Passphrase to hasło administratora, który jest superużytkownikiem urządzenia NetHSM. Fraza Unlock Passphrase służy do szyfrowania poufnych danych przechowywanych w NetHSM.

Informacja

Instancja demonstracyjna NetHSM pod adresem nethsmdemo.nitrokey.com jest już udostępniona.

$ nitropy nethsm --host $NETHSM_HOST provision

NetHSM localhost:8443 provisioned

NetHSM może być używany w trybie Attended Boot lub Unattended Boot.

W trybie Attended Boot podczas każdego uruchomienia należy wprowadzić Unlock Passphrase [hasło odblokowujące], które jest używane do szyfrowania magazynu danych. Ten tryb jest zalecany ze względów bezpieczeństwa.
W trybie Unattended Boot nie jest wymagane hasło odblokowujące, dlatego urządzenie NetHSM może być uruchamiane bez nadzoru, a magazyn danych jest przechowywany w niezaszyfrowanej postaci. Użyj tego trybu, jeśli wymagania dotyczące dostępności nie mogą być spełnione w trybie Attended Boot.

Uzyskanie bieżącego trybu pracy:

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

 Configuration for NetHSM localhost:8443:
 Unattended boot: off

Włączenie trybu Unattended Boot:

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

 Updated the unattended boot configuration for NetHSM localhost:8443

Zarządzanie użytkownikami #

Role #

Rozdzielenie obowiązków można zrealizować za pomocą różnych ról. Każde konto użytkownika skonfigurowane w NetHSM ma przypisaną jedną z poniższych ról. Poniżej przedstawiono ogólny opis operacji, które można wykonywać w ramach każdej roli. Szczegółowe informacje dotyczące poszczególnych punktów końcowych znajdują się w dokumentacji interfejsu API REST.

R-Administrator: Konto użytkownika z tą Rolą ma dostęp do wszystkich operacji wykonywanych przez interfejs REST API, z wyjątkiem operacji związanych z użyciem kluczy, tj. podpisywania i odszyfrowywania wiadomości.
R-Operator: Konto użytkownika z tą Rolą ma dostęp do wszystkich operacji użycia kluczy, podzbioru operacji zarządzania kluczami tylko do odczytu oraz operacji zarządzania użytkownikami, umożliwiając zmiany tylko na własnym koncie.
R-Metrics: Konto użytkownika z tą Rolą ma dostęp tylko do operacji metryk tylko do odczytu.
R-Backup: Konto użytkownika z tą Rolą ma dostęp tylko do operacji wymaganych do zainicjowania kopii zapasowej systemu.

Uwaga: W przyszłych wersjach mogą zostać wprowadzone dodatkowe role.

Tworzenie i usuwanie użytkowników.

Teraz utwórz nowego użytkownika z rolą Operator, który będzie mógł podpisywać i odszyfrowywać dane. Należy pamiętać, że NetHSM przydziela losowy identyfikator użytkownika, jeśli nie zostanie on określony.

$ 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"

Zarządzanie kluczami #

Generowanie kluczy #

W tym rozdziale chcemy użyć klucza RSA do odszyfrowania danych za pomocą PKCS#1 oraz do podpisania danych za pomocą PSS z użyciem SHA256. Wygenerujmy więc nowy klucz w urządzeniu NetHSM. Pamiętaj, aby użyć algorytmu RSA i wybrać mechanizmy klucza RSA_Signature_PSS_SHA256 oraz RSA_Decryption_PKCS1. Jeśli nie podasz identyfikatora klucza, urządzenie NetHSM wygeneruje losowy identyfikator dla nowego klucza.

$ 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

Klucze importowe #

Zamiast generować klucz w urządzeniu NetHSM, można również zaimportować istniejące klucze prywatne do urządzenia NetHSM:

$ 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

Lista kluczy #

Aby upewnić się, że klucz został utworzony i ma poprawne ustawienia algorytmu i mechanizmu, możemy odpytać wszystkie klucze w NetHSM:

$ 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

Pokaż szczegóły klucza #

Możemy również zapytać o klucz publiczny wygenerowanej pary kluczy:

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

Aby móc używać tego klucza w OpenSSL, eksportujemy go jako plik PEM i zapisujemy jako public.pem:

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

Klucz ten możemy sprawdzić za pomocą programu OpenSSL i wykorzystać go do szyfrowania lub weryfikacji podpisu (jak opisano w następnym rozdziale):

$ 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-----

Kluczowe certyfikaty #

Możliwe jest ustawianie i odpytywanie certyfikatów dla kluczy przechowywanych na instancji NetHSM:

$ 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

Żądania podpisania certyfikatu klucza #

NetHSM obsługuje generowanie żądań podpisania certyfikatu (CSR) dla przechowywanych kluczy:

$ 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

Kluczowe operacje #

Dane dla klucza przechowywanego na NetHSM można zaszyfrować za pomocą OpenSSL. (public.pem to plik klucza publicznego, który utworzyliśmy w sekcji Show Key Details).

$ 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!

Podobnie można podpisywać dane przy użyciu klucza znajdującego się w urządzeniu NetHSM. W przypadku algorytmów RSA i ECDSA należy najpierw obliczyć skrót:

$ echo 'NetHSM rulez!' > data

$ openssl dgst -sha256 -binary data | base64 > data.digest

Następnie możemy utworzyć podpis z tego skrótu za pomocą NetHSM:

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

Następnie należy użyć OpenSSL do weryfikacji podpisu:

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

Verified OK

Tworzenie kopii zapasowych #

Możliwe jest utworzenie kopii zapasowej programu NetHSM zawierającej zarówno konfigurację, jak i przechowywane klucze. Aby utworzyć kopię zapasową, należy najpierw ustawić frazę hasła kopii zapasowej, która będzie używana do szyfrowania pliku kopii zapasowej:

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

Updated the backup passphrase for NetHSM localhost:8443

Teraz należy utworzyć użytkownika z rolą R-Backup:

$ 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

Następnie można wygenerować kopię zapasową i zapisać ją do pliku:

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

Backup for localhost:8443 written to /tmp/backup

Przywracanie kopii zapasowych #

Ten plik kopii zapasowej można przywrócić na nieobsługiwanej instancji NetHSM:

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

Backup restored on NetHSM localhost:8443

Aktualizowanie NetHSM #

Ostrzeżenie

Instalacja aktualizacji w wersji beta może spowodować utratę danych!

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

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

Jeśli chcesz kontynuować instalację, możesz teraz zatwierdzić aktualizację:

$ nitropy nethsm --host $NETHSM_HOST     commit-update

Update successfully committed on NetHSM localhost:8443

Alternatywnie można anulować aktualizację:

$ nitropy nethsm --host $NETHSM_HOST  cancel-update

Update successfully cancelled on NetHSM localhost:8443