summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.3
diff options
context:
space:
mode:
authorTheo Buehler <tb@cvs.openbsd.org>2023-10-01 18:23:51 +0000
committerTheo Buehler <tb@cvs.openbsd.org>2023-10-01 18:23:51 +0000
commit70fa324d2bf7a5079eefa39a9091e97b59f43adb (patch)
tree840ae0d8879f8993a8a1a02b4b46b001719c36d5 /lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.3
parent0a3bdad13a46309016905d8d12b002ca7c57b637 (diff)
Document EVP_CIPHER_CTX_iv_length() return values
We aligned with upstream behavior. Let's document it properly. Surprisingly, OpenSSL 1.1 half-assed the docs: two parts of the manual contradict each other. The part getting EVP_CIPHER_CTX_iv_length() right, incorrectly documents possible -1 return value to EVP_CIPHER_iv_length(). OpenSSL 3 documentation improvement efforts seem to have tried to address this issue with the result that the manual is now entirely wrong when it comes to the EVP_CIPHER_CTX_iv_length() replacement. Par for the course.
Diffstat (limited to 'lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.3')
-rw-r--r--lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.310
1 files changed, 7 insertions, 3 deletions
diff --git a/lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.3 b/lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.3
index 40ed524ffa9..ba0e4b074db 100644
--- a/lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.3
+++ b/lib/libcrypto/man/EVP_CIPHER_CTX_ctrl.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: EVP_CIPHER_CTX_ctrl.3,v 1.1 2023/08/31 17:27:41 schwarze Exp $
+.\" $OpenBSD: EVP_CIPHER_CTX_ctrl.3,v 1.2 2023/10/01 18:23:50 tb Exp $
.\" full merge up to: OpenSSL 5211e094 Nov 11 14:39:11 2014 -0800
.\"
.\" This file is a derived work.
@@ -67,7 +67,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: August 31 2023 $
+.Dd $Mdocdate: October 1 2023 $
.Dt EVP_CIPHER_CTX_CTRL 3
.Os
.Sh NAME
@@ -178,7 +178,9 @@ return the IV length of a cipher when passed an
.Vt EVP_CIPHER_CTX
or
.Vt EVP_CIPHER .
-It will return zero if the cipher does not use an IV.
+They will return zero if the cipher does not use an IV.
+.Fn EVP_CIPHER_CTX_iv_length
+can fail and return \-1.
The constant
.Dv EVP_MAX_IV_LENGTH
is the maximum IV length for all ciphers.
@@ -220,6 +222,8 @@ return the key length.
and
.Fn EVP_CIPHER_iv_length
return the IV length or zero if the cipher does not use an IV.
+.Fn EVP_CIPHER_CTX_iv_length
+can fail and return \-1.
.Sh SEE ALSO
.Xr evp 3 ,
.Xr EVP_CIPHER_nid 3 ,