PivPinOnlyMode Enum

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

This enum lists the possible PIN-only modes for the PIV application.

C#

[Flags]
public enum PivPinOnlyMode

Remarks

PIN-only mode means that the application does not need to enter the management key in order to perform PIV operations that normally require it, only the PIN is needed.

See the User's Manual entry on PIN-only mode for a deeper discussion of this feature.

This enum is a bit field. If it is 0 (None, no bits set), that means there is no PIN-only mode set on the YubiKey, but it is available to be set.

If the 1 bit is set (PinProtectedUnavailable), then the YubiKey cannot be set to PIN-Protected.

If the 2 bit is set (PinDerivedUnavailable), then the YubiKey cannot be set to PIN-derived.

If the 4 bit is set (PinProtected), then the YubiKey is currently set to PIN-protected.

If the 8 bit is set (PinDerived), then the YubiKey is currently set to PIN-derived.

Certain combinations of bits are possible:

• PinProtectedUnavailable | PinProtectedUnavailable
• PinDerivedUnavailable | PinProtected
• PinProtectedUnavailable | PinDerived
• PinProtected | PinDerived

To determine if a field is set, you can use the Enum.HasFlag method.

Fields

None	The YubiKey is not set for PIN-only, but is available for this feature.
PinDerived	The YubiKey is set for PIN-derived. Warning You should not set a YubiKey for PIN-derived, this feature is provided only for backwards compatibility.
PinDerivedUnavailable	The YubiKey is not available for PIN-derived. This happens if some other application is using the ADMIN DATA.
PinProtected	The YubiKey is set for PIN-protected.
PinProtectedUnavailable	The YubiKey is not available for PIN-protected. This happens if some other application is using the ADMIN DATA and/or the PRINTED storage area.