- Go 99.3%
- Perl 0.6%
a0111f8274* Bound RSA parameters when parsing If we don't bound these, degenerate RSA parameters could cause us to use excessive CPU. This fix is not ideal. Really we should be separating RSA computation from JSON parsing. We leave this larger-scale improvement for v5. This is technically a breaking change, since anyone who is parsing RSA keys greater than 4096 will break. There is no practical use for RSA keys greater than 4096, so we don't expect this to break anyone. We leave an escape hatch `MaxRSAModulusBits` for those who need this functionality. * Move getJWK() to test code only It's only used in test code, and unexported, so move it there. This lets us avoid modifying it to care about whether it's parsing a private key or not. * Set unprotected header before merging in general serialization This fixes a bug where the unprotected header was not populated before invoking sanitized(). If we don't fix this now, the check that a JWK doesn't contain private parameters could be bypassed. * Check JWS and JWE algorithms before sanitizing headers Not doing this breaks tests for the future change, where we're checking for an invalid combination of parameters. Rather than fix those tests, let's move the algorithm check before sanitization. The former is less expensive than the latter, so it's cleaner to do it this way. * Reject JWK/EPKs containing private keys in header parsing For JWS and JWE, private material inside the JWK/EPK makes no sense and is not allowed by the spec. Reject private parameters during parsing. If we don't take this change, we are exposed to expensive computation, particularly around RSA validation. For header parsing, this is not acceptable. This _is not_ a breaking change, because we rejected non-public keys after parsing in the first place. We're just trying to avoid expensive parsing steps. * Wrap JWE header sanitization errors Avoids hiding the new ErrEmbeddedPrivateKey error. * Update jwk.go Co-authored-by: Jacob Hoffman-Andrews <github@hoffman-andrews.com> * PR feedback --------- Co-authored-by: Jacob Hoffman-Andrews <github@hoffman-andrews.com> |
History
|
|
|---|---|---|
| .github | ||
| cipher | ||
| cryptosigner | ||
| fuzz | ||
| jose-util | ||
| json | ||
| jwt | ||
| testutils | ||
| .gitignore | ||
| .golangci.yml | ||
| .travis.yml | ||
| asymmetric.go | ||
| asymmetric_test.go | ||
| CONTRIBUTING.md | ||
| crypter.go | ||
| crypter_test.go | ||
| doc.go | ||
| doc_test.go | ||
| encoding.go | ||
| encoding_test.go | ||
| go.mod | ||
| go.sum | ||
| jwe.go | ||
| jwe_test.go | ||
| jwk.go | ||
| jwk_test.go | ||
| jws.go | ||
| jws_test.go | ||
| LICENSE | ||
| opaque.go | ||
| opaque_test.go | ||
| README.md | ||
| SECURITY.md | ||
| shared.go | ||
| shared_test.go | ||
| signing.go | ||
| signing_test.go | ||
| symmetric.go | ||
| symmetric_test.go | ||
| tests.Containerfile | ||
| threat_model.md | ||
| utils_test.go | ||
Go JOSE
Package jose aims to provide an implementation of the Javascript Object Signing and Encryption set of standards. This includes support for JSON Web Encryption, JSON Web Signature, and JSON Web Token standards.
Overview
The implementation follows the
JSON Web Encryption (RFC 7516),
JSON Web Signature (RFC 7515), and
JSON Web Token (RFC 7519) specifications.
Tables of supported algorithms are shown below. The library supports both
the compact and JWS/JWE JSON Serialization formats, and has optional support for
multiple recipients. It also comes with a small command-line utility
(jose-util)
for dealing with JOSE messages in a shell.
Note: We use a forked version of the encoding/json package from the Go
standard library which uses case-sensitive matching for member names (instead
of case-insensitive matching).
This is to avoid differences in interpretation of messages between go-jose and
libraries in other languages.
Versions
The forthcoming Version 5 will be released with several breaking API changes,
and will require Golang's encoding/json/v2, which is currently requires
Go 1.25 built with GOEXPERIMENT=jsonv2.
Version 4 is the current stable version:
import "github.com/go-jose/go-jose/v4"
It supports at least the current and previous Golang release. Currently it requires Golang 1.24.
Version 3 is only receiving critical security updates. Migration to Version 4 is recommended.
Versions 1 and 2 are obsolete, but can be found in the old repository, square/go-jose.
Supported algorithms
See below for a table of supported algorithms. Algorithm identifiers match the names in the JSON Web Algorithms standard where possible. The Godoc reference has a list of constants.
| Key encryption | Algorithm identifier(s) |
|---|---|
| RSA-PKCS#1v1.5 | RSA1_5 |
| RSA-OAEP | RSA-OAEP, RSA-OAEP-256 |
| AES key wrap | A128KW, A192KW, A256KW |
| AES-GCM key wrap | A128GCMKW, A192GCMKW, A256GCMKW |
| ECDH-ES + AES key wrap | ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW |
| ECDH-ES (direct) | ECDH-ES1 |
| Direct encryption | dir1 |
1. Not supported in multi-recipient mode
| Signing / MAC | Algorithm identifier(s) |
|---|---|
| RSASSA-PKCS#1v1.5 | RS256, RS384, RS512 |
| RSASSA-PSS | PS256, PS384, PS512 |
| HMAC | HS256, HS384, HS512 |
| ECDSA | ES256, ES384, ES512 |
| Ed25519 | EdDSA2 |
2. Only available in version 2 of the package
| Content encryption | Algorithm identifier(s) |
|---|---|
| AES-CBC+HMAC | A128CBC-HS256, A192CBC-HS384, A256CBC-HS512 |
| AES-GCM | A128GCM, A192GCM, A256GCM |
| Compression | Algorithm identifiers(s) |
|---|---|
| DEFLATE (RFC 1951) | DEF |
Supported key types
See below for a table of supported key types. These are understood by the
library, and can be passed to corresponding functions such as NewEncrypter or
NewSigner. Each of these keys can also be wrapped in a JWK if desired, which
allows attaching a key id.
| Algorithm(s) | Corresponding types |
|---|---|
| RSA | *rsa.PublicKey, *rsa.PrivateKey |
| ECDH, ECDSA | *ecdsa.PublicKey, *ecdsa.PrivateKey |
| EdDSA1 | ed25519.PublicKey, ed25519.PrivateKey |
| AES, HMAC | []byte |
1. Only available in version 2 or later of the package
Examples
Examples can be found in the Godoc
reference for this package. The
jose-util
subdirectory also contains a small command-line utility which might be useful
as an example as well.