Manual pages for EVP_Open* and EVP_Seal*
[openssl.git] / doc / crypto / EVP_OpenInit.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_OpenInit, EVP_OpenUpdate, EVP_OpenFinal - EVP envelope decryption
6
7 =head1 SYNOPSIS
8
9  #include <openssl/evp.h>
10
11  int EVP_OpenInit(EVP_CIPHER_CTX *ctx,EVP_CIPHER *type,unsigned char *ek,
12                 int ekl,unsigned char *iv,EVP_PKEY *priv);
13  void EVP_OpenUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
14          int *outl, unsigned char *in, int inl);
15  void EVP_OpenFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
16          int *outl);
17
18 =head1 DESCRIPTION
19
20 The EVP envelope routines are a high level interface to envelope
21 decryption. They decrypt a public key encrypted symmetric key and
22 then decrypt data using it.
23
24 EVP_OpenInit() initialises a cipher context B<ctx> for decryption
25 with cipher B<type>. It decrypts the encrypted symmetric key of length
26 B<ekl> bytes passed in the B<ek> parameter using the private key B<priv>.
27 The IV is supplied in the B<iv> parameter.
28
29 EVP_OpenUpdate() and EVP_OpenFinal() have exactly the same properties
30 as the EVP_DecryptUpdate() and EVP_DecryptFinal() routines, as 
31 documented on the L<EVP_EncryptInit(3)|EVP_EncryptInit(3)> manual
32 page. 
33
34 =head1 RETURN VALUES
35
36 EVP_OpenInit() returns -1 on error or an non zero integer (actually the
37 recovered secret key size) if successful.
38
39 EVP_SealUpdate() does not return a value.
40
41 EVP_SealFinal() returns 0 if the decrypt failed or 1 for success.
42
43 =head1 SEE ALSO
44
45 L<evp(3)|evp(3)>,L<rand(3)|rand(3)>
46 L<EVP_EncryptInit(3)|EVP_EncryptInit(3)>,
47 L<EVP_SealInit(3)|EVP_SealInit(3)>
48
49 =head1 HISTORY
50
51 =cut