Usage Guide

Nitrokey Python SDK stöder för närvarande Nitrokey 3 (nitrokey.nk3.NK3) och Nitrokey Passkey (nitrokey.nkpk.NKPK) enheter. Båda enheterna är baserade på samma plattform, Trussed, och delar därför samma basklass nitrokey.trussed.TrussedDevice.

Trussed-enheter kan startas om till ett bootloader-läge som används för att tillämpa firmware-uppdateringar. Enheter i bootloader-läge kan nås med hjälp av nitrokey.nk3.NK3Bootloader och nitrokey.nkpk.NKPKBootloader (basklass nitrokey.trussed.TrussedBootloader).

Listing and Opening Devices

Use the nitrokey.trussed.list() function to list and open all connected devices:

import nitrokey.trussed

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

If you know the device path, use nitrokey.trussed.open() instead:

import nitrokey.trussed

path = "/dev/hidraw1"
device = nitrokey.trussed.open(path)
if device is not None:
    print(f"Found {device.name} at {path}")
else:
    print(f"No device found at {path}")

Om du vet vilken modell du vill ansluta till kan du också använda funktionerna list och open i modulerna nitrokey.nk3 eller nitrokey.nkpk. Om du också vet vilken typ av enhet det är kan du använda metoderna list och open i klasserna nitrokey.nk3.NK3, nitrokey.nkpk.NKPK, nitrokey.nk3.NK3Bootloader och nitrokey.nkpk.NKPKBootloader.

Using Applications

Nitrokey Python SDK stöder dessa applikationer för alla Trussed-enheter:

• nitrokey.trussed.admin_app.AdminApp: åtkomst till enhetsmetadata och hantering av enhetskonfigurationsstatus

• nitrokey.trussed.provisioner_app.ProvisionerApp: ställa in enheten i provisionerläge (endast tillämpligt för Hacker-enheter)

The Nitrokey 3 also provides these applications:

• nitrokey.nk3.secrets_app.SecretsApp: lagra lösenord och autentiseringsuppgifter på ett säkert sätt

Se API-referensen för applikationsklasserna för mer information.