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