Table of Contents

Class EnumerateRpsBeginCommand

Namespace
Yubico.YubiKey.Fido2.Commands
Assembly
Yubico.YubiKey.dll

Begin the process of getting information on all the relying parties represented in credentials on the YubiKey.

public class EnumerateRpsBeginCommand : CredentialMgmtSubCommand, IYubiKeyCommand<EnumerateRpsBeginResponse>
Inheritance
object
EnumerateRpsBeginCommand
Implements
Inherited Members

Remarks

The partner Response class is EnumerateRpsBeginResponse.

This returns the total number of relying parties represented in the set of credentials, along with information on the "first" relying party. If there is only one RP, then you have all the information you need. If there are more RPs, then you can get information on all of them by calling the enumerateRPsGetNextRP 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.

Constructors

EnumerateRpsBeginCommand(ReadOnlyMemory<byte>, PinUvAuthProtocolBase)

Constructs a new instance of EnumerateRpsBeginCommand.

public EnumerateRpsBeginCommand(ReadOnlyMemory<byte> pinUvAuthToken, PinUvAuthProtocolBase authProtocol)

Parameters

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 EnumerateRpsBeginResponse CreateResponseForApdu(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

EnumerateRpsBeginResponse

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