Class GetBioModalityCommand
Gets the modality of the BioEnrollment. This is a subcommand of the CTAP command "authenticatorBioEnrollment".
public sealed class GetBioModalityCommand : IYubiKeyCommand<GetBioModalityResponse>
- Inheritance
-
objectGetBioModalityCommand
- Implements
Remarks
The partner Response class is GetBioModalityResponse.
The modality describes what the Bio authentication (biometric) is. Currently, the only modality listed in the FIDO2 standard is fingerprint.
Constructors
GetBioModalityCommand()
Constructs an instance of the GetBioModalityCommand class.
public GetBioModalityCommand()
Properties
Application
Gets the YubiKeyApplication (e.g. PIV, OATH, etc.) to which this command applies.
public YubiKeyApplication Application { get; }
Property Value
- YubiKeyApplication
YubiKeyApplication.Otp, YubiKeyApplication.Piv, etc.
Methods
CreateCommandApdu()
Creates a well-formed CommandApdu to send to the YubiKey.
public CommandApdu CreateCommandApdu()
Returns
- CommandApdu
A valid CommandApdu that is ready to be sent to the YubiKey, or passed along to additional encoders for further processing.
Remarks
This method will first perform validation on all of the parameters and data provided to it. The CommandAPDU it creates should contain all of the data payload for the command, even if it exceeds 65,535 bytes as specified by the ISO 7816-4 specification. The APDU will be properly chained by the device connection prior to being sent to the YubiKey, and the responses will collapsed into a single result.
CreateResponseForApdu(ResponseApdu)
Creates the corresponding IYubiKeyResponse implementation for the current command.
public GetBioModalityResponse CreateResponseForApdu(ResponseApdu responseApdu)
Parameters
responseApdu
ResponseApduThe ResponseApdu returned by the YubiKey.
Returns
- GetBioModalityResponse
The implementation of IYubiKeyResponse that parses and presents ths response APDU.