Show / Hide Table of Contents

KeyEntryRequest Enum

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

This lists the possible actions or information the caller is requesting.

C#
public enum KeyEntryRequest

Remarks

This is used in conjunction with the KeyEntryData class. When the SDK needs a key, PIN, password, or some other user-supplied secret element, it will call the application-supplied, key-collecting delegate. Inside the KeyEntryData class is a property indicating what the SDK is requesting the delegate to collect.

This enum is the list of possible elements the SDK can request of the delegate.

Fields

AuthenticatePivManagementKey

Indicates that the SDK is requesting the current PIV management key in order to authenticate.

AuthenticateYubiHsmAuthCredentialPassword

Indicates that the SDK is requesting the YubiHSM Auth credential's password in order to authenticate.

AuthenticateYubiHsmAuthManagementKey

Indicates that the SDK is requesting the current YubiHSM Auth management key in order to authenticate.

ChangeFido2Pin

Indicates that the SDK is requesting the current FIDO2 PIN and a new PIN, in order to change the PIN from the current to the new. Collect both the current and new PINs.

ChangePivManagementKey

Indicates that the SDK is requesting the current PIV management key and a new PIV management key, in order to change the key from the current to the new. Collect both the current and a new management key.

ChangePivPin

Indicates that the SDK is requesting the current PIV PIN and a new PIN, in order to change the PIN from the current to the new. Collect both the current and a new PIN.

ChangePivPuk

Indicates that the SDK is requesting the current PIV PUK and a new PUK, in order to change the PUK from the current to the new. Collect both the current and a new PUK.

ChangeU2fPin

Indicates that the SDK is requesting the current FIDO U2F PIN and a new PIN, in order to change the PIN from the current to the new. Collect both the current and a new PIN.

ChangeYubiHsmAuthManagementKey

This indicates that the SDK is attempting to change the YubiHSM Auth management key. It is requesting the current YubiHSM Auth management key and a new YubiHSM Auth management key as part of the operation.

EnrollFingerprint

Indicates that the SDK is requesting the user provide a fingerprint sample.

Release

Indicates that the SDK has successfully used the element(s) requested and the caller can now release any resources related to obtaining the data.

ResetPivPinWithPuk

Indicates that the SDK is requesting the PIV PUK and a new PIN. This is the first call. This is used to recover the PIN using the PUK. Collect both the current PUK and a new PIN.

SetFido2Pin

Indicates that the SDK is setting the FIDO2 PIN. The YubiKey is not set with a FIDO2 PIN yet, so only collect a new PIN.

SetOathPassword

Indicates that the SDK is requesting a new password. Collect a new password.

SetU2fPin

Indicates that the SDK is setting the FIDO U2F PIN. The YubiKey is not set with a U2F PIN yet, so collect only a new PIN.

TouchRequest

The YubiKey is requesting touch for user presence verification. See the User's Manual entry on how to handle a touch notification in a key collector.

VerifyFido2Pin

Indicates that the SDK is verifying the FIDO2 PIN. Collect the current PIN.

VerifyFido2Uv

Indicates that the SDK and YubiKey are waiting for user verification. This usually means touching the biometric sensor on the YubiKey. Nothing to collect, this is an informative request.

VerifyOathPassword

Indicates that the SDK is requesting the OATH password to verify.

VerifyPivPin

Indicates that the SDK is requesting the PIV PIN to verify.

VerifyU2fPin

Indicates that the SDK is verifying the FIDO U2F PIN. Collect the current PIN.

In this article
Back to top Generated by DocFX