auth

package module

Go to main page

Versions in this module

v0

v0.1.2

Sep 6, 2025

v0.1.1

Sep 6, 2025

Changes in this version

+ const EventTypeOAuth2AuthURL

+ const EventTypeOAuth2Exchange

+ const EventTypeSessionAccessed

+ const EventTypeSessionCreated

+ const EventTypeSessionDestroyed

+ const EventTypeSessionExpired

+ const EventTypeTokenExpired

+ const EventTypeTokenGenerated

+ const EventTypeTokenRefreshed

+ const EventTypeTokenValidated

+ var ErrNoSubjectForEventEmission = errors.New("no subject available for event emission")

+ var ErrSessionStoreNotInterface = errors.New("session_store service does not implement SessionStore interface")

+ var ErrUserInfoURLNotConfigured = errors.New("user info URL not configured for provider")

+ var ErrUserStoreNotInterface = errors.New("user_store service does not implement UserStore interface")

+ type EventEmitter interface

+ EmitEvent func(ctx context.Context, event cloudevents.Event) error

type JWTConfig

+ func (c *JWTConfig) GetJWTExpiration() time.Duration

+ func (c *JWTConfig) GetJWTRefreshExpiration() time.Duration

type Module

+ func (m *Module) EmitEvent(ctx context.Context, event cloudevents.Event) error

+ func (m *Module) GetRegisteredEventTypes() []string

+ func (m *Module) RegisterObservers(subject modular.Subject) error

type Service

+ func (s *Service) SetEventEmitter(emitter EventEmitter)

type SessionConfig

+ func (c *SessionConfig) GetSessionMaxAge() time.Duration

+ type UserInfoError struct

+ Body string

+ StatusCode int

+ func (e *UserInfoError) Error() string

v0.1.0

Aug 3, 2025

Changes in this version

+ var ErrRandomGeneration = errors.New("failed to generate random bytes")

+ var ErrSessionStoreInvalid = errors.New("session_store service does not implement SessionStore interface")

+ var ErrUnexpectedSigningMethod = errors.New("unexpected signing method")

+ var ErrUserInfoNotConfigured = errors.New("user info URL not configured for provider")

+ var ErrUserStoreInvalid = errors.New("user_store service does not implement UserStore interface")

v0.0.6

Jun 28, 2025

v0.0.5

Jun 27, 2025

v0.0.4

Jun 27, 2025

v0.0.3

Jun 11, 2025

v0.0.2

Jun 5, 2025

v0.0.1

May 26, 2025

Changes in this version

+ const ServiceName

+ var ErrInvalidConfig = errors.New("invalid auth configuration")

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

+ var ErrOAuth2Failed = errors.New("oauth2 authentication failed")

+ var ErrPasswordTooWeak = errors.New("password does not meet requirements")

+ var ErrProviderNotFound = errors.New("oauth2 provider not found")

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

+ var ErrSessionNotFound = errors.New("session not found")

+ var ErrTokenExpired = errors.New("token has expired")

+ var ErrTokenInvalid = errors.New("token is invalid")

+ var ErrTokenMalformed = errors.New("token is malformed")

+ var ErrUserAlreadyExists = errors.New("user already exists")

+ var ErrUserNotFound = errors.New("user not found")

+ func NewModule() modular.Module

+ type AuthContext struct

+ Claims *Claims

+ Permissions []string

+ Roles []string

+ Session *Session

+ User *User

+ type AuthService interface

+ CreateSession func(userID string, metadata map[string]interface{}) (*Session, error)

+ DeleteSession func(sessionID string) error

+ ExchangeOAuth2Code func(provider, code, state string) (*OAuth2Result, error)

+ GenerateToken func(userID string, claims map[string]interface{}) (*TokenPair, error)

+ GetOAuth2AuthURL func(provider, state string) (string, error)

+ GetSession func(sessionID string) (*Session, error)

+ HashPassword func(password string) (string, error)

+ RefreshSession func(sessionID string) (*Session, error)

+ RefreshToken func(refreshToken string) (*TokenPair, error)

+ ValidatePasswordStrength func(password string) error

+ ValidateToken func(token string) (*Claims, error)

+ VerifyPassword func(hashedPassword, password string) error

+ type Claims struct

+ Custom map[string]interface{}

+ Email string

+ ExpiresAt time.Time

+ IssuedAt time.Time

+ Issuer string

+ Permissions []string

+ Roles []string

+ Subject string

+ UserID string

+ type Config struct

+ JWT JWTConfig

+ OAuth2 OAuth2Config

+ Password PasswordConfig

+ Session SessionConfig

+ func (c *Config) Validate() error

+ type JWTConfig struct

+ Algorithm string

+ Expiration time.Duration

+ Issuer string

+ RefreshExpiration time.Duration

+ Secret string

+ type MemorySessionStore struct

+ func NewMemorySessionStore() *MemorySessionStore

+ func (s *MemorySessionStore) Cleanup(ctx context.Context) error

+ func (s *MemorySessionStore) Delete(ctx context.Context, sessionID string) error

+ func (s *MemorySessionStore) Get(ctx context.Context, sessionID string) (*Session, error)

+ func (s *MemorySessionStore) Store(ctx context.Context, session *Session) error

+ type MemoryUserStore struct

+ func NewMemoryUserStore() *MemoryUserStore

+ func (s *MemoryUserStore) CreateUser(ctx context.Context, user *User) error

+ func (s *MemoryUserStore) DeleteUser(ctx context.Context, userID string) error

+ func (s *MemoryUserStore) GetUser(ctx context.Context, userID string) (*User, error)

+ func (s *MemoryUserStore) GetUserByEmail(ctx context.Context, email string) (*User, error)

+ func (s *MemoryUserStore) UpdateUser(ctx context.Context, user *User) error

+ type Middleware interface

+ OptionalAuth func(next http.Handler) http.Handler

+ RequireAuth func(next http.Handler) http.Handler

+ RequirePermission func(permission string) func(http.Handler) http.Handler

+ RequireRole func(role string) func(http.Handler) http.Handler

+ type Module struct

+ func (m *Module) Constructor() modular.ModuleConstructor

+ func (m *Module) Dependencies() []string

+ func (m *Module) Init(app modular.Application) error

+ func (m *Module) Name() string

+ func (m *Module) ProvidesServices() []modular.ServiceProvider

+ func (m *Module) RegisterConfig(app modular.Application) error

+ func (m *Module) RequiresServices() []modular.ServiceDependency

+ func (m *Module) Start(ctx context.Context) error

+ func (m *Module) Stop(ctx context.Context) error

+ type OAuth2Config struct

+ Providers map[string]OAuth2Provider

+ type OAuth2Provider struct

+ AuthURL string

+ ClientID string

+ ClientSecret string

+ RedirectURL string

+ Scopes []string

+ TokenURL string

+ UserInfoURL string

+ type OAuth2Result struct

+ AccessToken string

+ ExpiresAt time.Time

+ Provider string

+ RefreshToken string

+ UserInfo map[string]interface{}

+ type PasswordConfig struct

+ Algorithm string

+ BcryptCost int

+ MinLength int

+ RequireDigit bool

+ RequireLower bool

+ RequireSpecial bool

+ RequireUpper bool

+ type Service struct

+ func NewService(config *Config, userStore UserStore, sessionStore SessionStore) *Service

+ func (s *Service) CreateSession(userID string, metadata map[string]interface{}) (*Session, error)

+ func (s *Service) DeleteSession(sessionID string) error

+ func (s *Service) ExchangeOAuth2Code(provider, code, state string) (*OAuth2Result, error)

+ func (s *Service) GenerateToken(userID string, customClaims map[string]interface{}) (*TokenPair, error)

+ func (s *Service) GetOAuth2AuthURL(provider, state string) (string, error)

+ func (s *Service) GetSession(sessionID string) (*Session, error)

+ func (s *Service) HashPassword(password string) (string, error)

+ func (s *Service) RefreshSession(sessionID string) (*Session, error)

+ func (s *Service) RefreshToken(refreshTokenString string) (*TokenPair, error)

+ func (s *Service) ValidatePasswordStrength(password string) error

+ func (s *Service) ValidateToken(tokenString string) (*Claims, error)

+ func (s *Service) VerifyPassword(hashedPassword, password string) error

+ type Session struct

+ Active bool

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ IPAddress string

+ Metadata map[string]interface{}

+ UserAgent string

+ UserID string

+ type SessionConfig struct

+ CookieName string

+ Domain string

+ HTTPOnly bool

+ MaxAge time.Duration

+ Path string

+ SameSite string

+ Secure bool

+ Store string

+ type SessionStore interface

+ Cleanup func(ctx context.Context) error

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

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

+ Store func(ctx context.Context, session *Session) error

+ type TokenPair struct

+ AccessToken string

+ ExpiresAt time.Time

+ ExpiresIn int64

+ RefreshToken string

+ TokenType string

+ type User struct

+ Active bool

+ CreatedAt time.Time

+ Email string

+ ID string

+ LastLoginAt *time.Time

+ Metadata map[string]interface{}

+ PasswordHash string

+ Permissions []string

+ Roles []string

+ UpdatedAt time.Time

+ type UserStore interface

+ CreateUser func(ctx context.Context, user *User) error

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

+ GetUser func(ctx context.Context, userID string) (*User, error)

+ GetUserByEmail func(ctx context.Context, email string) (*User, error)

+ UpdateUser func(ctx context.Context, user *User) error

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