Nitrokey 3とnitropyの併用について#

nitropy を使って、Nitrokey 3 のデバイスを一覧表示し管理することができます。

インストール#

pynitrokey のインストール方法については、` このガイド <https://docs.nitrokey.com/software/nitropy/all-platforms/installation>`__ を参照してください。

Nitrokey 3デバイスのリストアップ#

nitropy list または nitropy nk3 list で、接続中のすべてのデバイスを一覧表示します。

$ nitropy list
Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
:: 'Nitrokey FIDO2' keys
:: 'Nitrokey Start' keys:
:: 'Nitrokey 3' keys
/dev/hidraw3: Nitrokey 3

$ nitropy nk3 list
Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
:: 'Nitrokey 3' keys
/dev/hidraw3: Nitrokey 3

デバイス情報を問い合わせる#

現在、デバイス情報を照会するために、以下のコマンドが利用可能です。

  • nitropy nk3 version: デバイスのファームウェアバージョンを照会する。

    $ nitropy nk3 version
    Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
    v1.0.0
    

複数のデバイスを操作する#

複数のNitrokey 3が接続されている場合、--path で、そのうちの一つを選択することができます。 デバイスのパスを決定するには、nitropy list または nitropy nk3 list コマンドを使ってください。

$ nitropy nk3 version
Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
Error: Multiple Nitrokey 3 devices found -- use the --path option to select one

$ nitropy nk3 list
Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
:: 'Nitrokey 3' keys
/dev/hidraw4: Nitrokey 3 DD59A7F00CCB715DB515F83C346CA8AD
/dev/hidraw3: Nitrokey 3

$ nitropy nk3 --path /dev/hidraw3 version
Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
v1.0.0

$ nitropy nk3 --path /dev/hidraw4 version
Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
v1.0.1

トラブルシューティング#

Nitrokey 3 デバイスの問題を診断するには、nitropy nk3 test コマンドを使用することができます。 これは、デバイスの状態を判断するために、いくつかのテストを実行します。

テストが成功した場合、手順の概要が印刷されます。

$ nitropy nk3 test
Nitrokey tool for Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 & NetHSM
Found 1 Nitrokey 3 device(s):
- Nitrokey 3 at /dev/hidraw3

Running tests for Nitrokey 3 at /dev/hidraw3

[1/3]   UUID query                      SUCCESS         [not supported]
[2/3]   Firmware version query          SUCCESS         v1.0.0
Please press the touch button on the device ...
Please press the touch button on the device ...
[3/3]   FIDO2                           SUCCESS

3 tests, 3 successful, 0 skipped, 0 failed

Summary: 1 device(s) tested, 1 successful, 0 failed

テストが失敗した場合、エラーメッセージには詳細な情報を含むログファイルのパスが含まれています。 サポート依頼の際には、このログファイルを添付してください。

デバイスにFIDO2ピンを設定している場合、--pin オプションを使用する必要があります。

$ nitropy nk3 test --pin 1234