summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/EVP_aes_128_gcm.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/EVP_aes_128_gcm.3')
-rw-r--r--src/lib/libcrypto/man/EVP_aes_128_gcm.317
1 files changed, 11 insertions, 6 deletions
diff --git a/src/lib/libcrypto/man/EVP_aes_128_gcm.3 b/src/lib/libcrypto/man/EVP_aes_128_gcm.3
index 1e15cb79aa..53c41ea162 100644
--- a/src/lib/libcrypto/man/EVP_aes_128_gcm.3
+++ b/src/lib/libcrypto/man/EVP_aes_128_gcm.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EVP_aes_128_gcm.3,v 1.1 2024/12/17 18:11:44 schwarze Exp $ 1.\" $OpenBSD: EVP_aes_128_gcm.3,v 1.2 2024/12/29 12:27:28 schwarze Exp $
2.\" full merge up to: 2.\" full merge up to:
3.\" OpenSSL EVP_EncryptInit.pod 0874d7f2 Oct 11 13:13:47 2022 +0100 3.\" OpenSSL EVP_EncryptInit.pod 0874d7f2 Oct 11 13:13:47 2022 +0100
4.\" OpenSSL EVP_aes.pod a1ec85c1 Apr 21 10:49:12 2020 +0100 4.\" OpenSSL EVP_aes.pod a1ec85c1 Apr 21 10:49:12 2020 +0100
@@ -67,7 +67,7 @@
67.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 67.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
68.\" OF THE POSSIBILITY OF SUCH DAMAGE. 68.\" OF THE POSSIBILITY OF SUCH DAMAGE.
69.\" 69.\"
70.Dd $Mdocdate: December 17 2024 $ 70.Dd $Mdocdate: December 29 2024 $
71.Dt EVP_AES_128_GCM 3 71.Dt EVP_AES_128_GCM 3
72.Os 72.Os
73.Sh NAME 73.Sh NAME
@@ -97,6 +97,11 @@ For GCM mode ciphers, the behaviour of the EVP interface is subtly
97altered and several additional 97altered and several additional
98.Xr EVP_CIPHER_CTX_ctrl 3 98.Xr EVP_CIPHER_CTX_ctrl 3
99operations are required to function correctly. 99operations are required to function correctly.
100Some of the
101.Dv EVP_CTRL_GCM_*
102control commands are older aliases for corresponding
103.Dv EVP_CTRL_AEAD_*
104constants as indicated below.
100.Pp 105.Pp
101To avoid using the cumbersome and error-prone API documented 106To avoid using the cumbersome and error-prone API documented
102in the present manual page, consider using the functions documented in 107in the present manual page, consider using the functions documented in
@@ -109,7 +114,7 @@ instead.
109.\" EVP_GCM_TLS_EXPLICIT_IV_LEN and EVP_GCM_TLS_TAG_LEN (used internally 114.\" EVP_GCM_TLS_EXPLICIT_IV_LEN and EVP_GCM_TLS_TAG_LEN (used internally
110.\" only in aes_gcm_tls_cipher(), which is unused) 115.\" only in aes_gcm_tls_cipher(), which is unused)
111.Bl -tag -width Ds 116.Bl -tag -width Ds
112.It Dv EVP_CTRL_GCM_SET_IVLEN 117.It Dv EVP_CTRL_AEAD_SET_IVLEN Pq == Dv EVP_CTRL_GCM_SET_IVLEN
113Set the length of the initialization vector to 118Set the length of the initialization vector to
114.Fa arg 119.Fa arg
115bytes; the 120bytes; the
@@ -124,7 +129,7 @@ Using this control command is discouraged because section 5.2.1.1 of the
124specification explicitly recommends that implementations of GCM restrict 129specification explicitly recommends that implementations of GCM restrict
125support to the default IV length of 12 bytes for interoperability, 130support to the default IV length of 12 bytes for interoperability,
126efficiency, and simplicity of design. 131efficiency, and simplicity of design.
127.It Dv EVP_CTRL_GCM_SET_IV_FIXED 132.It Dv EVP_CTRL_AEAD_SET_IV_FIXED Pq == Dv EVP_CTRL_GCM_SET_IV_FIXED
128Usually, \-1 is passed for 133Usually, \-1 is passed for
129.Fa arg . 134.Fa arg .
130In that case, the complete initialization vector is copied from 135In that case, the complete initialization vector is copied from
@@ -158,7 +163,7 @@ that may have been configured earlier and always operates on the
158last eight bytes of the initialization vector. 163last eight bytes of the initialization vector.
159It is an error to issue this command 164It is an error to issue this command
160when no key or no initialization vector is set. 165when no key or no initialization vector is set.
161.It Dv EVP_CTRL_GCM_GET_TAG 166.It Dv EVP_CTRL_AEAD_GET_TAG Pq == Dv EVP_CTRL_GCM_GET_TAG
162Write 167Write
163.Fa arg 168.Fa arg
164bytes of the tag value to the location pointed to by 169bytes of the tag value to the location pointed to by
@@ -194,7 +199,7 @@ When default lengths are in use, pass 8 for
194In that case, this control command sets the invocation field. 199In that case, this control command sets the invocation field.
195It is an error to issue this command 200It is an error to issue this command
196when no key or no initialization vector is set, or when encrypting. 201when no key or no initialization vector is set, or when encrypting.
197.It Dv EVP_CTRL_GCM_SET_TAG 202.It Dv EVP_CTRL_AEAD_SET_TAG Pq == Dv EVP_CTRL_GCM_SET_TAG
198Set the expected tag to the 203Set the expected tag to the
199.Fa arg 204.Fa arg
200bytes located at 205bytes located at