Rename INIT funtions, deprecate old ones.
[openssl.git] / doc / crypto / CMS_decrypt.pod
1 =pod
2
3 =head1 NAME
4
5  CMS_decrypt - decrypt content from a CMS envelopedData structure
6
7 =head1 SYNOPSIS
8
9  #include <openssl/cms.h>
10
11  int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert, BIO *dcont, BIO *out, unsigned int flags);
12
13 =head1 DESCRIPTION
14
15 CMS_decrypt() extracts and decrypts the content from a CMS EnvelopedData
16 structure. B<pkey> is the private key of the recipient, B<cert> is the
17 recipient's certificate, B<out> is a BIO to write the content to and
18 B<flags> is an optional set of flags.
19
20 The B<dcont> parameter is used in the rare case where the encrypted content
21 is detached. It will normally be set to NULL.
22
23 =head1 NOTES
24
25 Although the recipients certificate is not needed to decrypt the data it is
26 needed to locate the appropriate (of possible several) recipients in the CMS
27 structure.
28
29 If B<cert> is set to NULL all possible recipients are tried. This case however
30 is problematic. To thwart the MMA attack (Bleichenbacher's attack on
31 PKCS #1 v1.5 RSA padding) all recipients are tried whether they succeed or
32 not. If no recipient succeeds then a random symmetric key is used to decrypt
33 the content: this will typically output garbage and may (but is not guaranteed
34 to) ultimately return a padding error only. If CMS_decrypt() just returned an
35 error when all recipient encrypted keys failed to decrypt an attacker could
36 use this in a timing attack. If the special flag B<CMS_DEBUG_DECRYPT> is set
37 then the above behaviour is modified and an error B<is> returned if no
38 recipient encrypted key can be decrypted B<without> generating a random
39 content encryption key. Applications should use this flag with
40 B<extreme caution> especially in automated gateways as it can leave them
41 open to attack.
42
43 It is possible to determine the correct recipient key by other means (for
44 example looking them up in a database) and setting them in the CMS structure
45 in advance using the CMS utility functions such as CMS_set1_pkey(). In this
46 case both B<cert> and B<pkey> should be set to NULL.
47
48 To process KEKRecipientInfo types CMS_set1_key() or CMS_RecipientInfo_set0_key()
49 and CMS_ReceipientInfo_decrypt() should be called before CMS_decrypt() and
50 B<cert> and B<pkey> set to NULL.
51
52 The following flags can be passed in the B<flags> parameter.
53
54 If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are deleted
55 from the content. If the content is not of type B<text/plain> then an error is
56 returned.
57
58 =head1 RETURN VALUES
59
60 CMS_decrypt() returns either 1 for success or 0 for failure.
61 The error can be obtained from ERR_get_error(3)
62
63 =head1 BUGS
64
65 The lack of single pass processing and the need to hold all data in memory as
66 mentioned in CMS_verify() also applies to CMS_decrypt().
67
68 =head1 SEE ALSO
69
70 L<ERR_get_error(3)>, L<CMS_encrypt(3)>
71
72 =cut