275 lines
7.3 KiB
Markdown
275 lines
7.3 KiB
Markdown
# JWK [](https://pkg.go.dev/github.com/lestrrat-go/jwx/jwk)
|
|
|
|
Package jwk implements JWK as described in [RFC7517](https://tools.ietf.org/html/rfc7517)
|
|
|
|
* Parse and work with RSA/EC/Symmetric/OKP JWK types
|
|
* Convert to and from JSON
|
|
* Convert to and from raw key types (e.g. *rsa.PrivateKey)
|
|
* Ability to keep a JWKS fresh.
|
|
|
|
How-to style documentation can be found in the [docs directory](../docs).
|
|
|
|
Examples are located in the examples directory ([jwk_example_test.go](../examples/jwk_example_test.go))
|
|
|
|
Supported key types:
|
|
|
|
| kty | Curve | Go Key Type |
|
|
|:----|:------------------------|:----------------------------------------------|
|
|
| RSA | N/A | rsa.PrivateKey / rsa.PublicKey (2) |
|
|
| EC | P-256<br>P-384<br>P-521<br>secp256k1 (1) | ecdsa.PrivateKey / ecdsa.PublicKey (2) |
|
|
| oct | N/A | []byte |
|
|
| OKP | Ed25519 (1) | ed25519.PrivateKey / ed25519.PublicKey (2) |
|
|
| | X25519 (1) | (jwx/)x25519.PrivateKey / x25519.PublicKey (2)|
|
|
|
|
* Note 1: Experimental
|
|
* Note 2: Either value or pointers accepted (e.g. rsa.PrivateKey or *rsa.PrivateKey)
|
|
|
|
# SYNOPSIS
|
|
|
|
## Parse a JWK or a JWK set
|
|
|
|
```go
|
|
// Parse a single JWK key.
|
|
key, err := jwk.ParseKey(...)
|
|
|
|
// Parse a JWK set (or a single JWK key)
|
|
set, err := jwk.Parse(...)
|
|
```
|
|
|
|
## Create JWK keys from raw keys
|
|
|
|
```go
|
|
func ExampleNew() {
|
|
// New returns different underlying types of jwk.Key objects
|
|
// depending on the input value.
|
|
|
|
// []byte -> jwk.SymmetricKey
|
|
{
|
|
raw := []byte("Lorem Ipsum")
|
|
key, err := jwk.New(raw)
|
|
if err != nil {
|
|
fmt.Printf("failed to create symmetric key: %s\n", err)
|
|
return
|
|
}
|
|
if _, ok := key.(jwk.SymmetricKey); !ok {
|
|
fmt.Printf("expected jwk.SymmetricKey, got %T\n", key)
|
|
return
|
|
}
|
|
}
|
|
|
|
// *rsa.PrivateKey -> jwk.RSAPrivateKey
|
|
// *rsa.PublicKey -> jwk.RSAPublicKey
|
|
{
|
|
raw, err := rsa.GenerateKey(rand.Reader, 2048)
|
|
if err != nil {
|
|
fmt.Printf("failed to generate new RSA privatre key: %s\n", err)
|
|
return
|
|
}
|
|
|
|
key, err := jwk.New(raw)
|
|
if err != nil {
|
|
fmt.Printf("failed to create symmetric key: %s\n", err)
|
|
return
|
|
}
|
|
if _, ok := key.(jwk.RSAPrivateKey); !ok {
|
|
fmt.Printf("expected jwk.SymmetricKey, got %T\n", key)
|
|
return
|
|
}
|
|
// PublicKey is omitted for brevity
|
|
}
|
|
|
|
// *ecdsa.PrivateKey -> jwk.ECDSAPrivateKey
|
|
// *ecdsa.PublicKey -> jwk.ECDSAPublicKey
|
|
{
|
|
raw, err := ecdsa.GenerateKey(elliptic.P384(), rand.Reader)
|
|
if err != nil {
|
|
fmt.Printf("failed to generate new ECDSA privatre key: %s\n", err)
|
|
return
|
|
}
|
|
|
|
key, err := jwk.New(raw)
|
|
if err != nil {
|
|
fmt.Printf("failed to create symmetric key: %s\n", err)
|
|
return
|
|
}
|
|
if _, ok := key.(jwk.ECDSAPrivateKey); !ok {
|
|
fmt.Printf("expected jwk.SymmetricKey, got %T\n", key)
|
|
return
|
|
}
|
|
// PublicKey is omitted for brevity
|
|
}
|
|
|
|
// OUTPUT:
|
|
}
|
|
```
|
|
|
|
# Get the JSON representation of a key
|
|
|
|
```go
|
|
func ExampleMarshalJSON() {
|
|
// to get the same values every time, we need to create a static source
|
|
// of "randomness"
|
|
rdr := bytes.NewReader([]byte("01234567890123456789012345678901234567890123456789ABCDEF"))
|
|
raw, err := ecdsa.GenerateKey(elliptic.P384(), rdr)
|
|
if err != nil {
|
|
fmt.Printf("failed to generate new ECDSA privatre key: %s\n", err)
|
|
return
|
|
}
|
|
|
|
key, err := jwk.New(raw)
|
|
if err != nil {
|
|
fmt.Printf("failed to create symmetric key: %s\n", err)
|
|
return
|
|
}
|
|
if _, ok := key.(jwk.ECDSAPrivateKey); !ok {
|
|
fmt.Printf("expected jwk.SymmetricKey, got %T\n", key)
|
|
return
|
|
}
|
|
|
|
key.Set(jwk.KeyIDKey, "mykey")
|
|
|
|
buf, err := json.MarshalIndent(key, "", " ")
|
|
if err != nil {
|
|
fmt.Printf("failed to marshal key into JSON: %s\n", err)
|
|
return
|
|
}
|
|
fmt.Printf("%s\n", buf)
|
|
|
|
// OUTPUT:
|
|
// {
|
|
// "kty": "EC",
|
|
// "crv": "P-384",
|
|
// "d": "ODkwMTIzNDU2Nzg5MDEyMz7deMbyLt8g4cjcxozuIoygLLlAeoQ1AfM9TSvxkFHJ",
|
|
// "kid": "mykey",
|
|
// "x": "gvvRMqm1w5aHn7sVNA2QUJeOVcedUnmiug6VhU834gzS9k87crVwu9dz7uLOdoQl",
|
|
// "y": "7fVF7b6J_6_g6Wu9RuJw8geWxEi5ja9Gp2TSdELm5u2E-M7IF-bsxqcdOj3n1n7N"
|
|
// }
|
|
}
|
|
```
|
|
|
|
# Auto-Refresh a key during a long running process
|
|
|
|
```go
|
|
func ExampleAutoRefresh() {
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
|
|
const googleCerts = `https://www.googleapis.com/oauth2/v3/certs`
|
|
ar := jwk.NewAutoRefresh(ctx)
|
|
|
|
// Tell *jwk.AutoRefresh that we only want to refresh this JWKS
|
|
// when it needs to (based on Cache-Control or Expires header from
|
|
// the HTTP response). If the calculated minimum refresh interval is less
|
|
// than 15 minutes, don't go refreshing any earlier than 15 minutes.
|
|
ar.Configure(googleCerts, jwk.WithMinRefreshInterval(15*time.Minute))
|
|
|
|
// Refresh the JWKS once before getting into the main loop.
|
|
// This allows you to check if the JWKS is available before we start
|
|
// a long-running program
|
|
_, err := ar.Refresh(ctx, googleCerts)
|
|
if err != nil {
|
|
fmt.Printf("failed to refresh google JWKS: %s\n", err)
|
|
return
|
|
}
|
|
|
|
// Pretend that this is your program's main loop
|
|
MAIN:
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
break MAIN
|
|
default:
|
|
}
|
|
keyset, err := ar.Fetch(ctx, googleCerts)
|
|
if err != nil {
|
|
fmt.Printf("failed to fetch google JWKS: %s\n", err)
|
|
return
|
|
}
|
|
_ = keyset
|
|
|
|
// Do interesting stuff with the keyset... but here, we just
|
|
// sleep for a bit
|
|
time.Sleep(time.Second)
|
|
|
|
// Because we're a dummy program, we just cancel the loop now.
|
|
// If this were a real program, you prosumably loop forever
|
|
cancel()
|
|
}
|
|
// OUTPUT:
|
|
}
|
|
```
|
|
|
|
Parse and use a JWK key:
|
|
|
|
```go
|
|
|
|
import (
|
|
"encoding/json"
|
|
"log"
|
|
|
|
"github.com/lestrrat-go/jwx/jwk"
|
|
)
|
|
|
|
func main() {
|
|
set, err := jwk.Fetch(context.Background(), "https://www.googleapis.com/oauth2/v3/certs")
|
|
if err != nil {
|
|
log.Printf("failed to parse JWK: %s", err)
|
|
return
|
|
}
|
|
|
|
// Key sets can be serialized back to JSON
|
|
{
|
|
jsonbuf, err := json.Marshal(set)
|
|
if err != nil {
|
|
log.Printf("failed to marshal key set into JSON: %s", err)
|
|
return
|
|
}
|
|
log.Printf("%s", jsonbuf)
|
|
}
|
|
|
|
for it := set.Iterate(context.Background()); it.Next(context.Background()); {
|
|
pair := it.Pair()
|
|
key := pair.Value.(jwk.Key)
|
|
|
|
var rawkey interface{} // This is the raw key, like *rsa.PrivateKey or *ecdsa.PrivateKey
|
|
if err := key.Raw(&rawkey); err != nil {
|
|
log.Printf("failed to create public key: %s", err)
|
|
return
|
|
}
|
|
// Use rawkey for jws.Verify() or whatever.
|
|
_ = rawkey
|
|
|
|
// You can create jwk.Key from a raw key, too
|
|
fromRawKey, err := jwk.New(rawkey)
|
|
|
|
|
|
// Keys can be serialized back to JSON
|
|
jsonbuf, err := json.Marshal(key)
|
|
if err != nil {
|
|
log.Printf("failed to marshal key into JSON: %s", err)
|
|
return
|
|
}
|
|
log.Printf("%s", jsonbuf)
|
|
|
|
// If you know the underlying Key type (RSA, EC, Symmetric), you can
|
|
// create an empy instance first
|
|
// key := jwk.NewRSAPrivateKey()
|
|
// ..and then use json.Unmarshal
|
|
// json.Unmarshal(key, jsonbuf)
|
|
//
|
|
// but if you don't know the type first, you have an abstract type
|
|
// jwk.Key, which can't be used as the first argument to json.Unmarshal
|
|
//
|
|
// In this case, use jwk.Parse()
|
|
fromJsonKey, err := jwk.Parse(jsonbuf)
|
|
if err != nil {
|
|
log.Printf("failed to parse json: %s", err)
|
|
return
|
|
}
|
|
_ = fromJsonKey
|
|
_ = fromRawKey
|
|
}
|
|
}
|
|
```
|
|
|
|
|