Show / Hide Table of Contents

IOtpSession Interface

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

Interface for OtpSession.

C#
public interface IOtpSession

Remarks

This exists to facilitate mocking and dependency-injection for unit tests. Unless you are developing another mock session for testing, you have no reason to directly use this interface.

Properties

Name Description
IsLongPressConfigured

Indicates that the long-press configuration (slot 2) is present and valid.

IsShortPressConfigured

Indicates that the short-press configuration (slot 1) is present and valid.

LongPressRequiresTouch

Indicates that the long-press configuration (slot 2) requires touch for operation.

ShortPressRequiresTouch

Indicates that the short-press configuration (slot 1) requires touch for operation.

Methods

Name Description
CalculateChallengeResponse(Slot)

Submits a challenge to the YubiKey OTP application to be calculated.

ConfigureChallengeResponse(Slot)

Configures one of the OTP application slots to respond to challenges.

ConfigureHotp(Slot)

Configures a YubiKey OTP slot to emit sequence-based OTP codes.

ConfigureNdef(Slot)

Configures a YubiKey's NDEF slot for text or URI.

ConfigureStaticPassword(Slot)

Sets a static password for an OTP application slot on a YubiKey.

ConfigureYubicoOtp(Slot)

Configures one of the OTP application slots to act as a Yubico OTP device.

DeleteSlot(Slot)

Removes an OTP slot configuration and sets it to empty.

DeleteSlotConfiguration(Slot)

Removes a slot configuration in the YubiKey's OTP application.

ReadNdefTag()

Reads the OTP programmed in the short-press slot using the NFC Data-Exchange Format (NDEF) tag from NFC enabled YubiKeys. (Requires the YubiKey be connected via NFC).

SwapSlots()

Swaps the configurations in the short and long press slots.

UpdateSlot(Slot)

Updates the settings of an OTP application slot on a YubiKey without removing the existing configuration.

In this article
Back to top Generated by DocFX