public/libjwt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Reorg documents so latest devel if root and stable is in a subfolder

Browse source 
Added warnings

Signed-off-by: Ben Collins <bcollins@ubuntu.com>
This commit is contained in:
Ben Collins 2025-01-09 08:04:53 -05:00
parent 12c9530819
commit 112592b452
No known key found for this signature in database
GPG key ID: 5D5A57C7242B22CF
4 changed files with 34 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.github/workflows/deploys-docs.yml vendored
View file

@ -30,8 +30,7 @@ jobs:
set -e
cmake -B build
make -C build doxygen-doc
mkdir -p gh-pages
mv build/doxygen-doc/html gh-pages/HEAD
mv build/doxygen-doc/html gh-pages
rm -rf build
- name: Build Latest tag docs
@ -44,7 +43,7 @@ jobs:
../configure
make doxygen-doc
cd ..
mv build/doxygen-doc/html/* gh-pages/
mv build/doxygen-doc/html gh-pages/stable
rm -rf build
- name: Upload pages

5
.gitignore vendored
View file

@ -1,3 +1,6 @@
# Generic ignores for cmake project
/out/**
/build/**
/out/**
# VIM
*.swp

28
README.md
View file

@ -5,10 +5,14 @@
[![maClara](https://img.shields.io/badge/Sponsored%20by-maClara%2C%20LLC-blue?style=plastic&logoColor=blue)](https://maclara-llc.com)
> [!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
-------------------- | :--------: | --------------------------------------
Standard | RFC | Description
-------------------- | :------------------------------------------------------------------------: | ---------------------
``JWT`` | :page_facing_up: [RFC-7519](https://datatracker.ietf.org/doc/html/rfc7519) | JSON Web Token
``JWA`` | :page_facing_up: [RFC-7518](https://datatracker.ietf.org/doc/html/rfc7518) | JSON Web Algorithms
``JWS`` and ``JWE`` | :page_facing_up: [RFC-7518](https://datatracker.ietf.org/doc/html/rfc7518) | Specific types of JWA
@ -24,8 +28,8 @@ Standard | RFC | Description
### Required
- [JANSSON](https://github.com/akheron/jansson) (>= 2.0)
- CMake (>= 3.7)
- [JANSSON](https://github.com/akheron/jansson">JANSSON) (>= 2.0)
- [CMake](https://cmake.org) (>= 3.7)
### Crypto support
@ -38,14 +42,15 @@ Standard | RFC | Description
### Optional
- [Check Library](https://github.com/libcheck/check/issues) for unit testing
- Doxygen (>= 1.13.0)
- [Check Library](https://github.com/libcheck/check/issues) (>= 0.9.10) for unit
testing
- [Doxygen](https://www.doxygen.nl) (>= 1.13.0) for documentation
## :books: Docs and Source
:link: [Release](https://libjwt.io/)
:link: [Current codebase](https://libjwt.io)
:link: [Development](https://libjwt.io/HEAD/)
:link: [Stable](https://libjwt.io/stable)
:link: [GitHub Repo](https://github.com/benmcollins/libjwt)
@ -63,10 +68,3 @@ for Linux, macOS, and Windows.
$ cd build
$ cmake ..
$ make
### Extra Build Info
If you have *libcheck* installed you can compile the test suite which you can
run using the ``check`` target.
CMake will auto detect *OpenSSL* and *GnuTLS* and use one or both. There are
CMake options to force either one on or off.

32
doxygen/mainpage.dox
View file

@ -1,12 +1,18 @@
@mainpage Welcome to LibJWT
@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. If
you want to see the older documentation,
[here's the latest](https://libjwt.io/stable)
@section standards \emoji :bulb: 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
``JWS`` and ``JWE`` | @rfc{7518} | Specific types of JWT
``JWK`` and ``JWKS`` | @rfc{7517} | JSON Web Keys and Sets
@note Throughout this documentation you will see links such as the ones
@ -18,8 +24,8 @@ Standard | RFC | Description
@subsection req Required
- <a href="https://github.com/akheron/jansson">JANSSON</a> (>= 2.0)
- CMake (>= 3.7)
- [JANSSON](https://github.com/akheron/jansson">JANSSON) (>= 2.0)
- [CMake](https://cmake.org) (>= 3.7)
@subsection req_crypto Crypto support
@ -31,22 +37,22 @@ Standard | RFC | Description
@subsection optional Optional
- <a href="https://github.com/libcheck/check/issues">Check Library</a> for unit
- [Check Library](https://github.com/libcheck/check/issues) (>= 0.9.10) for unit
testing
- Doxygen (>= 1.13.0)
- [Doxygen](https://www.doxygen.nl) (>= 1.13.0) for documentation
@section docs \emoji :open_book: Docs and Source
\emoji :link: <a href="https://libjwt.io/">Release</a>
\emoji :link: [Current codebase](https://libjwt.io)
\emoji :link: <a href="https://libjwt.io/HEAD">Development</a>
\emoji :link: [Stable](https://libjwt.io/stable)
\emoji :link: <a href="https://github.com/benmcollins/libjwt">GitHub Repo</a>
\emoji :link: [GitHub Repo](https://github.com/benmcollins/libjwt)
@section prebuilt \emoji :package: Pre-built Packages
LibJWT is available in most Linux distributions as well as through
<a href="https://formulae.brew.sh/formula/libjwt#default">Homebrew</a>
[Homebrew](https://formulae.brew.sh/formula/libjwt#default)
for Linux, macOS, and Windows.
@section instructions \emoji :hammer: Build Instructions
@ -59,11 +65,3 @@ $ cd build
$ cmake ..
$ make
@endcode
@subsection extra Extra Build Info
If you have *libcheck* installed you can compile the test suite which you can
run using the ``check`` target.
CMake will auto detect *OpenSSL* and *GnuTLS* and use one or both. There are
CMake options to force either one on or off.