]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Clarify Tag Length Setting in OCB Mode
authorerbsland-dev <github@erbsland.dev>
Tue, 10 Sep 2024 17:20:17 +0000 (19:20 +0200)
committerTomas Mraz <tomas@openssl.org>
Thu, 19 Sep 2024 18:52:19 +0000 (20:52 +0200)
Fixes #8331: Updated the description for setting the tag length in OCB mode to remove the misleading “when encrypting” and “during encryption” phrasing. This change emphasizes that setting a custom tag length requires a call with NULL, applicable to both encryption and decryption contexts.

Reviewed-by: Frederik Wedel-Heinen <fwh.openssl@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/25424)

(cherry picked from commit 1299699a90967c3a0b236e552d92dc307d0d6da3)

doc/man3/EVP_EncryptInit.pod

index cb0603a87f60d07eb196eb34440341970719fd8e..0f281e0bfb976a15c3dac21dc28f111979eab9f9 100644 (file)
@@ -1346,10 +1346,9 @@ For GCM, this call is only valid when decrypting data.
 For OCB, this call is valid when decrypting data to set the expected tag,
 and when encrypting to set the desired tag length.
 
-In OCB mode, calling this when encrypting with C<tag> set to C<NULL> sets the
-tag length. The tag length can only be set before specifying an IV. If this is
-not called prior to setting the IV during encryption, then a default tag length
-is used.
+In OCB mode, calling this with C<tag> set to C<NULL> sets the tag length.
+The tag length can only be set before specifying an IV. If this is not called
+prior to setting the IV, then a default tag length is used.
 
 For OCB AES, the default tag length is 16 (i.e. 128 bits).  It is also the
 maximum tag length for OCB.