Documentation
¶
Index ¶
- Constants
- Variables
- func ContextHasScope(ctx context.Context, scope Scope) error
- func ContextHasScopeOrIsUserIDAndHasScope(ctx context.Context, scope Scope, id *uuid.UUID, userScope Scope) error
- func ContextIsUserIDAndHasScope(ctx context.Context, id uuid.UUID, scope Scope) error
- type OIDCConfig
- type OIDCDiscovery
- type RequestAuth
- type Scope
- type Scopes
- type TokenClaims
Constants ¶
const ( ScopeAdminRead = Scope("admin.read") ScopeAdminWrite = Scope("admin.write") ScopeAdminDelete = Scope("admin.delete") ScopeSelfRead = Scope("self.read") ScopeSelfWrite = Scope("self.write") ScopeSelfDelete = Scope("self.delete") )
TODO rework, split up
Variables ¶
var AuthCtxKey = &contextKey{"auth"}
Functions ¶
func ContextHasScope ¶
ContextHasScope checks if a user is authenticated and has the scope By guarding a request with this, accessing the RequestAuth.User is always safe
func ContextHasScopeOrIsUserIDAndHasScope ¶
func ContextHasScopeOrIsUserIDAndHasScope(ctx context.Context, scope Scope, id *uuid.UUID, userScope Scope) error
ContextHasScopeOrIsUserIDAndHasScope checks if a user is authenticated and has the scope OR has the id and the userScope By guarding a request with this, accessing the RequestAuth.User is always safe
Types ¶
type OIDCConfig ¶
type OIDCConfig struct {
Provider string `json:"provider"`
ClientID string `json:"client_id"`
ScopePrefix string `json:"scope_prefix"`
}
func (*OIDCConfig) Discover ¶
func (c *OIDCConfig) Discover() (*OIDCDiscovery, error)
type OIDCDiscovery ¶
type RequestAuth ¶
type RequestAuth struct {
User *model.User
Token *jwt.Token
// Scopes is a filtered list of scopes with the configured prefix removed
Scopes *Scopes
}
RequestAuth contains information about the authenticated user It always contains validated data, but fields may be nil
func ForContext ¶
func ForContext(ctx context.Context) *RequestAuth
ForContext gets the auth data from the context. Middleware.Middleware must have run to set the data. Can be nil.
func (*RequestAuth) TokenClaims ¶
func (ra *RequestAuth) TokenClaims() *TokenClaims
TokenClaims returns the Claims of the Token as TokenClaims or nil, when no Token is set This will intentionally panic if the Claims are the wrong type
type TokenClaims ¶
type TokenClaims jwt.MapClaims
func (TokenClaims) Scopes ¶
func (c TokenClaims) Scopes() Scopes
Scopes returns all scopes from the scope claim
func (TokenClaims) Sub ¶
func (c TokenClaims) Sub() *string
Sub returns the sub claim or nil if missing
func (TokenClaims) Valid ¶
func (c TokenClaims) Valid() error
Source Files
Directories