types

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 11, 2026 License: GPL-3.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Validation errors
	MsgEmailRequired                     = "Email is required field"
	MsgPasswordRequired                  = "Password is required field"
	MsgFirstNameRequired                 = "First name is required field"
	MsgLastNameRequired                  = "Last name is required field"
	MsgTokenRequired                     = "Token is required field"
	MsgVerificationCodeRequired          = "Verification code is required field"
	MsgPasswordsDoNotMatch               = "Passwords do not match"
	MsgEmailInvalid                      = "Email is invalid"
	MsgVerificationCodeInvalidLength     = "Verification code is invalid length"
	MsgVerificationCodeInvalidCharacters = "Verification code contains invalid characters"
	MsgVerificationCodeExpired           = "Verification code has expired"
	MsgSerializedFormatMalformed         = "Serialized format is malformed"

	// Auth errors
	MsgInvalidCredentials = "Invalid credentials"
	MsgUserNotFound       = "User not found"

	// Operation errors
	MsgRegistrationFailed          = "registration failed."
	MsgRegistrationFailedFn        = "registration failed. FuncUserRegister function not defined"
	MsgRegistrationFailedEmailTpl  = "registration failed. FuncEmailTemplateRegisterCode function not defined"
	MsgRegistrationFailedEmailSend = "registration failed. FuncEmailSend function not defined"
	MsgRegistrationFailedGeneric   = "Registration failed. Please try again later"
	MsgPasswordResetFailed         = "Password reset failed. Please try again later"
	MsgLogoutFailed                = "Logout failed. Please try again later"
	MsgPasswordValidationFailed    = "Password validation failed"

	// Generic internal errors
	MsgInternalServer        = "Internal server error. Please try again later"
	MsgFailedToProcess       = "Failed to process request. Please try again later"
	MsgFailedToGenerateCode  = "Failed to generate verification code. Please try again later"
	MsgFailedToSendEmail     = "Failed to send email. Please try again later"
	MsgLinkNotValidOrExpired = "Link not valid or expired"
	MsgTooManyRequests       = "Too many requests. Please try again later."

	// Email subjects
	EmailSubjectRegistrationCode = "Registration Code"

	// Success messages
	MsgLoginSuccess          = "login success"
	MsgRegistrationSuccess   = "registration success"
	MsgRegistrationCodeSent  = "Registration code was sent successfully"
	MsgLoginCodeSent         = "Login code was sent successfully"
	MsgPasswordResetLinkSent = "Password reset link was sent to your e-mail"
	MsgPasswordResetSuccess  = "Password has been reset successfully"
)

Error messages for validation and internal failures. These constants centralize all user-facing strings so applications can override or localize them without modifying core business logic.

View Source 
const (
	LoginMethodPassword     = "password"
	LoginMethodPasswordless = "passwordless"
)

Login method identifiers used by RecordLoginAttempt.

View Source 
const CookieName = "authtoken"

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthPasswordInterface added in v0.30.0 

type AuthPasswordInterface interface {
	AuthSharedInterface

	// Password reset URLs (web and API).
	LinkPasswordRestore() string
	LinkPasswordReset(token string) string
	LinkApiPasswordRestore() string
	LinkApiPasswordReset() string
}

AuthPasswordInterface represents username/password based authentication. It extends the shared interface with password-reset specific helpers.

type AuthPasswordlessInterface added in v0.30.0 

type AuthPasswordlessInterface interface {
	AuthSharedInterface

	// Passwordless-only URL helpers.
	LinkLoginCodeVerify() string
	LinkApiLoginCodeVerify() string
}

AuthPasswordlessInterface represents passwordless authentication flows. It extends the shared interface with login/verification code helpers.

type AuthSharedInterface added in v0.30.0 

type AuthSharedInterface interface {
	// Router returns an HTTP mux that serves all auth routes.
	Router() *http.ServeMux

	IsRegistrationEnabled() bool
	IsPasswordless() bool
	IsVerificationEnabled() bool

	// Middlewares for protecting or enriching routes.
	WebAuthOrRedirectMiddleware(next http.Handler) http.Handler
	// ApiAuthOrErrorMiddleware(next http.Handler) http.Handler
	WebAppendUserIdIfExistsMiddleware(next http.Handler) http.Handler

	// Current user lookup from the request context.
	GetCurrentUserID(r *http.Request) string

	// Web URL helpers
	LinkLogin() string
	LinkLogout() string
	LinkRegister() string
	LinkRegisterCodeVerify() string
	LinkRedirectOnSuccess() string

	// API URL helpers
	LinkApiLogin() string
	LinkApiLogout() string
	LinkApiRegister() string
	LinkApiRegisterCodeVerify() string

	GetEndpoint() string
	SetEndpoint(endpoint string)

	GetLogger() *slog.Logger
	SetLogger(logger *slog.Logger)

	GetLayout() func(content string) string
	SetLayout(layout func(content string) string)

	GetFuncTemporaryKeyGet() func(key string) (string, error)
	SetFuncTemporaryKeyGet(fn func(key string) (string, error))

	GetFuncTemporaryKeySet() func(key string, value string, expiresSeconds int) error
	SetFuncTemporaryKeySet(fn func(key string, value string, expiresSeconds int) error)

	GetUseCookies() bool
	SetUseCookies(useCookies bool)

	GetFuncUserFindByAuthToken() func(ctx context.Context, token string, options UserAuthOptions) (userID string, err error)
	SetFuncUserFindByAuthToken(fn func(ctx context.Context, token string, options UserAuthOptions) (userID string, err error))

	// Additional accessors used by internal API flows.
	GetDisableRateLimit() bool
	SetDisableRateLimit(disable bool)

	GetPasswordStrength() *PasswordStrengthConfig
	SetPasswordStrength(cfg *PasswordStrengthConfig)

	GetFuncUserLogin() func(ctx context.Context, username, password string, options UserAuthOptions) (string, error)
	SetFuncUserLogin(fn func(ctx context.Context, username, password string, options UserAuthOptions) (string, error))

	GetPasswordlessUserRegister() func(ctx context.Context, email, firstName, lastName string, options UserAuthOptions) error
	SetPasswordlessUserRegister(fn func(ctx context.Context, email, firstName, lastName string, options UserAuthOptions) error)

	GetFuncUserRegister() func(ctx context.Context, username, password, firstName, lastName string, options UserAuthOptions) error
	SetFuncUserRegister(fn func(ctx context.Context, username, password, firstName, lastName string, options UserAuthOptions) error)

	GetFuncUserPasswordChange() func(ctx context.Context, userID, password string, options UserAuthOptions) error
	SetFuncUserPasswordChange(fn func(ctx context.Context, userID, password string, options UserAuthOptions) error)

	GetFuncUserLogout() func(ctx context.Context, userID string, options UserAuthOptions) error
	SetFuncUserLogout(fn func(ctx context.Context, userID string, options UserAuthOptions) error)

	GetPasswordlessUserFindByEmail() func(ctx context.Context, email string, options UserAuthOptions) (string, error)
	SetPasswordlessUserFindByEmail(fn func(ctx context.Context, email string, options UserAuthOptions) (string, error))

	GetFuncUserFindByUsername() func(ctx context.Context, username, firstName, lastName string, options UserAuthOptions) (string, error)
	SetFuncUserFindByUsername(fn func(ctx context.Context, username, firstName, lastName string, options UserAuthOptions) (string, error))

	GetFuncEmailTemplatePasswordRestore() func(ctx context.Context, userID string, passwordRestoreLink string, options UserAuthOptions) string
	SetFuncEmailTemplatePasswordRestore(fn func(ctx context.Context, userID string, passwordRestoreLink string, options UserAuthOptions) string)

	GetFuncEmailTemplateRegisterCode() func(ctx context.Context, email string, passwordRestoreLink string, options UserAuthOptions) string
	SetFuncEmailTemplateRegisterCode(fn func(ctx context.Context, email string, passwordRestoreLink string, options UserAuthOptions) string)

	GetFuncEmailSend() func(ctx context.Context, userID, emailSubject, emailBody string) error
	SetFuncEmailSend(fn func(ctx context.Context, userID, emailSubject, emailBody string) error)

	GetPasswordlessFuncEmailTemplateLoginCode() func(ctx context.Context, email string, passwordRestoreLink string, options UserAuthOptions) string
	SetPasswordlessFuncEmailTemplateLoginCode(fn func(ctx context.Context, email string, passwordRestoreLink string, options UserAuthOptions) string)

	GetPasswordlessFuncEmailTemplateRegisterCode() func(ctx context.Context, email string, passwordRestoreLink string, options UserAuthOptions) string
	SetPasswordlessFuncEmailTemplateRegisterCode(fn func(ctx context.Context, email string, passwordRestoreLink string, options UserAuthOptions) string)

	GetPasswordlessFuncEmailSend() func(ctx context.Context, email string, emailSubject, emailBody string) error
	SetPasswordlessFuncEmailSend(fn func(ctx context.Context, email string, emailSubject, emailBody string) error)

	GetFuncUserStoreAuthToken() func(ctx context.Context, token, userID string, options UserAuthOptions) error
	SetFuncUserStoreAuthToken(fn func(ctx context.Context, token, userID string, options UserAuthOptions) error)

	SetAuthCookie(w http.ResponseWriter, r *http.Request, token string)
	RemoveAuthCookie(w http.ResponseWriter, r *http.Request)

	// Observability hooks for metrics and tracing (optional).
	GetObservabilityHooks() ObservabilityHooks
	SetObservabilityHooks(hooks ObservabilityHooks)

	// Final authentication step helpers used by internal API flows.
	AuthenticateViaUsername(w http.ResponseWriter, r *http.Request, email, firstName, lastName string)
}

AuthSharedInterface defines the common behavior shared by all auth modes. It includes routing helpers, middleware, current user access, and the primary login/register URL helpers.

type AuthenticatedUserID added in v0.30.0 

type AuthenticatedUserID struct{}

type ConfigPasswordless added in v0.30.0 

type ConfigPasswordless struct {

	// ===== START: shared by all implementations
	EnableRegistration      bool
	Endpoint                string
	FuncLayout              func(content string) string
	FuncTemporaryKeyGet     func(key string) (value string, err error)
	FuncTemporaryKeySet     func(key string, value string, expiresSeconds int) (err error)
	FuncUserFindByAuthToken func(ctx context.Context, sessionID string, options UserAuthOptions) (userID string, err error)
	FuncUserLogout          func(ctx context.Context, userID string, options UserAuthOptions) (err error)
	FuncUserStoreAuthToken  func(ctx context.Context, sessionID string, userID string, options UserAuthOptions) error
	UrlRedirectOnSuccess    string
	UseCookies              bool
	UseLocalStorage         bool
	CookieConfig            *CookieConfig
	// Rate limiting options
	DisableRateLimit   bool                                                                                 // Set to true to disable rate limiting (not recommended for production)
	FuncCheckRateLimit func(ip string, endpoint string) (allowed bool, retryAfter time.Duration, err error) // Optional: override default rate limiter
	MaxLoginAttempts   int                                                                                  // Maximum attempts before lockout (default: 5)
	LockoutDuration    time.Duration                                                                        // Duration to lock after max attempts (default: 15 minutes)
	// CSRF Protection
	EnableCSRFProtection bool
	CSRFSecret           string
	Logger               *slog.Logger

	// ===== START: passwordless options
	FuncUserFindByEmail           func(ctx context.Context, email string, options UserAuthOptions) (userID string, err error)
	FuncEmailTemplateLoginCode    func(ctx context.Context, email string, logingLink string, options UserAuthOptions) string   // optional
	FuncEmailTemplateRegisterCode func(ctx context.Context, email string, registerLink string, options UserAuthOptions) string // optional
	FuncEmailSend                 func(ctx context.Context, email string, emailSubject string, emailBody string) (err error)
	FuncUserRegister              func(ctx context.Context, email string, firstName string, lastName string, options UserAuthOptions) (err error)
	// Observability hooks for metrics and tracing (optional)
	ObservabilityHooks ObservabilityHooks
}

type ConfigUsernameAndPassword added in v0.30.0 

type ConfigUsernameAndPassword struct {
	// ===== START: shared by all implementations
	EnableRegistration      bool
	Endpoint                string
	FuncLayout              func(content string) string
	FuncTemporaryKeyGet     func(key string) (value string, err error)
	FuncTemporaryKeySet     func(key string, value string, expiresSeconds int) (err error)
	FuncUserStoreAuthToken  func(ctx context.Context, sessionID string, userID string, options UserAuthOptions) error
	FuncUserFindByAuthToken func(ctx context.Context, sessionID string, options UserAuthOptions) (userID string, err error)
	UrlRedirectOnSuccess    string
	UseCookies              bool
	UseLocalStorage         bool
	CookieConfig            *CookieConfig
	// Rate limiting options
	DisableRateLimit   bool                                                                                 // Set to true to disable rate limiting (not recommended for production)
	FuncCheckRateLimit func(ip string, endpoint string) (allowed bool, retryAfter time.Duration, err error) // Optional: override default rate limiter
	MaxLoginAttempts   int                                                                                  // Maximum attempts before lockout (default: 5)
	LockoutDuration    time.Duration                                                                        // Duration to lock after max attempts (default: 15 minutes)
	// CSRF Protection
	EnableCSRFProtection bool
	CSRFSecret           string
	Logger               *slog.Logger

	// ===== START: username(email) and password options
	EnableVerification               bool
	FuncEmailTemplatePasswordRestore func(ctx context.Context, userID string, passwordRestoreLink string, options UserAuthOptions) string // optional
	FuncEmailTemplateRegisterCode    func(ctx context.Context, userID string, passwordRestoreLink string, options UserAuthOptions) string // optional
	FuncEmailSend                    func(ctx context.Context, userID string, emailSubject string, emailBody string) (err error)
	FuncUserFindByUsername           func(ctx context.Context, username string, firstName string, lastName string, options UserAuthOptions) (userID string, err error)
	FuncUserLogin                    func(ctx context.Context, username string, password string, options UserAuthOptions) (userID string, err error)
	FuncUserLogout                   func(ctx context.Context, userID string, options UserAuthOptions) (err error)
	FuncUserPasswordChange           func(ctx context.Context, username string, newPassword string, options UserAuthOptions) (err error)
	FuncUserRegister                 func(ctx context.Context, username string, password string, first_name string, last_name string, options UserAuthOptions) (err error)
	PasswordStrength                 *PasswordStrengthConfig
	LabelUsername                    string
	// Observability hooks for metrics and tracing (optional)
	ObservabilityHooks ObservabilityHooks
}

Config defines the available configuration options for authentication

type CookieConfig added in v0.30.0 

type CookieConfig struct {
	HttpOnly bool
	Secure   bool
	SameSite http.SameSite
	MaxAge   int
	Domain   string
	Path     string
}

type NoopObservabilityHooks added in v0.31.0 

type NoopObservabilityHooks struct{}

NoopObservabilityHooks is a no-op implementation of ObservabilityHooks. It is the default when no hooks are configured.

func (NoopObservabilityHooks) RecordLoginAttempt added in v0.31.0 

func (NoopObservabilityHooks) RecordLoginAttempt(string, bool, error)

func (NoopObservabilityHooks) RecordPasswordReset added in v0.31.0 

func (NoopObservabilityHooks) RecordPasswordReset(bool, error)

func (NoopObservabilityHooks) RecordRateLimitHit added in v0.31.0 

func (NoopObservabilityHooks) RecordRateLimitHit(string, string)

func (NoopObservabilityHooks) RecordRegistrationAttempt added in v0.31.0 

func (NoopObservabilityHooks) RecordRegistrationAttempt(bool, error)

func (NoopObservabilityHooks) RecordSessionCreated added in v0.31.0 

func (NoopObservabilityHooks) RecordSessionCreated(string)

type ObservabilityHooks added in v0.31.0 

type ObservabilityHooks interface {
	// RecordLoginAttempt is called after every login attempt (success or
	// failure). method is "password" or "passwordless". err is nil on
	// success.
	RecordLoginAttempt(method string, success bool, err error)

	// RecordRegistrationAttempt is called after every registration attempt.
	// err is nil on success.
	RecordRegistrationAttempt(success bool, err error)

	// RecordRateLimitHit is called when a request is denied due to rate
	// limiting.
	RecordRateLimitHit(endpoint string, ip string)

	// RecordSessionCreated is called when a new session/token is issued
	// for a user.
	RecordSessionCreated(userID string)

	// RecordPasswordReset is called after a password reset attempt.
	// err is nil on success.
	RecordPasswordReset(success bool, err error)
}

ObservabilityHooks allows applications to record metrics and tracing spans for authentication events using their preferred provider (Prometheus, Datadog, OpenTelemetry, etc.).

All methods must be safe to call from multiple goroutines. Implementations should be non-blocking; if a method needs to do expensive work it should do so asynchronously.

A nil ObservabilityHooks is valid and means no metrics are recorded.

type PasswordStrengthConfig 

type PasswordStrengthConfig struct {
	MinLength         int
	RequireUppercase  bool
	RequireLowercase  bool
	RequireDigit      bool
	RequireSpecial    bool
	ForbidCommonWords bool
}

PasswordStrengthConfig defines configurable rules for password strength.

type UserAuthOptions added in v0.30.0 

type UserAuthOptions struct {
	UserIp    string
	UserAgent string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.