webauthnplugin.h header

Provides APIs for registering plugin authenticators with Windows, maintaining browser autofill credential metadata, integrating Windows Hello user verification, and encoding or decoding CTAP CBOR payloads for plugin-authenticator operations.

webauthnplugin.h contains the following programming interfaces:

Functions

WebAuthNDecodeGetAssertionRequest Decodes a CTAP CBOR-encoded getAssertion request.
WebAuthNDecodeMakeCredentialRequest Decodes a CTAP CBOR-encoded makeCredential request.
WebAuthNEncodeGetAssertionResponse Encodes a getAssertion response as CTAP CBOR.
WebAuthNEncodeMakeCredentialResponse Encodes a credential attestation as a CTAP CBOR makeCredential response.
WebAuthNFreeDecodedGetAssertionRequest Frees a decoded getAssertion request.
WebAuthNFreeDecodedMakeCredentialRequest Frees a decoded makeCredential request.
WebAuthNPluginAddAuthenticator Registers a plugin authenticator with Windows.
WebAuthNPluginAddAuthenticator2 Registers a plugin authenticator with Windows by using the extended add-authenticator options.
WebAuthNPluginAuthenticatorAddCredentials Adds cached credential metadata for a plugin authenticator.
WebAuthNPluginAuthenticatorFreeCredentialDetailsArray Frees an array returned by WebAuthNPluginAuthenticatorGetAllCredentials.
WebAuthNPluginAuthenticatorGetAllCredentials Gets all cached credential metadata for a plugin authenticator.
WebAuthNPluginAuthenticatorRemoveAllCredentials Removes all cached credential metadata for a plugin authenticator.
WebAuthNPluginAuthenticatorRemoveCredentials Removes cached credential metadata for a plugin authenticator.
WebAuthNPluginFreeAddAuthenticatorResponse Frees a response returned by WebAuthNPluginAddAuthenticator or EXPERIMENTAL_WebAuthNPluginAddAuthenticator2.
WebAuthNPluginFreePublicKeyResponse Frees a public-key buffer returned by a WebAuthN plugin public-key function.
WebAuthNPluginFreeUserVerificationResponse Frees a response buffer returned by a plugin user-verification function.
WebAuthNPluginGetAuthenticatorState Gets the current enabled or disabled state of a plugin authenticator.
WebAuthNPluginGetOperationSigningPublicKey Gets the operation-signing public key for a plugin authenticator.
WebAuthNPluginGetUserVerificationCount Gets the user-verification counter for a plugin authenticator.
WebAuthNPluginGetUserVerificationPublicKey Gets the public key associated with plugin user verification.
WebAuthNPluginPerformUserVerification Performs Windows Hello user verification for a plugin authenticator operation.
WebAuthNPluginPerformUserVerification2 Performs Windows Hello user verification for a plugin authenticator operation by using the extended user-verification request.
WebAuthNPluginRegisterStatusChangeCallback Registers a callback that is invoked when plugin authenticator status changes.
WebAuthNPluginRemoveAuthenticator Unregisters a plugin authenticator from Windows.
WebAuthNPluginUnregisterStatusChangeCallback Unregisters a previously registered plugin status-change callback.
WebAuthNPluginUpdateAuthenticatorDetails Updates metadata for a registered plugin authenticator.
WebAuthNPluginUpdateAuthenticatorDetails2 Updates metadata for a registered plugin authenticator by using the extended update-details structure.

Callback functions

WEBAUTHN_PLUGIN_STATUS_CHANGE_CALLBACK An application-defined callback that Windows invokes when plugin authenticator status changes.

Structures

WEBAUTHN_CTAPCBOR_AUTHENTICATOR_OPTIONS Contains CTAP authenticator option values used with decoded plugin requests.
WEBAUTHN_CTAPCBOR_ECC_PUBLIC_KEY Represents an elliptic-curve public key used in CTAP CBOR extensions.
WEBAUTHN_CTAPCBOR_GET_ASSERTION_REQUEST Contains a decoded CTAP CBOR getAssertion request.
WEBAUTHN_CTAPCBOR_GET_ASSERTION_RESPONSE Contains data for a CTAP CBOR getAssertion response.
WEBAUTHN_CTAPCBOR_HMAC_SALT_EXTENSION Contains data for the CTAP HMAC-salt extension.
WEBAUTHN_CTAPCBOR_MAKE_CREDENTIAL_REQUEST Contains a decoded CTAP CBOR makeCredential request.
WEBAUTHN_PLUGIN_ADD_AUTHENTICATOR_OPTIONS Contains options for registering a plugin authenticator with Windows.
WEBAUTHN_PLUGIN_ADD_AUTHENTICATOR_OPTIONS_2 Contains extended options for registering a plugin authenticator with Windows.
WEBAUTHN_PLUGIN_ADD_AUTHENTICATOR_RESPONSE Contains the response returned when a plugin authenticator is registered.
WEBAUTHN_PLUGIN_CREDENTIAL_DETAILS Contains metadata for a credential exposed by a plugin authenticator.
WEBAUTHN_PLUGIN_UPDATE_AUTHENTICATOR_DETAILS Contains updated metadata for a registered plugin authenticator.
WEBAUTHN_PLUGIN_UPDATE_AUTHENTICATOR_DETAILS_2 Contains extended metadata for updating a registered plugin authenticator.
WEBAUTHN_PLUGIN_USER_VERIFICATION_REQUEST Describes a Windows Hello user-verification request for a plugin authenticator.
WEBAUTHN_PLUGIN_USER_VERIFICATION_REQUEST_2 Describes an extended Windows Hello user-verification request for a plugin authenticator.

Enumerations

AUTHENTICATOR_STATE Specifies whether a plugin authenticator is enabled.
WEBAUTHN_PLUGIN_PERFORM_UV_OPERATION_TYPE Specifies the type of Windows Hello user-verification operation for a plugin authenticator.