jwt

Documentation

Index

• Variables
• func Feature(config ...func(*Installer)) miruken.Feature
• type Installer
  • func (v *Installer) Install(setup *miruken.SetupBuilder) error
• type KeySet
• type LoginModule
  • func (l *LoginModule) Constructor(_ ..., jwks KeySet)
  • func (l *LoginModule) Init(opts map[string]any) error
  • func (l *LoginModule) Login(subject security.Subject, handler miruken.Handler) error
  • func (l *LoginModule) Logout(subject security.Subject, handler miruken.Handler) error
• type Scope
  • func (s *Scope) InitWithTag(tag reflect.StructTag) error
  • func (s Scope) Name() string

Variables

var (
	ErrMissingToken  = errors.New("missing security token")
	ErrEmptyToken    = errors.New("empty security token")
	ErrInvalidToken  = errors.New("invalid security token")
	ErrInvalidClaims = errors.New("invalid security claims")
)

Functions

func Feature

func Feature(config ...func(*Installer)) miruken.Feature

Types

type Installer

type Installer struct{}

Installer enables core api support.

func (*Installer) Install

func (v *Installer) Install(setup *miruken.SetupBuilder) error

type KeySet

type KeySet interface {
	At(jwksURI string) *promise.Promise[jwt.Keyfunc]
	From(jwksJSON json.RawMessage) (jwt.Keyfunc, error)
}

KeySet provides JWKS (JSON Web Key Sets) to verify JWT signatures.

type LoginModule

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

LoginModule authenticates a subject from a JWT (JSON Web Token).

func (*LoginModule) Constructor

func (l *LoginModule) Constructor(
	_ *struct {
		creates.It `key:"login.jwt"`
	}, jwks KeySet,
)

func (*LoginModule) Init

func (l *LoginModule) Init(opts map[string]any) error

func (*LoginModule) Login

func (l *LoginModule) Login(
	subject security.Subject,
	handler miruken.Handler,
) error

func (*LoginModule) Logout

func (l *LoginModule) Logout(
	subject security.Subject,
	handler miruken.Handler,
) error

type Scope

type Scope string

Scope is a grouping of claims which effectively represents a permission that is set on a token. e.g. orders:read

func (*Scope) InitWithTag

func (s *Scope) InitWithTag(tag reflect.StructTag) error

func (Scope) Name

func (s Scope) Name() string