Tracker issue for v1.1.0, which is planned to introduce breaking changes. Development is being done in https://github.com/lestrrat-go/jwx/tree/develop/v1.1.0

Planned Breaking Changes

• Remove all Parse(io.Reader), ParseBytes([]byte), and ParseString(string) methods (closes #291)
  • Add Parse([]byte) and ParseReader(io.Reader) methods
  • Remove jws.ParseVerify
• Change jwk.Set to a an interface (closes #293)
  • Change API to allow mutation. Add(jwk.Key), Remove(jwk.Key), Clear(), etc. (note: treat it as a “set”; don’t create lookups, because “kid” is not guaranteed to be there)
  • Fix JSON marshaling
  • (jwk.Set).LookupKeyID(string) returns the first jwk.Key matching the “kid”. If multiple kids are available, use (jwk.Set).Iterate(context.Context)
• Remove jwk.PublicKeyOf(rawKey)
  • Add jwk.PublicRawKeyOf(rawKey)
  • Add jwk.PublicKeyOf(jwk.Key)
  • Add jwk.PublicSetOf(jwk.Set)
  • Change (jwk.Key).PublicKey() to return a jwk.Key. Implement it in all applicable key types
  • Make key.PublicKey() return a key with all fields (except for those explicitly not allowed) copied from the original key.
• Remove jws.VerifyXXXX.
  • Allow jws.Verify() to take a raw key or a jwk.Key
  • Add jws.VerifySet([]byte, jwk.Set)
• Remove jwk.FetchXXXX methods. Only jwk.Fetch() remains.
  • Reuse jwk.Fetch() from jwk.AutoRefresh.
  • Reclassify WithHTTPClient() as FetchOption
  • Rename WithRefreshBackoff() to WithFetchBackoff()
• Add ReadFile() to all packages, to read from local file system. On go >= 1.16 , io/fs should be supported, so you could even embed your jwk in your compiled program
• Remove jws.SplitCompact(io.Reader) (NEW!)
  • Add jws.SplitCompact([]byte)
  • Add jws.SplitCompactReader(io.Reader)
• Remove jws.SignLiteral
• Change options to jws.SignMulti
• Change jwe.WithPrettyJSONFormat to jwe.WithPrettyFormat, and its return type to jws.SerializerOption
• Remove buffer.Buffer

Miscellaneous

• switch default branch to main
• Optimizations
  • Optimize (jwk.Set).MarshalJSON (36% reduction in memory allocation)
  • Optimize (jwt.Token).MarshalJSON
  • Optimize (jws.Header).MarshalJSON
  • Optimize (jwe.Header).MarshalJSON