Nitropyコマンドラインツール#

このチュートリアルでは、nitropy コマンドラインツールを使って、NetHMSにアクセスする方法を紹介します。

注釈

Dockerイメージなどを使用して自己署名証明書付きのNetHSMデモインスタンスを使用する場合は、``--no-verify-tls``オプションで``nitropy``を使用して、証明書のチェックを省略する必要があります。

注釈

まず、$NETHSM_HOSTの値に、お使いのNetHSMのIPアドレスまたはURLを設定します。私たちのデモサーバーは、https://nethsmdemo.nitrokey.com/ にアクセスできます。

デバイス情報&ステータス#

$ 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

プロビジョニング#

新しいNetHSMは、まずパスフレーズと現在時刻をプロビジョニングする必要があります。Admin Passphraseは、NetHSMのスーパーユーザーであるAdministratorのパスフレーズです。Unlock Passphraseは、NetHSMの機密データストアを暗号化するために使用されます。

注釈

nethsmdemo.nitrokey.comのNetHSMデモインスタンスは、すでにプロビジョニングされています。

$ nitropy nethsm --host $NETHSM_HOST provision

NetHSM localhost:8443 provisioned

NetHSMは、*Attended Boot*モードと*Unattended Boot*モードで使用できます。

  • Attended Boot*モードでは、データストアを暗号化するために使用される*Unlock Passphrase*を、起動のたびに入力する必要があります。セキュリティ上の理由から、このモードを推奨します。

  • アンアテンデッド・ブート*モードでは、アンロック・パスフレーズが必要ないため、NetHSM は無人で起動し、データストアは暗号化されずに保存されます。このモードは、Attended Boot モードでは可用性の要件を満たすことができない場合に使用します。

現在のモードを取得します。

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

 Configuration for NetHSM localhost:8443:
 Unattended boot: off

無人起動モードをオンにします。

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

 Updated the unattended boot configuration for NetHSM localhost:8443

ユーザー管理#

役割#

職務の分担は、異なるロールを使用することで実現できます。NetHSMに設定された各ユーザーアカウントには、以下のロールのいずれかが割り当てられています。以下は、各ロールで許可される操作のハイレベルな説明です。エンドポイント固有の詳細については、REST APIのドキュメントを参照してください。

  • R-Administrator。このRoleを持つユーザーアカウントは、鍵の使用操作(メッセージの署名と復号化)を除き、REST APIが提供するすべての操作にアクセスできます。

  • R-Operator。このロールを持つユーザーアカウントは、すべての鍵使用操作、鍵管理操作の読み取り専用サブセット、およびユーザー管理操作へのアクセス権を持ち、自分のアカウントのみの変更が可能です。

  • *R-Metrics*です。このロールを持つユーザーアカウントは、読み取り専用のメトリクス操作にのみアクセスできます。

  • R-Backup。この役割を持つユーザーアカウントは、システムのバックアップを開始するために必要な操作にのみアクセスできます。

注:将来のリリースでは、追加のロールが導入される可能性があります。

**ユーザーの作成と削除**について

ここで、データの署名と復号に使用できるOperatorロールを持つ新しいユーザーを作成します。NetHSMは、指定しない場合、ランダムなユーザーIDを割り当てることに注意してください。

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

キーマネージメント#

キーの生成#

ここでは、RSAキーを使ってPKCS#1を使ったデータの復号化と、SHA256を使ったPSSによるデータ署名を行いたいと思います。 そこで、NetHSMで新しい鍵を生成してみましょう。必ずRSAアルゴリズムを使用し、RSA_Signature_PSS_SHA256とRSA_Decryption_PKCS1キーメカニズムを選択してください。 キーIDを指定しない場合、NetHSMは新しいキーのためにランダムなIDを生成します。

$ 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

インポートキー#

NetHSM上で鍵を生成するのではなく、既存の秘密鍵を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

リストキー#

鍵が作成され、正しいアルゴリズムとメカニズムの設定がなされていることを確認するために、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

キーの詳細を表示#

また、生成されたキーペアの公開鍵を照会することもできます。

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

OpenSSLで利用できるようにするために、鍵をPEMファイルとしてエクスポートし、public.pemとして保存しています。

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

この鍵をOpenSSLで検査し、暗号化や署名検証(次節で説明)に利用することができるのです。

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

重要な証明書#

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

鍵証明書の署名要求#

NetHSMは、保存された鍵に対するCSR(Certificate Signing Request)の生成をサポートしています。

$ 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

主要業務#

NetHSMに保存されている鍵のデータをOpenSSLを使用して暗号化することができます。(public.pemは、「鍵の詳細を表示する」で作成した公開鍵ファイルです)。

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

同様に、NetHSM上のキーを使ってデータに署名することができます。RSAとECDSAの場合、最初にダイジェストを計算する必要があります。

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

そして、このダイジェストからNetHSMを使って署名を作成します。

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

そして、OpenSSLで署名を検証する。

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

Verified OK

バックアップの作成#

NetHSMのバックアップを作成し、設定と保存されたキーの両方を取得することが可能です。バックアップを作成するためには、まず、バックアップファイルを暗号化するために使用されるバックアップパスフレーズを設定する必要があります。

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

Updated the backup passphrase for NetHSM localhost:8443

ここで、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

そして、バックアップを生成し、ファイルに書き込むことができます。

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

Backup for localhost:8443 written to /tmp/backup

バックアップの復元#

このバックアップファイルは、プロビジョニングされていないNetHSMインスタンスにリストアすることができます。

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

Backup restored on NetHSM localhost:8443

NetHSMのアップデート#

警告

ベータ版アップデートのインストールにより、データ損失が発生する可能性があります

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

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

インストールを続行する場合は、アップデートをコミットすることができます。

$ nitropy nethsm --host $NETHSM_HOST     commit-update

Update successfully committed on NetHSM localhost:8443

また、アップデートをキャンセルすることもできます。

$ nitropy nethsm --host $NETHSM_HOST  cancel-update

Update successfully cancelled on NetHSM localhost:8443