auth

Documentation

Overview

Package auth provides authentication and authorization support.

Index

• Variables
• type Auth
• type Claims
  • func (c Claims) HasRole(r string) bool
• type Config
• type KeyLookup

Variables

var ErrForbidden = errors.New("action is not allowed")

ErrForbidden is returned for auth issues.

Types

type Auth

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

Auth is used to authenticate clients.

type Claims

type Claims struct {
	jwt.RegisteredClaims
	Roles []string `json:"roles"`
}

Claims reprents authorization via JWT.

func (Claims) HasRole

func (c Claims) HasRole(r string) bool

HasRole checks if the specified role exists.

type Config

type Config struct {
	Log       *logger.Logger
	KeyLookup KeyLookup
	Issuer    string
}

Config is information we need to initialize auth.

type KeyLookup

type KeyLookup interface {
	PrivateKey(kid string) (key string, err error)
	PublicKey(kid string) (key string, err error)
}

KeyLookup declares a method set of behaviour for looking keys for JWT use.