diff options
Diffstat (limited to '')
| -rw-r--r-- | src/lib/libcrypto/doc/PKCS7_decrypt.pod | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/src/lib/libcrypto/doc/PKCS7_decrypt.pod b/src/lib/libcrypto/doc/PKCS7_decrypt.pod deleted file mode 100644 index 325699d0b6..0000000000 --- a/src/lib/libcrypto/doc/PKCS7_decrypt.pod +++ /dev/null | |||
| @@ -1,55 +0,0 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | PKCS7_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 | |||
| 15 | PKCS7_decrypt() extracts and decrypts the content from a PKCS#7 envelopedData | ||
| 16 | structure. B<pkey> is the private key of the recipient, B<cert> is the | ||
| 17 | recipients certificate, B<data> is a BIO to write the content to and | ||
| 18 | B<flags> is an optional set of flags. | ||
| 19 | |||
| 20 | =head1 NOTES | ||
| 21 | |||
| 22 | OpenSSL_add_all_algorithms() (or equivalent) should be called before using this | ||
| 23 | function or errors about unknown algorithms will occur. | ||
| 24 | |||
| 25 | Although the recipients certificate is not needed to decrypt the data it is needed | ||
| 26 | to locate the appropriate (of possible several) recipients in the PKCS#7 structure. | ||
| 27 | |||
| 28 | The following flags can be passed in the B<flags> parameter. | ||
| 29 | |||
| 30 | If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> are deleted | ||
| 31 | from the content. If the content is not of type B<text/plain> then an error is | ||
| 32 | returned. | ||
| 33 | |||
| 34 | =head1 RETURN VALUES | ||
| 35 | |||
| 36 | PKCS7_decrypt() returns either 1 for success or 0 for failure. | ||
| 37 | The error can be obtained from ERR_get_error(3) | ||
| 38 | |||
| 39 | =head1 BUGS | ||
| 40 | |||
| 41 | PKCS7_decrypt() must be passed the correct recipient key and certificate. It would | ||
| 42 | be better if it could look up the correct key and certificate from a database. | ||
| 43 | |||
| 44 | The lack of single pass processing and need to hold all data in memory as | ||
| 45 | mentioned in PKCS7_sign() also applies to PKCS7_verify(). | ||
| 46 | |||
| 47 | =head1 SEE ALSO | ||
| 48 | |||
| 49 | L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)> | ||
| 50 | |||
| 51 | =head1 HISTORY | ||
| 52 | |||
| 53 | PKCS7_decrypt() was added to OpenSSL 0.9.5 | ||
| 54 | |||
| 55 | =cut | ||
