projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| e33ffaca DSH |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| bb9ad09e | 5 | SMIME_write_CMS - convert CMS structure to S/MIME format |
| e33ffaca DSH |
6 | |
| 7 | =head1 SYNOPSIS | |
| 8 | ||
| 9 | #include <openssl/cms.h> | |
| 10 | ||
| 11 | int SMIME_write_CMS(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags); | |
| 12 | ||
| 13 | =head1 DESCRIPTION | |
| 14 | ||
| 15 | SMIME_write_CMS() adds the appropriate MIME headers to a CMS | |
| 16 | structure to produce an S/MIME message. | |
| 17 | ||
| 18 | B<out> is the BIO to write the data to. B<cms> is the appropriate | |
| 19 | B<CMS_ContentInfo> structure. If streaming is enabled then the content must be | |
| 20 | supplied in the B<data> argument. B<flags> is an optional set of flags. | |
| 21 | ||
| 22 | =head1 NOTES | |
| 23 | ||
| 24 | The following flags can be passed in the B<flags> parameter. | |
| 25 | ||
| 38d3a738 DSH |
26 | If B<CMS_DETACHED> is set then cleartext signing will be used, this option only |
| 27 | makes sense for SignedData where B<CMS_DETACHED> is also set when CMS_sign() is | |
| 28 | called. | |
| e33ffaca | 29 | |
| 38d3a738 DSH |
30 | If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are added to |
| 31 | the content, this only makes sense if B<CMS_DETACHED> is also set. | |
| e33ffaca | 32 | |
| 38d3a738 DSH |
33 | If the B<CMS_STREAM> flag is set streaming is performed. This flag should only |
| 34 | be set if B<CMS_STREAM> was also set in the previous call to a CMS_ContentInfo | |
| 35 | creation function. | |
| e33ffaca | 36 | |
| 38d3a738 DSH |
37 | If cleartext signing is being used and B<CMS_STREAM> not set then the data must |
| 38 | be read twice: once to compute the signature in CMS_sign() and once to output | |
| 39 | the S/MIME message. | |
| e33ffaca DSH |
40 | |
| 41 | If streaming is performed the content is output in BER format using indefinite | |
| c420fab5 | 42 | length constructed encoding except in the case of signed data with detached |
| e33ffaca DSH |
43 | content where the content is absent and DER format is used. |
| 44 | ||
| 45 | =head1 BUGS | |
| 46 | ||
| 38d3a738 DSH |
47 | SMIME_write_CMS() always base64 encodes CMS structures, there should be an |
| 48 | option to disable this. | |
| e33ffaca DSH |
49 | |
| 50 | =head1 RETURN VALUES | |
| 51 | ||
| 52 | SMIME_write_CMS() returns 1 for success or 0 for failure. | |
| 53 | ||
| 54 | =head1 SEE ALSO | |
| 55 | ||
| 9b86974e RS |
56 | L<ERR_get_error(3)>, L<CMS_sign(3)>, |
| 57 | L<CMS_verify(3)>, L<CMS_encrypt(3)> | |
| 58 | L<CMS_decrypt(3)> | |
| e33ffaca | 59 | |
| e2f92610 RS |
60 | =head1 COPYRIGHT |
| 61 | ||
| 62 | Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved. | |
| 63 | ||
| 64 | Licensed under the OpenSSL license (the "License"). You may not use | |
| 65 | this file except in compliance with the License. You can obtain a copy | |
| 66 | in the file LICENSE in the source distribution or at | |
| 67 | L<https://www.openssl.org/source/license.html>. | |
| 68 | ||
| 69 | =cut |