auth

package module

Go to main page

Versions in this module

v0

v0.29.0

Nov 28, 2025

Changes in this version

+ const DefaultAuthTokenExpiration

+ const DefaultLockoutDuration

+ const DefaultMaxLoginAttempts

+ const DefaultPasswordResetExpiration

+ const DefaultVerificationCodeExpiration

+ const ErrCodeAuthenticationFailed

+ const ErrCodeCodeGenerationFailed

+ const ErrCodeEmailSendFailed

+ const ErrCodeInternalError

+ const ErrCodeLogoutFailed

+ const ErrCodePasswordResetFailed

+ const ErrCodeRegistrationFailed

+ const ErrCodeSerializationFailed

+ const ErrCodeTokenStoreFailed

+ const ErrCodeValidationFailed

+ type AuthError struct

+ Code string

+ InternalErr error

+ Message string

+ func NewAuthenticationError(err error) AuthError

+ func NewCodeGenerationError(err error) AuthError

+ func NewEmailSendError(err error) AuthError

+ func NewInternalError(err error) AuthError

+ func NewLogoutError(err error) AuthError

+ func NewPasswordResetError(err error) AuthError

+ func NewRegistrationError(err error) AuthError

+ func NewSerializationError(err error) AuthError

+ func NewTokenStoreError(err error) AuthError

+ func (e AuthError) Error() string

type ConfigPasswordless

+ CookieConfig *CookieConfig

+ Logger *slog.Logger

type ConfigUsernameAndPassword

+ CookieConfig *CookieConfig

+ Logger *slog.Logger

+ PasswordStrength *authtypes.PasswordStrengthConfig

+ type CookieConfig struct

+ Domain string

+ HttpOnly bool

+ MaxAge int

+ Path string

+ SameSite http.SameSite

+ Secure bool

v0.28.0

Nov 28, 2025

Changes in this version

type ConfigPasswordless

+ CSRFSecret string

+ DisableRateLimit bool

+ EnableCSRFProtection bool

+ FuncCheckRateLimit func(ip string, endpoint string) (allowed bool, retryAfter time.Duration, err error)

+ LockoutDuration time.Duration

+ MaxLoginAttempts int

type ConfigUsernameAndPassword

+ CSRFSecret string

+ DisableRateLimit bool

+ EnableCSRFProtection bool

+ FuncCheckRateLimit func(ip string, endpoint string) (allowed bool, retryAfter time.Duration, err error)

+ LockoutDuration time.Duration

+ MaxLoginAttempts int

+ type InMemoryRateLimiter struct

+ func GetDefaultRateLimiter() *InMemoryRateLimiter

+ func NewInMemoryRateLimiter(maxAttempts int, windowDuration time.Duration, lockoutDuration time.Duration) *InMemoryRateLimiter

+ func (r *InMemoryRateLimiter) Check(ip string, endpoint string) RateLimitResult

+ func (r *InMemoryRateLimiter) Stop()

+ type RateLimitResult struct

+ Allowed bool

+ RetryAfter time.Duration

v0.27.0

Nov 27, 2025

v0.26.0

Nov 26, 2025

v0.25.0

Oct 30, 2025

v0.24.0

Sep 13, 2025

v0.23.0

Sep 13, 2025

Changes in this version

+ const CookieName

+ const LoginCodeGamma

+ const LoginCodeLength

+ const PathApiLogin

+ const PathApiLoginCodeVerify

+ const PathApiLogout

+ const PathApiRegister

+ const PathApiRegisterCodeVerify

+ const PathApiResetPassword

+ const PathApiRestorePassword

+ const PathLogin

+ const PathLoginCodeVerify

+ const PathLogout

+ const PathPasswordReset

+ const PathPasswordRestore

+ const PathRegister

+ const PathRegisterCodeVerify

+ func AuthCookieGet(r *http.Request) string

+ func AuthCookieRemove(w http.ResponseWriter, r *http.Request)

+ func AuthCookieSet(w http.ResponseWriter, r *http.Request, token string)

+ func AuthTokenRetrieve(r *http.Request, useCookies bool) string

+ func BearerTokenFromHeader(authHeader string) string

+ type Auth struct

+ func NewPasswordlessAuth(config ConfigPasswordless) (*Auth, error)

+ func NewUsernameAndPasswordAuth(config ConfigUsernameAndPassword) (*Auth, error)

+ func (a Auth) ApiAuthOrErrorMiddleware(next http.Handler) http.Handler

+ func (a Auth) AuthHandler(w http.ResponseWriter, r *http.Request)

+ func (a Auth) AuthMiddleware(next http.Handler) http.Handler

+ func (a Auth) GetCurrentUserID(r *http.Request) string

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

+ func (a Auth) LinkApiLogin() string

+ func (a Auth) LinkApiLoginCodeVerify() string

+ func (a Auth) LinkApiLogout() string

+ func (a Auth) LinkApiPasswordReset() string

+ func (a Auth) LinkApiPasswordRestore() string

+ func (a Auth) LinkApiRegister() string

+ func (a Auth) LinkApiRegisterCodeVerify() string

+ func (a Auth) LinkLogin() string

+ func (a Auth) LinkLoginCodeVerify() string

+ func (a Auth) LinkLogout() string

+ func (a Auth) LinkPasswordReset(token string) string

+ func (a Auth) LinkPasswordRestore() string

+ func (a Auth) LinkRedirectOnSuccess() string

+ func (a Auth) LinkRegister() string

+ func (a Auth) LinkRegisterCodeVerify() string

+ func (a Auth) LoginWithUsernameAndPassword(email string, password string, options UserAuthOptions) (response LoginUsernameAndPasswordResponse)

+ func (a Auth) RegisterWithUsernameAndPassword(email string, password string, firstName string, lastName string, ...) (response RegisterUsernameAndPasswordResponse)

+ func (a Auth) RegistrationDisable()

+ func (a Auth) RegistrationEnable()

+ func (a Auth) Router() *http.ServeMux

+ func (a Auth) WebAppendUserIdIfExistsMiddleware(next http.Handler) http.Handler

+ func (a Auth) WebAuthOrRedirectMiddleware(next http.Handler) http.Handler

+ type AuthenticatedUserID struct

+ type ConfigPasswordless struct

+ EnableRegistration bool

+ Endpoint string

+ FuncEmailSend func(email string, emailSubject string, emailBody string) (err error)

+ FuncEmailTemplateLoginCode func(email string, logingLink string, options UserAuthOptions) string

+ FuncEmailTemplateRegisterCode func(email string, registerLink string, options UserAuthOptions) 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(sessionID string, options UserAuthOptions) (userID string, err error)

+ FuncUserFindByEmail func(email string, options UserAuthOptions) (userID string, err error)

+ FuncUserLogout func(userID string, options UserAuthOptions) (err error)

+ FuncUserRegister func(email string, firstName string, lastName string, options UserAuthOptions) (err error)

+ FuncUserStoreAuthToken func(sessionID string, userID string, options UserAuthOptions) error

+ UrlRedirectOnSuccess string

+ UseCookies bool

+ UseLocalStorage bool

+ type ConfigUsernameAndPassword struct

+ EnableRegistration bool

+ EnableVerification bool

+ Endpoint string

+ FuncEmailSend func(userID string, emailSubject string, emailBody string) (err error)

+ FuncEmailTemplatePasswordRestore func(userID string, passwordRestoreLink string, options UserAuthOptions) string

+ FuncEmailTemplateRegisterCode func(userID string, passwordRestoreLink string, options UserAuthOptions) 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(sessionID string, options UserAuthOptions) (userID string, err error)

+ FuncUserFindByUsername func(username string, firstName string, lastName string, options UserAuthOptions) (userID string, err error)

+ FuncUserLogin func(username string, password string, options UserAuthOptions) (userID string, err error)

+ FuncUserLogout func(username string, options UserAuthOptions) (err error)

+ FuncUserPasswordChange func(username string, newPassword string, options UserAuthOptions) (err error)

+ FuncUserRegister func(username string, password string, first_name string, last_name string, ...) (err error)

+ FuncUserStoreAuthToken func(sessionID string, userID string, options UserAuthOptions) error

+ LabelUsername string

+ UrlRedirectOnSuccess string

+ UseCookies bool

+ UseLocalStorage bool

+ type LoginUsernameAndPasswordResponse struct

+ ErrorMessage string

+ SuccessMessage string

+ Token string

+ type RegisterUsernameAndPasswordResponse struct

+ ErrorMessage string

+ SuccessMessage string

+ Token string

+ type UserAuthOptions struct

+ UserAgent string

+ UserIp string

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