Usage Guide¶
Das Nitrokey Python SDK unterstützt derzeit Nitrokey 3 (nitrokey.nk3.NK3) und Nitrokey Hauptschlüssel (nitrokey.nkpk.NKPK) Geräte. Beide Geräte basieren auf der gleichen Plattform, Trussed, und teilen sich daher die gleiche Basisklasse nitrokey.trussed.TrussedDevice.
Geräte mit Truss können in einem Bootloader-Modus neu gebootet werden, der für Firmware-Updates verwendet wird. Auf Geräte im Bootloader-Modus kann mit nitrokey.nk3.NK3Bootloader und nitrokey.nkpk.NKPKBootloader (Basisklasse nitrokey.trussed.TrussedBootloader) zugegriffen werden.
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}")
Wenn Sie das Modell kennen, mit dem Sie sich verbinden wollen, können Sie auch die Funktionen list und open in den Modulen nitrokey.nk3 oder nitrokey.nkpk verwenden. Wenn Sie auch den Typ des Geräts kennen, können Sie die Methoden list und open der Klassen nitrokey.nk3.NK3, nitrokey.nkpk.NKPK, nitrokey.nk3.NK3Bootloader und nitrokey.nkpk.NKPKBootloader verwenden.
Using Applications¶
Das Nitrokey Python SDK unterstützt diese Anwendungen für alle Trussed-Geräte:
nitrokey.trussed.admin_app.AdminApp: Zugriff auf Geräte-Metadaten und Verwaltung des Gerätekonfigurationsstatusnitrokey.trussed.provisioner_app.ProvisionerApp: Gerät im Provisioner-Modus einrichten (gilt nur für Hacker-Geräte)
The Nitrokey 3 also provides these applications:
nitrokey.nk3.secrets_app.SecretsApp: Passwörter und Anmeldedaten sicher speichern
Weitere Informationen finden Sie in der API-Referenz für die Anwendungsklassen.