auth

Jul 26, 2026

Changes in this version

type Option

+ func WithStore(s store.Store) Option

Jul 25, 2026

retracted

Changes in this version

+ const ReleaseVersion

Jul 8, 2026

Changes in this version

+ var ErrInvalidRequest = errors.New("auth: invalid request")

type Option

+ func WithSQLiteDB(db *sql.DB) Option

May 19, 2026

retracted

Changes in this version

+ const APIPath

+ const AdminPagePath

+ const EntityName

+ const ModuleDescription

+ const ModuleID

+ const ModuleName

+ const ModuleVersion

+ var ErrInvalidCredentials = errors.New("auth: invalid credentials")

+ var ErrNoCredentials = errors.New("auth: credentials require email or username")

+ var ErrPolicyDenied = errors.New("auth: login policy denied")

+ var ErrSessionExpired = errors.New("auth: session expired")

+ var ErrSessionRevoked = errors.New("auth: session revoked")

+ var ErrUserInactive = errors.New("auth: user is inactive")

+ type AuthService interface

+ InvalidateAllSessions func(ctx context.Context, userID string) error

+ Login func(ctx context.Context, tenantID string, creds Credentials) (*Session, error)

+ Logout func(ctx context.Context, sessionID string) error

+ ValidateSession func(ctx context.Context, sessionID string) (*Session, error)

+ type Credentials struct

+ Email string

+ Password string

+ Username string

+ func (c Credentials) Identifier() string

+ type Handler struct

+ func NewHandler(svc AuthService) *Handler

+ func (h *Handler) RegisterRoutes(mux *http.ServeMux)

+ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type LoginPolicy interface

+ AllowLogin func(ctx context.Context, tenantID, identifier string) error

+ RecordFailure func(ctx context.Context, tenantID, identifier string)

+ RecordSuccess func(ctx context.Context, tenantID, identifier string)

+ func PermissiveLoginPolicy() LoginPolicy

+ type Module struct

+ func MustNewModule(opts ...Option) *Module

+ func NewModule(opts ...Option) (*Module, error)

+ func (m *Module) Compose() pkmodule.Composable

+ func (m *Module) HTTPHandler() *Handler

+ func (m *Module) Hasher() passhash.Hasher

+ func (m *Module) Migrations() fs.FS

+ func (m *Module) Service() AuthService

+ func (m *Module) SessionTTL() time.Duration

+ func (m *Module) Sessions() SessionStore

+ type Option func(*config)

+ func WithAdminRegistrar(r portslib.AdminRegistrar) Option

+ func WithAuditEmitter(a audit.AuditEmitter) Option

+ func WithHasher(h passhash.Hasher) Option

+ func WithHealthRegistrar(r portslib.HealthRegistrar) Option

+ func WithLoginPolicy(p LoginPolicy) Option

+ func WithSQLiteDSN(dsn string) Option

+ func WithSQLiteDriver(driverName string) Option

+ func WithSessionStore(s SessionStore) Option

+ func WithSessionTTL(d time.Duration) Option

+ func WithUserReader(r user.UserBoundaryReader) Option

+ type Session struct

+ ExpiresAt time.Time

+ ID string

+ IssuedAt time.Time

+ RevokedAt *time.Time

+ TenantID string

+ UserID string

+ func (s *Session) Validate() error

+ type SessionStore interface

+ Create func(ctx context.Context, s *Session) error

+ Get func(ctx context.Context, id string) (*Session, error)

+ Revoke func(ctx context.Context, id string) error

+ RevokeByUser func(ctx context.Context, userID string) error