passkey

type AfterAuthenticationHook func(ctx context.Context, passkey *entity.Passkey, user *entity.User, session *entity.Session) error

type AfterRegistrationHook func(ctx context.Context, passkey *entity.Passkey, user *entity.User) error

type AuthenticationFailedPayload struct {
	UserID         *string        `json:"userId,omitempty"`
	ChallengeToken string         `json:"challengeToken"`
	Reason         string         `json:"reason"`
	Extra          map[string]any `json:"extra,omitempty"`
	Timestamp      time.Time      `json:"timestamp"`
}

type AuthenticationOptionsCreatedPayload struct {
	UserID         *string        `json:"userId,omitempty"`
	ChallengeToken string         `json:"challengeToken"`
	ExpiresAt      time.Time      `json:"expiresAt"`
	Extra          map[string]any `json:"extra,omitempty"`
	Timestamp      time.Time      `json:"timestamp"`
}

type AuthenticationOptionsResult struct {
	Options        *protocol.CredentialAssertion `json:"options"`
	ChallengeToken string                        `json:"challengeToken"`
	ExpiresAt      time.Time                     `json:"expiresAt"`
}

type AuthenticationVerifiedPayload struct {
	Passkey   *entity.Passkey `json:"passkey"`
	User      *entity.User    `json:"user"`
	Session   *entity.Session `json:"session"`
	Extra     map[string]any  `json:"extra,omitempty"`
	Timestamp time.Time       `json:"timestamp"`
}

type CeremonyType string

type Config struct {
	RPDisplayName                string                               // Relying Party human-readable name (default: "GoModularAuth")
	RPID                         string                               // Relying Party domain identifier (default: "localhost")
	RPOrigins                    []string                             // Allowed origin URLs (e.g. "http://localhost:3000")
	ChallengeTimeout             time.Duration                        // Ephemeral challenge lifespan (default: 5 minutes)
	RequireSessionOnRegistration bool                                 // Enforce caller session during registration (default: true)
	UserVerification             protocol.UserVerificationRequirement // User verification requirement (default: "preferred")
	ResidentKey                  protocol.ResidentKeyRequirement      // Resident key / Discoverable credential preference (default: "preferred")
	Attestation                  protocol.ConveyancePreference        // Attestation conveyance preference (default: "none")
	AuthenticatorAttachment      *protocol.AuthenticatorAttachment    // Optional attachment ("platform" or "cross-platform")
	SessionDuration              time.Duration                        // Lifespan of created user sessions (default: 7 days)
	ResolveUser                  ResolveUserFunc                      // User resolution callback
	AfterRegistration            AfterRegistrationHook                // Post-registration hook
	AfterAuthentication          AfterAuthenticationHook              // Post-authentication hook
}

type DeletePasskeyParams struct {
	ID           string `json:"id"`
	CallerUserID string `json:"callerUserId"`
	plugin.ExtraContainer
}

type GenerateAuthenticationOptionsParams struct {
	UserID *string `json:"userId,omitempty"` // Optional. Omit for discoverable/resident key/autofill login.
	plugin.ExtraContainer
}

type GenerateRegistrationOptionsParams struct {
	UserID                  string                            `json:"userId,omitempty"`
	UserName                string                            `json:"userName,omitempty"`
	UserDisplayName         string                            `json:"userDisplayName,omitempty"`
	AuthenticatorAttachment *protocol.AuthenticatorAttachment `json:"authenticatorAttachment,omitempty"`
	Context                 *string                           `json:"context,omitempty"`
	CustomName              *string                           `json:"customName,omitempty"`
	plugin.ExtraContainer
}

type ListPasskeysParams struct {
	UserID string `json:"userId"`
	plugin.ExtraContainer
}

type Option func(*Config)

type PasskeyChallenge struct {
	Token       string       `json:"token"`
	Type        CeremonyType `json:"type"`
	Challenge   string       `json:"challenge"`
	UserID      *string      `json:"userId,omitempty"`
	UserName    *string      `json:"userName,omitempty"`
	DisplayName *string      `json:"displayName,omitempty"`
	Context     *string      `json:"context,omitempty"`
	SessionData string       `json:"sessionData"` // Serialized JSON of webauthn.SessionData
	ExpiresAt   time.Time    `json:"expiresAt"`
	CreatedAt   time.Time    `json:"createdAt"`
}

type PasskeyDeletedPayload struct {
	PasskeyID string    `json:"passkeyId"`
	UserID    string    `json:"userId"`
	Timestamp time.Time `json:"timestamp"`
}

type PasskeyRegistrationUser struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	DisplayName string `json:"displayName"`
}

type PasskeyUpdatedPayload struct {
	Passkey   *entity.Passkey `json:"passkey"`
	OldName   *string         `json:"oldName,omitempty"`
	NewName   string          `json:"newName"`
	Timestamp time.Time       `json:"timestamp"`
}

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

type RegistrationFailedPayload struct {
	UserID         *string        `json:"userId,omitempty"`
	ChallengeToken string         `json:"challengeToken"`
	Reason         string         `json:"reason"`
	Extra          map[string]any `json:"extra,omitempty"`
	Timestamp      time.Time      `json:"timestamp"`
}

type RegistrationOptionsCreatedPayload struct {
	UserID         string         `json:"userId"`
	UserName       string         `json:"userName"`
	ChallengeToken string         `json:"challengeToken"`
	ExpiresAt      time.Time      `json:"expiresAt"`
	Extra          map[string]any `json:"extra,omitempty"`
	Timestamp      time.Time      `json:"timestamp"`
}

type RegistrationOptionsResult struct {
	Options        *protocol.CredentialCreation `json:"options"`
	ChallengeToken string                       `json:"challengeToken"`
	ExpiresAt      time.Time                    `json:"expiresAt"`
}

type RegistrationVerifiedPayload struct {
	Passkey   *entity.Passkey `json:"passkey"`
	User      *entity.User    `json:"user"`
	Extra     map[string]any  `json:"extra,omitempty"`
	Timestamp time.Time       `json:"timestamp"`
}

type Repository interface {
	// Passkeys CRUD
	CreatePasskey(ctx context.Context, passkey *entity.Passkey) error
	GetPasskeyByID(ctx context.Context, id string) (*entity.Passkey, error)
	GetPasskeyByCredentialID(ctx context.Context, credentialID string) (*entity.Passkey, error)
	ListPasskeysByUserID(ctx context.Context, userID string) ([]*entity.Passkey, error)
	UpdatePasskey(ctx context.Context, passkey *entity.Passkey) error
	UpdatePasskeyCounter(ctx context.Context, id string, newCounter uint32) error
	DeletePasskey(ctx context.Context, id string) error
	DeletePasskeysByUserID(ctx context.Context, userID string) error

	// Ephemeral Challenges
	SavePasskeyChallenge(ctx context.Context, challenge *PasskeyChallenge) error
	GetPasskeyChallenge(ctx context.Context, token string) (*PasskeyChallenge, error)
	ConsumePasskeyChallenge(ctx context.Context, token string) (*PasskeyChallenge, error)
	DeletePasskeyChallenge(ctx context.Context, token string) error

	// User & Session Integration
	GetUserByID(ctx context.Context, userID string) (*entity.User, error)
	GetUserByEmail(ctx context.Context, email string) (*entity.User, error)
	CreateSession(ctx context.Context, session *dto.CreateSessionParams) (*entity.Session, error)
}

type ResolveUserFunc func(ctx context.Context, queryContext *string, extra map[string]any) (*PasskeyRegistrationUser, error)

type UpdatePasskeyParams struct {
	ID           string `json:"id"`
	CallerUserID string `json:"callerUserId"`
	Name         string `json:"name"`
	plugin.ExtraContainer
}

type VerifyAuthenticationParams struct {
	ChallengeToken string                                `json:"challengeToken"`
	Origin         string                                `json:"origin,omitempty"`
	Response       *protocol.CredentialAssertionResponse `json:"response"`
	plugin.ExtraContainer
}

type VerifyAuthenticationResult struct {
	User    *entity.User    `json:"user"`
	Session *entity.Session `json:"session"`
	Passkey *entity.Passkey `json:"passkey"`
}

type VerifyRegistrationParams struct {
	ChallengeToken string                               `json:"challengeToken"`
	Origin         string                               `json:"origin,omitempty"`
	Response       *protocol.CredentialCreationResponse `json:"response"`
	Name           *string                              `json:"name,omitempty"`
	CallerUserID   *string                              `json:"callerUserId,omitempty"`
	plugin.ExtraContainer
}