nitrokey.trussed

Submodules

Příhradové objekty zařízení

class nitrokey.trussed.TrussedBase

Základní třída pro zařízení Nitrokey používající rámec Trussed a spouštějící firmware nebo zavaděč.

abstract close()
Typ návratové hodnoty:

None

abstract reboot()
Typ návratové hodnoty:

bool

abstract uuid()
Typ návratové hodnoty:

Uuid | None

abstract property name: str
abstract property path: str
abstract property pid: int
property vid: int
class nitrokey.trussed.TrussedDevice

Báze: TrussedBase

__init__(device, fido2_certs)
Parametry:
  • device (CtapHidDevice)

  • fido2_certs (Sequence[Fido2Certs])

Typ návratové hodnoty:

None

close()
Typ návratové hodnoty:

None

abstract classmethod from_device(device)
Parametry:

device (CtapHidDevice)

Typ návratové hodnoty:

T

classmethod list()
Typ návratové hodnoty:

list[T]

classmethod open(path)
Parametry:

path (str)

Typ návratové hodnoty:

T | None

reboot()
Typ návratové hodnoty:

bool

uuid()
Typ návratové hodnoty:

Uuid | None

wink()
Typ návratové hodnoty:

None

property path: str
class nitrokey.trussed.TrussedBootloader

Báze: TrussedBase

abstract update(image, callback=None)
Parametry:
  • image (bytes)

  • callback (Callable[[int, int], None] | None)

Typ návratové hodnoty:

None

abstract property variant: Variant

Update Container Objects

nitrokey.trussed.parse_firmware_image(variant, data, model)
Parametry:
Typ návratové hodnoty:

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)
Parametry:
Typ návratové hodnoty:

None

classmethod parse(path, model)
Parametry:
  • path (str | BytesIO)

  • model (Model)

Typ návratové hodnoty:

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)
Parametry:
  • version (Version)

  • signed_by (str | None)

  • signed_by_nitrokey (bool)

Typ návratové hodnoty:

None

signed_by: str | None = None
signed_by_nitrokey: bool = False
version: Version
class nitrokey.trussed.Variant

Základy: Enum

classmethod from_str(s)
Parametry:

s (str)

Typ návratové hodnoty:

Variant

LPC55 = 'lpc55'
NRF52 = 'nrf52'

Užitečné objekty

class nitrokey.trussed.App

Základy: Enum

Příkazy CTAPHID specifické pro dodavatele pro aplikace Trussed.

ADMIN = 114
PROVISIONER = 113
SECRETS = 112
class nitrokey.trussed.Fido2Certs

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

__init__(start, hashes)
Parametry:
  • start (Version)

  • hashes (list[str])

Typ návratové hodnoty:

None

static get(certs, version)
Parametry:
Typ návratové hodnoty:

Fido2Certs | None

hashes: list[str]
start: Version
class nitrokey.trussed.Model

Základy: Enum

classmethod from_str(s)
Parametry:

s (str)

Typ návratové hodnoty:

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)
Parametry:

value (int)

Typ návratové hodnoty:

None

value: int
class nitrokey.trussed.Version

Verze zařízení Nitrokey Trussed podle sémantického verzování 2.0.0.

Některé zdroje informací o verzi, konkrétně verze vrácená staršími zařízeními a binární soubory firmwaru, neobsahují složku před vydáním. Tyto případy jsou označeny complete=False. Tento příznak ovlivňuje porovnávání: Verze před vydáním je brána v úvahu pouze tehdy, pokud jsou obě instance verzí úplné.

>>> 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)
Parametry:
  • major (int)

  • minor (int)

  • patch (int)

  • pre (str | None)

  • build (str | None)

  • complete (bool)

Typ návratové hodnoty:

None

core()

Vrací základní část této verze, tj. verzi bez komponent pre-release a build.

>>> 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)
Typ návratové hodnoty:

Version

classmethod from_int(version)
Parametry:

version (int)

Typ návratové hodnoty:

Version

classmethod from_str(s)
Parametry:

s (str)

Typ návratové hodnoty:

Version

classmethod from_v_str(s)
Parametry:

s (str)

Typ návratové hodnoty:

Version

build: str | None = None
complete: bool = False
major: int
minor: int
patch: int
pre: str | None = None

Trussed Exceptions

class nitrokey.trussed.TrussedException

Základy: Exception

class nitrokey.trussed.TimeoutException

Báze: TrussedException

__init__()
Typ návratové hodnoty:

None