Provide documentation for i2d_ECPrivateKey and d2i_ECPrivateKey
[openssl.git] / doc / crypto / SMIME_write_PKCS7.pod
1 =pod
2
3 =head1 NAME
4
5 SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/pkcs7.h>
10
11  int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);
12
13 =head1 DESCRIPTION
14
15 SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7
16 structure to produce an S/MIME message.
17
18 B<out> is the BIO to write the data to. B<p7> is the appropriate B<PKCS7>
19 structure. If streaming is enabled then the content must be supplied in the
20 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<PKCS7_DETACHED> is set then cleartext signing will be used,
27 this option only makes sense for signedData where B<PKCS7_DETACHED>
28 is also set when PKCS7_sign() is also called.
29
30 If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain>
31 are added to the content, this only makes sense if B<PKCS7_DETACHED>
32 is also set.
33
34 If the B<PKCS7_STREAM> flag is set streaming is performed. This flag should
35 only be set if B<PKCS7_STREAM> was also set in the previous call to
36 PKCS7_sign() or B<PKCS7_encrypt()>.
37
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()
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_PKCS7() always base64 encodes PKCS#7 structures, there
49 should be an option to disable this.
50
51 =head1 RETURN VALUES
52
53 SMIME_write_PKCS7() 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<PKCS7_sign(3)|PKCS7_sign(3)>,
58 L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)>
59 L<PKCS7_decrypt(3)|PKCS7_decrypt(3)>
60
61 =head1 HISTORY
62
63 SMIME_write_PKCS7() was added to OpenSSL 0.9.5
64
65 =cut