jwtauth

Documentation

Index

• Variables
• type Authorizer
  • func NewAuthorizer(key crypto.PublicKey, options Options) Authorizer
  • func (a Authorizer) Authorize(claims *Claims, scopes ...string) error
  • func (a Authorizer) Validate(tokenStr string) (*Claims, error)
• type Claims
• type Issuer
  • func NewIssuer(key crypto.PrivateKey, options Options) *Issuer
  • func (i Issuer) CreateToken(ttl time.Duration, scopes ...string) *Claims
  • func (i Issuer) Sign(claims *Claims) (string, error)
• type Options

Variables

var (
	ErrTokenUnexpectedSigningMethod = errors.New("unexpected signing method")
	ErrTokenInvalid                 = errors.New("invalid token")
	ErrAudienceUnknown              = errors.New("unknown audience")
	ErrSubjectUnknown               = errors.New("unknown subject")
	ErrMissingScopes                = errors.New("missing scopes")
	ErrTokenExpired                 = errors.New("token expired")
)

Types

type Authorizer

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

func NewAuthorizer

func NewAuthorizer(key crypto.PublicKey, options Options) Authorizer

func (Authorizer) Authorize

func (a Authorizer) Authorize(claims *Claims, scopes ...string) error

func (Authorizer) Validate

func (a Authorizer) Validate(tokenStr string) (*Claims, error)

type Claims

type Claims struct {
	jwt.RegisteredClaims
	ClientID string   `json:"client_id"`
	Scopes   []string `json:"scopes"`
}

type Issuer

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

func NewIssuer

func NewIssuer(key crypto.PrivateKey, options Options) *Issuer

func (Issuer) CreateToken

func (i Issuer) CreateToken(ttl time.Duration, scopes ...string) *Claims

func (Issuer) Sign

func (i Issuer) Sign(claims *Claims) (string, error)

type Options

type Options struct {
	// if Issuer is empty, all issuers are allowed
	Issuer string
	// if Subject is empty, all subjects are allowed
	Subject string
	// if Audience is empty, all audiences are allowed
	Audience []string

	SigningMethod jwt.SigningMethod

	ClientID string
}