jwksx

package

v0.0.631 Latest Latest Go to latest Published: Apr 30, 2024 License: Apache-2.0 Imports: 26 Imported by: 7

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ory/x

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func GenerateSigningKeys(id, alg string, bits int) (*jose.JSONWebKeySet, error)
func GenerateSigningKeysAvailableAlgorithms() []string
type Fetcher
- func NewFetcher(remote string) *Fetcher
- func (f *Fetcher) GetKey(kid string) (*jose.JSONWebKey, error)
type FetcherNext
- func NewFetcherNext(cache *ristretto.Cache) *FetcherNext
- 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

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

func GenerateSigningKeys ¶ added in v0.0.60

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

GenerateSigningKeys generates a JSON Web Key Set for signing.

func GenerateSigningKeysAvailableAlgorithms ¶ added in v0.0.60

func GenerateSigningKeysAvailableAlgorithms() []string

GenerateSigningKeysAvailableAlgorithms lists available algorithms that are supported by GenerateSigningKeys.

Types ¶

type Fetcher ¶

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 ¶

func NewFetcher(remote string) *Fetcher

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

DEPRECATED: Use FetcherNext instead.

func (*Fetcher) GetKey ¶

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 ¶ added in v0.0.586

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 ¶ added in v0.0.586

func NewFetcherNext(cache *ristretto.Cache) *FetcherNext

NewFetcherNext returns a new FetcherNext instance.

func (*FetcherNext) ResolveKey ¶ added in v0.0.586

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

func (*FetcherNext) ResolveKeyFromLocations ¶ added in v0.0.586

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

type FetcherNextOption ¶ added in v0.0.586

type FetcherNextOption func(*fetcherNextOptions)

FetcherNextOption is a functional option for the FetcherNext.

func WithCacheEnabled ¶ added in v0.0.586

func WithCacheEnabled() FetcherNextOption

WithCacheEnabled enables the cache.

func WithCacheTTL ¶ added in v0.0.586

func WithCacheTTL(ttl time.Duration) FetcherNextOption

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

func WithForceKID ¶ added in v0.0.586

func WithForceKID(kid string) FetcherNextOption

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

func WithHTTPClient ¶ added in v0.0.586

func WithHTTPClient(c *retryablehttp.Client) FetcherNextOption

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL