auth

package module

Go to main page

Versions in this module

v1

v1.1.0

Aug 7, 2025

Changes in this version

type OAuthService

+ BaseURL string

+ FailureURL string

+ FindUserByEmail types.FindUserByEmailFunc

+ FindUserByID types.FindUserByIDFunc

+ SuccessURL string

v1.0.2

Aug 5, 2025

Changes in this version

+ var ErrInvalidJWTSecret = errors.New("invalid JWT secret")

+ var ErrInvalidProvider = errors.New("invalid oauth provider configuration")

+ var ErrInvalidSID = errors.New("invalid session ID")

+ var ErrInvalidSession = errors.New("invalid session")

+ var ErrJWTGenerationFailed = errors.New("failed to generate JWT")

+ var ErrJWTValidationFailed = errors.New("failed to validate JWT")

+ var ErrNotImplemented = errors.New("oauth feature not implemented yet")

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

+ var ErrUnsupportedProvider = errors.New("unsupported oauth provider")

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

type AuthOptions

+ OAuth *OAuthConfig

+ func (opts *AuthOptions) ValidateAuthOptions() error

type AuthService

+ BFF *BFFService

+ JWT *JWTService

+ OAuth *OAuthService

+ func NewBFFAuthService(opts *BFFAuthOptions) (*AuthService, error)

+ type BFFAuthMiddleware struct

+ func NewBFFAuthMiddleware(sessionService SessionService, jwtExchangeService *JWTExchangeService, ...) *BFFAuthMiddleware

+ func (auth *BFFAuthMiddleware) OptionalSession() gin.HandlerFunc

+ func (auth *BFFAuthMiddleware) RequireSession() gin.HandlerFunc

+ func (auth *BFFAuthMiddleware) RequireValidSession() gin.HandlerFunc

+ type BFFAuthOptions struct

+ FindUserByEmail FindUserByEmailFunc

+ FindUserByID FindUserByIDFunc

+ JWTExpiry time.Duration

+ JWTSecret string

+ OAuth *OAuthConfig

+ SIDCookieName string

+ SIDCookiePath string

+ SessionDomain string

+ SessionMaxAge int

+ SessionSecret string

+ SessionSecure bool

+ SessionService SessionService

+ func (opts *BFFAuthOptions) ValidateBFFAuthOptions() error

+ type BFFService struct

+ Exchange *JWTExchangeService

+ Middleware *BFFAuthMiddleware

+ Sessions SessionService

+ type JWTExchangeService struct

+ func NewJWTExchangeService(jwtSecret string, sessionService SessionService, jwtExpiry time.Duration) *JWTExchangeService

+ func (exchangeService *JWTExchangeService) ExchangeSessionForJWT(sid string) (string, error)

+ func (exchangeService *JWTExchangeService) RefreshSessionJWT(sid string) (string, error)

type JWTMiddleware

+ func NewJWTMiddleware(opts *JWTOptions) (*JWTMiddleware, error)

+ type JWTOptions struct

+ FindUserByEmail FindUserByEmailFunc

+ FindUserByID FindUserByIDFunc

+ IdentityKey string

+ Key []byte

+ MaxRefresh time.Duration

+ Realm string

+ SessionDomain string

+ SessionSameSite string

+ SessionSecure bool

+ Timeout time.Duration

+ type JWTService struct

+ Middleware AuthMiddleware

+ type OAuthConfig struct

+ BaseURL string

+ FailureURL string

+ FindUserByEmail FindUserByEmailFunc

+ FindUserByID FindUserByIDFunc

+ Providers map[string]OAuthProvider

+ SuccessURL string

+ func (config *OAuthConfig) ValidateOAuthConfig() error

+ type OAuthProvider struct

+ ClientID string

+ ClientSecret string

+ RedirectURL string

+ Scopes []string

+ func (provider *OAuthProvider) ValidateOAuthProvider() error

+ type OAuthService struct

+ Providers map[string]goth.Provider

+ func NewOAuthService(config *OAuthConfig) *OAuthService

+ func (auth *OAuthService) BeginAuthHandler() gin.HandlerFunc

+ func (auth *OAuthService) CompleteAuthHandler() gin.HandlerFunc

+ func (auth *OAuthService) GetProvider(name string) (goth.Provider, error)

+ func (auth *OAuthService) MapGothUserToUserInfo(gothUser goth.User) (UserInfo, error)

+ func (auth *OAuthService) RegisterProvider(name string, provider goth.Provider)

+ type SessionService interface

+ CreateSession func(user UserInfo, expiry time.Duration) (string, error)

+ DeleteSession func(sid string) error

+ GetSession func(sid string) (UserInfo, error)

+ ValidateSession func(sid string) (UserInfo, error)

v1.0.1

Jul 22, 2025

Changes in this version

type AuthOptions

+ FindUserByEmail FindUserByEmailFunc

+ FindUserByID FindUserByIDFunc

type AuthService

+ func (as *AuthService) GetSessionStore() sessions.Store

+ type FindUserByEmailFunc func(email string) (UserInfo, error)

+ type FindUserByIDFunc func(id uint) (UserInfo, error)

+ type UserInfo struct

+ Email string

+ ID uint

+ PasswordHash string

+ Role string

v1.0.0

Jul 22, 2025

Changes in this version

+ func Authenticator(userRepo UserRepository, logger Logger) func(c *gin.Context) (interface{}, error)

+ func Authorizator(data interface{}, c *gin.Context) bool

+ func IdentityHandler(userRepo UserRepository, logger Logger) func(c *gin.Context) interface

+ func PayloadFunc(data interface{}) jwt.MapClaims

+ func Unauthorized(c *gin.Context, code int, message string)

+ type AuthMiddleware interface

+ LoginHandler func() gin.HandlerFunc

+ LogoutHandler func() gin.HandlerFunc

+ MiddlewareFunc func() gin.HandlerFunc

+ RefreshHandler func() gin.HandlerFunc

+ type AuthOptions struct

+ BcryptCost int

+ IdentityKey string

+ JWTRealm string

+ JWTSecret string

+ RefreshExpireTime time.Duration

+ SessionDomain string

+ SessionMaxAge int

+ SessionSameSite string

+ SessionSecret string

+ SessionSecure bool

+ TokenExpireTime time.Duration

+ type AuthService struct

+ func NewAuthService(opts *AuthOptions, userRepo UserRepository, logger Logger) (*AuthService, error)

+ func (s *AuthService) LoginHandler() gin.HandlerFunc

+ func (s *AuthService) LogoutHandler() gin.HandlerFunc

+ func (s *AuthService) MiddlewareFunc() gin.HandlerFunc

+ func (s *AuthService) RefreshHandler() gin.HandlerFunc

+ func (s *AuthService) SessionStore() *sessions.CookieStore

+ type JWTMiddleware struct

+ func (mw *JWTMiddleware) LoginHandler() gin.HandlerFunc

+ func (mw *JWTMiddleware) LogoutHandler() gin.HandlerFunc

+ func (mw *JWTMiddleware) MiddlewareFunc() gin.HandlerFunc

+ func (mw *JWTMiddleware) RefreshHandler() gin.HandlerFunc

+ type LogEvent interface

+ Err func(err error) LogEvent

+ Msg func(msg string)

+ Str func(key, val string) LogEvent

+ Uint func(key string, val uint) LogEvent

+ type Logger interface

+ Debug func() LogEvent

+ Error func() LogEvent

+ Warn func() LogEvent

+ type User interface

+ GetEmail func() string

+ GetID func() uint

+ GetPasswordHash func() string

+ GetRole func() string

+ type UserRepository interface

+ FindByEmail func(email string) (User, error)

+ FindByID func(id uint) (User, error)

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