PKCS7_decrypt.pod 1.7 KB

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