119 lines
5.8 KiB
Markdown
119 lines
5.8 KiB
Markdown
# Go JOSE
|
|
|
|
[](https://godoc.org/gopkg.in/square/go-jose.v1)
|
|
[](https://godoc.org/gopkg.in/square/go-jose.v2)
|
|
[](https://raw.githubusercontent.com/square/go-jose/master/LICENSE)
|
|
[](https://travis-ci.org/square/go-jose)
|
|
[](https://coveralls.io/r/square/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.
|
|
|
|
**Disclaimer**: This library contains encryption software that is subject to
|
|
the U.S. Export Administration Regulations. You may not export, re-export,
|
|
transfer or download this code or any part of it in violation of any United
|
|
States law, directive or regulation. In particular this software may not be
|
|
exported or re-exported in any form or on any media to Iran, North Sudan,
|
|
Syria, Cuba, or North Korea, or to denied persons or entities mentioned on any
|
|
US maintained blocked list.
|
|
|
|
## Overview
|
|
|
|
The implementation follows the
|
|
[JSON Web Encryption](http://dx.doi.org/10.17487/RFC7516) (RFC 7516),
|
|
[JSON Web Signature](http://dx.doi.org/10.17487/RFC7515) (RFC 7515), and
|
|
[JSON Web Token](http://dx.doi.org/10.17487/RFC7519) (RFC 7519).
|
|
Tables of supported algorithms are shown below. The library supports both
|
|
the compact and full serialization formats, and has optional support for
|
|
multiple recipients. It also comes with a small command-line utility
|
|
([`jose-util`](https://github.com/square/go-jose/tree/v2/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](https://www.ietf.org/mail-archive/web/json/current/msg03763.html)).
|
|
This is to avoid differences in interpretation of messages between go-jose and
|
|
libraries in other languages.
|
|
|
|
### Versions
|
|
|
|
We use [gopkg.in](https://gopkg.in) for versioning.
|
|
|
|
[Version 1](https://gopkg.in/square/go-jose.v1) is the old stable version:
|
|
|
|
import "gopkg.in/square/go-jose.v1"
|
|
|
|
[Version 2](https://gopkg.in/square/go-jose.v2) is for new development:
|
|
|
|
import "gopkg.in/square/go-jose.v2"
|
|
|
|
The interface for [go-jose.v1](https://gopkg.in/square/go-jose.v1) will remain
|
|
backwards compatible. No new feature development will take place on the `v1` branch,
|
|
however bug fixes and security fixes will be backported.
|
|
|
|
The interface for [go-jose.v2](https://gopkg.in/square/go-jose.v2) is mostly
|
|
stable, but we suggest pinning to a particular revision for now as we still reserve
|
|
the right to make changes. New feature development happens on this branch.
|
|
|
|
New in [go-jose.v2](https://gopkg.in/square/go-jose.v2) is a
|
|
[jwt](https://godoc.org/gopkg.in/square/go-jose.v2/jwt) sub-package
|
|
contributed by [@shaxbee](https://github.com/shaxbee).
|
|
|
|
### Supported algorithms
|
|
|
|
See below for a table of supported algorithms. Algorithm identifiers match
|
|
the names in the [JSON Web Algorithms](http://dx.doi.org/10.17487/RFC7518)
|
|
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-ES<sup>1</sup>
|
|
Direct encryption | dir<sup>1</sup>
|
|
|
|
<sup>1. Not supported in multi-recipient mode</sup>
|
|
|
|
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
|
|
|
|
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](http://golang.org/pkg/crypto/rsa/#PublicKey), *[rsa.PrivateKey](http://golang.org/pkg/crypto/rsa/#PrivateKey)
|
|
ECDH, ECDSA | *[ecdsa.PublicKey](http://golang.org/pkg/crypto/ecdsa/#PublicKey), *[ecdsa.PrivateKey](http://golang.org/pkg/crypto/ecdsa/#PrivateKey)
|
|
AES, HMAC | []byte
|
|
|
|
## Examples
|
|
|
|
[](https://godoc.org/gopkg.in/square/go-jose.v1)
|
|
[](https://godoc.org/gopkg.in/square/go-jose.v2)
|
|
|
|
Examples can be found in the Godoc
|
|
reference for this package. The
|
|
[`jose-util`](https://github.com/square/go-jose/tree/v2/jose-util)
|
|
subdirectory also contains a small command-line utility which might be useful
|
|
as an example.
|