IYubiKeyDevice Interface

Namespace: Yubico.YubiKey Assembly: Yubico.YubiKey.dll

Interface for class that provides device and enumeration capabilities.

C#
public interface IYubiKeyDevice : IYubiKeyDeviceInfo, IEquatable<IYubiKeyDevice>, IComparable<IYubiKeyDevice>

Properties

Name Description
AvailableTransports

Indicates which logical device transports are available to this YubiKey device.

Methods

Name Description
Connect(Byte[])

Initiate a connection to the specified application represented as an applicationId on a YubiKey device.
Connect(YubiKeyApplication)

Initiate a connection to the specified application on a YubiKey device.
ConnectScp03(Byte[], StaticKeys)

Initiate a connection to the specified application represented as an applicationId on a YubiKey device. The connection will be made over SCP03 (assuming the keys are the ones loaded onto the YubiKey).
ConnectScp03(YubiKeyApplication, StaticKeys)

Initiate a connection to the specified application on a YubiKey device. The connection will be made over SCP03 (assuming the keys are the ones loaded onto the YubiKey).
DeviceReset()

Perform a device-wide factory reset on a YubiKey Bio Multi-protocol Edition key.
LockConfiguration(ReadOnlySpan<Byte>)

Sets a configuration lock code, which prevents changes to YubiKey's user-settable IYubiKeyDeviceInfo values.
SetAutoEjectTimeout(Int32)

Sets the CCID auto-eject timeout (in seconds).
SetChallengeResponseTimeout(Int32)

Sets the timeout on OTP challenge-response operations.
SetDeviceFlags(DeviceFlags)

Modifies the value of DeviceFlags.
SetEnabledNfcCapabilities(YubiKeyCapabilities)

Sets which NFC features are enabled (and disabled).
SetEnabledUsbCapabilities(YubiKeyCapabilities)

Sets which USB features are enabled (and disabled).
SetIsNfcRestricted(Boolean)

Sets the IsNfcRestricted on the YubiKeyDeviceInfo
SetLegacyDeviceConfiguration(YubiKeyCapabilities, Byte, Boolean, Int32)

Manage configuration settings on YubiKeys prior to firmware version 5.
SetTemporaryTouchThreshold(Int32)

Temporarily set the threshold at which a capacitive touch should be considered active.
TryConnect(Byte[], out IYubiKeyConnection)

Attempt to connect to the YubiKey device.
TryConnect(YubiKeyApplication, out IYubiKeyConnection)

Attempt to connect to the YubiKey device.
TryConnectScp03(Byte[], StaticKeys, out IScp03YubiKeyConnection)

Attempt to connect to the YubiKey device. The connection will be made over SCP03 (assuming the keys are the ones loaded onto the YubiKey).
TryConnectScp03(YubiKeyApplication, StaticKeys, out IScp03YubiKeyConnection)

Attempt to connect to the YubiKey device. The connection will be made over SCP03 (assuming the keys are the ones loaded onto the YubiKey).
UnlockConfiguration(ReadOnlySpan<Byte>)

Removes the configuration lock code, allowing changes to YubiKey's user-settable IYubiKeyDeviceInfo values.

Extension Methods