auth

Documentation

Index

• Constants
• type Auth
  • func New(algorithm string, keyLookup KeyLookup) (*Auth, error)
  • func (a *Auth) GenerateToken(kid string, claims Claims) (string, error)
  • func (a *Auth) ValidateToken(tokenStr string) (Claims, error)
• type Claims
  • func (c Claims) Authorized(roles ...string) bool
  • func (c Claims) Valid(h *jwt.ValidationHelper) error
• type KeyLookup
• type Keys

Constants

const (
	RoleAdmin = "ADMIN"
	RoleUser  = "USER"
)

These are the expected values for Claims.Roles.

const Key ctxKey = 1

Key is used to store/retrieve a Claims value from a context.Context.

Types

type Auth

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

Auth is used to authenticate clients. It can generate a token for a set of user claims and recreate the claims by parsing the token.

func New

func New(algorithm string, keyLookup KeyLookup) (*Auth, error)

New creates an *Auth for use. It will error if: - The private key is nil. - The public key func is nil. - The key ID is blank. - The specified algorithm is unsupported.

func (*Auth) GenerateToken

func (a *Auth) GenerateToken(kid string, claims Claims) (string, error)

GenerateToken generates a signed JWT token string representing the user Claims.

func (*Auth) ValidateToken

func (a *Auth) ValidateToken(tokenStr string) (Claims, error)

ValidateToken recreates the Claims that were used to generate a token. It verifies that the token was signed using our key.

type Claims

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

Claims represents the authorization claims transmitted via a JWT.

func (Claims) Authorized

func (c Claims) Authorized(roles ...string) bool

Authorized returns true if the claims has at least one of the provided roles.

func (Claims) Valid

func (c Claims) Valid(h *jwt.ValidationHelper) error

Valid is called during the parsing of a token.

type KeyLookup

type KeyLookup interface {
	PrivateKey(kid string) (*rsa.PrivateKey, error)
	PublicKey(kid string) (*rsa.PublicKey, error)
}

KeyLookup declares a method set of behavior for looking up private and public keys for JWT use.

type Keys

type Keys map[string]*rsa.PrivateKey

Keys represents an in memory store of keys.