43 lines
1.9 KiB
Diff
43 lines
1.9 KiB
Diff
From a47dd08d6cacc64536c2f57e0f0aee03dcfaab3d Mon Sep 17 00:00:00 2001
|
|
From: Pauli <paul.dale@oracle.com>
|
|
Date: Tue, 14 Jul 2020 08:39:32 +1000
|
|
Subject: [PATCH 052/147] doc: Fix documentation of EVP_EncryptUpdate().
|
|
|
|
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 | 13 +++++++++----
|
|
1 file changed, 9 insertions(+), 4 deletions(-)
|
|
|
|
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod
|
|
index 2828bca..23ddf91 100644
|
|
--- a/doc/man3/EVP_EncryptInit.pod
|
|
+++ b/doc/man3/EVP_EncryptInit.pod
|
|
@@ -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.
|
|
|
|
--
|
|
1.8.3.1
|
|
|