Usage Guide¶
Šiuo metu „Nitrokey Python SDK“ palaiko „Nitrokey 3“ (nitrokey.nk3.NK3
) ir „Nitrokey Passkey“ (nitrokey.nkpk.NKPK
) įrenginius. Abu įrenginiai yra pagrįsti ta pačia platforma Trussed, todėl turi tą pačią bazinę klasę nitrokey.trussed.TrussedDevice
.
Įrenginius su trišakiais galima perkrauti į įkrovos įkroviklio režimą, kuris naudojamas programinės aparatinės įrangos atnaujinimams taikyti. Prietaisus įkroviklio režimu galima pasiekti naudojant nitrokey.nk3.NK3Bootloader
ir nitrokey.nkpk.NKPKBootloader
(bazinė klasė nitrokey.trussed.TrussedBootloader
).
Listing and Opening Devices¶
Naudokite nitrokey.trussed.TrussedDevice.list()
funkciją, kad išvardytumėte ir atidarytumėte visus prijungtus įrenginius:
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}")
Jei žinote įrenginio kelią, vietoj jo naudokite 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}")
Panašios funkcijos prieinamos nitrokey.nk3.NK3Bootloader
ir nitrokey.nkpk.NKPKBootloader
. Jei norite išvardyti ir įprastus, ir įkroviklio įrenginius, naudokite nitrokey.nk3.list()
ir nitrokey.nkpk.list()
.
Pastaba
Šiuo metu įrenginiai, kuriuos grąžina nitrokey.trussed.TrussedDevice.list()
, nitrokey.nk3.list()
ir nitrokey.nkpk.list()
, galioja tik iki kito bet kurios iš šių funkcijų iškvietimo. Daugiau informacijos žr. 31 klausimą.
Using Applications¶
„Nitrokey Python SDK“ palaiko šias programas visiems „Trussed“ įrenginiams:
nitrokey.trussed.admin_app.AdminApp
: prieiga prie įrenginio metaduomenų ir įrenginio konfigūracijos būsenos valdymasnitrokey.trussed.provisioner_app.ProvisionerApp
: įrenginio nustatymas provisioner režimu (taikoma tik Hacker įrenginiams)
The Nitrokey 3 also provides these applications:
nitrokey.nk3.secrets_app.SecretsApp
: saugiai saugokite slaptažodžius ir įgaliojimus
Daugiau informacijos rasite taikomųjų programų klasių API nuorodoje.