xref: /freebsd/crypto/openssl/doc/man3/PKCS7_decrypt.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1=pod
2
3=head1 NAME
4
5PKCS7_decrypt - decrypt content from a PKCS#7 envelopedData structure
6
7=head1 SYNOPSIS
8
9 #include <openssl/pkcs7.h>
10
11 int PKCS7_decrypt(PKCS7 *p7, EVP_PKEY *pkey, X509 *cert, BIO *data, int flags);
12
13=head1 DESCRIPTION
14
15PKCS7_decrypt() extracts and decrypts the content from a PKCS#7 envelopedData
16structure. B<pkey> is the private key of the recipient, B<cert> is the
17recipients certificate, B<data> is a BIO to write the content to and
18B<flags> is an optional set of flags.
19
20=head1 NOTES
21
22Although the recipients certificate is not needed to decrypt the data it is needed
23to locate the appropriate (of possible several) recipients in the PKCS#7 structure.
24
25The following flags can be passed in the B<flags> parameter.
26
27If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> are deleted
28from the content. If the content is not of type B<text/plain> then an error is
29returned.
30
31=head1 RETURN VALUES
32
33PKCS7_decrypt() returns either 1 for success or 0 for failure.
34The error can be obtained from ERR_get_error(3)
35
36=head1 BUGS
37
38PKCS7_decrypt() must be passed the correct recipient key and certificate. It would
39be better if it could look up the correct key and certificate from a database.
40
41The lack of single pass processing and need to hold all data in memory as
42mentioned in PKCS7_sign() also applies to PKCS7_verify().
43
44=head1 SEE ALSO
45
46L<ERR_get_error(3)>, L<PKCS7_encrypt(3)>
47
48=head1 COPYRIGHT
49
50Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
51
52Licensed under the Apache License 2.0 (the "License").  You may not use
53this file except in compliance with the License.  You can obtain a copy
54in the file LICENSE in the source distribution or at
55L<https://www.openssl.org/source/license.html>.
56
57=cut
58