AuthenticateManagementKeyResult Enum

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

This enum lists the possible results of authenticating the management key.

C#

public enum AuthenticateManagementKeyResult

Remarks

The response to the CompleteAuthenticateManagementKeyCommand is CompleteAuthenticateManagementKeyResponse. Call the GetData method in the response object to get the result of the authentication process. This enum is returned.

There are two possible modes of authenticating: single and mutual. In single authentication, only the "Off-Card" application is authenticated to the YubiKey. In mutual authentication, the Off-Card app is authenticated, but also the YubiKey is authenticated to the Off-Card app.

There are five possible results of a management key authentication:

                OffCard                YubiKey
mutual :  Authenticated          Authenticated
mutual :  Authenticated          AuthenticationFailed
mutual :  AuthenticationFailed   Unknown
single :  Authenticated          Unknown
single :  AuthenticationFailed   Unknown

If the process is mutual authentication, but the YubiKey was not able to authenticate the Off-Card app, it will not provide any information that allows the YubiKey to be authenticated itself. Hence, if the Off-Card app is not authenticated, there is no way to know if the YubiKey is authenticated.

In mutual authentication, if the Off-Card app authenticates, but the YubiKey does not authenticate, operations that require management key authentication will be able to process, but the device the app with which the app is communicating is likely not the YubiKey requested.

Fields

MutualFullyAuthenticated	Mutual authentication, Off-Card app authenticated, the YubiKey authenticated.
MutualOffCardAuthenticationFailed	Mutual authentication, Off-Card app did not authenticate, authentication status of the YubiKey is unknown.
MutualYubiKeyAuthenticationFailed	Mutual authentication, Off-Card app authenticated, the YubiKey did not authenticate.
SingleAuthenticated	Single authentication, Off-Card app authenticated.
SingleAuthenticationFailed	Single authentication, Off-Card app did not authenticate.
Unauthenticated	Not authenticated, authentication has not been attempted or was not completed because of an error.