Some algorithms are intentionally left out because they are not as common in the wild, and you may want to avoid compiling this extra information in. To enable these, you must explicitly provide a build tag.
| Algorithm | Build Tag |
|---|---|
| secp256k1/ES256K | jwx_es256k |
If you do not provide these tags, the program will still compile, but it will return an error during runtime saying that these algorithms are not supported.
By default, we use the standard library's encoding/json for all of our JSON needs.
However, if performance for parsing/serializing JSON is really important to you, you might want to enable github.com/goccy/go-json by enabling the jwx_goccy tag.
% go build -tags jwx_goccy ...github.com/goccy/go-json is disabled by default because it uses some really advanced black magic, and I really do not feel like debugging it IF it breaks. Please note that that's a big "if". As of github.com/goccy/[email protected] I haven't seen any problems, and I would say that it is mostly stable.
However, it is a dependency that you can go without, and I won't be of much help if it breaks -- therefore it is not the default. If you know what you are doing, I highly recommend enabling this module -- all you need to do is to enable this tag. Disable the tag if you feel like it's not worth the hassle.
And when you do enable github.com/goccy/go-json, and you encounter some mysterious error, I also trust that you know to file an issue to github.com/goccy/go-json and NOT to this library.
This feature is currently considered experimental.
Currently, you can enable github.com/segmentio/asm/base64 by specifying the jwx_asmbase64 build tag
% go build -tags jwx_goccy ...In our limited testing, this does not seem to improve performance significantly: presumably the other bottlenecks are more dominant. If you care enough to use this option, you probably want to enable jwx_goccy build tag as well.
If you want to parse numbers in the incoming JSON objects as json.Number instead of floats, you can use the following call to globally affect the behavior of JSON parsing.
func init() {
jwx.DecoderSettings(jwx.WithUseNumber(true))
}Do be aware that this has global effect. All code that calls in to encoding/json
within jwx will use your settings.
Packages within github.com/lestrrat-go/jwx/v3 parses known fields into pre-defined types,
but for everything else (usually called private fields/headers/claims) are decoded into
whatever "encoding/json".Unmarshal deems appropriate.
For example, JSON objects are converted to map[string]interface{}, JSON arrays into
[]interface{}, and so on.
Sometimes you know beforehand that it makes sense for certain fields to be decoded into
proper objects instead of generic maps or arrays. When you encounter this, you can use
the RegisterCustomField() method in each of jwe, jwk, jws, and jwt packages.
func init() {
jwt.RegisterCustomField(`x-foo-bar`, mypkg.FooBar{})
}This tells the decoder that when it encounters a JWT token with the field named
"x-foo-bar", it should be decoded to an instance of mypkg.FooBar. Then you can
access this value by using Get()
var v mypkg.FooBar
_ = token.Get(`x-foo-bar`, &v)Do be aware that this has global effect. In the above example, all JWT tokens containing
the "x-foo-bar" key will decode in the same way. If you need this behavior from
jwe, jwk, or jws packages, you need to do the same thing for each package.