nitrokey.trussed¶

Submodules

Gebundene Geräteobjekte¶

class nitrokey.trussed.TrussedBase¶

Basisklasse für Nitrokey-Geräte, die das Trussed-Framework verwenden und auf denen die Firmware oder der Bootloader läuft.

abstract close()¶

Rückgabetyp:: None

abstract reboot()¶

Rückgabetyp:: bool

abstract uuid()¶

Rückgabetyp:: Uuid | None

abstract property name: str¶

abstract property path: str¶

abstract property pid: int¶

property vid: int¶

class nitrokey.trussed.TrussedDevice¶

Basen: TrussedBase

__init__(device, fido2_certs)¶

Parameter:

device (CtapHidDevice)
fido2_certs (Sequence[Fido2Certs])

Rückgabetyp:

None

close()¶

Rückgabetyp:: None

abstract classmethod from_device(device)¶

Parameter:: device (CtapHidDevice)
Rückgabetyp:: T

classmethod list()¶

Rückgabetyp:: list[T]

classmethod open(path)¶

Parameter:: path (str)
Rückgabetyp:: T | None

reboot()¶

Rückgabetyp:: bool

uuid()¶

Rückgabetyp:: Uuid | None

wink()¶

Rückgabetyp:: None

property path: str¶

class nitrokey.trussed.TrussedBootloader¶

Basen: TrussedBase

abstract update(image, callback=None)¶

Parameter:

image (bytes)
callback (Callable[[int, int], None] | None)

Rückgabetyp:

None

abstract property variant: Variant¶

Update Container Objects¶

nitrokey.trussed.parse_firmware_image(variant, data, model)¶

Parameter:

variant (Variant)
data (bytes)
model (Model)

Rückgabetyp:

FirmwareMetadata

class nitrokey.trussed.FirmwareContainer¶

FirmwareContainer(version: nitrokey.trussed._utils.Version, pynitrokey: Optional[nitrokey.trussed._utils.Version], images: Dict[nitrokey.trussed._bootloader.Variant, bytes])

__init__(version, pynitrokey, images)¶

Parameter:

version (Version)
pynitrokey (Version | None)
images (Dict[Variant, bytes])

Rückgabetyp:

None

classmethod parse(path, model)¶

Parameter:

path (str | BytesIO)
model (Model)

Rückgabetyp:

FirmwareContainer

images: Dict[Variant, bytes]¶

pynitrokey: Version | None¶

version: Version¶

class nitrokey.trussed.FirmwareMetadata¶

FirmwareMetadata(version: nitrokey.trussed._utils.Version, signed_by: Optional[str] = None, signed_by_nitrokey: bool = False)

__init__(version, signed_by=None, signed_by_nitrokey=False)¶

Parameter:

version (Version)
signed_by (str | None)
signed_by_nitrokey (bool)

Rückgabetyp:

None

signed_by: str | None = None¶

signed_by_nitrokey: bool = False¶

version: Version¶

class nitrokey.trussed.Variant¶

Basen: Enum

classmethod from_str(s)¶

Parameter:: s (str)
Rückgabetyp:: Variant

LPC55 = 'lpc55'¶

NRF52 = 'nrf52'¶

Utility-Objekte¶

class nitrokey.trussed.App¶

Basen: Enum

Anbieterspezifische CTAPHID-Befehle für Trussed-Anwendungen.

ADMIN = 114¶

PROVISIONER = 113¶

SECRETS = 112¶

class nitrokey.trussed.Fido2Certs¶

Fido2Certs(start: nitrokey.trussed._utils.Version, hashes: list[str])

__init__(start, hashes)¶

Parameter:

start (Version)
hashes (list[str])

Rückgabetyp:

None

static get(certs, version)¶

Parameter:

certs (Sequence[Fido2Certs])
version (Version)

Rückgabetyp:

Fido2Certs | None

hashes: list[str]¶

start: Version¶

class nitrokey.trussed.Model¶

Basen: Enum

classmethod from_str(s)¶

Parameter:: s (str)
Rückgabetyp:: Model

NK3 = 'Nitrokey 3'¶

NKPK = 'Nitrokey Passkey'¶

property firmware_pattern: Pattern[str]¶

property firmware_repository: Repository¶

class nitrokey.trussed.Uuid¶

UUID of a Nitrokey Trussed device.

__init__(value)¶

Parameter:: value (int)
Rückgabetyp:: None

value: int¶

class nitrokey.trussed.Version¶

Die Version eines Nitrokey Trussed-Gerätes, gemäß Semantic Versioning 2.0.0.

Einige Quellen für Versionsinformationen, nämlich die von älteren Geräten zurückgegebene Version und die Firmware-Binärdateien, enthalten nicht die Vorveröffentlichungskomponente. Diese Instanzen sind mit complete=False gekennzeichnet. Dieses Flag beeinflusst den Vergleich: Die Vorabversion wird nur berücksichtigt, wenn beide Versionsinstanzen vollständig sind.

>>> Version(1, 0, 0)
Version(major=1, minor=0, patch=0, pre=None, build=None)
>>> Version.from_str("1.0.0")
Version(major=1, minor=0, patch=0, pre=None, build=None)
>>> Version.from_v_str("v1.0.0")
Version(major=1, minor=0, patch=0, pre=None, build=None)
>>> Version(1, 0, 0, "rc.1")
Version(major=1, minor=0, patch=0, pre='rc.1', build=None)
>>> Version.from_str("1.0.0-rc.1")
Version(major=1, minor=0, patch=0, pre='rc.1', build=None)
>>> Version.from_v_str("v1.0.0-rc.1")
Version(major=1, minor=0, patch=0, pre='rc.1', build=None)
>>> Version.from_v_str("v1.0.0-rc.1+git")
Version(major=1, minor=0, patch=0, pre='rc.1', build='git')

__init__(major, minor, patch, pre=None, build=None, complete=False)¶

Parameter:

major (int)
minor (int)
patch (int)
pre (str | None)
build (str | None)
complete (bool)

Rückgabetyp:

None

core()¶

Gibt den Kernteil dieser Version zurück, d. h. die Version ohne die Vorabveröffentlichungs- und Build-Komponenten.

>>> Version(1, 0, 0).core()
Version(major=1, minor=0, patch=0, pre=None, build=None)
>>> Version(1, 0, 0, "rc.1").core()
Version(major=1, minor=0, patch=0, pre=None, build=None)
>>> Version(1, 0, 0, "rc.1", "git").core()
Version(major=1, minor=0, patch=0, pre=None, build=None)

Rückgabetyp:: Version

classmethod from_int(version)¶

Parameter:: version (int)
Rückgabetyp:: Version

classmethod from_str(s)¶

Parameter:: s (str)
Rückgabetyp:: Version

classmethod from_v_str(s)¶

Parameter:: s (str)
Rückgabetyp:: Version

build: str | None = None¶

complete: bool = False¶

major: int¶

minor: int¶

patch: int¶

pre: str | None = None¶

Trussed Exceptions¶

class nitrokey.trussed.TrussedException¶: Basen: Exception

class nitrokey.trussed.TimeoutException¶

Basen: TrussedException

__init__()¶

Rückgabetyp:: None