]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/lib/libcrypto/man/EVP_EncryptInit.3
Upgrade our copies of clang, llvm, lld, lldb, compiler-rt and libc++ to
[FreeBSD/FreeBSD.git] / secure / lib / libcrypto / man / EVP_EncryptInit.3
1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .if !\nF .nr F 0
58 .if \nF>0 \{\
59 .    de IX
60 .    tm Index:\\$1\t\\n%\t"\\$2"
61 ..
62 .    if !\nF==2 \{\
63 .        nr % 0
64 .        nr F 2
65 .    \}
66 .\}
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "EVP_EncryptInit 3"
132 .TH EVP_EncryptInit 3 "2017-12-07" "1.0.2n" "OpenSSL"
133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
135 .if n .ad l
136 .nh
137 .SH "NAME"
138 EVP_CIPHER_CTX_init, EVP_EncryptInit_ex, EVP_EncryptUpdate,
139 EVP_EncryptFinal_ex, EVP_DecryptInit_ex, EVP_DecryptUpdate,
140 EVP_DecryptFinal_ex, EVP_CipherInit_ex, EVP_CipherUpdate,
141 EVP_CipherFinal_ex, EVP_CIPHER_CTX_set_key_length,
142 EVP_CIPHER_CTX_ctrl, EVP_CIPHER_CTX_cleanup, EVP_EncryptInit,
143 EVP_EncryptFinal, EVP_DecryptInit, EVP_DecryptFinal,
144 EVP_CipherInit, EVP_CipherFinal, EVP_get_cipherbyname,
145 EVP_get_cipherbynid, EVP_get_cipherbyobj, EVP_CIPHER_nid,
146 EVP_CIPHER_block_size, EVP_CIPHER_key_length, EVP_CIPHER_iv_length,
147 EVP_CIPHER_flags, EVP_CIPHER_mode, EVP_CIPHER_type, EVP_CIPHER_CTX_cipher,
148 EVP_CIPHER_CTX_nid, EVP_CIPHER_CTX_block_size, EVP_CIPHER_CTX_key_length,
149 EVP_CIPHER_CTX_iv_length, EVP_CIPHER_CTX_get_app_data,
150 EVP_CIPHER_CTX_set_app_data, EVP_CIPHER_CTX_type, EVP_CIPHER_CTX_flags,
151 EVP_CIPHER_CTX_mode, EVP_CIPHER_param_to_asn1, EVP_CIPHER_asn1_to_param,
152 EVP_CIPHER_CTX_set_padding,  EVP_enc_null, EVP_des_cbc, EVP_des_ecb,
153 EVP_des_cfb, EVP_des_ofb, EVP_des_ede_cbc, EVP_des_ede, EVP_des_ede_ofb,
154 EVP_des_ede_cfb, EVP_des_ede3_cbc, EVP_des_ede3, EVP_des_ede3_ofb,
155 EVP_des_ede3_cfb, EVP_desx_cbc, EVP_rc4, EVP_rc4_40, EVP_rc4_hmac_md5,
156 EVP_idea_cbc, EVP_idea_ecb, EVP_idea_cfb, EVP_idea_ofb, EVP_rc2_cbc,
157 EVP_rc2_ecb, EVP_rc2_cfb, EVP_rc2_ofb, EVP_rc2_40_cbc, EVP_rc2_64_cbc,
158 EVP_bf_cbc, EVP_bf_ecb, EVP_bf_cfb, EVP_bf_ofb, EVP_cast5_cbc,
159 EVP_cast5_ecb, EVP_cast5_cfb, EVP_cast5_ofb, EVP_rc5_32_12_16_cbc,
160 EVP_rc5_32_12_16_ecb, EVP_rc5_32_12_16_cfb, EVP_rc5_32_12_16_ofb, 
161 EVP_aes_128_gcm, EVP_aes_192_gcm, EVP_aes_256_gcm, EVP_aes_128_ccm,
162 EVP_aes_192_ccm, EVP_aes_256_ccm,
163 EVP_aes_128_cbc_hmac_sha1, EVP_aes_256_cbc_hmac_sha1,
164 EVP_aes_128_cbc_hmac_sha256, EVP_aes_256_cbc_hmac_sha256
165 \&\- EVP cipher routines
166 .SH "SYNOPSIS"
167 .IX Header "SYNOPSIS"
168 .Vb 1
169 \& #include <openssl/evp.h>
170 \&
171 \& void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *a);
172 \&
173 \& int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
174 \&         ENGINE *impl, unsigned char *key, unsigned char *iv);
175 \& int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
176 \&         int *outl, const unsigned char *in, int inl);
177 \& int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out,
178 \&         int *outl);
179 \&
180 \& int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
181 \&         ENGINE *impl, unsigned char *key, unsigned char *iv);
182 \& int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
183 \&         int *outl, const unsigned char *in, int inl);
184 \& int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm,
185 \&         int *outl);
186 \&
187 \& int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
188 \&         ENGINE *impl, unsigned char *key, unsigned char *iv, int enc);
189 \& int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
190 \&         int *outl, unsigned char *in, int inl);
191 \& int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm,
192 \&         int *outl);
193 \&
194 \& int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
195 \&         unsigned char *key, unsigned char *iv);
196 \& int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
197 \&         int *outl);
198 \&
199 \& int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
200 \&         unsigned char *key, unsigned char *iv);
201 \& int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm,
202 \&         int *outl);
203 \&
204 \& int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
205 \&         unsigned char *key, unsigned char *iv, int enc);
206 \& int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm,
207 \&         int *outl);
208 \&
209 \& int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *x, int padding);
210 \& int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *x, int keylen);
211 \& int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr);
212 \& int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *a);
213 \&
214 \& const EVP_CIPHER *EVP_get_cipherbyname(const char *name);
215 \& #define EVP_get_cipherbynid(a) EVP_get_cipherbyname(OBJ_nid2sn(a))
216 \& #define EVP_get_cipherbyobj(a) EVP_get_cipherbynid(OBJ_obj2nid(a))
217 \&
218 \& #define EVP_CIPHER_nid(e)              ((e)\->nid)
219 \& #define EVP_CIPHER_block_size(e)       ((e)\->block_size)
220 \& #define EVP_CIPHER_key_length(e)       ((e)\->key_len)
221 \& #define EVP_CIPHER_iv_length(e)                ((e)\->iv_len)
222 \& #define EVP_CIPHER_flags(e)            ((e)\->flags)
223 \& #define EVP_CIPHER_mode(e)             ((e)\->flags) & EVP_CIPH_MODE)
224 \& int EVP_CIPHER_type(const EVP_CIPHER *ctx);
225 \&
226 \& #define EVP_CIPHER_CTX_cipher(e)       ((e)\->cipher)
227 \& #define EVP_CIPHER_CTX_nid(e)          ((e)\->cipher\->nid)
228 \& #define EVP_CIPHER_CTX_block_size(e)   ((e)\->cipher\->block_size)
229 \& #define EVP_CIPHER_CTX_key_length(e)   ((e)\->key_len)
230 \& #define EVP_CIPHER_CTX_iv_length(e)    ((e)\->cipher\->iv_len)
231 \& #define EVP_CIPHER_CTX_get_app_data(e) ((e)\->app_data)
232 \& #define EVP_CIPHER_CTX_set_app_data(e,d) ((e)\->app_data=(char *)(d))
233 \& #define EVP_CIPHER_CTX_type(c)         EVP_CIPHER_type(EVP_CIPHER_CTX_cipher(c))
234 \& #define EVP_CIPHER_CTX_flags(e)                ((e)\->cipher\->flags)
235 \& #define EVP_CIPHER_CTX_mode(e)         ((e)\->cipher\->flags & EVP_CIPH_MODE)
236 \&
237 \& int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
238 \& int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
239 .Ve
240 .SH "DESCRIPTION"
241 .IX Header "DESCRIPTION"
242 The \s-1EVP\s0 cipher routines are a high level interface to certain
243 symmetric ciphers.
244 .PP
245 \&\fIEVP_CIPHER_CTX_init()\fR initializes cipher contex \fBctx\fR.
246 .PP
247 \&\fIEVP_EncryptInit_ex()\fR sets up cipher context \fBctx\fR for encryption
248 with cipher \fBtype\fR from \s-1ENGINE \s0\fBimpl\fR. \fBctx\fR must be initialized
249 before calling this function. \fBtype\fR is normally supplied
250 by a function such as \fIEVP_aes_256_cbc()\fR. If \fBimpl\fR is \s-1NULL\s0 then the
251 default implementation is used. \fBkey\fR is the symmetric key to use
252 and \fBiv\fR is the \s-1IV\s0 to use (if necessary), the actual number of bytes
253 used for the key and \s-1IV\s0 depends on the cipher. It is possible to set
254 all parameters to \s-1NULL\s0 except \fBtype\fR in an initial call and supply
255 the remaining parameters in subsequent calls, all of which have \fBtype\fR
256 set to \s-1NULL.\s0 This is done when the default cipher parameters are not
257 appropriate.
258 .PP
259 \&\fIEVP_EncryptUpdate()\fR encrypts \fBinl\fR bytes from the buffer \fBin\fR and
260 writes the encrypted version to \fBout\fR. This function can be called
261 multiple times to encrypt successive blocks of data. The amount
262 of data written depends on the block alignment of the encrypted data:
263 as a result the amount of data written may be anything from zero bytes
264 to (inl + cipher_block_size \- 1) so \fBout\fR should contain sufficient
265 room. The actual number of bytes written is placed in \fBoutl\fR.
266 .PP
267 If padding is enabled (the default) then \fIEVP_EncryptFinal_ex()\fR encrypts
268 the \*(L"final\*(R" data, that is any data that remains in a partial block.
269 It uses standard block padding (aka \s-1PKCS\s0 padding). The encrypted
270 final data is written to \fBout\fR which should have sufficient space for
271 one cipher block. The number of bytes written is placed in \fBoutl\fR. After
272 this function is called the encryption operation is finished and no further
273 calls to \fIEVP_EncryptUpdate()\fR should be made.
274 .PP
275 If padding is disabled then \fIEVP_EncryptFinal_ex()\fR will not encrypt any more
276 data and it will return an error if any data remains in a partial block:
277 that is if the total data length is not a multiple of the block size.
278 .PP
279 \&\fIEVP_DecryptInit_ex()\fR, \fIEVP_DecryptUpdate()\fR and \fIEVP_DecryptFinal_ex()\fR are the
280 corresponding decryption operations. \fIEVP_DecryptFinal()\fR will return an
281 error code if padding is enabled and the final block is not correctly
282 formatted. The parameters and restrictions are identical to the encryption
283 operations except that if padding is enabled the decrypted data buffer \fBout\fR
284 passed to \fIEVP_DecryptUpdate()\fR should have sufficient room for
285 (\fBinl\fR + cipher_block_size) bytes unless the cipher block size is 1 in
286 which case \fBinl\fR bytes is sufficient.
287 .PP
288 \&\fIEVP_CipherInit_ex()\fR, \fIEVP_CipherUpdate()\fR and \fIEVP_CipherFinal_ex()\fR are
289 functions that can be used for decryption or encryption. The operation
290 performed depends on the value of the \fBenc\fR parameter. It should be set
291 to 1 for encryption, 0 for decryption and \-1 to leave the value unchanged
292 (the actual value of 'enc' being supplied in a previous call).
293 .PP
294 \&\fIEVP_CIPHER_CTX_cleanup()\fR clears all information from a cipher context
295 and free up any allocated memory associate with it. It should be called
296 after all operations using a cipher are complete so sensitive information
297 does not remain in memory.
298 .PP
299 \&\fIEVP_EncryptInit()\fR, \fIEVP_DecryptInit()\fR and \fIEVP_CipherInit()\fR behave in a
300 similar way to \fIEVP_EncryptInit_ex()\fR, EVP_DecryptInit_ex and
301 \&\fIEVP_CipherInit_ex()\fR except the \fBctx\fR parameter does not need to be
302 initialized and they always use the default cipher implementation.
303 .PP
304 \&\fIEVP_EncryptFinal()\fR, \fIEVP_DecryptFinal()\fR and \fIEVP_CipherFinal()\fR are
305 identical to \fIEVP_EncryptFinal_ex()\fR, \fIEVP_DecryptFinal_ex()\fR and
306 \&\fIEVP_CipherFinal_ex()\fR. In previous releases they also cleaned up
307 the \fBctx\fR, but this is no longer done and \fIEVP_CIPHER_CTX_clean()\fR
308 must be called to free any context resources.
309 .PP
310 \&\fIEVP_get_cipherbyname()\fR, \fIEVP_get_cipherbynid()\fR and \fIEVP_get_cipherbyobj()\fR
311 return an \s-1EVP_CIPHER\s0 structure when passed a cipher name, a \s-1NID\s0 or an
312 \&\s-1ASN1_OBJECT\s0 structure.
313 .PP
314 \&\fIEVP_CIPHER_nid()\fR and \fIEVP_CIPHER_CTX_nid()\fR return the \s-1NID\s0 of a cipher when
315 passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR structure.  The actual \s-1NID\s0
316 value is an internal value which may not have a corresponding \s-1OBJECT
317 IDENTIFIER.\s0
318 .PP
319 \&\fIEVP_CIPHER_CTX_set_padding()\fR enables or disables padding. By default
320 encryption operations are padded using standard block padding and the
321 padding is checked and removed when decrypting. If the \fBpad\fR parameter
322 is zero then no padding is performed, the total amount of data encrypted
323 or decrypted must then be a multiple of the block size or an error will
324 occur.
325 .PP
326 \&\fIEVP_CIPHER_key_length()\fR and \fIEVP_CIPHER_CTX_key_length()\fR return the key
327 length of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR
328 structure. The constant \fB\s-1EVP_MAX_KEY_LENGTH\s0\fR is the maximum key length
329 for all ciphers. Note: although \fIEVP_CIPHER_key_length()\fR is fixed for a
330 given cipher, the value of \fIEVP_CIPHER_CTX_key_length()\fR may be different
331 for variable key length ciphers.
332 .PP
333 \&\fIEVP_CIPHER_CTX_set_key_length()\fR sets the key length of the cipher ctx.
334 If the cipher is a fixed length cipher then attempting to set the key
335 length to any value other than the fixed value is an error.
336 .PP
337 \&\fIEVP_CIPHER_iv_length()\fR and \fIEVP_CIPHER_CTX_iv_length()\fR return the \s-1IV\s0
338 length of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR.
339 It will return zero if the cipher does not use an \s-1IV. \s0 The constant
340 \&\fB\s-1EVP_MAX_IV_LENGTH\s0\fR is the maximum \s-1IV\s0 length for all ciphers.
341 .PP
342 \&\fIEVP_CIPHER_block_size()\fR and \fIEVP_CIPHER_CTX_block_size()\fR return the block
343 size of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR
344 structure. The constant \fB\s-1EVP_MAX_IV_LENGTH\s0\fR is also the maximum block
345 length for all ciphers.
346 .PP
347 \&\fIEVP_CIPHER_type()\fR and \fIEVP_CIPHER_CTX_type()\fR return the type of the passed
348 cipher or context. This \*(L"type\*(R" is the actual \s-1NID\s0 of the cipher \s-1OBJECT
349 IDENTIFIER\s0 as such it ignores the cipher parameters and 40 bit \s-1RC2\s0 and
350 128 bit \s-1RC2\s0 have the same \s-1NID.\s0 If the cipher does not have an object
351 identifier or does not have \s-1ASN1\s0 support this function will return
352 \&\fBNID_undef\fR.
353 .PP
354 \&\fIEVP_CIPHER_CTX_cipher()\fR returns the \fB\s-1EVP_CIPHER\s0\fR structure when passed
355 an \fB\s-1EVP_CIPHER_CTX\s0\fR structure.
356 .PP
357 \&\fIEVP_CIPHER_mode()\fR and \fIEVP_CIPHER_CTX_mode()\fR return the block cipher mode:
358 \&\s-1EVP_CIPH_ECB_MODE, EVP_CIPH_CBC_MODE, EVP_CIPH_CFB_MODE\s0 or
359 \&\s-1EVP_CIPH_OFB_MODE.\s0 If the cipher is a stream cipher then
360 \&\s-1EVP_CIPH_STREAM_CIPHER\s0 is returned.
361 .PP
362 \&\fIEVP_CIPHER_param_to_asn1()\fR sets the AlgorithmIdentifier \*(L"parameter\*(R" based
363 on the passed cipher. This will typically include any parameters and an
364 \&\s-1IV.\s0 The cipher \s-1IV \s0(if any) must be set when this call is made. This call
365 should be made before the cipher is actually \*(L"used\*(R" (before any
366 \&\fIEVP_EncryptUpdate()\fR, \fIEVP_DecryptUpdate()\fR calls for example). This function
367 may fail if the cipher does not have any \s-1ASN1\s0 support.
368 .PP
369 \&\fIEVP_CIPHER_asn1_to_param()\fR sets the cipher parameters based on an \s-1ASN1\s0
370 AlgorithmIdentifier \*(L"parameter\*(R". The precise effect depends on the cipher
371 In the case of \s-1RC2,\s0 for example, it will set the \s-1IV\s0 and effective key length.
372 This function should be called after the base cipher type is set but before
373 the key is set. For example \fIEVP_CipherInit()\fR will be called with the \s-1IV\s0 and
374 key set to \s-1NULL,\s0 \fIEVP_CIPHER_asn1_to_param()\fR will be called and finally
375 \&\fIEVP_CipherInit()\fR again with all parameters except the key set to \s-1NULL.\s0 It is
376 possible for this function to fail if the cipher does not have any \s-1ASN1\s0 support
377 or the parameters cannot be set (for example the \s-1RC2\s0 effective key length
378 is not supported.
379 .PP
380 \&\fIEVP_CIPHER_CTX_ctrl()\fR allows various cipher specific parameters to be determined
381 and set.
382 .SH "RETURN VALUES"
383 .IX Header "RETURN VALUES"
384 \&\fIEVP_EncryptInit_ex()\fR, \fIEVP_EncryptUpdate()\fR and \fIEVP_EncryptFinal_ex()\fR
385 return 1 for success and 0 for failure.
386 .PP
387 \&\fIEVP_DecryptInit_ex()\fR and \fIEVP_DecryptUpdate()\fR return 1 for success and 0 for failure.
388 \&\fIEVP_DecryptFinal_ex()\fR returns 0 if the decrypt failed or 1 for success.
389 .PP
390 \&\fIEVP_CipherInit_ex()\fR and \fIEVP_CipherUpdate()\fR return 1 for success and 0 for failure.
391 \&\fIEVP_CipherFinal_ex()\fR returns 0 for a decryption failure or 1 for success.
392 .PP
393 \&\fIEVP_CIPHER_CTX_cleanup()\fR returns 1 for success and 0 for failure.
394 .PP
395 \&\fIEVP_get_cipherbyname()\fR, \fIEVP_get_cipherbynid()\fR and \fIEVP_get_cipherbyobj()\fR
396 return an \fB\s-1EVP_CIPHER\s0\fR structure or \s-1NULL\s0 on error.
397 .PP
398 \&\fIEVP_CIPHER_nid()\fR and \fIEVP_CIPHER_CTX_nid()\fR return a \s-1NID.\s0
399 .PP
400 \&\fIEVP_CIPHER_block_size()\fR and \fIEVP_CIPHER_CTX_block_size()\fR return the block
401 size.
402 .PP
403 \&\fIEVP_CIPHER_key_length()\fR and \fIEVP_CIPHER_CTX_key_length()\fR return the key
404 length.
405 .PP
406 \&\fIEVP_CIPHER_CTX_set_padding()\fR always returns 1.
407 .PP
408 \&\fIEVP_CIPHER_iv_length()\fR and \fIEVP_CIPHER_CTX_iv_length()\fR return the \s-1IV\s0
409 length or zero if the cipher does not use an \s-1IV.\s0
410 .PP
411 \&\fIEVP_CIPHER_type()\fR and \fIEVP_CIPHER_CTX_type()\fR return the \s-1NID\s0 of the cipher's
412 \&\s-1OBJECT IDENTIFIER\s0 or NID_undef if it has no defined \s-1OBJECT IDENTIFIER.\s0
413 .PP
414 \&\fIEVP_CIPHER_CTX_cipher()\fR returns an \fB\s-1EVP_CIPHER\s0\fR structure.
415 .PP
416 \&\fIEVP_CIPHER_param_to_asn1()\fR and \fIEVP_CIPHER_asn1_to_param()\fR return 1 for 
417 success or zero for failure.
418 .SH "CIPHER LISTING"
419 .IX Header "CIPHER LISTING"
420 All algorithms have a fixed key length unless otherwise stated.
421 .IP "\fIEVP_enc_null()\fR" 4
422 .IX Item "EVP_enc_null()"
423 Null cipher: does nothing.
424 .IP "EVP_des_cbc(void), EVP_des_ecb(void), EVP_des_cfb(void), EVP_des_ofb(void)" 4
425 .IX Item "EVP_des_cbc(void), EVP_des_ecb(void), EVP_des_cfb(void), EVP_des_ofb(void)"
426 \&\s-1DES\s0 in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
427 .IP "EVP_des_ede_cbc(void), \fIEVP_des_ede()\fR, EVP_des_ede_ofb(void),  EVP_des_ede_cfb(void)" 4
428 .IX Item "EVP_des_ede_cbc(void), EVP_des_ede(), EVP_des_ede_ofb(void), EVP_des_ede_cfb(void)"
429 Two key triple \s-1DES\s0 in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
430 .IP "EVP_des_ede3_cbc(void), \fIEVP_des_ede3()\fR, EVP_des_ede3_ofb(void),  EVP_des_ede3_cfb(void)" 4
431 .IX Item "EVP_des_ede3_cbc(void), EVP_des_ede3(), EVP_des_ede3_ofb(void), EVP_des_ede3_cfb(void)"
432 Three key triple \s-1DES\s0 in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
433 .IP "EVP_desx_cbc(void)" 4
434 .IX Item "EVP_desx_cbc(void)"
435 \&\s-1DESX\s0 algorithm in \s-1CBC\s0 mode.
436 .IP "EVP_rc4(void)" 4
437 .IX Item "EVP_rc4(void)"
438 \&\s-1RC4\s0 stream cipher. This is a variable key length cipher with default key length 128 bits.
439 .IP "EVP_rc4_40(void)" 4
440 .IX Item "EVP_rc4_40(void)"
441 \&\s-1RC4\s0 stream cipher with 40 bit key length. This is obsolete and new code should use \fIEVP_rc4()\fR
442 and the \fIEVP_CIPHER_CTX_set_key_length()\fR function.
443 .IP "\fIEVP_idea_cbc()\fR EVP_idea_ecb(void), EVP_idea_cfb(void), EVP_idea_ofb(void)" 4
444 .IX Item "EVP_idea_cbc() EVP_idea_ecb(void), EVP_idea_cfb(void), EVP_idea_ofb(void)"
445 \&\s-1IDEA\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
446 .IP "EVP_rc2_cbc(void), EVP_rc2_ecb(void), EVP_rc2_cfb(void), EVP_rc2_ofb(void)" 4
447 .IX Item "EVP_rc2_cbc(void), EVP_rc2_ecb(void), EVP_rc2_cfb(void), EVP_rc2_ofb(void)"
448 \&\s-1RC2\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key
449 length cipher with an additional parameter called \*(L"effective key bits\*(R" or \*(L"effective key length\*(R".
450 By default both are set to 128 bits.
451 .IP "EVP_rc2_40_cbc(void), EVP_rc2_64_cbc(void)" 4
452 .IX Item "EVP_rc2_40_cbc(void), EVP_rc2_64_cbc(void)"
453 \&\s-1RC2\s0 algorithm in \s-1CBC\s0 mode with a default key length and effective key length of 40 and 64 bits.
454 These are obsolete and new code should use \fIEVP_rc2_cbc()\fR, \fIEVP_CIPHER_CTX_set_key_length()\fR and
455 \&\fIEVP_CIPHER_CTX_ctrl()\fR to set the key length and effective key length.
456 .IP "EVP_bf_cbc(void), EVP_bf_ecb(void), EVP_bf_cfb(void), EVP_bf_ofb(void);" 4
457 .IX Item "EVP_bf_cbc(void), EVP_bf_ecb(void), EVP_bf_cfb(void), EVP_bf_ofb(void);"
458 Blowfish encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key
459 length cipher.
460 .IP "EVP_cast5_cbc(void), EVP_cast5_ecb(void), EVP_cast5_cfb(void), EVP_cast5_ofb(void)" 4
461 .IX Item "EVP_cast5_cbc(void), EVP_cast5_ecb(void), EVP_cast5_cfb(void), EVP_cast5_ofb(void)"
462 \&\s-1CAST\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key
463 length cipher.
464 .IP "EVP_rc5_32_12_16_cbc(void), EVP_rc5_32_12_16_ecb(void), EVP_rc5_32_12_16_cfb(void), EVP_rc5_32_12_16_ofb(void)" 4
465 .IX Item "EVP_rc5_32_12_16_cbc(void), EVP_rc5_32_12_16_ecb(void), EVP_rc5_32_12_16_cfb(void), EVP_rc5_32_12_16_ofb(void)"
466 \&\s-1RC5\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key length
467 cipher with an additional \*(L"number of rounds\*(R" parameter. By default the key length is set to 128
468 bits and 12 rounds.
469 .IP "EVP_aes_128_gcm(void), EVP_aes_192_gcm(void), EVP_aes_256_gcm(void)" 4
470 .IX Item "EVP_aes_128_gcm(void), EVP_aes_192_gcm(void), EVP_aes_256_gcm(void)"
471 \&\s-1AES\s0 Galois Counter Mode (\s-1GCM\s0) for 128, 192 and 256 bit keys respectively.
472 These ciphers require additional control operations to function correctly: see
473 \&\*(L"\s-1GCM\s0 mode\*(R" section below for details.
474 .IP "EVP_aes_128_ccm(void), EVP_aes_192_ccm(void), EVP_aes_256_ccm(void)" 4
475 .IX Item "EVP_aes_128_ccm(void), EVP_aes_192_ccm(void), EVP_aes_256_ccm(void)"
476 \&\s-1AES\s0 Counter with CBC-MAC Mode (\s-1CCM\s0) for 128, 192 and 256 bit keys respectively.
477 These ciphers require additional control operations to function correctly: see
478 \&\s-1CCM\s0 mode section below for details.
479 .SH "GCM Mode"
480 .IX Header "GCM Mode"
481 For \s-1GCM\s0 mode ciphers the behaviour of the \s-1EVP\s0 interface is subtly altered and
482 several \s-1GCM\s0 specific ctrl operations are supported.
483 .PP
484 To specify any additional authenticated data (\s-1AAD\s0) a call to \fIEVP_CipherUpdate()\fR,
485 \&\fIEVP_EncryptUpdate()\fR or \fIEVP_DecryptUpdate()\fR should be made with the output 
486 parameter \fBout\fR set to \fB\s-1NULL\s0\fR.
487 .PP
488 When decrypting the return value of \fIEVP_DecryptFinal()\fR or \fIEVP_CipherFinal()\fR
489 indicates if the operation was successful. If it does not indicate success
490 the authentication operation has failed and any output data \fB\s-1MUST NOT\s0\fR
491 be used as it is corrupted.
492 .PP
493 The following ctrls are supported in \s-1GCM\s0 mode:
494 .PP
495 .Vb 1
496 \& EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_SET_IVLEN, ivlen, NULL);
497 .Ve
498 .PP
499 Sets the \s-1GCM IV\s0 length: this call can only be made before specifying an \s-1IV.\s0 If
500 not called a default \s-1IV\s0 length is used (96 bits for \s-1AES\s0).
501 .PP
502 .Vb 1
503 \& EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_GET_TAG, taglen, tag);
504 .Ve
505 .PP
506 Writes \fBtaglen\fR bytes of the tag value to the buffer indicated by \fBtag\fR.
507 This call can only be made when encrypting data and \fBafter\fR all data has been
508 processed (e.g. after an \fIEVP_EncryptFinal()\fR call).
509 .PP
510 .Vb 1
511 \& EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_SET_TAG, taglen, tag);
512 .Ve
513 .PP
514 Sets the expected tag to \fBtaglen\fR bytes from \fBtag\fR. This call is only legal
515 when decrypting data.
516 .SH "CCM Mode"
517 .IX Header "CCM Mode"
518 The behaviour of \s-1CCM\s0 mode ciphers is similar to \s-1CCM\s0 mode but with a few
519 additional requirements and different ctrl values.
520 .PP
521 Like \s-1GCM\s0 mode any additional authenticated data (\s-1AAD\s0) is passed by calling
522 \&\fIEVP_CipherUpdate()\fR, \fIEVP_EncryptUpdate()\fR or \fIEVP_DecryptUpdate()\fR with the output 
523 parameter \fBout\fR set to \fB\s-1NULL\s0\fR. Additionally the total plaintext or ciphertext
524 length \fB\s-1MUST\s0\fR be passed to \fIEVP_CipherUpdate()\fR, \fIEVP_EncryptUpdate()\fR or
525 \&\fIEVP_DecryptUpdate()\fR with the output and input parameters (\fBin\fR and \fBout\fR) 
526 set to \fB\s-1NULL\s0\fR and the length passed in the \fBinl\fR parameter.
527 .PP
528 The following ctrls are supported in \s-1CCM\s0 mode:
529 .PP
530 .Vb 1
531 \& EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_TAG, taglen, tag);
532 .Ve
533 .PP
534 This call is made to set the expected \fB\s-1CCM\s0\fR tag value when decrypting or
535 the length of the tag (with the \fBtag\fR parameter set to \s-1NULL\s0) when encrypting.
536 The tag length is often referred to as \fBM\fR. If not set a default value is
537 used (12 for \s-1AES\s0).
538 .PP
539 .Vb 1
540 \& EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_L, ivlen, NULL);
541 .Ve
542 .PP
543 Sets the \s-1CCM \s0\fBL\fR value. If not set a default is used (8 for \s-1AES\s0).
544 .PP
545 .Vb 1
546 \& EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_IVLEN, ivlen, NULL);
547 .Ve
548 .PP
549 Sets the \s-1CCM\s0 nonce (\s-1IV\s0) length: this call can only be made before specifying
550 an nonce value. The nonce length is given by \fB15 \- L\fR so it is 7 by default
551 for \s-1AES.\s0
552 .SH "NOTES"
553 .IX Header "NOTES"
554 Where possible the \fB\s-1EVP\s0\fR interface to symmetric ciphers should be used in
555 preference to the low level interfaces. This is because the code then becomes
556 transparent to the cipher used and much more flexible. Additionally, the
557 \&\fB\s-1EVP\s0\fR interface will ensure the use of platform specific cryptographic
558 acceleration such as AES-NI (the low level interfaces do not provide the
559 guarantee).
560 .PP
561 \&\s-1PKCS\s0 padding works by adding \fBn\fR padding bytes of value \fBn\fR to make the total 
562 length of the encrypted data a multiple of the block size. Padding is always
563 added so if the data is already a multiple of the block size \fBn\fR will equal
564 the block size. For example if the block size is 8 and 11 bytes are to be
565 encrypted then 5 padding bytes of value 5 will be added.
566 .PP
567 When decrypting the final block is checked to see if it has the correct form.
568 .PP
569 Although the decryption operation can produce an error if padding is enabled,
570 it is not a strong test that the input data or key is correct. A random block
571 has better than 1 in 256 chance of being of the correct format and problems with
572 the input data earlier on will not produce a final decrypt error.
573 .PP
574 If padding is disabled then the decryption operation will always succeed if
575 the total amount of data decrypted is a multiple of the block size.
576 .PP
577 The functions \fIEVP_EncryptInit()\fR, \fIEVP_EncryptFinal()\fR, \fIEVP_DecryptInit()\fR,
578 \&\fIEVP_CipherInit()\fR and \fIEVP_CipherFinal()\fR are obsolete but are retained for
579 compatibility with existing code. New code should use \fIEVP_EncryptInit_ex()\fR,
580 \&\fIEVP_EncryptFinal_ex()\fR, \fIEVP_DecryptInit_ex()\fR, \fIEVP_DecryptFinal_ex()\fR,
581 \&\fIEVP_CipherInit_ex()\fR and \fIEVP_CipherFinal_ex()\fR because they can reuse an
582 existing context without allocating and freeing it up on each call.
583 .SH "BUGS"
584 .IX Header "BUGS"
585 For \s-1RC5\s0 the number of rounds can currently only be set to 8, 12 or 16. This is
586 a limitation of the current \s-1RC5\s0 code rather than the \s-1EVP\s0 interface.
587 .PP
588 \&\s-1EVP_MAX_KEY_LENGTH\s0 and \s-1EVP_MAX_IV_LENGTH\s0 only refer to the internal ciphers with
589 default key lengths. If custom ciphers exceed these values the results are
590 unpredictable. This is because it has become standard practice to define a 
591 generic key as a fixed unsigned char array containing \s-1EVP_MAX_KEY_LENGTH\s0 bytes.
592 .PP
593 The \s-1ASN1\s0 code is incomplete (and sometimes inaccurate) it has only been tested
594 for certain common S/MIME ciphers (\s-1RC2, DES,\s0 triple \s-1DES\s0) in \s-1CBC\s0 mode.
595 .SH "EXAMPLES"
596 .IX Header "EXAMPLES"
597 Encrypt a string using \s-1IDEA:\s0
598 .PP
599 .Vb 12
600 \& int do_crypt(char *outfile)
601 \&        {
602 \&        unsigned char outbuf[1024];
603 \&        int outlen, tmplen;
604 \&        /* Bogus key and IV: we\*(Aqd normally set these from
605 \&         * another source.
606 \&         */
607 \&        unsigned char key[] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
608 \&        unsigned char iv[] = {1,2,3,4,5,6,7,8};
609 \&        char intext[] = "Some Crypto Text";
610 \&        EVP_CIPHER_CTX ctx;
611 \&        FILE *out;
612 \&
613 \&        EVP_CIPHER_CTX_init(&ctx);
614 \&        EVP_EncryptInit_ex(&ctx, EVP_idea_cbc(), NULL, key, iv);
615 \&
616 \&        if(!EVP_EncryptUpdate(&ctx, outbuf, &outlen, intext, strlen(intext)))
617 \&                {
618 \&                /* Error */
619 \&                return 0;
620 \&                }
621 \&        /* Buffer passed to EVP_EncryptFinal() must be after data just
622 \&         * encrypted to avoid overwriting it.
623 \&         */
624 \&        if(!EVP_EncryptFinal_ex(&ctx, outbuf + outlen, &tmplen))
625 \&                {
626 \&                /* Error */
627 \&                return 0;
628 \&                }
629 \&        outlen += tmplen;
630 \&        EVP_CIPHER_CTX_cleanup(&ctx);
631 \&        /* Need binary mode for fopen because encrypted data is
632 \&         * binary data. Also cannot use strlen() on it because
633 \&         * it wont be null terminated and may contain embedded
634 \&         * nulls.
635 \&         */
636 \&        out = fopen(outfile, "wb");
637 \&        fwrite(outbuf, 1, outlen, out);
638 \&        fclose(out);
639 \&        return 1;
640 \&        }
641 .Ve
642 .PP
643 The ciphertext from the above example can be decrypted using the \fBopenssl\fR
644 utility with the command line (shown on two lines for clarity):
645 .PP
646 .Vb 2
647 \& openssl idea \-d <filename
648 \&          \-K 000102030405060708090A0B0C0D0E0F \-iv 0102030405060708
649 .Ve
650 .PP
651 General encryption and decryption function example using \s-1FILE I/O\s0 and \s-1AES128\s0
652 with a 128\-bit key:
653 .PP
654 .Vb 11
655 \& int do_crypt(FILE *in, FILE *out, int do_encrypt)
656 \&        {
657 \&        /* Allow enough space in output buffer for additional block */
658 \&        unsigned char inbuf[1024], outbuf[1024 + EVP_MAX_BLOCK_LENGTH];
659 \&        int inlen, outlen;
660 \&        EVP_CIPHER_CTX ctx;
661 \&        /* Bogus key and IV: we\*(Aqd normally set these from
662 \&         * another source.
663 \&         */
664 \&        unsigned char key[] = "0123456789abcdeF";
665 \&        unsigned char iv[] = "1234567887654321";
666 \&
667 \&        /* Don\*(Aqt set key or IV right away; we want to check lengths */
668 \&        EVP_CIPHER_CTX_init(&ctx);
669 \&        EVP_CipherInit_ex(&ctx, EVP_aes_128_cbc(), NULL, NULL, NULL,
670 \&                do_encrypt);
671 \&        OPENSSL_assert(EVP_CIPHER_CTX_key_length(&ctx) == 16);
672 \&        OPENSSL_assert(EVP_CIPHER_CTX_iv_length(&ctx) == 16);
673 \&
674 \&        /* Now we can set key and IV */
675 \&        EVP_CipherInit_ex(&ctx, NULL, NULL, key, iv, do_encrypt);
676 \&
677 \&        for(;;) 
678 \&                {
679 \&                inlen = fread(inbuf, 1, 1024, in);
680 \&                if(inlen <= 0) break;
681 \&                if(!EVP_CipherUpdate(&ctx, outbuf, &outlen, inbuf, inlen))
682 \&                        {
683 \&                        /* Error */
684 \&                        EVP_CIPHER_CTX_cleanup(&ctx);
685 \&                        return 0;
686 \&                        }
687 \&                fwrite(outbuf, 1, outlen, out);
688 \&                }
689 \&        if(!EVP_CipherFinal_ex(&ctx, outbuf, &outlen))
690 \&                {
691 \&                /* Error */
692 \&                EVP_CIPHER_CTX_cleanup(&ctx);
693 \&                return 0;
694 \&                }
695 \&        fwrite(outbuf, 1, outlen, out);
696 \&
697 \&        EVP_CIPHER_CTX_cleanup(&ctx);
698 \&        return 1;
699 \&        }
700 .Ve
701 .SH "SEE ALSO"
702 .IX Header "SEE ALSO"
703 \&\fIevp\fR\|(3)
704 .SH "HISTORY"
705 .IX Header "HISTORY"
706 \&\fIEVP_CIPHER_CTX_init()\fR, \fIEVP_EncryptInit_ex()\fR, \fIEVP_EncryptFinal_ex()\fR,
707 \&\fIEVP_DecryptInit_ex()\fR, \fIEVP_DecryptFinal_ex()\fR, \fIEVP_CipherInit_ex()\fR,
708 \&\fIEVP_CipherFinal_ex()\fR and \fIEVP_CIPHER_CTX_set_padding()\fR appeared in
709 OpenSSL 0.9.7.
710 .PP
711 \&\s-1IDEA\s0 appeared in OpenSSL 0.9.7 but was often disabled due to
712 patent concerns; the last patents expired in 2012.