jwksx

package

v0.0.0-...-398cf1c Latest Latest Go to latest Published: Mar 11, 2025 License: Apache-2.0 Imports: 26 Imported by: 0

Details

This section is empty.

View Source

var ErrUnableToFindKeyID = errors.New("specified JWK kid can not be found in the JWK sets")

func GenerateSigningKeys(id, alg string, bits int) (*jose.JSONWebKeySet, error)

GenerateSigningKeys generates a JSON Web Key Set for signing.

func GenerateSigningKeysAvailableAlgorithms() []string

GenerateSigningKeysAvailableAlgorithms lists available algorithms that are supported by GenerateSigningKeys.

type Fetcher struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Fetcher is a small helper for fetching JSON Web Keys from remote endpoints.

DEPRECATED: Use FetcherNext instead.

func NewFetcher(remote string) *Fetcher

NewFetcher returns a new fetcher that can download JSON Web Keys from remote endpoints.

DEPRECATED: Use FetcherNext instead.

func (f *Fetcher) GetKey(kid string) (*jose.JSONWebKey, error)

GetKey retrieves a JSON Web Key from the cache, fetches it from a remote if it is not yet cached or returns an error.

DEPRECATED: Use FetcherNext instead.

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

FetcherNext is a JWK fetcher that can be used to fetch JWKs from multiple locations.

func NewFetcherNext(cache *ristretto.Cache[[]byte, jwk.Set]) *FetcherNext

NewFetcherNext returns a new FetcherNext instance.

func (f *FetcherNext) ResolveKey(ctx context.Context, locations string, modifiers ...FetcherNextOption) (jwk.Key, error)

func (f *FetcherNext) ResolveKeyFromLocations(ctx context.Context, locations []string, modifiers ...FetcherNextOption) (jwk.Key, error)

type FetcherNextOption func(*fetcherNextOptions)

FetcherNextOption is a functional option for the FetcherNext.

func WithCacheEnabled() FetcherNextOption

WithCacheEnabled enables the cache.

func WithCacheTTL(ttl time.Duration) FetcherNextOption

WithCacheTTL sets the cache TTL. If not set, the TTL is unlimited.

func WithForceKID(kid string) FetcherNextOption

WithForceKID forces the key ID to be used. Required when multiple JWK sets are configured.

func WithHTTPClient(c *retryablehttp.Client) FetcherNextOption

WithHTTPClient will use the given HTTP client to fetch the JSON Web Keys.