summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorschwarze <>2023-09-12 13:29:38 +0000
committerschwarze <>2023-09-12 13:29:38 +0000
commit69216c6b0c10750010be239fe39466c2a5129b34 (patch)
treeb9b5e06ddd73ddd65d7631416cf205815bcf42ba /src/lib
parentd4f66fd58741d8da1a8a46df900cfcded61a4af2 (diff)
downloadopenbsd-69216c6b0c10750010be239fe39466c2a5129b34.tar.gz
openbsd-69216c6b0c10750010be239fe39466c2a5129b34.tar.bz2
openbsd-69216c6b0c10750010be239fe39466c2a5129b34.zip
Document EVP_AEAD_DEFAULT_TAG_LENGTH and EVP_AEAD_MAX_TAG_LENGTH,
making some adjacent wordings slightly more precise.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libcrypto/man/EVP_AEAD_CTX_init.325
1 files changed, 20 insertions, 5 deletions
diff --git a/src/lib/libcrypto/man/EVP_AEAD_CTX_init.3 b/src/lib/libcrypto/man/EVP_AEAD_CTX_init.3
index ad37842cc8..02f6e275d1 100644
--- a/src/lib/libcrypto/man/EVP_AEAD_CTX_init.3
+++ b/src/lib/libcrypto/man/EVP_AEAD_CTX_init.3
@@ -1,8 +1,9 @@
1.\" $OpenBSD: EVP_AEAD_CTX_init.3,v 1.13 2023/08/24 04:33:08 tb Exp $ 1.\" $OpenBSD: EVP_AEAD_CTX_init.3,v 1.14 2023/09/12 13:29:38 schwarze Exp $
2.\" 2.\"
3.\" Copyright (c) 2014, Google Inc. 3.\" Copyright (c) 2014, Google Inc.
4.\" Parts of the text were written by Adam Langley and David Benjamin. 4.\" Parts of the text were written by Adam Langley and David Benjamin.
5.\" Copyright (c) 2015 Reyk Floeter <reyk@openbsd.org> 5.\" Copyright (c) 2015 Reyk Floeter <reyk@openbsd.org>
6.\" Copyright (c) 2023 Ingo Schwarze <schwarze@openbsd.org>
6.\" 7.\"
7.\" Permission to use, copy, modify, and/or distribute this software for any 8.\" Permission to use, copy, modify, and/or distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above 9.\" purpose with or without fee is hereby granted, provided that the above
@@ -16,7 +17,7 @@
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\" 19.\"
19.Dd $Mdocdate: August 24 2023 $ 20.Dd $Mdocdate: September 12 2023 $
20.Dt EVP_AEAD_CTX_INIT 3 21.Dt EVP_AEAD_CTX_INIT 3
21.Os 22.Os
22.Sh NAME 23.Sh NAME
@@ -147,7 +148,11 @@ argument must be
147for the default implementation; 148for the default implementation;
148other values are currently not supported. 149other values are currently not supported.
149Authentication tags may be truncated by passing a tag length. 150Authentication tags may be truncated by passing a tag length.
150A tag length of zero indicates the default tag length should be used. 151A
152.Fa tag_len
153argument of
154.Dv EVP_AEAD_DEFAULT_TAG_LENGTH ,
155which has the value 0, causes the default tag length to be used.
151.Pp 156.Pp
152.Fn EVP_AEAD_CTX_cleanup 157.Fn EVP_AEAD_CTX_cleanup
153frees any data allocated for the context 158frees any data allocated for the context
@@ -241,6 +246,18 @@ and
241provide information about the AEAD algorithm 246provide information about the AEAD algorithm
242.Fa aead . 247.Fa aead .
243.Pp 248.Pp
249.Fn EVP_AEAD_max_tag_len
250returns the maximum tag length that can be used with the given
251.Fa aead .
252This is the largest value that can be passed as the
253.Fa tag_len
254argument to
255.Fn EVP_AEAD_CTX_init .
256No built-in
257.Vt EVP_AEAD
258object has a maximum tag length larger than the constant
259.Dv EVP_AEAD_MAX_TAG_LENGTH .
260.Pp
244All cipher algorithms have a fixed key length unless otherwise stated. 261All cipher algorithms have a fixed key length unless otherwise stated.
245The following ciphers are available: 262The following ciphers are available:
246.Bl -tag -width Ds -offset indent 263.Bl -tag -width Ds -offset indent
@@ -310,8 +327,6 @@ sealing data with the AEAD.
310.Pp 327.Pp
311.Fn EVP_AEAD_max_tag_len 328.Fn EVP_AEAD_max_tag_len
312returns the maximum tag length when using this AEAD. 329returns the maximum tag length when using this AEAD.
313This is the largest value that can be passed as a tag length to
314.Fn EVP_AEAD_CTX_init .
315.Pp 330.Pp
316.Fn EVP_AEAD_nonce_length 331.Fn EVP_AEAD_nonce_length
317returns the length of the per-message nonce. 332returns the length of the per-message nonce.