jose

package module

Go to main page

Versions in this module

v2

v2.8.0

Feb 27, 2025

Changes in this version

+ func X5TS256KeyIDGetter(key *jose.JSONWebKey) string

+ func X5TS256TokenKeyIDGetter(token *jwt.JSONWebToken) string

v2.7.0

Jan 15, 2025

v2.6.2

Sep 5, 2024

v2.6.1

Sep 5, 2024

Changes in this version

type JWKClient

+ func (j *JWKClient) GetKey(keyID string) (jose.JSONWebKey, error)

type JWKClientOptions

+ UnknownKeysTTL string

type SecretProviderConfig

+ UnknownKeysTTL string

type SignatureConfig

+ UnknownKeysTTL string

v2.6.0

Jun 19, 2024

Changes in this version

+ func SupportedAlgorithm(s string) (jose.SignatureAlgorithm, bool)

type JWKClient

+ func (j *JWKClient) SecretFromToken(token *jwt.JSONWebToken) (interface{}, error)

v2.5.0

Apr 5, 2024

Changes in this version

type SignatureConfig

+ Leeway string

v2.4.0

Jan 24, 2024

Changes in this version

type SignatureConfig

+ AuthHeaderName string

type SignerConfig

+ Type string

v2.3.0

Nov 2, 2023

v2.2.2

May 5, 2023

Changes in this version

+ var ErrNoHeadersToPropagate = fmt.Errorf(...)

v2.2.1

May 3, 2023

v2.2.0

Apr 18, 2023

Changes in this version

+ func SetGlobalCacher(l logging.Logger, cfg config.ExtraConfig) error

+ type GMemoryKeyCacher struct

+ Global GlobalCacher

+ func (gkc *GMemoryKeyCacher) Add(keyID string, downloadedKeys []jose.JSONWebKey) (*jose.JSONWebKey, error)

+ func (gkc *GMemoryKeyCacher) Get(keyID string) (*jose.JSONWebKey, error)

+ type GlobalCacher struct

type KeyCacher

+ func NewGlobalMemoryKeyCacher(maxKeyAge time.Duration, maxCacheSize int, keyIdentifyStrategy string) KeyCacher

v2.1.0

Feb 2, 2023

v2.0.5

Oct 19, 2022

Changes in this version

type Dialer

+ func (d *Dialer) DialTLSContext(ctx context.Context, network, addr string) (net.Conn, error)

v2.0.4

Jun 14, 2022

v2.0.3

Jun 8, 2022

Changes in this version

+ const SignerNamespace

+ const ValidatorNamespace

+ var DefaultEnabledCipherSuites = []uint16

+ var ErrInsecureJWKSource = errors.New("JWK client is using an insecure connection to the JWK service")

+ var ErrKeyExpired = errors.New("key exists but is expired")

+ var ErrNoKeyFound = errors.New("no Keys have been found")

+ var ErrNoSignerCfg = errors.New("no signer config")

+ var ErrNoValidatorCfg = errors.New("no validator config")

+ var ErrPinnedKeyNotFound = errors.New("JWK client did not find a pinned key")

+ var MaxKeyAgeNoCheck = time.Duration(-1)

+ func CalculateHeadersToPropagate(propagationCfg [][]string, claims map[string]interface{}) (map[string]string, error)

+ func CanAccess(roleKey string, claims map[string]interface{}, required []string) bool

+ func CanAccessNested(roleKey string, claims map[string]interface{}, required []string) bool

+ func CompoundX5TKeyIDGetter(key *jose.JSONWebKey) string

+ func CompoundX5TTokenKeyIDGetter(token *jwt.JSONWebToken) string

+ func DecodeFingerprints(in []string) ([][]byte, error)

+ func DefaultKeyIDGetter(key *jose.JSONWebKey) string

+ func DefaultTokenKeyIDGetter(token *jwt.JSONWebToken) string

+ func NewSigner(cfg *config.EndpointConfig, te auth0.RequestTokenExtractor) (*SignerConfig, Signer, error)

+ func NewValidator(signatureConfig *SignatureConfig, ef ExtractorFactory) (*auth0.JWTValidator, error)

+ func ScopesAllMatcher(scopesKey string, claims map[string]interface{}, requiredScopes []string) bool

+ func ScopesAnyMatcher(scopesKey string, claims map[string]interface{}, requiredScopes []string) bool

+ func ScopesDefaultMatcher(scopesKey string, claims map[string]interface{}, requiredScopes []string) bool

+ func SignFields(keys []string, signer Signer, response *proxy.Response) error

+ func X5TKeyIDGetter(key *jose.JSONWebKey) string

+ func X5TTokenKeyIDGetter(token *jwt.JSONWebToken) string

+ type ChainedRejecterFactory []RejecterFactory

+ func (c ChainedRejecterFactory) New(l logging.Logger, cfg *config.EndpointConfig) Rejecter

+ type Claims map[string]interface

+ func (c Claims) Get(name string) (string, bool)

+ type Dialer struct

+ func NewDialer(cfg SecretProviderConfig) *Dialer

+ func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)

+ func (d *Dialer) DialTLS(network, addr string) (net.Conn, error)

+ type ExtractorFactory func(string) func(r *http.Request) (*jwt.JSONWebToken, error)

+ type FileKeyCacher struct

+ func NewFileKeyCacher(data []byte, keyIdentifyStrategy string) (*FileKeyCacher, error)

+ func (f *FileKeyCacher) Add(keyID string, _ []jose.JSONWebKey) (*jose.JSONWebKey, error)

+ func (f *FileKeyCacher) Get(keyID string) (*jose.JSONWebKey, error)

+ type FixedRejecter bool

+ func (f FixedRejecter) Reject(_ map[string]interface{}) bool

+ type JWKClient struct

+ func NewJWKClientWithCache(options JWKClientOptions, extractor auth0.RequestTokenExtractor, ...) *JWKClient

+ func SecretProvider(cfg SecretProviderConfig, te auth0.RequestTokenExtractor) (*JWKClient, error)

+ func (j *JWKClient) GetSecret(r *http.Request) (interface{}, error)

+ type JWKClientOptions struct

+ KeyIdentifyStrategy string

+ type KeyCacher interface

+ Add func(keyID string, webKeys []jose.JSONWebKey) (*jose.JSONWebKey, error)

+ Get func(keyID string) (*jose.JSONWebKey, error)

+ func NewMemoryKeyCacher(maxKeyAge time.Duration, maxCacheSize int, keyIdentifyStrategy string) KeyCacher

+ type KeyIDGetter interface

+ Get func(*jose.JSONWebKey) string

+ func KeyIDGetterFactory(keyIdentifyStrategy string) KeyIDGetter

+ type KeyIDGetterFunc func(*jose.JSONWebKey) string

+ func (f KeyIDGetterFunc) Get(key *jose.JSONWebKey) string

+ type MemoryKeyCacher struct

+ func (mkc *MemoryKeyCacher) Add(keyID string, downloadedKeys []jose.JSONWebKey) (*jose.JSONWebKey, error)

+ func (mkc *MemoryKeyCacher) Get(keyID string) (*jose.JSONWebKey, error)

+ type NopRejecterFactory struct

+ func (NopRejecterFactory) New(_ logging.Logger, _ *config.EndpointConfig) Rejecter

+ type Rejecter interface

+ Reject func(map[string]interface{}) bool

+ type RejecterFactory interface

+ New func(logging.Logger, *config.EndpointConfig) Rejecter

+ type RejecterFactoryFunc func(logging.Logger, *config.EndpointConfig) Rejecter

+ func (f RejecterFactoryFunc) New(l logging.Logger, cfg *config.EndpointConfig) Rejecter

+ type RejecterFunc func(map[string]interface{}) bool

+ func (r RejecterFunc) Reject(v map[string]interface{}) bool

+ type SecretProviderConfig struct

+ AllowInsecure bool

+ CacheDuration uint32

+ CacheEnabled bool

+ CipherKey []byte

+ Cs []uint16

+ Fingerprints [][]byte

+ KeyIdentifyStrategy string

+ LocalCA string

+ LocalPath string

+ SecretURL string

+ URI string

+ type SignatureConfig struct

+ Alg string

+ Audience []string

+ CacheDuration uint32

+ CacheEnabled bool

+ CipherKey []byte

+ CipherSuites []uint16

+ CookieKey string

+ DisableJWKSecurity bool

+ Fingerprints []string

+ Issuer string

+ KeyIdentifyStrategy string

+ LocalCA string

+ LocalPath string

+ OperationDebug bool

+ PropagateClaimsToHeader [][]string

+ Roles []string

+ RolesKey string

+ RolesKeyIsNested bool

+ Scopes []string

+ ScopesKey string

+ ScopesMatcher string

+ SecretURL string

+ URI string

+ func GetSignatureConfig(cfg *config.EndpointConfig) (*SignatureConfig, error)

+ type Signer func(interface{}) (string, error)

+ type SignerConfig struct

+ Alg string

+ CipherKey []byte

+ CipherSuites []uint16

+ DisableJWKSecurity bool

+ Fingerprints []string

+ FullSerialization bool

+ KeyID string

+ KeysToSign []string

+ LocalCA string

+ LocalPath string

+ SecretURL string

+ URI string

+ type TokenIDGetter interface

+ Get func(*jwt.JSONWebToken) string

+ func TokenIDGetterFactory(keyIdentifyStrategy string) TokenIDGetter

+ type TokenKeyIDGetterFunc func(*jwt.JSONWebToken) string

+ func (f TokenKeyIDGetterFunc) Get(token *jwt.JSONWebToken) string

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