1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
|
package jwk
import (
"context"
"fmt"
"io"
"net/http"
"time"
"github.com/lestrrat-go/httprc"
"github.com/lestrrat-go/iter/arrayiter"
"github.com/lestrrat-go/iter/mapiter"
)
type Transformer = httprc.Transformer
type HTTPClient = httprc.HTTPClient
type ErrSink = httprc.ErrSink
// Whitelist describes a set of rules that allows users to access
// a particular URL. By default all URLs are blocked for security
// reasons. You will HAVE to provide some sort of whitelist. See
// the documentation for github.com/lestrrat-go/httprc for more details.
type Whitelist = httprc.Whitelist
// Cache is a container that keeps track of Set object by their source URLs.
// The Set objects are stored in memory, and are refreshed automatically
// behind the scenes.
//
// Before retrieving the Set objects, the user must pre-register the
// URLs they intend to use by calling `Register()`
//
// c := jwk.NewCache(ctx)
// c.Register(url, options...)
//
// Once registered, you can call `Get()` to retrieve the Set object.
//
// All JWKS objects that are retrieved via this mechanism should be
// treated read-only, as they are shared among all consumers, as well
// as the `jwk.Cache` object.
//
// There are cases where `jwk.Cache` and `jwk.CachedSet` should and
// should not be used.
//
// First and foremost, do NOT use a cache for those JWKS objects that
// need constant checking. For example, unreliable or user-provided JWKS (i.e. those
// JWKS that are not from a well-known provider) should not be fetched
// through a `jwk.Cache` or `jwk.CachedSet`.
//
// For example, if you have a flaky JWKS server for development
// that can go down often, you should consider alternatives such as
// providing `http.Client` with a caching `http.RoundTripper` configured
// (see `jwk.WithHTTPClient`), setting up a reverse proxy, etc.
// These techniques allow you to set up a more robust way to both cache
// and report precise causes of the problems than using `jwk.Cache` or
// `jwk.CachedSet`. If you handle the caching at the HTTP level like this,
// you will be able to use a simple `jwk.Fetch` call and not worry about the cache.
//
// User-provided JWKS objects may also be problematic, as it may go down
// unexpectedly (and frequently!), and it will be hard to detect when
// the URLs or its contents are swapped.
//
// A good use-case for `jwk.Cache` and `jwk.CachedSet` are for "stable"
// JWKS objects.
//
// When we say "stable", we are thinking of JWKS that should mostly be
// ALWAYS available. A good example are those JWKS objects provided by
// major cloud providers such as Google Cloud, AWS, or Azure.
// Stable JWKS may still experience intermittent network connectivity problems,
// but you can expect that they will eventually recover in relatively
// short period of time. They rarely change URLs, and the contents are
// expected to be valid or otherwise it would cause havoc to those providers
//
// We also know that these stable JWKS objects are rotated periodically,
// which is a perfect use for `jwk.Cache` and `jwk.CachedSet`. The caches
// can be configured to periodically refresh the JWKS thereby keeping them
// fresh without extra intervention from the developer.
//
// Notice that for these recommended use-cases the requirement to check
// the validity or the availability of the JWKS objects are non-existent,
// as it is expected that they will be available and will be valid. The
// caching mechanism can hide intermittent connectivity problems as well
// as keep the objects mostly fresh.
type Cache struct {
cache *httprc.Cache
}
// PostFetcher is an interface for objects that want to perform
// operations on the `Set` that was fetched.
type PostFetcher interface {
// PostFetch receives the URL and the JWKS, after a successful
// fetch and parse.
//
// It should return a `Set`, optionally modified, to be stored
// in the cache for subsequent use
PostFetch(string, Set) (Set, error)
}
// PostFetchFunc is a PostFetcher based on a function.
type PostFetchFunc func(string, Set) (Set, error)
func (f PostFetchFunc) PostFetch(u string, set Set) (Set, error) {
return f(u, set)
}
// httprc.Transformer that transforms the response into a JWKS
type jwksTransform struct {
postFetch PostFetcher
parseOptions []ParseOption
}
// Default transform has no postFetch. This can be shared
// by multiple fetchers
var defaultTransform = &jwksTransform{}
func (t *jwksTransform) Transform(u string, res *http.Response) (interface{}, error) {
if res.StatusCode != http.StatusOK {
return nil, fmt.Errorf(`failed to process response: non-200 response code %q`, res.Status)
}
buf, err := io.ReadAll(res.Body)
if err != nil {
return nil, fmt.Errorf(`failed to read response body status: %w`, err)
}
set, err := Parse(buf, t.parseOptions...)
if err != nil {
return nil, fmt.Errorf(`failed to parse JWK set at %q: %w`, u, err)
}
if pf := t.postFetch; pf != nil {
v, err := pf.PostFetch(u, set)
if err != nil {
return nil, fmt.Errorf(`failed to execute PostFetch: %w`, err)
}
set = v
}
return set, nil
}
// NewCache creates a new `jwk.Cache` object.
//
// Please refer to the documentation for `httprc.New` for more
// details.
func NewCache(ctx context.Context, options ...CacheOption) *Cache {
var hrcopts []httprc.CacheOption
for _, option := range options {
//nolint:forcetypeassert
switch option.Ident() {
case identRefreshWindow{}:
hrcopts = append(hrcopts, httprc.WithRefreshWindow(option.Value().(time.Duration)))
case identErrSink{}:
hrcopts = append(hrcopts, httprc.WithErrSink(option.Value().(ErrSink)))
}
}
return &Cache{
cache: httprc.NewCache(ctx, hrcopts...),
}
}
// Register registers a URL to be managed by the cache. URLs must
// be registered before issuing `Get`
//
// This method is almost identical to `(httprc.Cache).Register`, except
// it accepts some extra options.
//
// Use `jwk.WithParser` to configure how the JWKS should be parsed,
// such as passing it extra options.
//
// Please refer to the documentation for `(httprc.Cache).Register` for more
// details.
//
// Register does not check for the validity of the url being registered.
// If you need to make sure that a url is valid before entering your main
// loop, call `Refresh` once to make sure the JWKS is available.
//
// _ = cache.Register(url)
// if _, err := cache.Refresh(ctx, url); err != nil {
// // url is not a valid JWKS
// panic(err)
// }
func (c *Cache) Register(u string, options ...RegisterOption) error {
var hrropts []httprc.RegisterOption
var pf PostFetcher
var parseOptions []ParseOption
// Note: we do NOT accept Transform option
for _, option := range options {
if parseOpt, ok := option.(ParseOption); ok {
parseOptions = append(parseOptions, parseOpt)
continue
}
//nolint:forcetypeassert
switch option.Ident() {
case identHTTPClient{}:
hrropts = append(hrropts, httprc.WithHTTPClient(option.Value().(HTTPClient)))
case identRefreshInterval{}:
hrropts = append(hrropts, httprc.WithRefreshInterval(option.Value().(time.Duration)))
case identMinRefreshInterval{}:
hrropts = append(hrropts, httprc.WithMinRefreshInterval(option.Value().(time.Duration)))
case identFetchWhitelist{}:
hrropts = append(hrropts, httprc.WithWhitelist(option.Value().(httprc.Whitelist)))
case identPostFetcher{}:
pf = option.Value().(PostFetcher)
}
}
var t *jwksTransform
if pf == nil && len(parseOptions) == 0 {
t = defaultTransform
} else {
// User-supplied PostFetcher is attached to the transformer
t = &jwksTransform{
postFetch: pf,
parseOptions: parseOptions,
}
}
// Set the transformer at the end so that nobody can override it
hrropts = append(hrropts, httprc.WithTransformer(t))
return c.cache.Register(u, hrropts...)
}
// Get returns the stored JWK set (`Set`) from the cache.
//
// Please refer to the documentation for `(httprc.Cache).Get` for more
// details.
func (c *Cache) Get(ctx context.Context, u string) (Set, error) {
v, err := c.cache.Get(ctx, u)
if err != nil {
return nil, err
}
set, ok := v.(Set)
if !ok {
return nil, fmt.Errorf(`cached object is not a Set (was %T)`, v)
}
return set, nil
}
// Refresh is identical to Get(), except it always fetches the
// specified resource anew, and updates the cached content
//
// Please refer to the documentation for `(httprc.Cache).Refresh` for
// more details
func (c *Cache) Refresh(ctx context.Context, u string) (Set, error) {
v, err := c.cache.Refresh(ctx, u)
if err != nil {
return nil, err
}
set, ok := v.(Set)
if !ok {
return nil, fmt.Errorf(`cached object is not a Set (was %T)`, v)
}
return set, nil
}
// IsRegistered returns true if the given URL `u` has already been registered
// in the cache.
//
// Please refer to the documentation for `(httprc.Cache).IsRegistered` for more
// details.
func (c *Cache) IsRegistered(u string) bool {
return c.cache.IsRegistered(u)
}
// Unregister removes the given URL `u` from the cache.
//
// Please refer to the documentation for `(httprc.Cache).Unregister` for more
// details.
func (c *Cache) Unregister(u string) error {
return c.cache.Unregister(u)
}
func (c *Cache) Snapshot() *httprc.Snapshot {
return c.cache.Snapshot()
}
// CachedSet is a thin shim over jwk.Cache that allows the user to cloak
// jwk.Cache as if it's a `jwk.Set`. Behind the scenes, the `jwk.Set` is
// retrieved from the `jwk.Cache` for every operation.
//
// Since `jwk.CachedSet` always deals with a cached version of the `jwk.Set`,
// all operations that mutate the object (such as AddKey(), RemoveKey(), et. al)
// are no-ops and return an error.
//
// Note that since this is a utility shim over `jwk.Cache`, you _will_ lose
// the ability to control the finer details (such as controlling how long to
// wait for in case of a fetch failure using `context.Context`)
//
// Make sure that you read the documentation for `jwk.Cache` as well.
type CachedSet struct {
cache *Cache
url string
}
var _ Set = &CachedSet{}
func NewCachedSet(cache *Cache, url string) Set {
return &CachedSet{
cache: cache,
url: url,
}
}
func (cs *CachedSet) cached() (Set, error) {
return cs.cache.Get(context.Background(), cs.url)
}
// Add is a no-op for `jwk.CachedSet`, as the `jwk.Set` should be treated read-only
func (*CachedSet) AddKey(_ Key) error {
return fmt.Errorf(`(jwk.Cachedset).AddKey: jwk.CachedSet is immutable`)
}
// Clear is a no-op for `jwk.CachedSet`, as the `jwk.Set` should be treated read-only
func (*CachedSet) Clear() error {
return fmt.Errorf(`(jwk.CachedSet).Clear: jwk.CachedSet is immutable`)
}
// Set is a no-op for `jwk.CachedSet`, as the `jwk.Set` should be treated read-only
func (*CachedSet) Set(_ string, _ interface{}) error {
return fmt.Errorf(`(jwk.CachedSet).Set: jwk.CachedSet is immutable`)
}
// Remove is a no-op for `jwk.CachedSet`, as the `jwk.Set` should be treated read-only
func (*CachedSet) Remove(_ string) error {
// TODO: Remove() should be renamed to Remove(string) error
return fmt.Errorf(`(jwk.CachedSet).Remove: jwk.CachedSet is immutable`)
}
// RemoveKey is a no-op for `jwk.CachedSet`, as the `jwk.Set` should be treated read-only
func (*CachedSet) RemoveKey(_ Key) error {
return fmt.Errorf(`(jwk.CachedSet).RemoveKey: jwk.CachedSet is immutable`)
}
func (cs *CachedSet) Clone() (Set, error) {
set, err := cs.cached()
if err != nil {
return nil, fmt.Errorf(`failed to get cached jwk.Set: %w`, err)
}
return set.Clone()
}
// Get returns the value of non-Key field stored in the jwk.Set
func (cs *CachedSet) Get(name string) (interface{}, bool) {
set, err := cs.cached()
if err != nil {
return nil, false
}
return set.Get(name)
}
// Key returns the Key at the specified index
func (cs *CachedSet) Key(idx int) (Key, bool) {
set, err := cs.cached()
if err != nil {
return nil, false
}
return set.Key(idx)
}
func (cs *CachedSet) Index(key Key) int {
set, err := cs.cached()
if err != nil {
return -1
}
return set.Index(key)
}
func (cs *CachedSet) Keys(ctx context.Context) KeyIterator {
set, err := cs.cached()
if err != nil {
return arrayiter.New(nil)
}
return set.Keys(ctx)
}
func (cs *CachedSet) Iterate(ctx context.Context) HeaderIterator {
set, err := cs.cached()
if err != nil {
return mapiter.New(nil)
}
return set.Iterate(ctx)
}
func (cs *CachedSet) Len() int {
set, err := cs.cached()
if err != nil {
return -1
}
return set.Len()
}
func (cs *CachedSet) LookupKeyID(kid string) (Key, bool) {
set, err := cs.cached()
if err != nil {
return nil, false
}
return set.LookupKeyID(kid)
}
|