Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/go-jose/go-jose

An implementation of JOSE standards (JWE, JWS, JWT) in Go
https://github.com/go-jose/go-jose

Last synced: 14 days ago
JSON representation

An implementation of JOSE standards (JWE, JWS, JWT) in Go

Host: GitHub
URL: https://github.com/go-jose/go-jose
Owner: go-jose
License: apache-2.0
Created: 2020-08-07T15:38:05.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-10-07T04:27:07.000Z (about 1 month ago)
Last Synced: 2024-10-24T22:31:05.914Z (15 days ago)
Language: Go
Homepage:
Size: 1.27 MB
Stars: 326
Watchers: 8
Forks: 78
Open Issues: 25
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-go - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
awesome-go - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
awesome-go-with-stars - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
awesome-go-stars - go-jose(stars: 242) - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
awesome-go - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
awesome-go - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
fucking-awesome-go - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
fucking-awesome-go - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. (Authentication and OAuth)
awesome-go-plus - go-jose - Fairly complete implementation of the JOSE working group's JSON Web Token, JSON Web Signatures, and JSON Web Encryption specs. ![stars](https://img.shields.io/badge/stars-332-blue) ![forks](https://img.shields.io/badge/forks-77-blue) (Authentication and OAuth)

README

        # Go JOSE

[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v4.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v4)

[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v4/jwt.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v4/jwt)

[![license](https://img.shields.io/badge/license-apache_2.0-blue.svg?style=flat)](https://raw.githubusercontent.com/go-jose/go-jose/master/LICENSE)

[![test](https://img.shields.io/github/checks-status/go-jose/go-jose/v4)](https://github.com/go-jose/go-jose/actions)

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](https://dx.doi.org/10.17487/RFC7516) (RFC 7516),

[JSON Web Signature](https://dx.doi.org/10.17487/RFC7515) (RFC 7515), and

[JSON Web Token](https://dx.doi.org/10.17487/RFC7519) (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`](https://pkg.go.dev/github.com/go-jose/go-jose/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

[Version 4](https://github.com/go-jose/go-jose)

([branch](https://github.com/go-jose/go-jose/tree/main),

[doc](https://pkg.go.dev/github.com/go-jose/go-jose/v4), [releases](https://github.com/go-jose/go-jose/releases)) is the current stable version:

    import "github.com/go-jose/go-jose/v4"

The old [square/go-jose](https://github.com/square/go-jose) repo contains the prior v1 and v2 versions, which

are still useable but not actively developed anymore.

Version 3, in this repo, is still receiving security fixes but not functionality

updates.

### Supported algorithms

See below for a table of supported algorithms. Algorithm identifiers match

the names in the [JSON Web Algorithms](https://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¹

 Direct encryption          | dir¹

^{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                    | EdDSA²

^{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](https://pkg.go.dev/crypto/rsa/#PublicKey), *[rsa.PrivateKey](https://pkg.go.dev/crypto/rsa/#PrivateKey)

 ECDH, ECDSA                | *[ecdsa.PublicKey](https://pkg.go.dev/crypto/ecdsa/#PublicKey), *[ecdsa.PrivateKey](https://pkg.go.dev/crypto/ecdsa/#PrivateKey)

 EdDSA¹          | [ed25519.PublicKey](https://pkg.go.dev/crypto/ed25519#PublicKey), [ed25519.PrivateKey](https://pkg.go.dev/crypto/ed25519#PrivateKey)

 AES, HMAC                  | []byte

^{1. Only available in version 2 or later of the package}

## Examples

[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v4.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v4)

[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v4/jwt.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v4/jwt)

Examples can be found in the Godoc

reference for this package. The

[`jose-util`](https://github.com/go-jose/go-jose/tree/v4/jose-util)

subdirectory also contains a small command-line utility which might be useful

as an example as well.