Usage Guide¶
Nitrokey Python SDK tukee tällä hetkellä Nitrokey 3 (nitrokey.nk3.NK3) ja Nitrokey Passkey (nitrokey.nkpk.NKPK) laitteita. Molemmat laitteet perustuvat samaan alustaan, Trussediin, ja siksi niillä on sama perusluokka nitrokey.trussed.TrussedDevice.
Trussatut laitteet voidaan käynnistää uudelleen bootloader-tilaan, jota käytetään laiteohjelmistopäivitysten käyttöönotossa. Käynnistyslataustilassa olevia laitteita voidaan käyttää nitrokey.nk3.NK3Bootloader ja nitrokey.nkpk.NKPKBootloader (perusluokka nitrokey.trussed.TrussedBootloader).
Listing and Opening Devices¶
Käytä nitrokey.trussed.TrussedDevice.list()-funktiota luetellaksesi ja avataksesi kaikki liitetyt laitteet:
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}")
Jos tiedät laitteen polun, käytä nitrokey.trussed.TrussedDevice.open() sen sijaan:
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}")
Samanlaisia toimintoja on saatavilla nitrokey.nk3.NK3Bootloader ja nitrokey.nkpk.NKPKBootloader. Jos haluat luetella sekä normaalit että käynnistyslatauslaitteet, käytä nitrokey.nk3.list() ja nitrokey.nkpk.list().
Muista
Tällä hetkellä nitrokey.trussed.TrussedDevice.list(), nitrokey.nk3.list() ja nitrokey.nkpk.list() palauttamat laitteet ovat voimassa vain siihen asti, kunnes näitä funktioita kutsutaan seuraavan kerran. Katso lisätietoja osoitteesta issue 31.
Using Applications¶
Nitrokey Python SDK tukee näitä sovelluksia kaikille Trussed-laitteille:
nitrokey.trussed.admin_app.AdminApp: Pääsy laitteen metatietoihin ja laitteen konfiguraatiotilan hallinta.nitrokey.trussed.provisioner_app.ProvisionerApp: Laitteen asettaminen provisiointitilaan (koskee vain Hacker-laitteita).
The Nitrokey 3 also provides these applications:
nitrokey.nk3.secrets_app.SecretsApp: salasanojen ja tunnistetietojen turvallinen tallennus.
Lisätietoja on sovellusluokkien API-viitteessä.