summaryrefslogtreecommitdiffstats
path: root/doc/crypto/CMS_decrypt.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_decrypt.pod
parent73b3c2d8616801cab74368022e7d8edced922e05 (diff)
Reformat, fix typos and clarify CMS API docs.
Diffstat (limited to 'doc/crypto/CMS_decrypt.pod')
-rw-r--r--doc/crypto/CMS_decrypt.pod11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/crypto/CMS_decrypt.pod b/doc/crypto/CMS_decrypt.pod
index b6bb3b1188..cacab3819c 100644
--- a/doc/crypto/CMS_decrypt.pod
+++ b/doc/crypto/CMS_decrypt.pod
@@ -2,7 +2,7 @@
=head1 NAME
-CMS_decrypt - decrypt content from a CMS envelopedData structure
+ CMS_decrypt - decrypt content from a CMS envelopedData structure
=head1 SYNOPSIS
@@ -12,9 +12,9 @@ CMS_decrypt - decrypt content from a CMS envelopedData structure
=head1 DESCRIPTION
-CMS_decrypt() extracts and decrypts the content from a CMS envelopedData
+CMS_decrypt() extracts and decrypts the content from a CMS EnvelopedData
structure. B<pkey> is the private key of the recipient, B<cert> is the
-recipients certificate, B<data> is a BIO to write the content to and
+recipient's certificate, B<data> is a BIO to write the content to and
B<flags> is an optional set of flags.
The B<dcont> parameter is used in the rare case where the encrypted content
@@ -34,8 +34,9 @@ example looking them up in a database) and setting them in the CMS structure
in advance using the CMS utility functions such as CMS_set1_pkey(). In this
case both B<cert> and B<pkey> should be set to NULL.
-To process KEKRecipientInfo types CMS_set1_key() should be used and B<cert>
-and B<pkey> set to NULL.
+To process KEKRecipientInfo types CMS_set1_key() or CMS_RecipientInfo_set0_key()
+and CMS_ReceipientInfo_decrypt() should be called before CMS_decrypt() and
+B<cert> and B<pkey> set to NULL.
The following flags can be passed in the B<flags> parameter.