Usage Guide

De Nitrokey Python SDK ondersteunt momenteel Nitrokey 3 (nitrokey.nk3.NK3) en Nitrokey Passkey (nitrokey.nkpk.NKPK) apparaten. Beide apparaten zijn gebaseerd op hetzelfde platform, Trussed, en delen daarom dezelfde basisklasse nitrokey.trussed.TrussedDevice.

Apparaten met een truss kunnen opnieuw worden opgestart in een bootloadermodus die wordt gebruikt om firmware-updates toe te passen. Apparaten in bootloader-modus zijn toegankelijk met nitrokey.nk3.NK3Bootloader en nitrokey.nkpk.NKPKBootloader (basisklasse nitrokey.trussed.TrussedBootloader).

Listing and Opening Devices

Gebruik de nitrokey.trussed.trussedDevice.list() functie om alle aangesloten apparaten op te sommen en te openen:

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}")

Als je het apparaatpad weet, gebruik dan 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}")

Soortgelijke functies zijn beschikbaar voor nitrokey.nk3.NK3Bootloader en nitrokey.nkpk.NKPKBootloader. Gebruik nitrokey.nk3.list() en nitrokey.nkpk.list() om zowel normale als bootloader apparaten op te sommen.

Notitie

Momenteel zijn de apparaten die worden geretourneerd door nitrokey.trussed.TrussedDevice.list(), nitrokey.nk3.list() en nitrokey.nkpk.list() alleen geldig tot de volgende oproep aan een van deze functies. Zie issue 31 voor meer informatie.

Using Applications

De Nitrokey Python SDK ondersteunt deze toepassingen voor alle Trussed apparaten:

The Nitrokey 3 also provides these applications:

Raadpleeg de API-referentie voor de applicatieklassen voor meer informatie.