passkey

type CloneAction int

type Config struct {
	// RPDisplayName is shown to the user by the authenticator ("Example
	// Inc").
	RPDisplayName string
	// RPID is the relying party identifier: your registrable domain, with
	// no scheme, port or path ("example.com"). A credential is bound to it
	// permanently — change it and every passkey your users hold stops
	// working, with no migration.
	RPID string
	// RPOrigins are the exact origins allowed to complete a ceremony
	// ("https://example.com"). Every entry is checked against the origin
	// the browser reports, which is what stops a page on another site from
	// driving your authenticator.
	RPOrigins []string
	// UserVerification defaults to protocol.VerificationRequired. Lower it
	// only for a passkey used strictly as a second factor behind a
	// password, and understand that doing so makes a passkey-only login
	// single-factor.
	UserVerification protocol.UserVerificationRequirement
	// OnClone defaults to CloneReject.
	OnClone CloneAction
	// Timeout bounds how long a ceremony may take. Defaults to 60s.
	Timeout time.Duration
	// AuditLogger receives registration, login and revocation events.
	AuditLogger audit.Logger
}

type Options []byte

type Result struct {
	// User is the authit account that just authenticated.
	User store.User
	// Credential is the authenticator that signed, as it now stands.
	Credential store.WebAuthnCredential
	// UserVerified reports whether the authenticator verified the user
	// with a PIN or biometric.
	//
	// It is the difference between one factor and two. A Service
	// configured with VerificationRequired refuses an assertion without
	// it, so this is always true there; it is reported so that a Service
	// configured otherwise can still tell, and can decide to ask for a
	// password as well.
	UserVerified bool
}

type Service struct {
	// contains filtered or unexported fields
}

type Session []byte

type Stores struct {
	Users       store.UserStore
	Credentials store.WebAuthnCredentialStore
	// Challenges holds in-flight ceremonies. Required.
	//
	// It is not optional the way Tx is, and the difference is deliberate.
	// Leaving Tx nil costs atomicity a host may never have had; leaving
	// this nil would cost single-use challenges, and a challenge that can
	// be redeemed twice is a captured assertion that can be replayed --
	// indefinitely, against any authenticator reporting a signature
	// counter of zero, which is every synced passkey. There is no version
	// of that worth offering as a convenience.
	Challenges store.WebAuthnChallengeStore
	// Tx is optional; see store.TxRunner.
	Tx store.TxRunner
}