]> git.ipfire.org Git - thirdparty/openssl.git/commit
doc: improve documentation of EVP in-place encryption
authorMatthias St. Pierre <matthias.st.pierre@ncp-e.com>
Wed, 29 Nov 2023 21:12:45 +0000 (22:12 +0100)
committerMatthias St. Pierre <matthias.st.pierre@ncp-e.com>
Tue, 12 Dec 2023 09:40:56 +0000 (10:40 +0100)
commit6ebdbba76a45294e22006ede1442847cdee24f03
tree954560b85229a8eacf6c9694e812643b1ad11581
parent986c48c4eb26861f25bc68ea252d8f2aad592735
doc: improve documentation of EVP in-place encryption

The EVP interface explicitly allows in-place encryption/decryption,
but this fact is just 'partially' documented in `EVP_EncryptUpdate(3)`
(pun intended): the manual page mentions only operation failure in
case of 'partial' overlaps. This is not even correct, because
the check for partially overlapping buffers is only implemented
in legacy code paths.

Currently, in-place encryption/decryption is only documented for
RSA (`RSA_public_encrypt(3)`) and DES (`DES_ecb_encrypt(3)`), as
well as in the provider interface (`provider-cipher(7)`).

This commit amends `EVP_EncryptUpdate(3)` and `provider-cipher(7)`
to make the front-end and back-end documentation consistent.

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
(Merged from https://github.com/openssl/openssl/pull/22875)
doc/man3/EVP_EncryptInit.pod
doc/man7/provider-cipher.pod