SMIME_write_CMS.pod 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. =pod
  2. =head1 NAME
  3. SMIME_write_CMS - convert CMS structure to S/MIME format.
  4. =head1 SYNOPSIS
  5. #include <openssl/cms.h>
  6. int SMIME_write_CMS(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags);
  7. =head1 DESCRIPTION
  8. SMIME_write_CMS() adds the appropriate MIME headers to a CMS
  9. structure to produce an S/MIME message.
  10. B<out> is the BIO to write the data to. B<cms> is the appropriate
  11. B<CMS_ContentInfo> structure. If streaming is enabled then the content must be
  12. supplied in the B<data> argument. B<flags> is an optional set of flags.
  13. =head1 NOTES
  14. The following flags can be passed in the B<flags> parameter.
  15. If B<CMS_DETACHED> is set then cleartext signing will be used, this option only
  16. makes sense for SignedData where B<CMS_DETACHED> is also set when CMS_sign() is
  17. called.
  18. If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are added to
  19. the content, this only makes sense if B<CMS_DETACHED> is also set.
  20. If the B<CMS_STREAM> flag is set streaming is performed. This flag should only
  21. be set if B<CMS_STREAM> was also set in the previous call to a CMS_ContentInfo
  22. creation function.
  23. If cleartext signing is being used and B<CMS_STREAM> not set then the data must
  24. be read twice: once to compute the signature in CMS_sign() and once to output
  25. the S/MIME message.
  26. If streaming is performed the content is output in BER format using indefinite
  27. length constructed encoding except in the case of signed data with detached
  28. content where the content is absent and DER format is used.
  29. =head1 BUGS
  30. SMIME_write_CMS() always base64 encodes CMS structures, there should be an
  31. option to disable this.
  32. =head1 RETURN VALUES
  33. SMIME_write_CMS() returns 1 for success or 0 for failure.
  34. =head1 SEE ALSO
  35. L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>,
  36. L<CMS_verify(3)|CMS_verify(3)>, L<CMS_encrypt(3)|CMS_encrypt(3)>
  37. L<CMS_decrypt(3)|CMS_decrypt(3)>
  38. =head1 HISTORY
  39. SMIME_write_CMS() was added to OpenSSL 0.9.8
  40. =cut