ConfigureYubicoOtp Class
Namespace: Yubico.YubiKey.Otp.Operations Assembly: Yubico.YubiKey.dllConfigures a YubiKey's OTP slot to perform OTP using the Yubico OTP protocol.
public class ConfigureYubicoOtp : OperationBase<ConfigureYubicoOtp>Remarks
Once configured, pressing the button on the YubiKey will cause it to emit the standard Yubico OTP challenge string.
This class is not to be instantiated by non-SDK code. Instead, you will get a reference to an instance of this class by calling ConfigureYubicoOtp(Slot).
Once you have a reference to an instance, the member methods of this class can be used to chain together configurations using a builder pattern.
Fields
| Name | Description |
|---|---|
| KeySize | The key size of the Yubico OTP credential. |
| PrivateIdentifierSize | The count of bytes used as the private identifier for the Yubico OTP credential. |
| PublicIdentifierMaxLength | The count of bytes that are prepended to the Yubico OTP challenge. |
Methods
| Name | Description |
|---|---|
| AppendCarriageReturn(Boolean) | Sends a carriage return [Enter Key] after all characters have been sent. |
| AppendDelayToFixed(Boolean) | Adds a 500ms delay after sending the fixed string. |
| AppendDelayToOtp(Boolean) | Adds a 500ms delay after sending the OTP string. |
| AppendTabToFixed(Boolean) | Sends a tab character after the fixed string. |
| ExecuteOperation() | Execute the operation here. |
| GenerateKey(Memory<Byte>) | Generates a cryptographically random series of bytes as the key for the Yubico OTP credential. |
| GeneratePrivateId(Memory<Byte>) | Generates a cryptographically random series of bytes as the private ID for the Yubico OTP credential. |
| PreLaunchOperation() | Validate all settings and choices here. |
| SendReferenceString(Boolean) | Sends a reference string of the ModHex characters for 0-15 before the fixed or OTP data. |
| SendTabFirst(Boolean) | Sends a tab character before the fixed string. |
| SetAllowUpdate(Boolean) | Allows certain non-security related settings to be modified after the configuration has been written. |
| Use10msPacing(Boolean) | Adds an inter-character pacing time of 10ms between each keystroke. |
| Use20msPacing(Boolean) | Adds an inter-character pacing time of 20ms between each keystroke. |
| UseFastTrigger(Boolean) | Causes the trigger action of the YubiKey button to become faster. |
| UseKey(Memory<Byte>) | Explicitly sets the key of the Yubico OTP credential. |
| UseNumericKeypad(Boolean) | Causes numeric characters to be sent as keystrokes from the numeric keypad rather than the normal numeric keys on an 84-key keyboard. |
| UsePrivateId(ReadOnlyMemory<Byte>) | Explicitly sets the private ID of the Yubico OTP credential. |
| UsePublicId(ReadOnlyMemory<Byte>) | Explicitly sets the public ID of the Yubico OTP credential. |
| UseSerialNumberAsPublicId(Nullable<Memory<Byte>>) | Uses a binary representation of the YubiKey serial number as the public ID for this credential. |