135 lines
7.3 KiB
Markdown
135 lines
7.3 KiB
Markdown
# github.com/lestrrat-go/jwx  [](https://pkg.go.dev/github.com/lestrrat-go/jwx) [](http://codecov.io/github/lestrrat-go/jwx?branch=main)
|
|
|
|
Various libraries implementing various JWx technologies. Please click on the package names in the table below to find the synopsis/description for each package.
|
|
|
|
If you are using this module in your product or your company, please add your product and/or company name in the [Wiki](https://github.com/lestrrat-go/jwx/wiki/Users)! It really helps keeping up our motivation.
|
|
|
|
| Package name | Notes |
|
|
|-----------------------------------------------------------|-------------------------------------------------|
|
|
| [jwt](https://github.com/lestrrat-go/jwx/tree/main/jwt) | [RFC 7519](https://tools.ietf.org/html/rfc7519) |
|
|
| [jwk](https://github.com/lestrrat-go/jwx/tree/main/jwk) | [RFC 7517](https://tools.ietf.org/html/rfc7517) + [RFC 7638](https://tools.ietf.org/html/rfc7638) |
|
|
| [jwa](https://github.com/lestrrat-go/jwx/tree/main/jwa) | [RFC 7518](https://tools.ietf.org/html/rfc7518) |
|
|
| [jws](https://github.com/lestrrat-go/jwx/tree/main/jws) | [RFC 7515](https://tools.ietf.org/html/rfc7515) + [RFC 7797](https://tools.ietf.org/html/rfc7797) |
|
|
| [jwe](https://github.com/lestrrat-go/jwx/tree/main/jwe) | [RFC 7516](https://tools.ietf.org/html/rfc7516) |
|
|
|
|
# How to Use
|
|
|
|
* [API documentation](https://pkg.go.dev/github.com/lestrrat-go/jwx)
|
|
* [How-to style documentation](./docs)
|
|
* [Runnable Examples](./examples)
|
|
|
|
# Description
|
|
|
|
## History
|
|
|
|
My goal was to write a server that heavily uses JWK and JWT. At first glance
|
|
the libraries that already exist seemed sufficient, but soon I realized that
|
|
|
|
1. To completely implement the protocols, I needed the entire JWT, JWK, JWS, JWE (and JWA, by necessity).
|
|
2. Most of the libraries that existed only deal with a subset of the various JWx specifications that were necessary to implement their specific needs
|
|
|
|
For example, a certain library looks like it had most of JWS, JWE, JWK covered, but then it lacked the ability to include private claims in its JWT responses. Another library had support of all the private claims, but completely lacked in its flexibility to generate various different response formats.
|
|
|
|
Because I was writing the server side (and the client side for testing), I needed the *entire* JOSE toolset to properly implement my server, **and** they needed to be *flexible* enough to fulfill the entire spec that I was writing.
|
|
|
|
So here's `github.com/lestrrat-go/jwx`. This library is extensible, customizable, and hopefully well organized to the point that it is easy for you to slice and dice it.
|
|
|
|
## Why would I use this library?
|
|
|
|
There are several other major Go modules that handle JWT and related data formats,
|
|
so why should you use this library?
|
|
|
|
From a purely functional perspective, the only major difference is this:
|
|
Whereas most other projects only deal with what they seem necessary to handle
|
|
JWTs, this module handles the **_entire_** spectrum of JWS, JWE, JWK, and JWT.
|
|
|
|
That is, if you need to not only parse JWTs, but also to control JWKs, or
|
|
if you need to handle payloads that are NOT JWTs, you should probably consider
|
|
using this module. You should also note that JWT is built _on top_ of those
|
|
other technologies. You simply cannot have a complete JWT package without
|
|
implementing the entirety of JWS/JWS/JWK, which this library does.
|
|
|
|
Next, from an implementation perspective, this module differs significantly
|
|
from others in that it tries very hard to expose only the APIs, and not the
|
|
internal data. For example, individual JWT claims are not accessible through
|
|
struct field lookups. You need to use one of the getter methods.
|
|
|
|
This is because this library takes the stance that the end user is fully capable
|
|
and even willing to shoot themselves on the foot when presented with a lax
|
|
API. By making sure that users do not have access to open structs, we can protect
|
|
users from doing silly things like creating _incomplete_ structs, or access the
|
|
structs concurrently without any protection. This structure also allows
|
|
us to put extra smarts in the structs, such as doing the right thing when
|
|
you want to parse / write custom fields (this module does not require the user
|
|
to specify alternate structs to parse objects with custom fields)
|
|
|
|
In the end I think it comes down to your usage pattern, and priorities.
|
|
Some general guidelines that come to mind are:
|
|
|
|
* If you want a single library to handle everything JWx, such as using JWE, JWK, JWS, handling [auto-refreshing JWKs](https://github.com/lestrrat-go/jwx/blob/main/docs/04-jwk.md#auto-refreshing-remote-keys), use this module.
|
|
* If you want to honor all possible custom fields transparently, use this module.
|
|
* If you want a standardized clean API, use this module.
|
|
|
|
Otherwise, feel free to choose something else.
|
|
|
|
# Command Line Tool
|
|
|
|
Since v1.1.1 we have a command line tool `jwx` (*). With `jwx` you can create JWKs (from PEM files, even), sign and verify JWS message, encrypt and decrypt JWE messages, etc.
|
|
|
|
(*) Okay, it existed since a long time ago, but it was never useful.
|
|
|
|
## Installation
|
|
|
|
```
|
|
go install github.com/lestrrat-go/jwx/cmd/jwx
|
|
```
|
|
|
|
# Caveats
|
|
|
|
## Backwards Compatibility Notice
|
|
|
|
### Users of github.com/lestrrat/go-jwx
|
|
|
|
Uh, why are you using such an ancient version? You know that repository is archived for a reason, yeah? Please use the new version.
|
|
|
|
### Pre-1.0.0 users
|
|
|
|
The API has been reworked quite substantially between pre- and post 1.0.0 releases. Please check out the [Changes](./Changes) file (or the [diff](https://github.com/lestrrat-go/jwx/compare/v0.9.2...v1.0.0), if you are into that sort of thing)
|
|
|
|
### v1.0.x users
|
|
|
|
The API has gone under some changes for v1.1.0. If you are upgrading, you might want to read the relevant parts in the [Changes](./Changes) file.
|
|
|
|
# Contributions
|
|
|
|
## Issues
|
|
|
|
For bug reports and feature requests, please try to follow the issue templates as much as possible.
|
|
For either bug reports or feature requests, failing tests are even better.
|
|
|
|
## Pull Requests
|
|
|
|
Please make sure to include tests that excercise the changes you made.
|
|
|
|
If you are editing auto-generated files (those files with the `_gen.go` suffix, please make sure that you do the following:
|
|
|
|
1. Edit the generator, not the generated files (e.g. internal/cmd/genreadfile/main.go)
|
|
2. Run `make generate` (or `go generate`) to generate the new code
|
|
3. Commit _both_ the generator _and_ the generated files
|
|
|
|
## Discussions / Usage
|
|
|
|
Please try [discussions](https://github.com/lestrrat-go/jwx/discussions) first.
|
|
|
|
# Related Modules
|
|
|
|
* [github.com/jwx-go/crypto-signer/gcp](https://github.com/jwx-go/crypto-signer/tree/main/gcp) - GCP KMS wrapper that implements [`crypto.Signer`](https://pkg.go.dev/crypto#Signer)
|
|
* [github.com/jwx-go/crypto-signer/aws](https://github.com/jwx-go/crypto-signer/tree/main/aws) - AWS KMS wrapper that implements [`crypto.Signer`](https://pkg.go.dev/crypto#Signer)
|
|
|
|
# Credits
|
|
|
|
* Initial work on this library was generously sponsored by HDE Inc (https://www.hde.co.jp)
|
|
* Lots of code, especially JWE was taken from go-jose library (https://github.com/square/go-jose)
|
|
* Lots of individual contributors have helped this project over the years. Thank each and everyone of you very much.
|
|
|