diff options
Diffstat (limited to 'src/lib/libcrypto/doc/SMIME_write_PKCS7.pod')
-rw-r--r-- | src/lib/libcrypto/doc/SMIME_write_PKCS7.pod | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/src/lib/libcrypto/doc/SMIME_write_PKCS7.pod b/src/lib/libcrypto/doc/SMIME_write_PKCS7.pod index 61945b3887..ca6bd02763 100644 --- a/src/lib/libcrypto/doc/SMIME_write_PKCS7.pod +++ b/src/lib/libcrypto/doc/SMIME_write_PKCS7.pod | |||
@@ -6,17 +6,18 @@ SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format. | |||
6 | 6 | ||
7 | =head1 SYNOPSIS | 7 | =head1 SYNOPSIS |
8 | 8 | ||
9 | int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags); | 9 | #include <openssl/pkcs7.h> |
10 | |||
11 | int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags); | ||
10 | 12 | ||
11 | =head1 DESCRIPTION | 13 | =head1 DESCRIPTION |
12 | 14 | ||
13 | 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 |
14 | structure to produce an S/MIME message. | 16 | structure to produce an S/MIME message. |
15 | 17 | ||
16 | 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> |
17 | B<PKCS7> structure. If cleartext signing (B<multipart/signed>) is | 19 | structure. If streaming is enabled then the content must be supplied in the |
18 | 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. |
19 | argument. B<flags> is an optional set of flags. | ||
20 | 21 | ||
21 | =head1 NOTES | 22 | =head1 NOTES |
22 | 23 | ||
@@ -30,15 +31,18 @@ If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> | |||
30 | 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> |
31 | is also set. | 32 | is also set. |
32 | 33 | ||
33 | 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 |
34 | 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 |
35 | if B<PKCS7_DETACHED> is also set and the previous call to PKCS7_sign() | 36 | PKCS7_sign() or B<PKCS7_encrypt()>. |
36 | also set these flags. | ||
37 | 37 | ||
38 | 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 |
39 | 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() |
40 | and once to output the S/MIME message. | 40 | and once to output the S/MIME message. |
41 | 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 | |||
42 | =head1 BUGS | 46 | =head1 BUGS |
43 | 47 | ||
44 | SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there | 48 | SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there |