KeyEntryData Class

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

This class contains methods and data that describe the state of the process to provide keys, PINs, and other sensitive data to the SDK.

C#

public sealed class KeyEntryData : Object

Inheritance System.Object KeyEntryData

Remarks

At times, the SDK will need the caller to provide keys, PINs, or other sensitive data. Generally, this will be done through a delegate (callback). The caller provides a method the SDK can call requesting the key, PIN, or whatever element is needed. This method will take as an argument an instance of this KeyEntryData class.

When the SDK calls the delegate, it will pass an instance of this class, which contains information the method can use to perform its operations. For example, the SDK, when calling the delegate, must describe what element it is requesting, and whether this is the first request, or a subsequent request because the previous data returned did not verify.

Constructors

Name	Description
KeyEntryData()	Create a new instance of the KeyEntryData class.

Properties

Name	Description
IsRetry	Indicates if the current request for an item has already been tried and was incorrect. That is, is the current request the initial request or did a previous attempt fail and the SDK is requesting the KeyCollector try again? If true, the request is for a retry, if false, the request is the initial attempt.
IsViolatingPinComplexity	Indicates if the current request for an item has violated PIN complexity.
LastBioEnrollSampleResult	This is the result of the last fingerprint sample. This will be null if the Request is for something other than EnrollFingerprint or if it is the first call to Enroll.
Request	This indicates what the SDK is requesting.
RetriesRemaining	This is the number of retries remaining before the element requested is blocked. This can be null if the element is one that is never blocked or the retries remaining count is not known yet because the KeyEntryData represents the initial request.
SignalUserCancel	For some operations, this property is an implementation of a delegate the KeyCollector can call to indicate the user is canceling the operation. If it is null, report cancellation normally, by having the KeyCollector return false. If it is not null, use the supplied delegate to report user cancellation.

Methods

Name	Description
Clear()	Clear any sensitive data in the object.
GetCurrentValue()	Return a reference to the submitted current value.
GetNewValue()	Return a reference to the submitted new value.
SubmitValue(ReadOnlySpan<Byte>)	Submit the requested value, when there is only one value to submit.
SubmitValues(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Submit the requested values, when there are two values to submit. This is generally used when changing or resetting a value.