Usage Guide

Nitrokey Python SDK pašlaik atbalsta Nitrokey 3 (nitrokey.nk3.NK3) un Nitrokey Passkey (nitrokey.nkpk.NKPK) ierīces. Abu ierīču pamatā ir viena un tā pati platforma Trussed, tāpēc tām ir viena un tā pati bāzes klase nitrokey.trussed.TrussedDevice.

Šasijas ierīces var pārstartēt bootloader režīmā, ko izmanto, lai piemērotu programmaparatūras atjauninājumus. Ierīcēm bootloader režīmā var piekļūt, izmantojot nitrokey.nk3.NK3Bootloader un nitrokey.nkpk.NKPKBootloader (bāzes klases nitrokey.trussed.TrussedBootloader).

Listing and Opening Devices

Izmantojiet nitrokey.trussed.TrussedDevice.list() funkciju, lai uzskaitītu un atvērtu visas pievienotās ierīces:

from nitrokey.nk3 import NK3
from nitrokey.nkpk import NKPK

print("Connected Nitrokey devices:")
for device in NK3.list():
    print(f"- {device.name} at {device.path}")
for device in NKPK.list():
    print(f"- {device.name} at {device.path}")

Ja jūs zināt ierīces ceļu, tā vietā izmantojiet nitrokey.trussed.TrussedDevice.open():

from nitrokey.nk3 import NK3
from nitrokey.nkpk import NKPK

path = "/dev/hidraw1"
device = NK3.open(path)
if device is not None:
    print(f"Found {device.name} at {path}")
device = NKPK.open(path)
if device is not None:
    print(f"Found {device.name} at {path}")

Līdzīgas funkcijas ir pieejamas arī nitrokey.nk3.NK3Bootloader un nitrokey.nkpk.NKPKBootloader. Lai uzskaitītu gan parastās, gan bootloader ierīces, izmantojiet nitrokey.nk3.list() un nitrokey.nkpk.list().

Piezīme

Pašlaik ierīces, ko atgriež nitrokey.trussed.TrussedDevice.list(), nitrokey.nk3.list() un nitrokey.nkpk.list(), ir derīgas tikai līdz nākamajam jebkuras no šīm funkcijām izsaukumam. Plašāku informāciju sk. 31. jautājumā.

Using Applications

Nitrokey Python SDK atbalsta šīs lietojumprogrammas visām Trussed ierīcēm:

• nitrokey.trussed.admin_app.AdminApp: piekļuve ierīces metadatiem un ierīces konfigurācijas stāvokļa pārvaldība

• nitrokey.trussed.provisioner_app.ProvisionerApp: ierīces iestatīšana provisioner režīmā (attiecas tikai uz Hacker ierīcēm)

The Nitrokey 3 also provides these applications:

• nitrokey.nk3.secrets_app.SecretsApp: droša paroļu un pilnvaru glabāšana

Lai iegūtu vairāk informācijas, skatiet API atsauces uz lietojumprogrammu klasēm.