Class EnumerateCredentialsBeginCommand

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

Begin the process of getting information on all the credentials associated with a specific relying party stored on the YubiKey.

public class EnumerateCredentialsBeginCommand : CredentialMgmtSubCommand, IYubiKeyCommand<EnumerateCredentialsBeginResponse>

Inheritance

object

CredentialMgmtSubCommand

EnumerateCredentialsBeginCommand

Implements

IYubiKeyCommand<EnumerateCredentialsBeginResponse>

Inherited Members

CredentialMgmtSubCommand.Command

CredentialMgmtSubCommand.Application

CredentialMgmtSubCommand.IsPreview

CredentialMgmtSubCommand.CreateCommandApdu()

Remarks

The partner Response class is EnumerateCredentialsBeginResponse.

This returns the total number of credentials for the given relying party on the YubiKey along with information on the "first" credential. If there is only one credential, then you have all the information you need. If there are more credentials, then you can get information on all of them by calling the enumerateCredentialsGetNextRP subcommand.

Note that if there are no credentials associated with the given relying party, the response will be "No Data" (Status = ResponseStatus.NoData, and CtapStatus = CtapStatus.NoCredentials). In this case, calling the response.GetData() method will result in an exception.

The return from this command consist of the user, credentialId, publicKey, credProtect, largeBlobKey, and credentialCount.

Constructors

EnumerateCredentialsBeginCommand(RelyingParty, ReadOnlyMemory<byte>, PinUvAuthProtocolBase)

Constructs a new instance of EnumerateCredentialsBeginCommand.

public EnumerateCredentialsBeginCommand(RelyingParty relyingParty, ReadOnlyMemory<byte> pinUvAuthToken, PinUvAuthProtocolBase authProtocol)

Parameters

relyingParty RelyingParty

The relying party for which the credential enumeration is requested.

pinUvAuthToken ReadOnlyMemory<byte>

The PIN/UV Auth Token built from the PIN. This is the encrypted token key.

authProtocol PinUvAuthProtocolBase

The Auth Protocol used to build the Auth Token.

Methods

CreateResponseForApdu(ResponseApdu)

Creates the corresponding IYubiKeyResponse implementation for the current command.

public EnumerateCredentialsBeginResponse CreateResponseForApdu(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

EnumerateCredentialsBeginResponse

The implementation of IYubiKeyResponse that parses and presents ths response APDU.