projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| e33ffaca DSH |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | SMIME_write_CMS - convert CMS structure to S/MIME format. | |
| 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 | ||
| 26 | If B<CMS_DETACHED> is set then cleartext signing will be used, | |
| 27 | this option only makes sense for signedData where B<CMS_DETACHED> | |
| 28 | is also set when CMS_sign() is called. | |
| 29 | ||
| 30 | If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> | |
| 31 | are added to the content, this only makes sense if B<CMS_DETACHED> | |
| 32 | is also set. | |
| 33 | ||
| 34 | If the B<CMS_STREAM> flag is set streaming is performed. This flag should | |
| 35 | only be set if B<CMS_STREAM> was also set in the previous call to a | |
| 36 | CMS_ContentInfo creation function. | |
| 37 | ||
| 38 | If cleartext signing is being used and B<CMS_STREAM> not set then | |
| 39 | the data must be read twice: once to compute the signature in CMS_sign() | |
| 40 | and once to output the S/MIME message. | |
| 41 | ||
| 42 | If streaming is performed the content is output in BER format using indefinite | |
| 43 | length constructuted encoding except in the case of signed data with detached | |
| 44 | content where the content is absent and DER format is used. | |
| 45 | ||
| 46 | =head1 BUGS | |
| 47 | ||
| 48 | SMIME_write_CMS() always base64 encodes CMS structures, there | |
| 49 | should be an option to disable this. | |
| 50 | ||
| 51 | =head1 RETURN VALUES | |
| 52 | ||
| 53 | SMIME_write_CMS() returns 1 for success or 0 for failure. | |
| 54 | ||
| 55 | =head1 SEE ALSO | |
| 56 | ||
| 57 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>, | |
| 58 | L<CMS_verify(3)|CMS_verify(3)>, L<CMS_encrypt(3)|CMS_encrypt(3)> | |
| 59 | L<CMS_decrypt(3)|CMS_decrypt(3)> | |
| 60 | ||
| 61 | =head1 HISTORY | |
| 62 | ||
| 63 | SMIME_write_CMS() was added to OpenSSL 0.9.8 | |
| 64 | ||
| 65 | =cut |