auth

Documentation

Index

• Constants
• type Claims
  • func NewClaims(subject string, roles []string, now time.Time, expires time.Duration) Claims
  • func (c Claims) HasRole(roles ...string) bool
  • func (c Claims) Valid(h *jwt.ValidationHelper) error

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 Claims

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

Claims represents the authorization claims transmitted via a JWT.

func NewClaims

func NewClaims(subject string, roles []string, now time.Time, expires time.Duration) Claims

NewClaims constructs a Claims value for the identified user. The Claims expire within a specified duration of the provided time. Additional fields of the Claims can be set after calling NewClaims is desired.

func (Claims) HasRole

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

HasRole 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.