Show / Hide Table of Contents

IYubiKeyCommand<TResponse> Interface

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

An interface for representing a command that can be run on a YubiKey.

C#
public interface IYubiKeyCommand<out TResponse> where TResponse : IYubiKeyResponse
Type Parameters
Class.Header.Syntax.TypeParameters:Name Description
TResponse

The concrete type of the response to this command.

Remarks

Classes that implement this interface represent a low level command that can be Sent to the YubiKey.

An implementation of this interface can be thought of as a factory class for creating the necessary CommandApdu to send to the YubiKey (but does not actually send it itself). In addition, the implementation serves as a factory for creating the necessary IYubiKeyResponse based on the ResponseApdu.

Derived classes should expose strongly typed properties and methods to take in the parameters and data that the YubiKey command requires.

Properties

Name Description
Application

Gets the YubiKeyApplication (e.g. PIV, OATH, etc.) to which this command applies.

Methods

Name Description
CreateCommandApdu()

Creates a well-formed CommandApdu to send to the YubiKey.

CreateResponseForApdu(ResponseApdu)

Creates the corresponding IYubiKeyResponse implementation for the current command.

In this article
Back to top Generated by DocFX