Show / Hide Table of Contents

InitializeAuthenticateManagementKeyResponse Class

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

The response to the initialize authenticate management key command.

C#
public sealed class InitializeAuthenticateManagementKeyResponse : PivResponse, IYubiKeyResponseWithData<(bool isMutualAuth, ReadOnlyMemory<byte> clientAuthenticationChallenge)>, IYubiKeyResponse
Inheritance object YubiKeyResponse PivResponse InitializeAuthenticateManagementKeyResponse
Implements
IYubiKeyResponseWithData<(bool isMutualAuth, ReadOnlyMemory<byte> clientAuthenticationChallenge)>
IYubiKeyResponse

Remarks

This is the partner Response class to InitializeAuthenticateManagementKeyCommand.

The data returned is a tuple consisting of a boolean and a ReadOnlyMemory<byte>. The boolean indicates if this is mutual authentication or not, true for mutual auth, false for single. The byte array is "Client Authentication Challenge".

See the comments for the class InitializeAuthenticateManagementKeyCommand, there is a lengthy discussion of the process of authenticating the management key, including descriptions of the challenges and responses.

It is likely that you will never need to call GetData in this class. You will pass an instance of this class to the constructor for CompleteAuthenticateManagementKeyCommand, which will process the challenge.

Constructors

Name Description
InitializeAuthenticateManagementKeyResponse(ResponseApdu)
InitializeAuthenticateManagementKeyResponse(ResponseApdu, PivAlgorithm)

Constructs an InitializeAuthenticateManagementKeyResponse based on a ResponseApdu received from the YubiKey for the specified algorithm.

Properties

Name Description
Algorithm

Which algorithm is the management key.

Methods

Name Description
GetData()

Return the boolean indicating mutual auth or not, along with the value portion of the Response Data, namely, Client Authentication Challenge.

In this article
Back to top Generated by DocFX