authall

package module

Go to main page

Versions in this module

v0

v0.4.1

Sep 11, 2026

v0.4.0

Sep 11, 2026

Changes in this version

type Auth

+ func (a *Auth) ChangePassword(ctx context.Context, in ChangePasswordInput) error

+ func (a *Auth) ClearSessionCookie(w http.ResponseWriter)

+ func (a *Auth) SetSessionCookie(w http.ResponseWriter, token string, expiresAt time.Time)

+ func (a *Auth) SignIn(ctx context.Context, in SignInInput) (*SignInResult, error)

+ func (a *Auth) SignOut(ctx context.Context, session *store.Session) error

+ func (a *Auth) SignOutToken(ctx context.Context, token string) error

+ type ChangePasswordInput struct

+ ClientIP string

+ CurrentPassword string

+ KeepOtherSessions bool

+ KeepSessionID string

+ NewPassword string

+ UserID string

type Option

+ func WithOrganizationFields(fields ...schema.UserField) Option

+ func WithStrictOriginCheck() Option

type Principal

+ Membership *store.Membership

+ Organization *store.Organization

+ type RateLimitError struct

+ RetryAfter time.Duration

+ func (e *RateLimitError) Error() string

+ func (e *RateLimitError) Unwrap() error

+ type SignInInput struct

+ ClientIP string

+ Email string

+ Password string

+ PreviousSessionToken string

+ type SignInResult struct

+ MFARequired bool

+ MFAToken string

+ Session *store.Session

+ Token string

+ User *store.User

v0.3.0

Sep 10, 2026

Changes in this version

+ const DefaultConsistencyBound

+ const MethodAPIKey

+ const MethodSession

+ var ErrAPIKeyExpiryRequired = apierr.ErrAPIKeyExpiryRequired

+ var ErrAPIKeyExpiryTooLong = apierr.ErrAPIKeyExpiryTooLong

+ var ErrInsufficientRole = apierr.ErrInsufficientRole

+ var ErrLastAdmin = apierr.ErrLastAdmin

+ var ErrPasswordChangeRequired = apierr.ErrPasswordChangeRequired

+ var ErrRoleNotAllowed = apierr.ErrRoleNotAllowed

+ var ErrRoleUnknown = apierr.ErrRoleUnknown

+ var ErrUserDisabled = apierr.ErrUserDisabled

+ func Field[T any](user *store.User, name string) (T, error)

type Auth

+ func (a *Auth) ConsistencyBound() time.Duration

+ func (a *Auth) DefaultRole() string

+ func (a *Auth) ExportMigrations(d schema.Dialect, f migrations.Format) ([]migrations.File, error)

+ func (a *Auth) HandlerStripped() http.Handler

+ func (a *Auth) RevokeOtherSessions(ctx context.Context, sessionID string) (int, error)

+ func (a *Auth) RoleAtLeast(role, min string) bool

+ func (a *Auth) RoleNames() []string

+ func (a *Auth) Store() store.Store

+ func (a *Auth) UserFields() []schema.UserField

type CreateUserInput

+ Extra *store.ExtraFields

type Option

+ func WithConsistencyBound(d time.Duration) Option

+ func WithErrorWriter(f func(w http.ResponseWriter, r *http.Request, e *Error)) Option

+ func WithHostOriginCheck(on bool) Option

+ func WithPrincipalCache(ttl time.Duration) Option

+ func WithSchema(o schema.Options) Option

+ func WithSchemaCheck(m SchemaCheckMode) Option

+ func WithUserFields(fields ...schema.UserField) Option

+ type Principal struct

+ APIKey *store.APIKey

+ Method string

+ Role string

+ Session *store.Session

+ User *store.User

+ ViaCookie bool

+ func PrincipalFrom(ctx context.Context) *Principal

+ type SchemaCheckMode int

+ const SchemaCheckCatalog

+ const SchemaCheckRecord

+ type SchemaContributor interface

+ SchemaTables func(o schema.Options) []schema.Table

+ SchemaUnits func(o schema.Options) ([]schema.Unit, error)

v0.2.0

Sep 2, 2026

Changes in this version

+ const MFATokenKind

+ const RecoveryCodeCount

+ func SessionFrom(ctx context.Context) *store.Session

+ func UserFrom(ctx context.Context) *store.User

type Auth

+ func (a *Auth) LoadSession(next http.Handler) http.Handler

+ func (a *Auth) LoadSessionFunc(next http.HandlerFunc) http.Handler

+ func (a *Auth) RequireAuth(next http.Handler) http.Handler

+ func (a *Auth) RequireAuthFunc(next http.HandlerFunc) http.Handler

type Option

+ func WithTOTP(opts ...TOTPOptions) Option

+ type TOTPOptions struct

+ Issuer string

v0.1.0

Aug 24, 2026

Changes in this version

+ const DefaultBasePath

+ const DefaultCookieName

+ const DefaultOAuthStateTTL

+ const DefaultPasswordResetTTL

+ const DefaultSessionIdleTimeout

+ const DefaultSessionTTL

+ const DefaultSessionTouchInterval

+ const DefaultVerificationTTL

+ const Version

+ var ErrEmailAlreadyExists = apierr.ErrEmailAlreadyExists

+ var ErrForbidden = apierr.ErrForbidden

+ var ErrInvalidCredentials = apierr.ErrInvalidCredentials

+ var ErrInvalidRequest = apierr.ErrInvalidRequest

+ var ErrInvalidToken = apierr.ErrInvalidToken

+ var ErrLastAuthMethod = apierr.ErrLastAuthMethod

+ var ErrNoPasswordCredential = apierr.ErrNoPasswordCredential

+ var ErrNotFound = apierr.ErrNotFound

+ var ErrUnauthorized = apierr.ErrUnauthorized

+ var ErrWeakPassword = apierr.ErrWeakPassword

+ type AccountLinkingOptions struct

+ AllowVerifiedEmailAutoLink bool

+ type Argon2Params = crypto.Argon2Params

+ func DefaultArgon2Params() Argon2Params

+ type Auth struct

+ func New(opts ...Option) (*Auth, error)

+ func (a *Auth) Accounts(ctx context.Context, userID string) ([]store.Account, error)

+ func (a *Auth) BasePath() string

+ func (a *Auth) CheckSchema(ctx context.Context) error

+ func (a *Auth) Cleanup(ctx context.Context) error

+ func (a *Auth) CreateUser(ctx context.Context, in CreateUserInput) (*store.User, error)

+ func (a *Auth) GetUser(ctx context.Context, id string) (*store.User, error)

+ func (a *Auth) GetUserByEmail(ctx context.Context, address string) (*store.User, error)

+ func (a *Auth) Handler() http.Handler

+ func (a *Auth) Hooks() *hook.Hooks

+ func (a *Auth) Migrate(ctx context.Context) ([]schema.Statement, error)

+ func (a *Auth) MigrationPlan(ctx context.Context) ([]schema.Statement, error)

+ func (a *Auth) MigrationSQL(d schema.Dialect) ([]schema.Statement, error)

+ func (a *Auth) OpenAPI() *openapi.Document

+ func (a *Auth) RevokeSession(ctx context.Context, sessionID string) error

+ func (a *Auth) RevokeUserSessions(ctx context.Context, userID string) (int, error)

+ func (a *Auth) Routes() []RouteInfo

+ func (a *Auth) Schema() *schema.Schema

+ func (a *Auth) Session(ctx context.Context, r *http.Request) (*store.Session, error)

+ func (a *Auth) User(ctx context.Context, r *http.Request) (*store.User, error)

+ func (a *Auth) VerifyEmailToken(ctx context.Context, token string) (*store.User, error)

+ type Code = apierr.Code

+ type CookieOptions struct

+ Domain string

+ Name string

+ Path string

+ SameSite http.SameSite

+ Secure *bool

+ type CreateUserInput struct

+ DisplayName string

+ Email string

+ EmailVerified bool

+ ImageURL string

+ Password string

+ type EmailPasswordOptions struct

+ ChangeEmailURL string

+ DeleteAccountURL string

+ RequireEmailVerification bool

+ ResetPasswordURL string

+ SendVerificationOnSignUp bool

+ VerifyEmailURL string

+ type Error = apierr.Error

+ type Option func(*config)

+ func WithAccountLinking(o AccountLinkingOptions) Option

+ func WithArgon2Params(p crypto.Argon2Params) Option

+ func WithBasePath(p string) Option

+ func WithBaseURL(u string) Option

+ func WithClock(now func() time.Time) Option

+ func WithCookie(o CookieOptions) Option

+ func WithCookieSameSite(mode http.SameSite) Option

+ func WithEmailPassword(opts ...EmailPasswordOptions) Option

+ func WithEmailSender(s email.Sender) Option

+ func WithEventHandler(h events.Handler) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithPasswordPolicy(p PasswordPolicy) Option

+ func WithPlugins(plugins ...plugin.Plugin) Option

+ func WithProvider(providers ...oauth.Provider) Option

+ func WithRateLimiter(l ratelimit.Limiter) Option

+ func WithSession(o SessionOptions) Option

+ func WithSessionLifetime(idle, absolute time.Duration) Option

+ func WithStore(s store.Store) Option

+ func WithStrictRateLimiting() Option

+ func WithTokenTTL(o TokenTTLOptions) Option

+ func WithTrustedOrigins(origins ...string) Option

+ func WithTrustedProxies(cidrs ...string) Option

+ type PasswordPolicy struct

+ MaxLength int

+ MinLength int

+ func DefaultPasswordPolicy() PasswordPolicy

+ type RouteInfo struct

+ Documented bool

+ Method string

+ Path string

+ PluginID string

+ type SessionOptions struct

+ IdleTimeout time.Duration

+ TTL time.Duration

+ TouchInterval time.Duration

+ type TokenTTLOptions struct

+ EmailVerification time.Duration

+ OAuthState time.Duration

+ PasswordReset time.Duration

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL