]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: Fix documentation of EVP_EncryptUpdate().
authorPauli <paul.dale@oracle.com>
Mon, 13 Jul 2020 22:39:32 +0000 (08:39 +1000)
committerPauli <paul.dale@oracle.com>
Fri, 17 Jul 2020 12:23:42 +0000 (22:23 +1000)
The documentation was off by one for the length this function could return.

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/12435)

(cherry picked from commit 3fc164e8d18dcdef57d297956debf8d966e7fbef)

doc/man3/EVP_EncryptInit.pod

index 2828bca2f8315010b7a539521d86455616572658..23ddf9153d3f7cc71d0c6dfe4aeb7064e09a542d 100644 (file)
@@ -146,10 +146,15 @@ appropriate.
 EVP_EncryptUpdate() encrypts B<inl> bytes from the buffer B<in> and
 writes the encrypted version to B<out>. This function can be called
 multiple times to encrypt successive blocks of data. The amount
-of data written depends on the block alignment of the encrypted data:
-as a result the amount of data written may be anything from zero bytes
-to (inl + cipher_block_size - 1) so B<out> should contain sufficient
-room. The actual number of bytes written is placed in B<outl>. It also
+of data written depends on the block alignment of the encrypted data.
+For most ciphers and modes, the amount of data written can be anything
+from zero bytes to (inl + cipher_block_size - 1) bytes.
+For wrap cipher modes, the amount of data written can be anything
+from zero bytes to (inl + cipher_block_size) bytes.
+For stream ciphers, the amount of data written can be anything from zero
+bytes to inl bytes.
+Thus, B<out> should contain sufficient room for the operation being performed.
+The actual number of bytes written is placed in B<outl>. It also
 checks if B<in> and B<out> are partially overlapping, and if they are
 0 is returned to indicate failure.