s/recommend/recommended/
[oweals/openssl.git] / doc / crypto / CMS_sign_add1_signer.pod
index 6513885f8fb05e0992b1704796da040bce9748ba..bda3ca2adbd1c14c82a81096cee8657d14f637e9 100644 (file)
@@ -2,26 +2,26 @@
 
 =head1 NAME
 
-CMS_sign_add_signer, CMS_SignerInfo_sign - add a signer to a CMS_ContentInfo signed data structure.
+ CMS_sign_add1_signer, CMS_SignerInfo_sign - add a signer to a CMS_ContentInfo signed data structure.
 
 =head1 SYNOPSIS
 
  #include <openssl/cms.h>
 
- CMS_SignerInfo *CMS_sign_add1_signer(CMS_ContentInfo *cms, X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, int flags);
+ CMS_SignerInfo *CMS_sign_add1_signer(CMS_ContentInfo *cms, X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, unsigned int flags);
 
-int CMS_SignerInfo_sign(CMS_SignerInfo *si);
+ int CMS_SignerInfo_sign(CMS_SignerInfo *si);
 
 
 =head1 DESCRIPTION
 
 CMS_sign_add1_signer() adds a signer with certificate B<signcert> and private
-key B<pkey> using message digest B<md> to CMS_ContentInfo signed data
+key B<pkey> using message digest B<md> to CMS_ContentInfo SignedData
 structure B<cms>.
 
 The CMS_ContentInfo structure should be obtained from an initial call to
 CMS_sign() with the flag B<CMS_PARTIAL> set or in the case or re-signing a
-valid CMS_ContentInfo signed data structure.
+valid CMS_ContentInfo SignedData structure.
 
 If the B<md> parameter is B<NULL> then the default digest for the public
 key algorithm will be used.
@@ -36,24 +36,25 @@ are both set.
 
 =head1 NOTES
 
-The main purpose of this function is to provide finer control over a CMS
-signed data structure where the simpler CMS_sign() function defaults are
-not appropriate. For example if multiple signers or non default digest
+The main purpose of CMS_sign_add1_signer() is to provide finer control
+over a CMS signed data structure where the simpler CMS_sign() function defaults
+are not appropriate. For example if multiple signers or non default digest
 algorithms are needed. New attributes can also be added using the returned
-CMS_SignerInfo struture and the CMS attribute utility functions.
+CMS_SignerInfo structure and the CMS attribute utility functions or the
+CMS signed receipt request functions.
 
 Any of the following flags (ored together) can be passed in the B<flags>
 parameter.
 
 If B<CMS_REUSE_DIGEST> is set then an attempt is made to copy the content
-digest value from the CMS_ContentInfo struture: to add a signer to an existing
+digest value from the CMS_ContentInfo structure: to add a signer to an existing
 structure.  An error occurs if a matching digest value cannot be found to copy.
 The returned CMS_ContentInfo structure will be valid and finalized when this
 flag is set.
 
 If B<CMS_PARTIAL> is set in addition to B<CMS_REUSE_DIGEST> then the 
-B<CMS_SIGNER_INO> structure will not be finalized so additional attributes
-can be added. In this case an explicit call to CMS_SignerInfo_Sign() is
+CMS_SignerInfo structure will not be finalized so additional attributes
+can be added. In this case an explicit call to CMS_SignerInfo_sign() is
 needed to finalize it.
 
 If B<CMS_NOCERTS> is set the signer's certificate will not be included in the
@@ -62,7 +63,7 @@ the B<signcert> parameter though. This can reduce the size of the signature if
 the signers certificate can be obtained by other means: for example a
 previously signed message.
 
-The signedData structure includes several CMS signedAttributes including the
+The SignedData structure includes several CMS signedAttributes including the
 signing time, the CMS content type and the supported list of ciphers in an
 SMIMECapabilities attribute. If B<CMS_NOATTR> is set then no signedAttributes
 will be used. If B<CMS_NOSMIMECAP> is set then just the SMIMECapabilities are
@@ -74,10 +75,12 @@ identifier value instead. An error occurs if the signing certificate does not
 have a subject key identifier extension.
 
 If present the SMIMECapabilities attribute indicates support for the following
-algorithms: triple DES, 128 bit RC2, 64 bit RC2, DES and 40 bit RC2. If any of
-these algorithms is disabled then it will not be included.
+algorithms in preference order: 256 bit AES, Gost R3411-94, Gost 28147-89, 192
+bit AES, 128 bit AES, triple DES, 128 bit RC2, 64 bit RC2, DES and 40 bit RC2.
+If any of these algorithms is not available then it will not be included: for example the GOST algorithms will not be included if the GOST ENGINE is
+not loaded.
 
-CMS_sign_add_signers() returns an internal pointer to the CMS_SIGNER_INFO
+CMS_sign_add1_signer() returns an internal pointer to the CMS_SignerInfo
 structure just added, this can be used to set additional attributes 
 before it is finalized.
 
@@ -93,6 +96,6 @@ L<CMS_final(3)|CMS_final(3)>,
 
 =head1 HISTORY
 
-PEM_sign_add_signer() was added to OpenSSL 0.9.9
+CMS_sign_add1_signer() was added to OpenSSL 0.9.8
 
 =cut