X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=doc%2Fcrypto%2FCMS_sign_add1_signer.pod;h=bda3ca2adbd1c14c82a81096cee8657d14f637e9;hp=ee2f93a8aed8915542fbea40fa6b951a8a7c80f2;hb=2a0ff7ad20b732d2ad8b10f4e6924d1aad5812e7;hpb=86173db853263a9eebfb606308fc684ea56ec38b diff --git a/doc/crypto/CMS_sign_add1_signer.pod b/doc/crypto/CMS_sign_add1_signer.pod index ee2f93a8ae..bda3ca2adb 100644 --- a/doc/crypto/CMS_sign_add1_signer.pod +++ b/doc/crypto/CMS_sign_add1_signer.pod @@ -2,7 +2,7 @@ =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 @@ -10,18 +10,18 @@ CMS_sign_add_signer, CMS_SignerInfo_sign - add a signer to a CMS_ContentInfo sig 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 and private -key B using message digest B to CMS_ContentInfo signed data +key B using message digest B to CMS_ContentInfo SignedData structure B. The CMS_ContentInfo structure should be obtained from an initial call to CMS_sign() with the flag B set or in the case or re-signing a -valid CMS_ContentInfo signed data structure. +valid CMS_ContentInfo SignedData structure. If the B parameter is B then the default digest for the public key algorithm will be used. @@ -36,17 +36,18 @@ are both set. =head1 NOTES -The main purpose of this CMS_sign_add1_signer() is to provide finer control +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 parameter. If B 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. @@ -62,7 +63,7 @@ the B 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 is set then no signedAttributes will be used. If B is set then just the SMIMECapabilities are @@ -95,6 +96,6 @@ L, =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