generic-library/openssl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs.

Browse Source
This commit is contained in:
Dr. Stephen Henson 2007-04-13 13:13:14 +00:00
parent 4cfb986f27
commit 731c6802d7
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/crypto/SMIME_write_PKCS7.pod
View File

@ -15,10 +15,9 @@ SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format.
SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7 SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7
structure to produce an S/MIME message. structure to produce an S/MIME message.
B<out> is the BIO to write the data to. B<p7> is the appropriate B<out> is the BIO to write the data to. B<p7> is the appropriate B<PKCS7>
B<PKCS7> structure. If cleartext signing (B<multipart/signed>) is structure. If streaming is enabled then the content must be supplied in the
being used then the signed data must be supplied in the B<data> B<data> argument. B<flags> is an optional set of flags.
argument. B<flags> is an optional set of flags.
=head1 NOTES =head1 NOTES
@ -32,15 +31,20 @@ 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> are added to the content, this only makes sense if B<PKCS7_DETACHED>
is also set. is also set.
If the B<PKCS7_PARTSIGN> flag is set the signed data is finalized If the B<PKCS7_STREAM> flag is set streaming is performed. This flag should
and output along with the content. This flag should only be set only be set if B<PKCS7_STREAM> was also set in the previous call to
if B<PKCS7_DETACHED> is also set and the previous call to PKCS7_sign() PKCS7_sign() or B<PKCS7_encrypt()>.
also set these flags.
If cleartext signing is being used and B<PKCS7_PARTSIGN> not set then If cleartext signing is being used and B<PKCS7_STREAM> not set then
the data must be read twice: once to compute the signature in PKCS7_sign() the data must be read twice: once to compute the signature in PKCS7_sign()
and once to output the S/MIME message. and once to output the S/MIME message.
=head1 NOTES
If streaming is performed the content is output in BER format using indefinite
length constructuted encoding except in the case of signed data with detached
content where the content is absent and DER format is used.
=head1 BUGS =head1 BUGS
SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there