auth

Documentation

Index

• Variables
• func Authorize(principal Principal, requested Scope) error
• type Access
• type Authenticator
• type Kind
• type Principal
• type Scope
  • func API() Scope
  • func GroupControl(groupID string) Scope
  • func ParseScope(raw string) (Scope, error)
  • func SessionAdapter(sessionID string) Scope
  • func SessionControl(sessionID string) Scope
  • func SessionView(sessionID string) Scope
  • func (s Scope) String() string
  • func (s Scope) Validate() error

Variables

var (
	ErrInvalidScope = errors.New("invalid scope")
	ErrInvalidToken = errors.New("invalid token")
	ErrUnauthorized = errors.New("unauthorized")
)

Functions

func Authorize

func Authorize(principal Principal, requested Scope) error

Types

type Access

type Access string

const (
	AccessControl Access = "control"
	AccessView    Access = "view"
	AccessAdapter Access = "adapter"
	AccessAll     Access = "*"
)

type Authenticator

type Authenticator interface {
	Authenticate(ctx context.Context, token string) (Principal, error)
	Authorize(ctx context.Context, principal Principal, scope Scope) error
}

type Kind

type Kind string

const (
	KindSession Kind = "session"
	KindGroup   Kind = "group"
	KindAPI     Kind = "api"
)

type Principal

type Principal struct {
	Subject string
	Scopes  []Scope
}

type Scope

type Scope struct {
	Kind   Kind
	ID     string
	Access Access
}

func API

func API() Scope

func GroupControl

func GroupControl(groupID string) Scope

func ParseScope

func ParseScope(raw string) (Scope, error)

func SessionAdapter

func SessionAdapter(sessionID string) Scope

func SessionControl

func SessionControl(sessionID string) Scope

func SessionView

func SessionView(sessionID string) Scope

func (Scope) String

func (s Scope) String() string

func (Scope) Validate

func (s Scope) Validate() error