Debian Codegraph @

upstream/debian-unstable/man7/EVP_CIPHER-AES.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_CIPHER-AES 7SSL"
58 .TH EVP_CIPHER-AES 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_CIPHER\-AES \- The AES EVP_CIPHER implementations
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for AES symmetric encryption using the \fBEVP_CIPHER\fR API.
68 .SS "Algorithm Names"
69 .IX Subsection "Algorithm Names"
70 The following algorithms are available in the FIPS provider as well as the
71 default provider:
72 .IP """AES\-128\-CBC"", ""AES\-192\-CBC"" and ""AES\-256\-CBC""" 4
73 .IX Item """AES-128-CBC"", ""AES-192-CBC"" and ""AES-256-CBC"""
74 .PD 0
75 .IP """AES\-128\-CBC\-CTS"", ""AES\-192\-CBC\-CTS"" and ""AES\-256\-CBC\-CTS""" 4
76 .IX Item """AES-128-CBC-CTS"", ""AES-192-CBC-CTS"" and ""AES-256-CBC-CTS"""
77 .IP """AES\-128\-CFB"", ""AES\-192\-CFB"", ""AES\-256\-CFB"", ""AES\-128\-CFB1"", ""AES\-192\-CFB1"", ""AES\-256\-CFB1"", ""AES\-128\-CFB8"", ""AES\-192\-CFB8"" and ""AES\-256\-CFB8""" 4
78 .IX Item """AES-128-CFB"", ""AES-192-CFB"", ""AES-256-CFB"", ""AES-128-CFB1"", ""AES-192-CFB1"", ""AES-256-CFB1"", ""AES-128-CFB8"", ""AES-192-CFB8"" and ""AES-256-CFB8"""
79 .IP """AES\-128\-CTR"", ""AES\-192\-CTR"" and ""AES\-256\-CTR""" 4
80 .IX Item """AES-128-CTR"", ""AES-192-CTR"" and ""AES-256-CTR"""
81 .IP """AES\-128\-ECB"", ""AES\-192\-ECB"" and ""AES\-256\-ECB""" 4
82 .IX Item """AES-128-ECB"", ""AES-192-ECB"" and ""AES-256-ECB"""
83 .IP """AES\-192\-OFB"", ""AES\-128\-OFB"" and ""AES\-256\-OFB""" 4
84 .IX Item """AES-192-OFB"", ""AES-128-OFB"" and ""AES-256-OFB"""
85 .IP """AES\-128\-XTS"" and ""AES\-256\-XTS""" 4
86 .IX Item """AES-128-XTS"" and ""AES-256-XTS"""
87 .IP """AES\-128\-CCM"", ""AES\-192\-CCM"" and ""AES\-256\-CCM""" 4
88 .IX Item """AES-128-CCM"", ""AES-192-CCM"" and ""AES-256-CCM"""
89 .IP """AES\-128\-GCM"", ""AES\-192\-GCM"" and ""AES\-256\-GCM""" 4
90 .IX Item """AES-128-GCM"", ""AES-192-GCM"" and ""AES-256-GCM"""
91 .IP """AES\-128\-WRAP"", ""AES\-192\-WRAP"", ""AES\-256\-WRAP"", ""AES\-128\-WRAP\-PAD"", ""AES\-192\-WRAP\-PAD"", ""AES\-256\-WRAP\-PAD"", ""AES\-128\-WRAP\-INV"", ""AES\-192\-WRAP\-INV"", ""AES\-256\-WRAP\-INV"", ""AES\-128\-WRAP\-PAD\-INV"", ""AES\-192\-WRAP\-PAD\-INV"" and ""AES\-256\-WRAP\-PAD\-INV""" 4
92 .IX Item """AES-128-WRAP"", ""AES-192-WRAP"", ""AES-256-WRAP"", ""AES-128-WRAP-PAD"", ""AES-192-WRAP-PAD"", ""AES-256-WRAP-PAD"", ""AES-128-WRAP-INV"", ""AES-192-WRAP-INV"", ""AES-256-WRAP-INV"", ""AES-128-WRAP-PAD-INV"", ""AES-192-WRAP-PAD-INV"" and ""AES-256-WRAP-PAD-INV"""
93 .IP """AES\-128\-CBC\-HMAC\-SHA1"", ""AES\-256\-CBC\-HMAC\-SHA1"", ""AES\-128\-CBC\-HMAC\-SHA256"" and ""AES\-256\-CBC\-HMAC\-SHA256""" 4
94 .IX Item """AES-128-CBC-HMAC-SHA1"", ""AES-256-CBC-HMAC-SHA1"", ""AES-128-CBC-HMAC-SHA256"" and ""AES-256-CBC-HMAC-SHA256"""
95 .PD
96 .PP
97 The following algorithms are available in the default provider, but not the
98 FIPS provider:
99 .IP """AES\-128\-OCB"", ""AES\-192\-OCB"" and ""AES\-256\-OCB""" 4
100 .IX Item """AES-128-OCB"", ""AES-192-OCB"" and ""AES-256-OCB"""
101 .PD 0
102 .IP """AES\-128\-SIV"", ""AES\-192\-SIV"" and ""AES\-256\-SIV""" 4
103 .IX Item """AES-128-SIV"", ""AES-192-SIV"" and ""AES-256-SIV"""
104 .IP """AES\-128\-GCM\-SIV"", ""AES\-192\-GCM\-SIV"" and ""AES\-256\-GCM\-SIV""" 4
105 .IX Item """AES-128-GCM-SIV"", ""AES-192-GCM-SIV"" and ""AES-256-GCM-SIV"""
106 .PD
107 .SS Parameters
108 .IX Subsection "Parameters"
109 This implementation supports the parameters described in
110 "PARAMETERS" in \fBEVP_EncryptInit\fR\|(3).
111 .SH NOTES
112 .IX Header "NOTES"
113 The AES-SIV and AES-WRAP mode implementations do not support streaming. That
114 means to obtain correct results there can be only one \fBEVP_EncryptUpdate\fR\|(3)
115 or \fBEVP_DecryptUpdate\fR\|(3) call after the initialization of the context.
116 .PP
117 The AES-XTS implementations allow streaming to be performed, but each
118 \&\fBEVP_EncryptUpdate\fR\|(3) or \fBEVP_DecryptUpdate\fR\|(3) call requires each input
119 to be a multiple of the blocksize. Only the final \fBEVP_EncryptUpdate()\fR or
120 \&\fBEVP_DecryptUpdate()\fR call can optionally have an input that is not a multiple
121 of the blocksize but is larger than one block. In that case ciphertext
122 stealing (CTS) is used to fill the block.
123 .SH "SEE ALSO"
124 .IX Header "SEE ALSO"
125 \&\fBprovider\-cipher\fR\|(7), \fBOSSL_PROVIDER\-FIPS\fR\|(7), \fBOSSL_PROVIDER\-default\fR\|(7)
126 .SH HISTORY
127 .IX Header "HISTORY"
128 The GCM-SIV mode ciphers were added in OpenSSL version 3.2.
129 .SH COPYRIGHT
130 .IX Header "COPYRIGHT"
131 Copyright 2021\-2023 The OpenSSL Project Authors. All Rights Reserved.
132 .PP
133 Licensed under the Apache License 2.0 (the "License"). You may not use
134 this file except in compliance with the License. You can obtain a copy
135 in the file LICENSE in the source distribution or at
136 <https://www.openssl.org/source/license.html>.