diff options
| author | schwarze <> | 2016-11-03 15:20:36 +0000 |
|---|---|---|
| committer | schwarze <> | 2016-11-03 15:20:36 +0000 |
| commit | fd23280c77e6b5aeafeb054d4c9b369c079020a6 (patch) | |
| tree | 1ce08c06c8b7c83fa9592d241cddc0d7b95ce2ce /src/lib/libcrypto/doc/PKCS7_decrypt.pod | |
| parent | f540f1bc5dd92bb38eace75d62ec5676a16e242e (diff) | |
| download | openbsd-fd23280c77e6b5aeafeb054d4c9b369c079020a6.tar.gz openbsd-fd23280c77e6b5aeafeb054d4c9b369c079020a6.tar.bz2 openbsd-fd23280c77e6b5aeafeb054d4c9b369c079020a6.zip | |
convert PEM and PKCS manuals from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc/PKCS7_decrypt.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/PKCS7_decrypt.pod | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/src/lib/libcrypto/doc/PKCS7_decrypt.pod b/src/lib/libcrypto/doc/PKCS7_decrypt.pod deleted file mode 100644 index 78919998ce..0000000000 --- a/src/lib/libcrypto/doc/PKCS7_decrypt.pod +++ /dev/null | |||
| @@ -1,57 +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 | ||
| 26 | needed to locate the appropriate (of possible several) recipients in the PKCS#7 | ||
| 27 | structure. | ||
| 28 | |||
| 29 | The following flags can be passed in the B<flags> parameter. | ||
| 30 | |||
| 31 | If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> are deleted | ||
| 32 | from the content. If the content is not of type B<text/plain> then an error is | ||
| 33 | returned. | ||
| 34 | |||
| 35 | =head1 RETURN VALUES | ||
| 36 | |||
| 37 | PKCS7_decrypt() returns either 1 for success or 0 for failure. | ||
| 38 | The error can be obtained from ERR_get_error(3) | ||
| 39 | |||
| 40 | =head1 BUGS | ||
| 41 | |||
| 42 | PKCS7_decrypt() must be passed the correct recipient key and certificate. It | ||
| 43 | would be better if it could look up the correct key and certificate from a | ||
| 44 | database. | ||
| 45 | |||
| 46 | The lack of single pass processing and need to hold all data in memory as | ||
| 47 | mentioned in PKCS7_sign() also applies to PKCS7_verify(). | ||
| 48 | |||
| 49 | =head1 SEE ALSO | ||
| 50 | |||
| 51 | L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)> | ||
| 52 | |||
| 53 | =head1 HISTORY | ||
| 54 | |||
| 55 | PKCS7_decrypt() was added to OpenSSL 0.9.5 | ||
| 56 | |||
| 57 | =cut | ||
