Namespace Yubico.YubiKey
The Yubico.YubiKey namespace contains the classes that allow the developer to add
YubiKey functionality to an application.
Classes
- ApplicationSession
Abstract base class for sessions with a YubiKey. This class is used to wrap the
IYubiKeyConnectionand provide a way of interacting with the connection that is more convenient for most users.
- BioEnrollSampleResult
Contains the information about a sample provided for Bio enrollment.
- ImageProcessorVersion
Reports the version number of the Image Processor. This is a chip specifically used to process the fingerprint images.
- KeyEntryData
This class contains methods and data that describe the state of the process to provide keys, PINs, and other sensitive data to the SDK.
- MalformedYubiKeyResponseException
The exception thrown when the data received from the YubiKey does not match the expectations of the response class's parser.
- SmartCardMaxApduSizes
This contains the maximum size (in bytes) of APDU commands for the various YubiKey models.
- TemplateStorageVersion
Reports the version number of the Template Storage. This is a secure element that stores fingerprints. It is a chip separate from the primary processing chip which also has a secure element.
- VersionQualifier
Represents a version qualifier for a firmware version. A version qualifier typically includes the firmware version, a type (such as Alpha, Beta, or Final), and an iteration number.
- YubiKeyCompatSwitches
Compatibility switch names that can be used with
AppContext.SetSwitchto control breaking behavioral changes within theYubico.YubiKeylayer.
- YubiKeyDevice
Provides device and enumeration capabilities.
- YubiKeyDeviceEventArgs
This class contains properties that are specific to the event being raised.
- YubiKeyDeviceInfo
This class can be used in commands to set and retrieve detailed device and capabilities information for a YubiKey.
- YubiKeyDeviceListener
This class provides events for YubiKeyDevice arrival and removal.
- YubiKeyFeatureExtensions
A static class containing the HasFeature(IYubiKeyDevice, YubiKeyFeature) extension method.
- YubiKeyResponse
Base class for all YubiKey responses.
- YubiKeyResponse.ResponseStatusPair
Represents a ResponseStatus and StatusMessage pair returned by StatusCodeMap.
Interfaces
- IApduTransform
Represents an arbitrary pipeline that accepts command APDUs and returns response APDUs.
- IGetPagedDeviceInfoCommand<T>
Defines the contract for a command to retrieve paged device information associated with a YubiKey.
- IYubiKeyCommand<TResponse>
An interface for representing a command that can be run on a YubiKey.
- IYubiKeyConnection
Represents a connection to a YubiKey device, enabling the sending of commands and retrieval of responses.
- IYubiKeyDevice
Interface for class that provides device and enumeration capabilities.
- IYubiKeyDeviceInfo
Detailed device and capabilities information for a YubiKey.
- IYubiKeyResponse
This defines the minimal set of information returned by a YubiKey in response to a command.
- IYubiKeyResponseWithData<TData>
An interface which allows for retrieval of returned data.
Enums
- DeviceFlags
Miscellaneous flags representing various settings available on the YubiKey.
- FormFactor
Represents the form-factor of the YubiKey.
- KeyEntryRequest
This lists the possible actions or information the caller is requesting.
- ResponseStatus
An application independent way of reporting the status in a command's response.
- Transport
The communication methods a YubiKey may use to connect with a host device.
- VersionQualifierType
Represents the type of version qualifier for a firmware version. The version qualifier type indicates whether the version is an Alpha, Beta, or Final release.
- YubiKeyCapabilities
A set of flags that describe the capabilities that are currently enabled on a YubiKey.
- YubiKeyFeature
Named YubiKey features or distinct behaviors that have been added or changed over the years that can be queried.
Delegates
- QueryCancel
This delegate defines the signature of a method that can be called to determine if an operation should cancel. The caller supplies a commandByte and the Query responds with
true(the command should be canceled), orfalse(there is no current request that the command be canceled).
- SignalUserCancel
This delegate defines the signature of a method that can be called to let the SDK know that the user is canceling an operation.