secure/lib/libcrypto/man/EVP_EncryptInit.3

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