Class PubkeyCredCreationOptions

Definition

Namespace:: Tizen.Security.WebAuthn

Assembly:: Tizen.Security.WebAuthn.dll

Make credential options.

public class PubkeyCredCreationOptions

Inheritance: object

PubkeyCredCreationOptions

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

Constructors

View Source

PubkeyCredCreationOptions(RelyingPartyEntity, UserEntity, IEnumerable<PubkeyCredParam>, ulong, IEnumerable<PubkeyCredDescriptor>, AuthenticationSelectionCriteria, IEnumerable<PubkeyCredHint>, AttestationPref, IEnumerable<byte[]>, IEnumerable<AuthenticationExtension>, HybridLinkedData)

Initializes a new instance of the PubkeyCredCreationOptions class.

Declaration

public PubkeyCredCreationOptions(RelyingPartyEntity rp, UserEntity user, IEnumerable<PubkeyCredParam> pubkeyCredParams, ulong timeout = 0, IEnumerable<PubkeyCredDescriptor> excludeCredentials = null, AuthenticationSelectionCriteria authenticatorSelection = null, IEnumerable<PubkeyCredHint> hints = null, AttestationPref attestation = AttestationPref.None, IEnumerable<byte[]> attestationFormats = null, IEnumerable<AuthenticationExtension> extensions = null, HybridLinkedData linkedDevice = null)

Parameters

Type	Name	Description
RelyingPartyEntity	rp	Contains a name and an identifier for the Relying Party responsible for the request.
UserEntity	user	Contains names and an identifier for the user account performing the registration.
System.Collections.Generic.IEnumerable<T><PubkeyCredParam>	pubkeyCredParams	Lists the key types and signature algorithms the Relying Party supports, ordered from most preferred to least preferred.
ulong	timeout	Specifies a time, in milliseconds, that the Relying Party is willing to wait for the call to complete. This is treated as a hint, and MAY be overridden by the client. The value, '0', means no timeout is set. (optional)
System.Collections.Generic.IEnumerable<T><PubkeyCredDescriptor>	excludeCredentials	The Relying Party SHOULD use this argument to list any existing credentials mapped to this user account (as identified by user.id). (optional)
AuthenticationSelectionCriteria	authenticatorSelection	The Relying Party MAY use his argument to specify capabilities and settings that the authenticator MUST or SHOULD satisfy to participate in this operation. (optional)
System.Collections.Generic.IEnumerable<T><PubkeyCredHint>	hints	Contains zero or more elements from PubkeyCredHint to guide the user agent in interacting with the user. (optional)
AttestationPref	attestation	The Relying Party MAY use this argument to specify a preference regarding attestation conveyance. The default value is None. (optional)
System.Collections.Generic.IEnumerable<T><byte[]>	attestationFormats	The Relying Party MAY use this argument to specify a preference regarding the attestation statement format used by the authenticator. The default value is the empty list, which indicates no preference. (optional)
System.Collections.Generic.IEnumerable<T><AuthenticationExtension>	extensions	The Relying Party MAY use this argument to provide client extension inputs requesting additional processing by the client and authenticator. (optional)
HybridLinkedData	linkedDevice	Linked Device Connection Info. Optional. If not null, the state assisted transaction will start.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

Properties

View Source

Attestation

Gets the attestation conveyance preference.

Declaration

public AttestationPref Attestation { get; init; }

Property Value

Type	Description
AttestationPref	Specifies a preference regarding attestation conveyance.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

AttestationFormats

Gets the attestation format preference.

Declaration

public IEnumerable<byte[]> AttestationFormats { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><byte[]>	Specifies a preference regarding the attestation statement format used by the authenticator.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

AuthenticatorSelection

Gets the criteria for authenticator selection.

Declaration

public AuthenticationSelectionCriteria AuthenticatorSelection { get; init; }

Property Value

Type	Description
AuthenticationSelectionCriteria	The capabilities and settings that the authenticator MUST or SHOULD satisfy to participate in this operation.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

ExcludeCredentials

Gets the existing credentials mapped to this user account.

Declaration

public IEnumerable<PubkeyCredDescriptor> ExcludeCredentials { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><PubkeyCredDescriptor>	Any existing credentials mapped to this user account (as identified by user.id).

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

Extensions

Gets the client extension inputs.

Declaration

public IEnumerable<AuthenticationExtension> Extensions { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><AuthenticationExtension>	Client extension inputs requesting additional processing by the client and authenticator.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

Hints

Gets hints used to guide the user agent in interacting with the user.

Declaration

public IEnumerable<PubkeyCredHint> Hints { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><PubkeyCredHint>	Contains zero or more elements from PubkeyCredHint to guide the user agent in interacting with the user.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

LinkedDevice

Gets the Linked Device Connection Info.

Declaration

public HybridLinkedData LinkedDevice { get; init; }

Property Value

Type	Description
HybridLinkedData	Linked Device Connection Info. If not null, the state assisted transaction will start.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

PubkeyCredParams

Gets the key parameters the Relying Party supports.

Declaration

public IEnumerable<PubkeyCredParam> PubkeyCredParams { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><PubkeyCredParam>	The key types and signature algorithms the Relying Party supports, ordered from most preferred to least preferred.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

Rp

Gets the Relying Party data.

Declaration

public RelyingPartyEntity Rp { get; init; }

Property Value

Type	Description
RelyingPartyEntity	The name and identifier for the Relying Party responsible for the request.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

Timeout

Gets the timeout requested by the Relying Party.

Declaration

public ulong Timeout { get; init; }

Property Value

Type	Description
ulong	The time, in milliseconds, that the Relying Party is willing to wait for the call to complete. This is treated as a hint, and MAY be overridden by the client. The value, '0', means no timeout is set.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions

View Source

User

Gets user account data.

Declaration

public UserEntity User { get; init; }

Property Value

Type	Description
UserEntity	The names and identifier for the user account performing the registration.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptions