Show / Hide Table of Contents

IYubiKeyDevice Interface

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

Interface for class that provides device and enumeration capabilities.

C#
public interface IYubiKeyDevice : IYubiKeyDeviceInfo

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(byte[], ScpKeyParameters)

Initiate a connection to the specified application on a YubiKey device using SCP protocol.

Connect(YubiKeyApplication)

Initiate a connection to the specified application on a YubiKey device.

Connect(YubiKeyApplication, ScpKeyParameters)

Initiate a connection to the specified application on a YubiKey device using SCP protocol.

ConnectScp03(byte[], StaticKeys)
ConnectScp03(YubiKeyApplication, StaticKeys)
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(int)

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

SetChallengeResponseTimeout(int)

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(bool)

Sets the IsNfcRestricted on the YubiKeyDeviceInfo

SetLegacyDeviceConfiguration(YubiKeyCapabilities, byte, bool, int)

Manage configuration settings on YubiKeys prior to firmware version 5.

SetTemporaryTouchThreshold(int)

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(byte[], ScpKeyParameters, out IScpYubiKeyConnection)

Attempt to connect to the YubiKey device over SCP using the specified ScpKeyParameters

TryConnect(YubiKeyApplication, out IYubiKeyConnection)

Attempt to connect to the YubiKey device.

TryConnect(YubiKeyApplication, ScpKeyParameters, out IScpYubiKeyConnection)

Attempt to connect to the YubiKey device over SCP using the specified ScpKeyParameters

TryConnectScp03(byte[], StaticKeys, out IScp03YubiKeyConnection)
TryConnectScp03(YubiKeyApplication, StaticKeys, out IScp03YubiKeyConnection)
UnlockConfiguration(ReadOnlySpan<byte>)

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

Extension Methods

PivSessionExtensions.ThrowIfUnsupportedAlgorithm(IYubiKeyDevice, PivAlgorithm)
YubiKeyFeatureExtensions.HasFeature(IYubiKeyDevice, YubiKeyFeature)
YubiKeyFeatureExtensions.ThrowOnMissingFeature(IYubiKeyDevice, YubiKeyFeature)
In this article
Back to top Generated by DocFX