Usage Guide¶
Nitrokey Python SDK v súčasnosti podporuje zariadenia Nitrokey 3 (nitrokey.nk3.NK3
) a Nitrokey Passkey (nitrokey.nkpk.NKPK
). Obe zariadenia sú založené na rovnakej platforme Trussed, a preto majú rovnakú základnú triedu nitrokey.trussed.TrussedDevice
.
Zariadenia s priehradkami možno reštartovať do režimu zavádzača, ktorý sa používa na aktualizácie firmvéru. Zariadenia v režime zavádzača možno sprístupniť pomocou nitrokey.nk3.NK3Bootloader
a nitrokey.nkpk.NKPKBootloader
(základná trieda nitrokey.trussed.TrussedBootloader
).
Listing and Opening Devices¶
Použite funkciu nitrokey.trussed.TrussedDevice.list()
na vypísanie a otvorenie všetkých pripojených zariadení:
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}")
Ak poznáte cestu k zariadeniu, použite namiesto toho 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}")
Podobné funkcie sú k dispozícii pre nitrokey.nk3.NK3Bootloader
a nitrokey.nkpk.NKPKBootloader
. Ak chcete zobraziť zoznam normálnych zariadení aj zariadení s bootloaderom, použite nitrokey.nk3.list()
a nitrokey.nkpk.list()
.
Poznámka
V súčasnosti sú zariadenia vrátené funkciami nitrokey.trussed.TrussedDevice.list()
, nitrokey.nk3.list()
a nitrokey.nkpk.list()
platné len do ďalšieho volania niektorej z týchto funkcií. Viac informácií nájdete na issue 31.
Using Applications¶
Nitrokey Python SDK podporuje tieto aplikácie pre všetky zariadenia Trussed:
nitrokey.trussed.admin_app.AdminApp
: prístup k metadátam zariadenia a správa stavu konfigurácie zariadenianitrokey.trussed.provisioner_app.ProvisionerApp
: nastavenie zariadenia v režime provisioner (platí len pre zariadenia Hacker)
The Nitrokey 3 also provides these applications:
nitrokey.nk3.secrets_app.SecretsApp
: bezpečné ukladanie hesiel a poverení
Viac informácií nájdete v referencii API pre triedy aplikácie.