AuthenticatorOptions Class

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

All the standard Option strings.

C#

public static class AuthenticatorOptions : Object

Inheritance System.Object AuthenticatorOptions

Remarks

Some FIDO2 operations request the caller specify options. They are always provided as a key/value pair where the key is a string and the value is a boolean.

See section 6.4 of the FIDO2 standard for a list of all the defined options and their meanings. It is the chart with the column Option ID. Each option ID is a key of key/value. It is also the string that should be used. For example, the Option ID of credMgmt is defined as "Credential Management Support" and the meanings of true, false, and not present are described. To specify this Option, use the string "credMgmt".

When specifying an option (e.g., see Options of the MakeCredentialParameters class) provide the string and boolean. You can use this class to specify the string (the key of key/value). This might be helpful if you rely on IDE features such as autocompletion or symbolic searching. You can also specify the option string directly, if you so choose. Either choice is valid; you should choose the one most appropriate to your project's development style.

  var makeCredParams = new MakeCredentialParameters(relyingParty, userEntity)
  {
      ClientDataHash = clientDataHash,
  };
  makeCredParams.AddOption("rk", true);
  // or
  makeCredParams.AddOption(AuthenticatorOptions.rk, true);

Fields

Name	Description
alwaysUv	The string to use when specifying the alwaysUv Option.
authnrCfg	The string to use when specifying the authnrCfg Option.
bioEnroll	The string to use when specifying the bioEnroll Option.
clientPin	The string to use when specifying the clientPin Option.
credentialMgmtPreview	The string to use when specifying the credentialMgmtPreview Option.
credMgmt	The string to use when specifying the credMgmt Option.
ep	The string to use when specifying the ep Option.
largeBlobs	The string to use when specifying the largeBlobs Option.
makeCredUvNotRqd	The string to use when specifying the makeCredUvNotRqd Option.
noMcGaPermissionsWithClientPin	The string to use when specifying the noMcGaPermissionsWithClientPin Option.
pinUvAuthToken	The string to use when specifying the pinUvAuthToken Option.
plat	The string to use when specifying the plat Option.
rk	The string to use when specifying the rk Option.
setMinPINLength	The string to use when specifying the setMinPINLength Option.
up	The string to use when specifying the up Option.
userVerificationMgmtPreview	The string to use when specifying the userVerificationMgmtPreview Option.
uv	The string to use when specifying the uv Option.
uvAcfg	The string to use when specifying the uvAcfg Option.
uvBioEnroll	The string to use when specifying the uvBioEnroll Option.

Methods

Name	Description
GetDefaultOptionValue(String)	Return the default value for the given option.