Skip to content

update docs to note the AEAD AESGCM class only supports 128-bit tags #12862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
+7 −0
Merged

update docs to note the AEAD AESGCM class only supports 128-bit tags #12862

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/hazmat/primitives/aead.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,13 @@ also support providing integrity for associated data which is not encrypted.

.. versionadded:: 2.0

.. note::

This class only supports 128-bit tags. If you need tag truncation
(which is generally **not recommended**) you should use the
:class:`~cryptography.hazmat.primitives.ciphers.modes.GCM` class
with :class:`~cryptography.hazmat.primitives.ciphers.Cipher`.

The AES-GCM construction is composed of the
:class:`~cryptography.hazmat.primitives.ciphers.algorithms.AES` block
cipher utilizing Galois Counter Mode (GCM).
Expand Down