SMIME_write_PKCS7.pod 1.9 KB
Newer Older
D
Dr. Stephen Henson 已提交
1 2 3 4 5 6 7 8
=pod

=head1 NAME

SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format.

=head1 SYNOPSIS

U
Ulf Möller 已提交
9 10 11
 #include <openssl/pkcs7.h>

 int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);
D
Dr. Stephen Henson 已提交
12 13 14 15 16 17

=head1 DESCRIPTION

SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7
structure to produce an S/MIME message.

D
Dr. Stephen Henson 已提交
18 19 20
B<out> is the BIO to write the data to. B<p7> is the appropriate B<PKCS7>
structure. If streaming is enabled then the content must be supplied in the
B<data> argument. B<flags> is an optional set of flags.
D
Dr. Stephen Henson 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33

=head1 NOTES

The following flags can be passed in the B<flags> parameter.

If B<PKCS7_DETACHED> is set then cleartext signing will be used,
this option only makes sense for signedData where B<PKCS7_DETACHED>
is also set when PKCS7_sign() is also called.

If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain>
are added to the content, this only makes sense if B<PKCS7_DETACHED>
is also set.

D
Dr. Stephen Henson 已提交
34 35 36
If the B<PKCS7_STREAM> flag is set streaming is performed. This flag should
only be set if B<PKCS7_STREAM> was also set in the previous call to
PKCS7_sign() or B<PKCS7_encrypt()>.
D
Dr. Stephen Henson 已提交
37

D
Dr. Stephen Henson 已提交
38
If cleartext signing is being used and B<PKCS7_STREAM> not set then
D
Dr. Stephen Henson 已提交
39 40
the data must be read twice: once to compute the signature in PKCS7_sign()
and once to output the S/MIME message.
D
Dr. Stephen Henson 已提交
41

D
Dr. Stephen Henson 已提交
42
If streaming is performed the content is output in BER format using indefinite
43
length constructed encoding except in the case of signed data with detached
D
Dr. Stephen Henson 已提交
44 45
content where the content is absent and DER format is used.

D
Dr. Stephen Henson 已提交
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
=head1 BUGS

SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there
should be an option to disable this.

=head1 RETURN VALUES

SMIME_write_PKCS7() returns 1 for success or 0 for failure.

=head1 SEE ALSO

L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_sign(3)|PKCS7_sign(3)>,
L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)>
L<PKCS7_decrypt(3)|PKCS7_decrypt(3)>

=head1 HISTORY

SMIME_write_PKCS7() was added to OpenSSL 0.9.5

=cut