OLD | NEW |
1 =pod | 1 =pod |
2 | 2 |
3 =head1 NAME | 3 =head1 NAME |
4 | 4 |
5 SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format. | 5 SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format. |
6 | 6 |
7 =head1 SYNOPSIS | 7 =head1 SYNOPSIS |
8 | 8 |
9 #include <openssl/pkcs7.h> | 9 #include <openssl/pkcs7.h> |
10 | 10 |
11 int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags); | 11 int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags); |
12 | 12 |
13 =head1 DESCRIPTION | 13 =head1 DESCRIPTION |
14 | 14 |
15 SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7 | 15 SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7 |
16 structure to produce an S/MIME message. | 16 structure to produce an S/MIME message. |
17 | 17 |
18 B<out> is the BIO to write the data to. B<p7> is the appropriate | 18 B<out> is the BIO to write the data to. B<p7> is the appropriate B<PKCS7> |
19 B<PKCS7> structure. If cleartext signing (B<multipart/signed>) is | 19 structure. If streaming is enabled then the content must be supplied in the |
20 being used then the signed data must be supplied in the B<data> | 20 B<data> argument. B<flags> is an optional set of flags. |
21 argument. B<flags> is an optional set of flags. | |
22 | 21 |
23 =head1 NOTES | 22 =head1 NOTES |
24 | 23 |
25 The following flags can be passed in the B<flags> parameter. | 24 The following flags can be passed in the B<flags> parameter. |
26 | 25 |
27 If B<PKCS7_DETACHED> is set then cleartext signing will be used, | 26 If B<PKCS7_DETACHED> is set then cleartext signing will be used, |
28 this option only makes sense for signedData where B<PKCS7_DETACHED> | 27 this option only makes sense for signedData where B<PKCS7_DETACHED> |
29 is also set when PKCS7_sign() is also called. | 28 is also set when PKCS7_sign() is also called. |
30 | 29 |
31 If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> | 30 If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> |
32 are added to the content, this only makes sense if B<PKCS7_DETACHED> | 31 are added to the content, this only makes sense if B<PKCS7_DETACHED> |
33 is also set. | 32 is also set. |
34 | 33 |
35 If the B<PKCS7_PARTSIGN> flag is set the signed data is finalized | 34 If the B<PKCS7_STREAM> flag is set streaming is performed. This flag should |
36 and output along with the content. This flag should only be set | 35 only be set if B<PKCS7_STREAM> was also set in the previous call to |
37 if B<PKCS7_DETACHED> is also set and the previous call to PKCS7_sign() | 36 PKCS7_sign() or B<PKCS7_encrypt()>. |
38 also set these flags. | |
39 | 37 |
40 If cleartext signing is being used and B<PKCS7_PARTSIGN> not set then | 38 If cleartext signing is being used and B<PKCS7_STREAM> not set then |
41 the data must be read twice: once to compute the signature in PKCS7_sign() | 39 the data must be read twice: once to compute the signature in PKCS7_sign() |
42 and once to output the S/MIME message. | 40 and once to output the S/MIME message. |
43 | 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 |
44 =head1 BUGS | 46 =head1 BUGS |
45 | 47 |
46 SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there | 48 SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there |
47 should be an option to disable this. | 49 should be an option to disable this. |
48 | 50 |
49 =head1 RETURN VALUES | 51 =head1 RETURN VALUES |
50 | 52 |
51 SMIME_write_PKCS7() returns 1 for success or 0 for failure. | 53 SMIME_write_PKCS7() returns 1 for success or 0 for failure. |
52 | 54 |
53 =head1 SEE ALSO | 55 =head1 SEE ALSO |
54 | 56 |
55 L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_sign(3)|PKCS7_sign(3)>, | 57 L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_sign(3)|PKCS7_sign(3)>, |
56 L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)> | 58 L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)> |
57 L<PKCS7_decrypt(3)|PKCS7_decrypt(3)> | 59 L<PKCS7_decrypt(3)|PKCS7_decrypt(3)> |
58 | 60 |
59 =head1 HISTORY | 61 =head1 HISTORY |
60 | 62 |
61 SMIME_write_PKCS7() was added to OpenSSL 0.9.5 | 63 SMIME_write_PKCS7() was added to OpenSSL 0.9.5 |
62 | 64 |
63 =cut | 65 =cut |
OLD | NEW |