Skip to content

DSInternals.Win32.WebAuthn.Cryptography.CredentialExchangePasskey.md

Latest commit

 

History

History
157 lines (99 loc) · 5.24 KB

DSInternals.Win32.WebAuthn.Cryptography.CredentialExchangePasskey.md

File metadata and controls

157 lines (99 loc) · 5.24 KB

Class CredentialExchangePasskey

Namespace: DSInternals.Win32.WebAuthn.Cryptography
Assembly: DSInternals.Win32.WebAuthn.dll

Represents a CXF credential of type passkey.

public sealed class CredentialExchangePasskey : CredentialExchangeCredential

Inheritance

object ← CredentialExchangeCredential ← CredentialExchangePasskey

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

CredentialId

The WebAuthn Credential ID associated with the passkey.

[JsonPropertyName("credentialId")]
[JsonConverter(typeof(Base64UrlConverter))]
public byte[]? CredentialId { get; set; }

Property Value

byte[]?

Fido2Extensions

FIDO2 extension state captured for the passkey.

[JsonPropertyName("fido2Extensions")]
public CredentialExchangeFido2Extensions? Fido2Extensions { get; set; }

Property Value

CredentialExchangeFido2Extensions?

Key

The PKCS#8 ASN.1 DER encoded private key of the passkey.

[JsonPropertyName("key")]
[JsonConverter(typeof(Base64UrlConverter))]
public byte[]? Key { get; set; }

Property Value

byte[]?

RelyingPartyId

The WebAuthn Relying Party Identifier the passkey is bound to.

[JsonPropertyName("rpId")]
public string? RelyingPartyId { get; set; }

Property Value

string?

UserDisplayName

A human-palatable display name for the user account associated with the passkey.

[JsonPropertyName("userDisplayName")]
public string? UserDisplayName { get; set; }

Property Value

string?

UserHandle

The WebAuthn user handle bound to the passkey.

[JsonPropertyName("userHandle")]
[JsonConverter(typeof(Base64UrlConverter))]
public byte[]? UserHandle { get; set; }

Property Value

byte[]?

Username

A human-palatable identifier for the user account associated with the passkey.

[JsonPropertyName("username")]
public string? Username { get; set; }

Property Value

string?

Methods

LoadPrivateKey()

Loads the passkey private key as an . The caller is responsible for disposing the returned key.

public AsymmetricAlgorithm LoadPrivateKey()

Returns

AsymmetricAlgorithm

ToPasskey(Guid?)

Converts this CXF passkey credential into a normalized .

public ExportedPasskey ToPasskey(Guid? aaGuid = null)

Parameters

aaGuid Guid?

The AAGUID to associate with the imported passkey. CXF does not include an AAGUID, so importers may pick one that identifies the new platform authenticator. Defaults to .

Returns

ExportedPasskey