32d599e6fcd924b9759d507de2f1785376c75e43 - benmcollins/libjwt

tree: 9046bbdc867789c67232354e0356d3e8fb4edd43

README.md

[!WARNING] The current LibJWT code is under heavy reconstruction and is changing wildly from the API and ABI of v2 and prior. There's still a lot going on here, and there are no guarantees that this new API is set in stone. Users beware.

:bulb: Supported Standards

Standard	RFC	Description
`JWS`	:page_facing_up: RFC-7515	JSON Web Signature
`JWE`	:page_facing_up: RFC-7516	JSON Web Encryption
`JWK`	:page_facing_up: RFC-7517	JSON Web Keys and Sets
`JWA`	:page_facing_up: RFC-7518	JSON Web Algorithms
`JWT`	:page_facing_up: RFC-7519	JSON Web Token

[!NOTE] Throughout this documentation you will see links such as the ones above to RFC documents. These are relevant to that particular part of the library and are helpful to understand some of the specific standards that shaped the development of LibJWT.

:construction: Build Prerequisites

Required

JANSSON (>= 2.0)
CMake (>= 3.7)

Crypto support

OpenSSL (>= 3.0.0)
GnuTLS (>= 3.6.0)
MbedTLS (>= 3.6.0)

[!NOTE] OpenSSL is required and used for JWK(S) operations.

Algorithm support matrix

JWS Algorithm `alg`	OpenSSL	GnuTLS	MbedTLS
`HS256` `HS384` `HS512`	:white_check_mark:	:white_check_mark:	:white_check_mark:
`ES256` `ES384` `ES512`	:white_check_mark:	:white_check_mark:	:white_check_mark:
`RS256` `RS384` `RS512`	:white_check_mark:	:white_check_mark:	:white_check_mark:
`EdDSA` using `ED25519`	:white_check_mark:	:white_check_mark:	:x:
`EdDSA` using `ED448`	:white_check_mark:	:white_check_mark: `>= 3.8.8`	:x:
`PS256` `PS384` `PS512`	:white_check_mark:	:white_check_mark:	:white_check_mark:`*`
`ES256K`	:white_check_mark:	:x:	:white_check_mark:

* RSASSA-PSS support in MbedTLS depends on Mbed-TLS/TF-PSA-Crypto#154

Optional

Check Library (>= 0.9.10) for unit testing
Doxygen (>= 1.13.0) for documentation

:books: Docs and Source

:link: Current codebase

:link: Stable

:link: GitHub Repo

:package: Pre-built Packages

LibJWT is available in most Linux distributions as well as through Homebrew for Linux, macOS, and Windows.

:hammer: Build Instructions

With CMake:

$ mkdir build
$ cd build
$ cmake ..
$ make