Show / Hide Table of Contents

Classes

CalculateAllCredentialsCommand

Performs CALCULATE of OTP (One-Time Password) values for all available credentials on the YubiKey.

CalculateAllCredentialsResponse

The response to the CalculateAllCredentialsCommand command, containing the response from the oath application.

CalculateCredentialCommand

Performs CALCULATE of OTP (One-Time Password) values for one named credential.

CalculateCredentialResponse

The response to the CalculateCredentialCommand command, containing the response from the oath application.

DeleteCommand

Deletes an existing credential.

DeleteResponse

The response to the DeleteCommand command.

GetResponseCommand

Gets additional response data from the previously issued command.

ListCommand

Lists configured credentials on the YubiKey.

ListResponse

The response to the ListCommand command, containing the YubiKey's configured credentials list.

OathChallengeResponseBaseCommand

Provides helper methods that are used to calculate challenge-response for the commands: SetPassword, Validate, CalculateCredential, CalculateAllCredentials.

OathResponse

Base class for all OATH responses. Use this class to represent the status of an OATH command, or one of its derived classes to retrieve the full response.

PutCommand

Adds or overwrites an OATH credential.

RenameCommand

Renames an existing credential by setting new issuer and account names. This command is only available on the YubiKeys with firmware version 5.3.0 and later.

RenameResponse

The response to the RenameCommand command.

ResetCommand

Resets the YubiKey's OATH application back to a factory default state.

SelectOathCommand

Selects an OATH application.

SelectOathResponse

The response to the SelectOathCommand command, containing the YubiKey's OATH application info.

SetPasswordCommand

Configures Authentication. If length 0 is sent, authentication is removed. The key to be set is expected to be a user-supplied UTF-8 encoded password passed through 1000 rounds of PBKDF2 with the ID from SelectOathResponse used as salt. 16 bytes of that are used. When configuring authentication you are required to send an 8 byte challenge and one authentication-response with that key, in order to confirm that the application and the host software can calculate the same response for that key.

SetPasswordResponse

The response to the SetPasswordCommand command.

ValidateCommand

Validates authentication (mutually). The challenge for this comes from the SelectOathResponse. The response computed by performing the correct HMAC function of that challenge with the correct secret. A new challenge is then sent to the application along with the response. The application will then respond with a similar calculation that the host software can verify.

ValidateResponse

The response to the ValidateCommand command, containing the response from the oath application.

In this article
Back to top Generated by DocFX