SMIME_read_PKCS7.pod 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. =pod
  2. =head1 NAME
  3. SMIME_read_PKCS7 - parse S/MIME message.
  4. =head1 SYNOPSIS
  5. #include <openssl/pkcs7.h>
  6. PKCS7 *SMIME_read_PKCS7(BIO *in, BIO **bcont);
  7. =head1 DESCRIPTION
  8. SMIME_read_PKCS7() parses a message in S/MIME format.
  9. B<in> is a BIO to read the message from.
  10. If cleartext signing is used then the content is saved in
  11. a memory bio which is written to B<*bcont>, otherwise
  12. B<*bcont> is set to B<NULL>.
  13. The parsed PKCS#7 structure is returned or B<NULL> if an
  14. error occurred.
  15. =head1 NOTES
  16. If B<*bcont> is not B<NULL> then the message is clear text
  17. signed. B<*bcont> can then be passed to PKCS7_verify() with
  18. the B<PKCS7_DETACHED> flag set.
  19. Otherwise the type of the returned structure can be determined
  20. using PKCS7_type().
  21. To support future functionality if B<bcont> is not B<NULL>
  22. B<*bcont> should be initialized to B<NULL>. For example:
  23. BIO *cont = NULL;
  24. PKCS7 *p7;
  25. p7 = SMIME_read_PKCS7(in, &cont);
  26. =head1 BUGS
  27. The MIME parser used by SMIME_read_PKCS7() is somewhat primitive.
  28. While it will handle most S/MIME messages more complex compound
  29. formats may not work.
  30. The parser assumes that the PKCS7 structure is always base64
  31. encoded and will not handle the case where it is in binary format
  32. or uses quoted printable format.
  33. The use of a memory BIO to hold the signed content limits the size
  34. of message which can be processed due to memory restraints: a
  35. streaming single pass option should be available.
  36. =head1 RETURN VALUES
  37. SMIME_read_PKCS7() returns a valid B<PKCS7> structure or B<NULL>
  38. is an error occurred. The error can be obtained from ERR_get_error(3).
  39. =head1 SEE ALSO
  40. L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_type(3)|PKCS7_type(3)>
  41. L<SMIME_read_PKCS7(3)|SMIME_read_PKCS7(3)>, L<PKCS7_sign(3)|PKCS7_sign(3)>,
  42. L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)>
  43. L<PKCS7_decrypt(3)|PKCS7_decrypt(3)>
  44. =head1 HISTORY
  45. SMIME_read_PKCS7() was added to OpenSSL 0.9.5
  46. =cut