api

Documentation

Index

• func CreateClientData(action, origin, challenge, HashAlgID string) (*share.RawCollectedClientData, error)
• func NewGetAssertionOptions() *share.RawAuthenticatorGetAssertionOptions
• func NewMakeCredOpts() *share.RawAuthenticatorMakeCredentialOptions
• type User
• type WebAuthNClient
  • func NewClient(rpID, rpName, rpIcon string) *WebAuthNClient
  • func (c *WebAuthNClient) DeletePlatformCred(cbCred uint32, pbCred *byte) error
  • func (c *WebAuthNClient) GetAssertion(origin string, opts *share.RawAuthenticatorGetAssertionOptions) (*share.Assertion, error)
  • func (c *WebAuthNClient) GetPlatformCredentialList(rpid string) ([]*share.CredentialDetails, error)
  • func (c *WebAuthNClient) MakeCredential(user User, origin string, opts *share.RawAuthenticatorMakeCredentialOptions) (*share.CredentialAttestation, error)
  • func (c *WebAuthNClient) SetDefaultCOSE()

Functions

func CreateClientData

func CreateClientData(action, origin, challenge, HashAlgID string) (*share.RawCollectedClientData, error)

CreateClientData ...

func NewGetAssertionOptions

func NewGetAssertionOptions() *share.RawAuthenticatorGetAssertionOptions

NewGetAssertionOptions returns an AuthenticatorGetAssertionOptions struct pointer whih default value.

func NewMakeCredOpts

func NewMakeCredOpts() *share.RawAuthenticatorMakeCredentialOptions

NewMakeCredOpts returns an AuthenticatorMakeCredentialOptions struct pointer whih default value.

Types

type User

type User interface {
	GetID() []byte
	GetName() string
	GetDisplayName() string
	GetIcon() string
}

type WebAuthNClient

type WebAuthNClient struct {
	RPInfo                   share.RawRPInfo
	COSECredentialParameters []*share.RawCOSECredentialParameter

	Timeout uint32
	// contains filtered or unexported fields
}

WebAuthNClient ...

func NewClient

func NewClient(rpID, rpName, rpIcon string) *WebAuthNClient

NewClient inits a WebAuthN client with the basic information.

An rpID MUST be a valid domain string. See https://w3c.github.io/webauthn/#rp-id

func (*WebAuthNClient) DeletePlatformCred

func (c *WebAuthNClient) DeletePlatformCred(cbCred uint32, pbCred *byte) error

DeletePlatformCred removes a Public Key Credential Source stored on a Virtual Authenticator.

func (*WebAuthNClient) GetAssertion

func (c *WebAuthNClient) GetAssertion(origin string, opts *share.RawAuthenticatorGetAssertionOptions) (*share.Assertion, error)

func (*WebAuthNClient) GetPlatformCredentialList

func (c *WebAuthNClient) GetPlatformCredentialList(rpid string) ([]*share.CredentialDetails, error)

GetPlatformCredentialList gets the list of WebAuthN/FIDO2 credentials currently stored for the user.

If rpid is not given, will use client rpid.

If rpid is "-", will let this argurement empty when calling win32 api.

func (*WebAuthNClient) MakeCredential

func (c *WebAuthNClient) MakeCredential(user User, origin string, opts *share.RawAuthenticatorMakeCredentialOptions) (*share.CredentialAttestation, error)

func (*WebAuthNClient) SetDefaultCOSE

func (c *WebAuthNClient) SetDefaultCOSE()

SetDefaultCOSE sets COSECredentialParameters to ES256 and RS256.