Skip to content

Commit 709bdb1

Browse files
committed
docs: update algorithms guide
1 parent 5560a92 commit 709bdb1

1 file changed

Lines changed: 37 additions & 31 deletions

File tree

docs/guide/algorithms.rst

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -90,41 +90,47 @@ JSON Web Encryption
9090
``joserfc.jwe`` module supports algorithms from RFC7518, and drafts of
9191
``ECDH-1PU``. You MUST specify the correct key type for each algorithm.
9292

93-
=================== ========== ===========================
94-
Algorithm name Key Type Requirements
95-
=================== ========== ===========================
96-
dir OctKey :bdg-success:`Recommended`
97-
A128KW OctKey :bdg-success:`Recommended`
98-
A192KW OctKey :bdg-muted:`Optional`
99-
A256KW OctKey :bdg-success:`Recommended`
100-
RSA1_5 RSAKey :bdg-danger:`Deprecated`
101-
RSA-OAEP RSAKey :bdg-success:`Recommended`
102-
RSA-OAEP-256 RSAKey :bdg-muted:`Optional`
103-
ECDH-ES ECKey :bdg-success:`Recommended`
104-
ECDH-ES+A128KW ECKey :bdg-success:`Recommended`
105-
ECDH-ES+A192KW ECKey :bdg-muted:`Optional`
106-
ECDH-ES+A256KW ECKey :bdg-success:`Recommended`
107-
A128GCMKW OctKey :bdg-muted:`Optional`
108-
A192GCMKW OctKey :bdg-muted:`Optional`
109-
A256GCMKW OctKey :bdg-muted:`Optional`
110-
PBES2-HS256+A128KW RSAKey :bdg-muted:`Optional`
111-
PBES2-HS384+A192KW RSAKey :bdg-muted:`Optional`
112-
PBES2-HS512+A256KW RSAKey :bdg-muted:`Optional`
113-
=================== ========== ===========================
114-
115-
All algorithms defined in RFC7518 for "enc" value are recommended, which
116-
including:
117-
118-
- ``A128CBC-HS256``
119-
- ``A192CBC-HS384``
120-
- ``A256CBC-HS512``
121-
- ``A128GCM``
122-
- ``A192GCM``
123-
- ``A256GCM``
93+
=================== ===================== ===========================
94+
Algorithm name Key Type Requirements
95+
=================== ===================== ===========================
96+
dir OctKey :bdg-success:`Recommended`
97+
A128KW OctKey (128 bits) :bdg-success:`Recommended`
98+
A192KW OctKey (192 bits) :bdg-muted:`Optional`
99+
A256KW OctKey (256 bits) :bdg-success:`Recommended`
100+
RSA1_5 RSAKey :bdg-danger:`Deprecated`
101+
RSA-OAEP RSAKey :bdg-success:`Recommended`
102+
RSA-OAEP-256 RSAKey :bdg-muted:`Optional`
103+
ECDH-ES ECKey :bdg-success:`Recommended`
104+
ECDH-ES+A128KW ECKey :bdg-success:`Recommended`
105+
ECDH-ES+A192KW ECKey :bdg-muted:`Optional`
106+
ECDH-ES+A256KW ECKey :bdg-success:`Recommended`
107+
A128GCMKW OctKey (128 bits) :bdg-muted:`Optional`
108+
A192GCMKW OctKey (192 bits) :bdg-muted:`Optional`
109+
A256GCMKW OctKey (256 bits) :bdg-muted:`Optional`
110+
PBES2-HS256+A128KW RSAKey :bdg-muted:`Optional`
111+
PBES2-HS384+A192KW RSAKey :bdg-muted:`Optional`
112+
PBES2-HS512+A256KW RSAKey :bdg-muted:`Optional`
113+
=================== ===================== ===========================
124114

125115
.. warning::
126116
``RSA1_5`` algorithm is deprecated via https://datatracker.ietf.org/doc/draft-ietf-jose-deprecate-none-rsa15/
127117

118+
Encryption Algorithms
119+
~~~~~~~~~~~~~~~~~~~~~
120+
121+
All algorithms defined in RFC7518 for "enc" value are recommended.
122+
123+
=================== ===========================
124+
Encryption name Requirements
125+
=================== ===========================
126+
A128CBC-HS256 :bdg-success:`Recommended`
127+
A192CBC-HS384 :bdg-success:`Recommended`
128+
A256CBC-HS512 :bdg-success:`Recommended`
129+
A128GCM :bdg-success:`Recommended`
130+
A192GCM :bdg-success:`Recommended`
131+
A256GCM :bdg-success:`Recommended`
132+
=================== ===========================
133+
128134
There is also a ``DEF`` algorithm for the "zip" (compression) header parameter,
129135
using of ``DEF`` is optional.
130136

0 commit comments

Comments
 (0)