auth

Documentation

Index

• func AsProvider(provider any) any
• func InjectUser(ctx context.Context, user *ResolvedUser) context.Context
• func Module() module.Module
• type Middleware
  • func NewMiddleware(params MiddlewareParams) *Middleware
  • func (m *Middleware) Middleware(ctx huma.Context, next func(ctx huma.Context))
• type MiddlewareParams
• type Provider
• type Providers
  • func NewProviders(params ProvidersParams) *Providers
  • func (p *Providers) HydrateOas3(doc *huma.OpenAPI)
• type ProvidersParams
• type ResolvedUser
  • func UserFromContext(ctx context.Context) *ResolvedUser
  • func (r *ResolvedUser) ProviderUUID() uuid.UUID
  • func (r *ResolvedUser) Resolve(ctx huma.Context) []error

Functions

func AsProvider

func AsProvider(provider any) any

func InjectUser

func InjectUser(ctx context.Context, user *ResolvedUser) context.Context

func Module

func Module() module.Module

Types

type Middleware

type Middleware struct {
	// contains filtered or unexported fields
}

func NewMiddleware

func NewMiddleware(params MiddlewareParams) *Middleware

func (*Middleware) Middleware

func (m *Middleware) Middleware(ctx huma.Context, next func(ctx huma.Context))

type MiddlewareParams

type MiddlewareParams struct {
	fx.In
	API       huma.API
	Providers *Providers
}

type Provider

type Provider interface {
	SecurityScheme() *huma.SecurityScheme
	UserResolver(ctx huma.Context) (*ResolvedUser, error)
	AuthMiddleware(ctx huma.Context, next func(ctx huma.Context))
}

type Providers

type Providers struct {
	Registry map[string]Provider
}

func NewProviders

func NewProviders(params ProvidersParams) *Providers

func (*Providers) HydrateOas3

func (p *Providers) HydrateOas3(doc *huma.OpenAPI)

type ProvidersParams

type ProvidersParams struct {
	fx.In
	Providers []Provider `group:"auth.provider"`
}

type ResolvedUser

type ResolvedUser struct {
	ProviderName    string
	ProviderId      string
	Username        string
	Firstname       string
	Lastname        string
	Email           string
	IsEmailVerified bool
	Avatar          string
	IsAdmin         bool
}

func UserFromContext

func UserFromContext(ctx context.Context) *ResolvedUser

func (*ResolvedUser) ProviderUUID

func (r *ResolvedUser) ProviderUUID() uuid.UUID

func (*ResolvedUser) Resolve

func (r *ResolvedUser) Resolve(ctx huma.Context) []error