Class AuthenticatorOptions

Namespace

Yubico.YubiKey.Fido2

Assembly

Yubico.YubiKey.dll

All the standard Option strings.

public static class AuthenticatorOptions

Inheritance

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

alwaysUv

The string to use when specifying the alwaysUv Option.

public const string alwaysUv = "alwaysUv"

Field Value

string

authnrCfg

The string to use when specifying the authnrCfg Option.

public const string authnrCfg = "authnrCfg"

Field Value

string

bioEnroll

The string to use when specifying the bioEnroll Option.

public const string bioEnroll = "bioEnroll"

Field Value

string

clientPin

The string to use when specifying the clientPin Option.

public const string clientPin = "clientPin"

Field Value

string

credMgmt

The string to use when specifying the credMgmt Option.

public const string credMgmt = "credMgmt"

Field Value

string

credentialMgmtPreview

The string to use when specifying the credentialMgmtPreview Option.

public const string credentialMgmtPreview = "credentialMgmtPreview"

Field Value

string

ep

The string to use when specifying the ep Option.

public const string ep = "ep"

Field Value

string

largeBlobs

The string to use when specifying the largeBlobs Option.

public const string largeBlobs = "largeBlobs"

Field Value

string

makeCredUvNotRqd

The string to use when specifying the makeCredUvNotRqd Option.

public const string makeCredUvNotRqd = "makeCredUvNotRqd"

Field Value

string

noMcGaPermissionsWithClientPin

The string to use when specifying the noMcGaPermissionsWithClientPin Option.

public const string noMcGaPermissionsWithClientPin = "noMcGaPermissionsWithClientPin"

Field Value

string

pinUvAuthToken

The string to use when specifying the pinUvAuthToken Option.

public const string pinUvAuthToken = "pinUvAuthToken"

Field Value

string

plat

The string to use when specifying the plat Option.

public const string plat = "plat"

Field Value

string

rk

The string to use when specifying the rk Option.

public const string rk = "rk"

Field Value

string

setMinPINLength

The string to use when specifying the setMinPINLength Option.

public const string setMinPINLength = "setMinPINLength"

Field Value

string

up

The string to use when specifying the up Option.

public const string up = "up"

Field Value

string

userVerificationMgmtPreview

The string to use when specifying the userVerificationMgmtPreview Option.

public const string userVerificationMgmtPreview = "userVerificationMgmtPreview"

Field Value

string

uv

The string to use when specifying the uv Option.

public const string uv = "uv"

Field Value

string

uvAcfg

The string to use when specifying the uvAcfg Option.

public const string uvAcfg = "uvAcfg"

Field Value

string

uvBioEnroll

The string to use when specifying the uvBioEnroll Option.

public const string uvBioEnroll = "uvBioEnroll"

Field Value

string

Methods

GetDefaultOptionValue(string)

Return the default value for the given option.

public static OptionValue GetDefaultOptionValue(string option)

Parameters

option string

Returns

OptionValue

An OptionValue enum that specifies the default value for an option as either True, False, NotSupported, or Unknown.

Remarks

If an option is listed in the Options property, it will be true or false. If it is not listed, it will be a default value. The default value can be either True, False, or Not Supported. This method returns the default value for an option.

There is one more value it could be, Unknown. This happens when the option is a string not in the list here in this class.

Note that this method is not returning the current value of the given option, only what its default value is.