ykman.device

Functions

list_ccid_devices()

List CCID devices.

list_ctap_devices()

List CTAP devices.

list_otp_devices()

List OTP devices.

scan_devices()

Scan USB for attached YubiKeys, without opening any connections.

list_all_devices([connection_types])

Connect to all attached YubiKeys and read device info from them.

Module Contents

ykman.device.list_ccid_devices()[source]

List CCID devices.

ykman.device.list_ctap_devices()[source]

List CTAP devices.

ykman.device.list_otp_devices()[source]

List OTP devices.

ykman.device.scan_devices()[source]

Scan USB for attached YubiKeys, without opening any connections.

Returns:

A dict mapping PID to device count, and a state object which can be used to detect changes in attached devices.

Return type:

tuple[Mapping[yubikit.core.PID, int], int]

ykman.device.list_all_devices(connection_types=_CONNECTION_LIST_MAPPING.keys())[source]

Connect to all attached YubiKeys and read device info from them.

Parameters:

connection_types (Iterable[type[yubikit.core.Connection]]) – An iterable of YubiKey connection types.

Returns:

A list of (device, info) tuples for each connected device.

Return type:

list[tuple[ykman.base.YkmanDevice, yubikit.management.DeviceInfo]]