jwt

Documentation

Index

• Constants
• Variables
• func CreateJwkKey(privateKey interface{}) (jwk.Key, error)
• type Claims
  • func ParseToken(token string) (Claims, error)
  • func (c Claims) GetAudience() (jwt.ClaimStrings, error)
  • func (c Claims) GetClientID() (string, error)
  • func (c Claims) GetDeviceID(deviceIDClaim string) (string, error)
  • func (c Claims) GetEmail() (string, error)
  • func (c Claims) GetExpirationTime() (*jwt.NumericDate, error)
  • func (c Claims) GetID() (string, error)
  • func (c Claims) GetIssuedAt() (*jwt.NumericDate, error)
  • func (c Claims) GetIssuer() (string, error)
  • func (c Claims) GetName() (string, error)
  • func (c Claims) GetNotBefore() (*jwt.NumericDate, error)
  • func (c Claims) GetOwner(ownerClaim string) (string, error)
  • func (c Claims) GetScope() (jwt.ClaimStrings, error)
  • func (c Claims) GetSubject() (string, error)
  • func (c Claims) ValidateOwnerClaim(ownerClaim string, userID string) error
• type KeyCache
  • func NewKeyCache(url string, client *http.Client) *KeyCache
  • func (c *KeyCache) FetchKeys() error
  • func (c *KeyCache) FetchKeysWithContext(ctx context.Context) error
  • func (c *KeyCache) GetKey(token *jwt.Token) (interface{}, error)
  • func (c *KeyCache) GetOrFetchKey(token *jwt.Token) (interface{}, error)
  • func (c *KeyCache) GetOrFetchKeyWithContext(ctx context.Context, token *jwt.Token) (interface{}, error)
  • func (c *KeyCache) LookupKey(token *jwt.Token) (jwk.Key, error)
• type KeyCacheI
• type MultiKeyCache
  • func NewMultiKeyCache() *MultiKeyCache
  • func (c *MultiKeyCache) Add(authority, url string, client *http.Client)
  • func (c *MultiKeyCache) GetOrFetchKey(token *jwt.Token) (interface{}, error)
  • func (c *MultiKeyCache) GetOrFetchKeyWithContext(ctx context.Context, token *jwt.Token) (interface{}, error)
• type ScopeClaims
  • func NewRegexpScopeClaims(scope ...*regexp.Regexp) *ScopeClaims
  • func NewScopeClaims(scope ...string) *ScopeClaims
  • func (c *ScopeClaims) GetAudience() (jwt.ClaimStrings, error)
  • func (c *ScopeClaims) GetExpirationTime() (*jwt.NumericDate, error)
  • func (c *ScopeClaims) GetIssuedAt() (*jwt.NumericDate, error)
  • func (c *ScopeClaims) GetIssuer() (string, error)
  • func (c *ScopeClaims) GetNotBefore() (*jwt.NumericDate, error)
  • func (c *ScopeClaims) GetSubject() (string, error)
  • func (c *ScopeClaims) Validate() error
• type Validator
  • func NewValidator(keyCache KeyCacheI) *Validator
  • func (v *Validator) Parse(token string) (jwt.MapClaims, error)
  • func (v *Validator) ParseWithClaims(token string, claims jwt.Claims) error
  • func (v *Validator) ParseWithContext(ctx context.Context, token string) (jwt.MapClaims, error)

Constants

const (
	ClaimExpirationTime = "exp"
	ClaimNotBefore      = "nbf"
	ClaimIssuedAt       = "iat"
	ClaimAudience       = "aud"
	ClaimIssuer         = "iss"
	ClaimSubject        = "sub"
	ClaimScope          = "scope"
	ClaimID             = "jti"
	ClaimEmail          = "email"
	ClaimClientID       = "client_id"
	ClaimName           = "n"
)

const PlgdRequiredScope = "plgd:required:scope"

Variables

var (
	ErrMissingClaims = errors.New("missing claims")
	ErrMissingIssuer = errors.New("missing issuer")
)

var (
	ErrMissingToken     = errors.New("missing token")
	ErrCannotParseToken = errors.New("could not parse token")
)

var ErrMissingRequiredScopes = errors.New("required scopes not found")

var ErrOwnerClaimInvalid = errors.New("owner claim is invalid")

Functions

func CreateJwkKey

func CreateJwkKey(privateKey interface{}) (jwk.Key, error)

Types

type Claims

type Claims jwt.MapClaims

func ParseToken

func ParseToken(token string) (Claims, error)

func (Claims) GetAudience

func (c Claims) GetAudience() (jwt.ClaimStrings, error)

GetAudience returns the Audience ("aud") claim. If the claim does not exist, nil is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetClientID

func (c Claims) GetClientID() (string, error)

GetClientID returns the ClientID ("client_id") claim. If the claim does not exist, an empty string is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetDeviceID

func (c Claims) GetDeviceID(deviceIDClaim string) (string, error)

GetDeviceID returns the DeviceID ("device_id") claim. If the claim does not exist, an empty string is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetEmail

func (c Claims) GetEmail() (string, error)

GetEmail returns the Email ("email") claim. If the claim does not exist, an empty string is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetExpirationTime

func (c Claims) GetExpirationTime() (*jwt.NumericDate, error)

GetExpirationTime returns the Expiration Time ("exp") claim. If the claim does not exist, nil is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetID

func (c Claims) GetID() (string, error)

GetID returns the ID ("jti") claim. If the claim does not exist, an empty string is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetIssuedAt

func (c Claims) GetIssuedAt() (*jwt.NumericDate, error)

GetIssuedAt returns the Issued At ("iat") claim. If the claim does not exist, nil is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetIssuer

func (c Claims) GetIssuer() (string, error)

GetIssuer returns the Issuer ("iss") claim. If the claim does not exist, nil is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetName

func (c Claims) GetName() (string, error)

GetName returns the Name ("n") claim. If the claim does not exist, an empty string is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetNotBefore

func (c Claims) GetNotBefore() (*jwt.NumericDate, error)

GetNotBefore returns the Not Before ("nbf") claim. If the claim does not exist, nil is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetOwner

func (c Claims) GetOwner(ownerClaim string) (string, error)

GetOwner returns the Owner ("owner") claim. If the claim does not exist, an empty string is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetScope

func (c Claims) GetScope() (jwt.ClaimStrings, error)

GetScope returns the Scope ("scope") claim. If the claim does not exist, nil is returned. If the claim has the wrong type, an error is returned.

func (Claims) GetSubject

func (c Claims) GetSubject() (string, error)

GetSubject returns the Subject ("sub") claim. If the claim does not exist, nil is returned. If the claim has the wrong type, an error is returned.

func (Claims) ValidateOwnerClaim

func (c Claims) ValidateOwnerClaim(ownerClaim string, userID string) error

ValidateOwnerClaim validates that ownerClaim is set and that it matches given user ID

type KeyCache

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

func NewKeyCache

func NewKeyCache(url string, client *http.Client) *KeyCache

func (*KeyCache) FetchKeys

func (c *KeyCache) FetchKeys() error

func (*KeyCache) FetchKeysWithContext

func (c *KeyCache) FetchKeysWithContext(ctx context.Context) error

func (*KeyCache) GetKey

func (c *KeyCache) GetKey(token *jwt.Token) (interface{}, error)

func (*KeyCache) GetOrFetchKey

func (c *KeyCache) GetOrFetchKey(token *jwt.Token) (interface{}, error)

func (*KeyCache) GetOrFetchKeyWithContext

func (c *KeyCache) GetOrFetchKeyWithContext(ctx context.Context, token *jwt.Token) (interface{}, error)

func (*KeyCache) LookupKey

func (c *KeyCache) LookupKey(token *jwt.Token) (jwk.Key, error)

type KeyCacheI

type KeyCacheI interface {
	GetOrFetchKey(token *jwt.Token) (interface{}, error)
	GetOrFetchKeyWithContext(ctx context.Context, token *jwt.Token) (interface{}, error)
}

type MultiKeyCache

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

func NewMultiKeyCache

func NewMultiKeyCache() *MultiKeyCache

func (*MultiKeyCache) Add

func (c *MultiKeyCache) Add(authority, url string, client *http.Client)

func (*MultiKeyCache) GetOrFetchKey

func (c *MultiKeyCache) GetOrFetchKey(token *jwt.Token) (interface{}, error)

func (*MultiKeyCache) GetOrFetchKeyWithContext

func (c *MultiKeyCache) GetOrFetchKeyWithContext(ctx context.Context, token *jwt.Token) (interface{}, error)

type ScopeClaims

type ScopeClaims Claims

func NewRegexpScopeClaims

func NewRegexpScopeClaims(scope ...*regexp.Regexp) *ScopeClaims

func NewScopeClaims

func NewScopeClaims(scope ...string) *ScopeClaims

func (*ScopeClaims) GetAudience

func (c *ScopeClaims) GetAudience() (jwt.ClaimStrings, error)

func (*ScopeClaims) GetExpirationTime

func (c *ScopeClaims) GetExpirationTime() (*jwt.NumericDate, error)

func (*ScopeClaims) GetIssuedAt

func (c *ScopeClaims) GetIssuedAt() (*jwt.NumericDate, error)

func (*ScopeClaims) GetIssuer

func (c *ScopeClaims) GetIssuer() (string, error)

func (*ScopeClaims) GetNotBefore

func (c *ScopeClaims) GetNotBefore() (*jwt.NumericDate, error)

func (*ScopeClaims) GetSubject

func (c *ScopeClaims) GetSubject() (string, error)

func (*ScopeClaims) Validate

func (c *ScopeClaims) Validate() error

type Validator

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

func NewValidator

func NewValidator(keyCache KeyCacheI) *Validator

func (*Validator) Parse

func (v *Validator) Parse(token string) (jwt.MapClaims, error)

func (*Validator) ParseWithClaims

func (v *Validator) ParseWithClaims(token string, claims jwt.Claims) error

func (*Validator) ParseWithContext

func (v *Validator) ParseWithContext(ctx context.Context, token string) (jwt.MapClaims, error)