Show / Hide Table of Contents

Classes

AuthenticateCommand

The base class for some of the General Authenticate command classes, containing shared code.

AuthenticateDecryptCommand

Decrypt data using the private RSA key in one of the PIV slots.

AuthenticateDecryptResponse

The response to the authenticate: decrypt command, containing the plaintext result of the YubiKey's private key operation.

AuthenticateKeyAgreeCommand

Perform phase 2 of EC Diffie-Hellman key agreement using the private ECC key in one of the PIV slots.

AuthenticateKeyAgreeResponse

The response to the authenticate: key agree command, containing the shared secret result of the YubiKey's private key operation.

AuthenticateResponse

The base class for some of the General Authenticate response classes, containing shared code.

AuthenticateSignCommand

Build a digital signature using the private key in one of the PIV slots.

AuthenticateSignResponse

The response to the authenticate: sign command, containing the signature built by the YubiKey.

ChangeReferenceDataCommand

Change the PIN or PUK.

ChangeReferenceDataResponse

The response to changing the PIN or PUK.

CompleteAuthenticateManagementKeyCommand

Complete the process to authenticate the PIV management key.

CompleteAuthenticateManagementKeyResponse

The response to the complete authenticate management key command.

CreateAttestationStatementCommand

Build an attestation statement for a private key in a specified slot.

CreateAttestationStatementResponse

The response to the create attestation statement command, containing the cert created.

DeleteKeyCommand

The DeleteKeyCommand is used to delete a PIV key from the target slot. Any key, including the attestation key, can be deleted.

DeleteKeyResponse

The DeleteKeyResponse for the corresponding DeleteKeyCommand.

GenerateKeyPairCommand

Generate a new asymmetric key pair.

GenerateKeyPairResponse

The response to the generate key pair command, containing the public key of the pair that was generated.

GetBioMetadataCommand

Get information about a YubiKey Bio multi-protocol key.

GetBioMetadataResponse

The response to GetBioMetadataCommand containing YubiKey Bio Metadata about a particular key.

GetDataCommand

Get a Data Object from the YubiKey.

GetDataResponse

The response to the get data command, containing the information requested.

GetMetadataCommand

Get information about the key in a specified slot.

GetMetadataResponse

The response to the get metadata command, containing information about a particular key.

GetSerialNumberCommand

Get the YubiKey's serial number.

GetSerialNumberResponse

The response to the get serial number command, containing the YubiKey's serial number.

ImportAsymmetricKeyCommand

Import an existing private key into one of the asymmetric key slots (9a, 9c, 9d, 9e, 82 - 95).

ImportAsymmetricKeyResponse

The response to the import asymmetric key command, containing the result of the import process.

InitializeAuthenticateManagementKeyCommand

Initiate the process to authenticate the PIV management key.

InitializeAuthenticateManagementKeyResponse

The response to the initialize authenticate management key command.

MoveKeyCommand

The MoveKeyCommand is used to move a PIV key from one slot to another. The source slot must not be the Attestation slot, and the destination slot must be empty.

MoveKeyResponse

The MoveKeyResponse for the corresponding MoveKeyCommand.

PivResponse

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

PutDataCommand

Put a Data Object onto the YubiKey in a storage location.

PutDataResponse

The response to the PUT DATA command.

ResetPivCommand

Reset the YubiKey's PIV application

ResetPivResponse

The response to the resetting the PIV application.

ResetRetryCommand

Reset the PIN, using the PUK (PIN Unblocking Key).

ResetRetryResponse

The response to resetting the PIN, using the PUK (PIN Unblocking Key).

SetManagementKeyCommand

Set the value of the PIV management key.

SetManagementKeyResponse

The result of setting the value of the PIV management key.

SetPinRetriesCommand

Set the number of retries for the PIN and PUK.

SetPinRetriesResponse

The response to the setting the number of retries for the PIN or PUK.

VerifyPinCommand

Verify the PIV PIN.

VerifyPinResponse

The response to verifying the PIN.

VerifyTemporaryPinCommand

Verify the PIV Bio temporary PIN.

VerifyTemporaryPinResponse

The response to verifying the temporary PIN.

VerifyUvCommand

Authenticate with YubiKey Bio multi-protocol capabilities.

VerifyUvResponse

The response to biometric verification.

VersionCommand

Get the YubiKey's firmware version number.

VersionResponse

The response to the get version command, containing the YubiKey's firmware version.

In this article
Back to top Generated by DocFX