ykman.hid

Submodules

• ykman.hid.base
• ykman.hid.freebsd
• ykman.hid.linux
• ykman.hid.macos
• ykman.hid.windows

Attributes

list_otp_devices

Classes

YkmanDevice	YubiKey device reference, with optional PID
OtpYubiKeyDevice	YubiKey USB HID OTP device
backend
CtapYubiKeyDevice	YubiKey FIDO USB HID device

Package Contents

class ykman.hid.YkmanDevice(transport, fingerprint, pid)

Bases: yubikit.core.YubiKeyDevice

YubiKey device reference, with optional PID

Parameters:

• transport (yubikit.core.TRANSPORT)

• fingerprint (Hashable)

• pid (Optional[yubikit.core.PID])

property pid: yubikit.core.PID | None

Return the PID of the YubiKey, if available.

Return type:

Optional[yubikit.core.PID]

__repr__()

class ykman.hid.OtpYubiKeyDevice(path, pid, connection_cls)

Bases: ykman.base.YkmanDevice

YubiKey USB HID OTP device

path

supports_connection(connection_type)

Check if a YubiKeyDevice supports a specific Connection type

open_connection(connection_type)

Opens a connection to the YubiKey

class ykman.hid.backend

static list_devices()

Abstractmethod:

ykman.hid.list_otp_devices: Callable[[], list[base.OtpYubiKeyDevice]]

class ykman.hid.CtapYubiKeyDevice(descriptor)

Bases: ykman.base.YkmanDevice

YubiKey FIDO USB HID device

descriptor

supports_connection(connection_type)

Check if a YubiKeyDevice supports a specific Connection type

open_connection(connection_type)

Opens a connection to the YubiKey