doc/crypto/EVP_EncryptInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_EncryptInit, EVP_EncryptUpdate, EVP_EncryptFinal - EVP cipher routines
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/evp.h>
  10
  11  void EVP_EncryptInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *type, unsigned char *key, unsigned char *iv);
  12  void EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl, unsigned char *in, int inl);
  13  void EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl);
  14
  15  void EVP_DecryptInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *type, unsigned char *key, unsigned char *iv);
  16  void EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl, unsigned char *in, int inl);
  17  int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
  18
  19  void EVP_CipherInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *type, unsigned char *key,unsigned char *iv,int enc);
  20  void EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl, unsigned char *in, int inl);
  21  int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
  22
  23  void EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *a);
  24
  25  const EVP_CIPHER *EVP_get_cipherbyname(const char *name);
  26  #define EVP_get_cipherbynid(a) EVP_get_cipherbyname(OBJ_nid2sn(a))
  27  #define EVP_get_cipherbyobj(a) EVP_get_cipherbynid(OBJ_obj2nid(a))
  28
  29  #define EVP_CIPHER_nid(e)              ((e)->nid)
  30  #define EVP_CIPHER_block_size(e)       ((e)->block_size)
  31  #define EVP_CIPHER_key_length(e)       ((e)->key_len)
  32  #define EVP_CIPHER_iv_length(e)        ((e)->iv_len)
  33
  34  int EVP_CIPHER_type(const EVP_CIPHER *ctx);
  35  #define EVP_CIPHER_CTX_cipher(e)       ((e)->cipher)
  36  #define EVP_CIPHER_CTX_nid(e)          ((e)->cipher->nid)
  37  #define EVP_CIPHER_CTX_block_size(e)   ((e)->cipher->block_size)
  38  #define EVP_CIPHER_CTX_key_length(e)   ((e)->cipher->key_len)
  39  #define EVP_CIPHER_CTX_iv_length(e)    ((e)->cipher->iv_len)
  40  #define EVP_CIPHER_CTX_type(c)         EVP_CIPHER_type(EVP_CIPHER_CTX_cipher(c))
  41
  42  int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
  43  int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
  44
  45 =head1 DESCRIPTION
  46
  47 The EVP cipher routines are a high level interface to certain
  48 symmetric ciphers.
  49
  50 EVP_EncryptInit() initialises a cipher context B<ctx> for encryption
  51 with cipher B<type>. B<type> is normally supplied by a function such
  52 as EVP_des_cbc() . B<key> is the symmetric key to use and B<iv> is the
  53 IV to use (if necessary), the actual number of bytes used for the
  54 key and IV depends on the cipher. It is possible to set all parameters
  55 to NULL except B<type> in an initial call and supply the remaining
  56 parameters in subsequent calls. This is normally done when the
  57 EVP_CIPHER_asn1_to_param() function is called to set the cipher
  58 parameters from an ASN1 AlgorithmIdentifier and the key from a
  59 different source.
  60
  61 EVP_EncryptUpdate() encrypts B<inl> bytes from the buffer B<in> and
  62 writes the encrypted version to B<out>. This function can be called
  63 multiple times to encrypt successive blocks of data. The amount
  64 of data written depends on the block alignment of the encrypted data:
  65 as a result the amount of data written may be anything from zero bytes
  66 to (inl + cipher_block_size - 1) so B<outl> should contain sufficient
  67 room.  The actual number of bytes written is placed in B<outl>.
  68
  69 EVP_EncryptFinal() encrypts the "final" data, that is any data that
  70 remains in a partial block. It uses standard block padding (aka PKCS
  71 padding). The encrypted final data is written to B<out> which should
  72 have sufficient space for one cipher block. The number of bytes written
  73 is placed in B<outl>. After this function is called the encryption operation
  74 is finished and no further calls to EVP_EncryptUpdate() should be made.
  75
  76 EVP_DecryptInit(), EVP_DecryptUpdate() and EVP_DecryptFinal() are the
  77 corresponding decryption operations. EVP_DecryptFinal() will return an
  78 error code if the final block is not correctly formatted. The parameters
  79 and restrictions are identical to the encryption operations except that
  80 the decrypted data buffer B<out> passed to EVP_DecryptUpdate() should
  81 have sufficient room for (B<inl> + cipher_block_size) bytes unless the
  82 cipher block size is 1 in which case B<inl> bytes is sufficient.
  83
  84 EVP_CipherInit(), EVP_CipherUpdate() and EVP_CipherFinal() are functions
  85 that can be used for decryption or encryption. The operation performed
  86 depends on the value of the B<enc> parameter. It should be set to 1 for
  87 encryption and 0 for decryption.
  88
  89 EVP_CIPHER_CTX_cleanup() clears all information from a cipher context.
  90 It should be called after all operations using a cipher are complete
  91 so sensitive information does not remain in memory.
  92
  93 EVP_get_cipherbyname(), EVP_get_cipherbynid() and EVP_get_cipherbyobj()
  94 return an EVP_CIPHER structure when passed a cipher name, a NID or an
  95 ASN1_OBJECT structure.
  96
  97 EVP_CIPHER_nid() and EVP_CIPHER_CTX_nid() return the NID of a cipher when
  98 passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX> structure.  The actual NID
  99 value is an internal value which may not have a corresponding OBJECT
 100 IDENTIFIER.
 101
 102 EVP_CIPHER_key_length() and EVP_CIPHER_CTX_key_length() return the key
 103 length of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>
 104 structure. The constant B<EVP_MAX_KEY_LENGTH> is the maximum key length
 105 for all ciphers.
 106
 107 EVP_CIPHER_iv_length() and EVP_CIPHER_CTX_iv_length() return the IV
 108 length of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>.
 109 It will return zero if the cipher does not use an IV.  The constant
 110 B<EVP_MAX_IV_LENGTH> is the maximum IV length for all ciphers.
 111
 112 EVP_CIPHER_block_size() and EVP_CIPHER_CTX_block_size() return the block
 113 size of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>
 114 structure. The constant B<EVP_MAX_IV_LENGTH> is also the maximum block
 115 length for all ciphers.
 116
 117 EVP_CIPHER_type() and EVP_CIPHER_CTX_type() return the type of the passed
 118 cipher or context. This "type" is the actual NID of the cipher OBJECT
 119 IDENTIFIER as such it ignores the cipher parameters and 40 bit RC2 and
 120 128 bit RC2 have the same NID.
 121
 122 EVP_CIPHER_CTX_cipher() returns the B<EVP_CIPHER> structure when passed
 123 an B<EVP_CIPHER_CTX> structure.
 124
 125 EVP_CIPHER_param_to_asn1() sets the AlgorithmIdentifier "parameter" based
 126 on the passed cipher. This will typically include any parameters and an
 127 IV. The cipher IV (if any) must be set when this call is made. This call
 128 should be made before the cipher is actually "used" (before any
 129 EVP_EncryptUpdate(), EVP_DecryptUpdate() calls for example). This function
 130 may fail if the cipher does not have any ASN1 support.
 131
 132 EVP_CIPHER_asn1_to_param() sets the cipher parameters based on an ASN1
 133 AlgorithmIdentifier "parameter". The precise effect depends on the cipher
 134 In the case of RC2, for example, it will set the IV and effective key length.
 135 This function should be called after the base cipher type is set but before
 136 the key is set. For example EVP_CipherInit() will be called with the IV and
 137 key set to NULL, EVP_CIPHER_asn1_to_param() will be called and finally
 138 EVP_CipherInit() again with all parameters except the key set to NULL. It is
 139 possible for this function to fail if the cipher does not have any ASN1 support
 140 or the parameters cannot be set (for example the RC2 effective key length
 141 does not have an B<EVP_CIPHER> structure).
 142
 143 =head1 RETURN VALUES
 144
 145 EVP_EncryptInit(), EVP_EncryptUpdate() and EVP_EncryptFinal() do not return
 146 values.
 147
 148 EVP_DecryptInit() and EVP_DecryptUpdate() do not return values.
 149 EVP_DecryptFinal() returns 0 if the decrypt failed or 1 for success.
 150
 151 EVP_CipherInit() and EVP_CipherUpdate() do not return values.
 152 EVP_CipherFinal() returns 1 for a decryption failure or 1 for success, if
 153 the operation is encryption then it always returns 1.
 154
 155 EVP_CIPHER_CTX_cleanup() does not return a value.
 156
 157 EVP_get_cipherbyname(), EVP_get_cipherbynid() and EVP_get_cipherbyobj()
 158 return an B<EVP_CIPHER> structure or NULL on error.
 159
 160 EVP_CIPHER_nid() and EVP_CIPHER_CTX_nid() return a NID.
 161
 162 EVP_CIPHER_block_size() and EVP_CIPHER_CTX_block_size() return the block
 163 size.
 164
 165 EVP_CIPHER_key_length() and EVP_CIPHER_CTX_key_length() return the key
 166 length.
 167
 168 EVP_CIPHER_iv_length() and EVP_CIPHER_CTX_iv_length() return the IV
 169 length or zero if the cipher does not use an IV.
 170
 171 =head1 NOTES
 172
 173 Where possible the B<EVP> interface to symmetric ciphers should be used in
 174 preference to the low level interfaces. This is because the code then becomes
 175 transparent to the cipher used and much more flexible.
 176
 177 PKCS padding works by adding B<n> padding bytes of value B<n> to make the total
 178 length of the encrypted data a multiple of the block size. Padding is always
 179 added so if the data is already a multiple of the block size B<n> will equal
 180 the block size. For example if the block size is 8 and 11 bytes are to be
 181 encrypted then 5 padding bytes of value 5 will be added.
 182
 183 When decrypting the final block is checked to see if it has the correct form.
 184
 185 Although the decryption operation can produce an error, it is not a strong
 186 test that the input data or key is correct. A random block has better than
 187 1 in 256 chance of being of the correct format and problems with the
 188 input data earlier on will not produce a final decrypt error.
 189
 190 =head1 BUGS
 191
 192 The current B<EVP> cipher interface is not as flexible as it should be. Only
 193 certain "spot" encryption algorithms can be used for ciphers which have various
 194 parameters associated with them (RC2, RC5 for example) this is inadequate.
 195
 196 Several of the functions do not return error codes because the software versions
 197 can never fail. This is not true of hardware versions.
 198
 199 =head1 SEE ALSO
 200
 201 L<evp(3)|evp(3)>
 202
 203 =head1 HISTORY
 204
 205 =cut