summaryrefslogtreecommitdiffstats
path: root/doc/crypto/CMS_encrypt.pod
diff options
context:
space:
mode:
authorDr. Stephen Henson <steve@openssl.org>2008-04-10 23:28:25 +0000
committerDr. Stephen Henson <steve@openssl.org>2008-04-10 23:28:25 +0000
commit38d3a7380817e272df7df2e8c32fc22d6b35e332 (patch)
treeb816d45ce1ec153d47b6867cadbb210462ecf6da /doc/crypto/CMS_encrypt.pod
parent73b3c2d8616801cab74368022e7d8edced922e05 (diff)
Reformat, fix typos and clarify CMS API docs.
Diffstat (limited to 'doc/crypto/CMS_encrypt.pod')
-rw-r--r--doc/crypto/CMS_encrypt.pod14
1 files changed, 5 insertions, 9 deletions
diff --git a/doc/crypto/CMS_encrypt.pod b/doc/crypto/CMS_encrypt.pod
index 0e3c79e4b3..8d4975573b 100644
--- a/doc/crypto/CMS_encrypt.pod
+++ b/doc/crypto/CMS_encrypt.pod
@@ -2,7 +2,7 @@
=head1 NAME
-CMS_encrypt - create a CMS envelopedData structure
+ CMS_encrypt - create a CMS envelopedData structure
=head1 SYNOPSIS
@@ -12,23 +12,19 @@ CMS_encrypt - create a CMS envelopedData structure
=head1 DESCRIPTION
-CMS_encrypt() creates and returns a CMS envelopedData structure. B<certs>
+CMS_encrypt() creates and returns a CMS EnvelopedData structure. B<certs>
is a list of recipient certificates. B<in> is the content to be encrypted.
B<cipher> is the symmetric cipher to use. B<flags> is an optional set of flags.
=head1 NOTES
-Only certificates carrying RSA keys are supported in CMS and envelopedData so
-the recipient certificates supplied to this function must all contain RSA
-public keys, though they do not have to be signed using the RSA algorithm.
+Only certificates carrying RSA keys are supported so the recipient certificates
+supplied to this function must all contain RSA public keys, though they do not
+have to be signed using the RSA algorithm.
EVP_des_ede3_cbc() (triple DES) is the algorithm of choice for S/MIME use
because most clients will support it.
-Some old "export grade" clients may only support weak encryption using 40 or 64
-bit RC2. These can be used by passing EVP_rc2_40_cbc() and EVP_rc2_64_cbc()
-respectively.
-
The algorithm passed in the B<cipher> parameter must support ASN1 encoding of
its parameters.