nitrokey.trussed

Submodules

Feszített eszköz tárgyak

class nitrokey.trussed.TrussedBase

Alaposztály a Trussed keretrendszert használó és a firmware-t vagy a bootloadert futtató Nitrokey eszközökhöz.

abstract close()
Visszatérés típusa:

None

abstract reboot()
Visszatérés típusa:

bool

abstract uuid()
Visszatérés típusa:

Uuid | None

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

Alapok: TrussedBase

__init__(device, fido2_certs)
Paraméterek:

  • device (CtapHidDevice)

  • fido2_certs (Sequence[Fido2Certs])

Visszatérés típusa:

None

close()
Visszatérés típusa:

None

abstract classmethod from_device(device)
Paraméterek:

device (CtapHidDevice)

Visszatérés típusa:

T

classmethod list()
Visszatérés típusa:

list[T]

classmethod open(path)
Paraméterek:

path (str)

Visszatérés típusa:

T | None

reboot()
Visszatérés típusa:

bool

uuid()
Visszatérés típusa:

Uuid | None

wink()
Visszatérés típusa:

None

property path: str
class nitrokey.trussed.TrussedBootloader

Alapok: TrussedBase

abstract update(image, callback=None)
Paraméterek:

  • image (bytes)

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

Visszatérés típusa:

None

abstract property variant: Variant

Update Container Objects

nitrokey.trussed.parse_firmware_image(variant, data, model)
Paraméterek:
Visszatérés típusa:

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)
Paraméterek:
Visszatérés típusa:

None

classmethod parse(path, model)
Paraméterek:

  • path (str | BytesIO)

  • model (Model)

Visszatérés típusa:

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)
Paraméterek:

  • version (Version)

  • signed_by (str | None)

  • signed_by_nitrokey (bool)

Visszatérés típusa:

None

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

Alapok: Enum

classmethod from_str(s)
Paraméterek:

s (str)

Visszatérés típusa:

Variant

LPC55 = 'lpc55'
NRF52 = 'nrf52'

Hasznos objektumok

class nitrokey.trussed.App

Alapok: Enum

Szállítónk-specifikus CTAPHID parancsok a Trussed alkalmazásokhoz.

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

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

__init__(start, hashes)
Paraméterek:

  • start (Version)

  • hashes (list[str])

Visszatérés típusa:

None

static get(certs, version)
Paraméterek:
Visszatérés típusa:

Fido2Certs | None

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

Alapok: Enum

classmethod from_str(s)
Paraméterek:

s (str)

Visszatérés típusa:

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)
Paraméterek:

value (int)

Visszatérés típusa:

None

value: int
class nitrokey.trussed.Version

A Nitrokey Trussed eszköz verziója, a Semantic Versioning 2.0.0 szerint.

A verzióinformáció néhány forrása, nevezetesen a régebbi eszközök által visszaküldött verzió és a firmware bináris állományai nem tartalmazzák a kiadás előtti komponenst. Ezeket az eseteket a complete=False jelöli. Ez a jelző befolyásolja az összehasonlítást: A kiadás előtti változatot csak akkor veszi figyelembe a rendszer, ha mindkét verzió példánya teljes.

>>> 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)
Paraméterek:

  • major (int)

  • minor (int)

  • patch (int)

  • pre (str | None)

  • build (str | None)

  • complete (bool)

Visszatérés típusa:

None

core()

Visszaadja ennek a verziónak az alaprészét, azaz a kiadás előtti és a build komponensek nélküli verziót.

>>> 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)
Visszatérés típusa:

Version

classmethod from_int(version)
Paraméterek:

version (int)

Visszatérés típusa:

Version

classmethod from_str(s)
Paraméterek:

s (str)

Visszatérés típusa:

Version

classmethod from_v_str(s)
Paraméterek:

s (str)

Visszatérés típusa:

Version

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

Trussed Exceptions

class nitrokey.trussed.TrussedException

Alapok: Exception

class nitrokey.trussed.TimeoutException

Alapok: TrussedException

__init__()
Visszatérés típusa:

None