Initial CMS API documentation.
[openssl.git] / doc / crypto / CMS_sign_add1_signer.pod
1 =pod
2
3 =head1 NAME
4
5 CMS_sign_add_signer, CMS_SignerInfo_sign - add a signer to a CMS_ContentInfo signed data structure.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/cms.h>
10
11  CMS_SignerInfo *CMS_sign_add1_signer(CMS_ContentInfo *cms, X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, int flags);
12
13 int CMS_SignerInfo_sign(CMS_SignerInfo *si);
14
15
16 =head1 DESCRIPTION
17
18 CMS_sign_add1_signer() adds a signer with certificate B<signcert> and private
19 key B<pkey> using message digest B<md> to CMS_ContentInfo signed data
20 structure B<cms>.
21
22 The CMS_ContentInfo structure should be obtained from an initial call to
23 CMS_sign() with the flag B<CMS_PARTIAL> set or in the case or re-signing a
24 valid CMS_ContentInfo signed data structure.
25
26 If the B<md> parameter is B<NULL> then the default digest for the public
27 key algorithm will be used.
28
29 Unless the B<CMS_REUSE_DIGEST> flag is set the returned CMS_ContentInfo
30 structure is not complete and must be finalized either by streaming (if
31 applicable) or a call to CMS_final().
32
33 The CMS_SignerInfo_sign() function will explicitly sign a CMS_SignerInfo
34 structure, its main use is when B<CMS_REUSE_DIGEST> and B<CMS_PARTIAL> flags
35 are both set.
36
37 =head1 NOTES
38
39 The main purpose of this function is to provide finer control over a CMS
40 signed data structure where the simpler CMS_sign() function defaults are
41 not appropriate. For example if multiple signers or non default digest
42 algorithms are needed. New attributes can also be added using the returned
43 CMS_SignerInfo struture and the CMS attribute utility functions.
44
45 Any of the following flags (ored together) can be passed in the B<flags>
46 parameter.
47
48 If B<CMS_REUSE_DIGEST> is set then an attempt is made to copy the content
49 digest value from the CMS_ContentInfo struture: to add a signer to an existing
50 structure.  An error occurs if a matching digest value cannot be found to copy.
51 The returned CMS_ContentInfo structure will be valid and finalized when this
52 flag is set.
53
54 If B<CMS_PARTIAL> is set in addition to B<CMS_REUSE_DIGEST> then the 
55 B<CMS_SIGNER_INO> structure will not be finalized so additional attributes
56 can be added. In this case an explicit call to CMS_SignerInfo_Sign() is
57 needed to finalize it.
58
59 If B<CMS_NOCERTS> is set the signer's certificate will not be included in the
60 CMS_ContentInfo structure, the signer's certificate must still be supplied in
61 the B<signcert> parameter though. This can reduce the size of the signature if
62 the signers certificate can be obtained by other means: for example a
63 previously signed message.
64
65 The signedData structure includes several CMS signedAttributes including the
66 signing time, the CMS content type and the supported list of ciphers in an
67 SMIMECapabilities attribute. If B<CMS_NOATTR> is set then no signedAttributes
68 will be used. If B<CMS_NOSMIMECAP> is set then just the SMIMECapabilities are
69 omitted.
70
71 OpenSSL will by default identify signing certificates using issuer name
72 and serial number. If B<CMS_USE_KEYID> is set it will use the subject key
73 identifier value instead. An error occurs if the signing certificate does not
74 have a subject key identifier extension.
75
76 If present the SMIMECapabilities attribute indicates support for the following
77 algorithms: triple DES, 128 bit RC2, 64 bit RC2, DES and 40 bit RC2. If any of
78 these algorithms is disabled then it will not be included.
79
80 CMS_sign_add_signers() returns an internal pointer to the CMS_SIGNER_INFO
81 structure just added, this can be used to set additional attributes 
82 before it is finalized.
83
84 =head1 RETURN VALUES
85
86 CMS_sign1_add_signers() returns an internal pointer to the CMS_SignerInfo
87 structure just added or NULL if an error occurs.
88
89 =head1 SEE ALSO
90
91 L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>,
92 L<CMS_final(3)|CMS_final(3)>,
93
94 =head1 HISTORY
95
96 PEM_sign_add_signer() was added to OpenSSL 0.9.9
97
98 =cut