Show / Hide Table of Contents

OtpSettings<T> Class

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

Helper class to manage the flags used by the YubiKey OTP configuration.

C#
public class OtpSettings<T> where T : OperationBase<T>
Inheritance object OtpSettings<T>
Type Parameters
Class.Header.Syntax.TypeParameters:Name Description
T

The System.Type of the operation class.

Properties

Name Description
YubiKeyFlags

The YubiKey OTP flags collected in one data-structure.

Methods

Name Description
AllowHidTrigger(bool)

Reserved for compatibility with the YubiKey 1. Usage of this option is discouraged.

AllowManualUpdate(bool)

Configures the slot to allow for user-triggered static password change.

AllowUpdate(bool)

Allows certain non-security related settings to be modified after the configuration has been written.

AppendCarriageReturn(bool)

Sends a carriage return [Enter Key] after all characters have been sent.

AppendDelayToFixed(bool)

Adds a 500ms delay after sending the fixed string.

AppendDelayToOtp(bool)

Adds a 500ms delay after sending the OTP string.

AppendTabToFixed(bool)

Sends a tab character after the fixed string.

HmacLessThan64Bytes(bool)

Set when the HMAC message is less than 64 bytes.

OathFixedModhex1(bool)

Specifies that the first byte of the token identifier should be modhex.

ProtectLongPressSlot(bool)

Locks and/or protects the long press configuration slot of the YubiKey.

SendReferenceString(bool)

Sends a reference string of the ModHex characters for 0-15 before the fixed or OTP data.

SendTabFirst(bool)

Sends a tab character before the fixed string.

SetAppendTabToOtp(bool)

Sends a tab character after the OTP string.

SetDormant(bool)

Allows a configuration to be stored without being accessible.

SetInvertLed(bool)

Inverts the configured state of the LED.

SetOathHotp(bool)

Sets the configuration for OATH HOTP.

SetSerialNumberApiVisible(bool)

Allows the serial number to be read by proprietary means, including being visible to the Yubico.YubiKey SDK.

SetSerialNumberButtonVisible(bool)

Allows the serial number to be retrieved by holding down the touch button while inserting the device into the USB port.

SetSerialNumberUsbVisible(bool)

Makes the serial number appear in the YubiKey's USB descriptor's iSerialNumber field.

ShortTicket(bool)

Truncates the OTP string to 16 characters.

TicketFirst(bool)

Reserved for compatibility with the YubiKey 1. Usage of this option is discouraged.

ToString()
Use10msPacing(bool)

Adds an inter-character pacing time of 10ms between each keystroke.

Use20msPacing(bool)

Adds an inter-character pacing time of 20ms between each keystroke.

Use8DigitHotp(bool)

Configures the slot to use an eight-digit password for OATH-HOTP.

UseAlphaNumericPassword(bool)

Enables generation of mixed characters and digits.

UseButtonTrigger(bool)

Require user acceptance by touching the YubiKey button for challenge-response operations

UseFastTrigger(bool)

Causes the trigger action of the YubiKey button to become faster.

UseHmacSha1ChallengeResponseMode(bool)

HMAC-SHA1 Challenge-Response Mode

UseMixedCasePassword(bool)

Enable use of mixed case characters for password generation.

UseNumericKeypad(bool)

Causes numeric characters to be sent as keystrokes from the numeric keypad rather than the normal numeric keys on an 84-key keyboard.

UseOathFixedModhex(bool)

Specifies that all bytes of the token identifier should be modhex.

UseOathFixedModhex2(bool)

Specifies that the first two bytes of the token identifier should be modhex.

UseStaticPasswordMode(bool)

Configures the slow to emit a static password.

UseStaticTicketMode(bool)

Sets all dynamic fields to fixed values.

UseYubicoOtpChallengeResponseMode(bool)

Enables Yubico OTP Challenge-Response Mode

In this article
Back to top Generated by DocFX