Skip to content

Fix formatting issues in the key encapsulation chapter #226

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
athoelke merged 1 commit into from
Nov 15, 2024
Merged

Fix formatting issues in the key encapsulation chapter #226

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
10 changes: 5 additions & 5 deletions doc/crypto/api/ops/key-encapsulation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,16 +369,16 @@ Support macros
.. return::
A sufficient ciphertext buffer size for the specified algorithm, key type, and size. An implementation can return either ``0`` or a correct size for an algorithm, key type, and size that it recognizes, but does not support. If the parameters are not valid, the return value is unspecified.

If the size of the ciphertext buffer is at least this large, it is guaranteed that `psa_encapsulate()` will not fail due to an insufficient buffer size. The actual size of the ciphertext might be smaller in any given call.
If the size of the ciphertext buffer is at least this large, it is guaranteed that `psa_encapsulate()` will not fail due to an insufficient buffer size. The actual size of the ciphertext might be smaller in any given call.

See also `PSA_ENCAPSULATE_CIPHERTEXT_MAX_SIZE`.
See also `PSA_ENCAPSULATE_CIPHERTEXT_MAX_SIZE`.

.. macro:: PSA_ENCAPSULATE_CIPHERTEXT_MAX_SIZE
:definition: /* implementation-defined value */
:definition: /* implementation-defined value */

.. summary::
Sufficient ciphertext buffer size for `psa_encapsulate()`, for any of the supported key types and key-encapsulation algorithms.

If the size of the ciphertext buffer is at least this large, it is guaranteed that `psa_encapsulate()` will not fail due to an insufficient buffer size.
If the size of the ciphertext buffer is at least this large, it is guaranteed that `psa_encapsulate()` will not fail due to an insufficient buffer size.

See also `PSA_ENCAPSULATE_CIPHERTEXT_SIZE()`.
See also `PSA_ENCAPSULATE_CIPHERTEXT_SIZE()`.