Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

keyfunc

package module

Go to main page

Versions in this module

v2

v2.1.0

May 31, 2023

Changes in this version

type Options

+ TolerateInitialJWKHTTPError bool

v2.0.3

May 18, 2023

v2.0.2

May 13, 2023

v2.0.1

Apr 21, 2023

v2.0.0

Apr 19, 2023

Changes in this version

+ var ErrECDSACurve = errors.New("invalid ECDSA curve")

+ var ErrInvalidHTTPStatusCode = errors.New("invalid HTTP status code")

+ var ErrJWKAlgMismatch = errors.New(...)

+ var ErrJWKUseWhitelist = errors.New(`the given JWK was found, but its "use" parameter's value was not whitelisted`)

+ var ErrKID = errors.New("the JWT has an invalid kid")

+ var ErrKIDNotFound = errors.New("the given key ID was not found in the JWKS")

+ var ErrMissingAssets = errors.New("required assets are missing to create a public key")

+ var ErrMultipleJWKSSize = errors.New("multiple JWKS must have two or more remote JWK Set resources")

+ var ErrRefreshImpossible = errors.New("refresh impossible: JWKS was not created from a remote resource")

+ func KeySelectorFirst(multiJWKS *MultipleJWKS, token *jwt.Token) (key interface{}, err error)

+ func NewGivenKeysFromJSON(jwksBytes json.RawMessage) (map[string]GivenKey, error)

+ func ResponseExtractorStatusAny(ctx context.Context, resp *http.Response) (json.RawMessage, error)

+ func ResponseExtractorStatusOK(ctx context.Context, resp *http.Response) (json.RawMessage, error)

+ type ErrorHandler func(err error)

+ type GivenKey struct

+ func NewGivenCustom(key interface{}, options GivenKeyOptions) (givenKey GivenKey)

+ func NewGivenECDSA(key *ecdsa.PublicKey, options GivenKeyOptions) (givenKey GivenKey)

+ func NewGivenEdDSA(key ed25519.PublicKey, options GivenKeyOptions) (givenKey GivenKey)

+ func NewGivenHMAC(key []byte, options GivenKeyOptions) (givenKey GivenKey)

+ func NewGivenRSA(key *rsa.PublicKey, options GivenKeyOptions) (givenKey GivenKey)

+ type GivenKeyOptions struct

+ Algorithm string

+ type JWKS struct

+ func Get(jwksURL string, options Options) (jwks *JWKS, err error)

+ func NewGiven(givenKeys map[string]GivenKey) (jwks *JWKS)

+ func NewJSON(jwksBytes json.RawMessage) (jwks *JWKS, err error)

+ func (j *JWKS) EndBackground()

+ func (j *JWKS) KIDs() (kids []string)

+ func (j *JWKS) Keyfunc(token *jwt.Token) (interface{}, error)

+ func (j *JWKS) Len() int

+ func (j *JWKS) RawJWKS() []byte

+ func (j *JWKS) ReadOnlyKeys() map[string]interface{}

+ func (j *JWKS) Refresh(ctx context.Context, options RefreshOptions) error

+ type JWKUse string

+ const UseEncryption

+ const UseOmitted

+ const UseSignature

+ type MultipleJWKS struct

+ func GetMultiple(multiple map[string]Options, options MultipleOptions) (multiJWKS *MultipleJWKS, err error)

+ func (m *MultipleJWKS) JWKSets() map[string]*JWKS

+ func (m *MultipleJWKS) Keyfunc(token *jwt.Token) (interface{}, error)

+ type MultipleOptions struct

+ KeySelector func(multiJWKS *MultipleJWKS, token *jwt.Token) (key interface{}, err error)

+ type Options struct

+ Client *http.Client

+ Ctx context.Context

+ GivenKIDOverride bool

+ GivenKeys map[string]GivenKey

+ JWKUseNoWhitelist bool

+ JWKUseWhitelist []JWKUse

+ RefreshErrorHandler ErrorHandler

+ RefreshInterval time.Duration

+ RefreshRateLimit time.Duration

+ RefreshTimeout time.Duration

+ RefreshUnknownKID bool

+ RequestFactory func(ctx context.Context, url string) (*http.Request, error)

+ ResponseExtractor func(ctx context.Context, resp *http.Response) (json.RawMessage, error)

+ type RefreshOptions struct

+ IgnoreRateLimit bool

Other modules containing this package

github.com/MicahParks/keyfunc

github.com/MicahParks/keyfunc/v3