libjwt/README.md
Ben Collins 112592b452
Reorg documents so latest devel if root and stable is in a subfolder
Added warnings

Signed-off-by: Ben Collins <bcollins@ubuntu.com>
2025-01-09 08:04:53 -05:00

2.5 KiB

LibJWT - The C JWT Library

codecov

maClara

[!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.

💡 Supported Standards

Standard RFC Description
JWT 📄 RFC-7519 JSON Web Token
JWA 📄 RFC-7518 JSON Web Algorithms
JWS and JWE 📄 RFC-7518 Specific types of JWA
JWK and JWKS 📄 RFC-7517 JSON Web Key & Sets

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.

🚧 Build Prerequisites

Required

Crypto support

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

Note

OpenSSL is required and used for JWK(S) operations. GnuTLS is optional for use in signing and verifying if configured.

Optional

📚 Docs and Source

🔗 Current codebase

🔗 Stable

🔗 GitHub Repo

📦 Pre-built Packages

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

🔨 Build Instructions

With CMake:

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