ConfigCommand Class

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

The ConfigCommand is the class for authenticatorConfig. This command has a number of subcommands, each of which is represented by its own class. You will likely never use this class directly, but it does contain code shared by all the subcommands.

public class ConfigCommand : Object, IYubiKeyCommand<ConfigResponse>

Inheritance System.Object ConfigCommand

Implements

IYubiKeyCommand<ConfigResponse>

Remarks

The authenticatorConfig (0x0D) FIDO2 command can be thought of as a "meta" command. That is, it provides the structure and mechanism for performing a number of subcommands. These subcommands are:

- enableEnterpriseAttestation (0x01)
- toggleAlwaysUv (0x02)
- setMinPINLength (0x03)
- vendorPrototype (0xFF)

Since the SDK does not have the concept of a subcommand natively, these are all exposed as their own separate commands.

See the user manual entry on Authenticator Config for a much more in depth guide to working with the config commands. For more information on a particular subcommand, see the API reference documentation for that command class.

All of the subcommands return a success or failure response code.

Constructors

Name	Description
ConfigCommand()	This constructor will throw `NotImplementedException`. It is the default constructor explicitly defined. We don't want it to be used. It is made `protected` rather than `private` because there are subclasses.
ConfigCommand(Int32)	Constructs a new instance of ConfigCommand.
ConfigCommand(Int32, Byte[], ReadOnlyMemory<Byte>, PinUvAuthProtocolBase)	Constructs a new instance of ConfigCommand.

Properties

Name	Description
Application	Gets the YubiKeyApplication (e.g. PIV, OATH, etc.) to which this command applies.
PinUvAuthParam	The output of calling authenticate on the PIN/UV protocol specific to a particular subcommand.
PinUvAuthProtocol	The PIN/UV protocol version chosen by the platform.
SubCommand	The Config subcommand to issue to the YubiKey.
SubCommandParameters	The encoded params for the specified subcommand. If a subcommand has no parameters, this will be null.

Methods

Name	Description
CreateCommandApdu()	Creates a well-formed CommandApdu to send to the YubiKey.
CreateResponseForApdu(ResponseApdu)	Creates the corresponding IYubiKeyResponse implementation for the current command.