auth

Aug 20, 2026

Changes in this version

type AuthContext

+ Permissions []string

+ Roles []string

+ func (a *AuthContext) HasAllPermissions(permissions ...string) bool

+ func (a *AuthContext) HasAnyRole(roles ...string) bool

+ func (a *AuthContext) HasPermission(permission string) bool

+ func (a *AuthContext) HasRole(role string) bool

+ type Authorizer interface

+ Authorize func(ctx context.Context, authCtx *AuthContext, req Requirement) error

+ Name func() string

+ func NewDefaultAuthorizer() Authorizer

type Config

+ Authorizer Authorizer

type ConfigOption

+ func WithAuthorizer(a Authorizer) ConfigOption

type Registry

+ Authorizer func() Authorizer

+ MiddlewareWithRequirement func(req Requirement) forge.Middleware

+ SetAuthorizer func(a Authorizer)

+ type Requirement struct

+ Mode string

+ Permissions []string

+ Providers []string

+ Roles []string

+ Scopes []string

+ func (r Requirement) IsEmpty() bool

Feb 8, 2026

Changes in this version

+ const RegistryKey

+ const RegistryKeyLegacy

+ var ErrAuthenticationFailed = errors.New("authentication failed")

+ var ErrAuthorizationFailed = errors.New("authorization failed")

+ var ErrInsufficientScopes = errors.New("insufficient scopes")

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

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

+ var ErrMissingCredentials = errors.New("missing authentication credentials")

+ var ErrProviderExists = errors.New("auth provider already exists")

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

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

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

+ func NewExtension(opts ...ConfigOption) forge.Extension

+ func NewExtensionWithConfig(config Config) forge.Extension

+ func WithContext(ctx context.Context, authCtx *AuthContext) context.Context

+ type AuthContext struct

+ Claims map[string]any

+ Data any

+ Metadata map[string]any

+ ProviderName string

+ Scopes []string

+ Subject string

+ func FromContext(ctx context.Context) (*AuthContext, bool)

+ func GetAuthContext(ctx forge.Context) (*AuthContext, bool)

+ func GetAuthContextFromStdContext(ctx context.Context) (*AuthContext, bool)

+ func MustFromContext(ctx context.Context) *AuthContext

+ func MustGetAuthContext(ctx forge.Context) *AuthContext

+ func (a *AuthContext) GetClaim(key string) (any, bool)

+ func (a *AuthContext) GetClaimString(key string) (string, bool)

+ func (a *AuthContext) HasScope(scope string) bool

+ func (a *AuthContext) HasScopes(scopes ...string) bool

+ type AuthProvider interface

+ Authenticate func(ctx context.Context, r *http.Request) (*AuthContext, error)

+ Middleware func() forge.Middleware

+ Name func() string

+ OpenAPIScheme func() SecurityScheme

+ Type func() SecuritySchemeType

+ type Config struct

+ DefaultProvider string

+ Enabled bool

+ Providers []ProviderConfig

+ RequireConfig bool

+ func DefaultConfig() Config

+ type ConfigOption func(*Config)

+ func WithConfig(config Config) ConfigOption

+ func WithDefaultProvider(name string) ConfigOption

+ func WithEnabled(enabled bool) ConfigOption

+ func WithProviders(providers ...ProviderConfig) ConfigOption

+ func WithRequireConfig(require bool) ConfigOption

+ type Extension struct

+ func (e *Extension) Health(ctx context.Context) error

+ func (e *Extension) Register(app forge.App) error

+ func (e *Extension) Start(ctx context.Context) error

+ func (e *Extension) Stop(ctx context.Context) error

+ type OAuthFlow = shared.OAuthFlow

+ type OAuthFlows = shared.OAuthFlows

+ type ProviderConfig struct

+ Config map[string]any

+ Description string

+ Enabled bool

+ Name string

+ Type string

+ type ProviderFunc func(ctx context.Context, r *http.Request) (*AuthContext, error)

+ type Registry interface

+ Get func(name string) (AuthProvider, error)

+ Has func(name string) bool

+ List func() []string

+ Middleware func(providerNames ...string) forge.Middleware

+ MiddlewareAnd func(providerNames ...string) forge.Middleware

+ MiddlewareWithScopes func(providerName string, scopes ...string) forge.Middleware

+ OpenAPISchemes func() map[string]SecurityScheme

+ Register func(provider AuthProvider) error

+ Unregister func(name string) error

+ func GetRegistry(c forge.Container) (Registry, error)

+ func GetRegistryFromApp(app forge.App) (Registry, error)

+ func MustGetRegistry(c forge.Container) Registry

+ func MustGetRegistryFromApp(app forge.App) Registry

+ func NewRegistry(container forge.Container, logger forge.Logger) Registry

+ type SecurityScheme = shared.SecurityScheme

+ type SecuritySchemeType string

+ const SecurityTypeAPIKey

+ const SecurityTypeHTTP

+ const SecurityTypeMutualTLS

+ const SecurityTypeOAuth2

+ const SecurityTypeOpenIDConnect