build - Rewire secure, remove conflicts from libmd, libcrypt
[dragonfly.git] / lib / libcrypto / man / CMS_add1_signer.3
CommitLineData
1acffe94 1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
d95b477a
SW
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
35'br\}
36.el\{\
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
5a44c043
SW
41. ds C`
42. ds C'
d95b477a
SW
43'br\}
44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el .ds Aq '
48.\"
49.\" If the F register is turned on, we'll generate index entries on stderr for
50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51.\" entries marked with X<> in POD. Of course, you'll have to process the
52.\" output yourself in some meaningful fashion.
5a44c043
SW
53.\"
54.\" Avoid warning from groff about undefined register 'F'.
55.de IX
d95b477a 56..
5a44c043
SW
57.nr rF 0
58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
60. if \nF \{
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
d95b477a 63..
5a44c043
SW
64. if !\nF==2 \{
65. nr % 0
66. nr F 2
67. \}
68. \}
d95b477a 69.\}
5a44c043 70.rr rF
d95b477a
SW
71.\"
72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73.\" Fear. Run. Save yourself. No user-serviceable parts.
74. \" fudge factors for nroff and troff
75.if n \{\
76. ds #H 0
77. ds #V .8m
78. ds #F .3m
79. ds #[ \f1
80. ds #] \fP
81.\}
82.if t \{\
83. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84. ds #V .6m
85. ds #F 0
86. ds #[ \&
87. ds #] \&
88.\}
89. \" simple accents for nroff and troff
90.if n \{\
91. ds ' \&
92. ds ` \&
93. ds ^ \&
94. ds , \&
95. ds ~ ~
96. ds /
97.\}
98.if t \{\
99. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105.\}
106. \" troff and (daisy-wheel) nroff accents
107.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114.ds ae a\h'-(\w'a'u*4/10)'e
115.ds Ae A\h'-(\w'A'u*4/10)'E
116. \" corrections for vroff
117.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119. \" for low resolution devices (crt and lpr)
120.if \n(.H>23 .if \n(.V>19 \
121\{\
122. ds : e
123. ds 8 ss
124. ds o a
125. ds d- d\h'-1'\(ga
126. ds D- D\h'-1'\(hy
127. ds th \o'bp'
128. ds Th \o'LP'
129. ds ae ae
130. ds Ae AE
131.\}
132.rm #[ #] #H #V #F C
133.\" ========================================================================
134.\"
135.IX Title "CMS_add1_signer 3"
57eefc0b 136.TH CMS_add1_signer 3 "2016-05-03" "1.0.2h" "OpenSSL"
d95b477a
SW
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents.
139.if n .ad l
140.nh
141.SH "NAME"
142.Vb 1
143\& CMS_add1_signer, CMS_SignerInfo_sign \- add a signer to a CMS_ContentInfo signed data structure.
144.Ve
145.SH "SYNOPSIS"
146.IX Header "SYNOPSIS"
147.Vb 1
148\& #include <openssl/cms.h>
149\&
150\& CMS_SignerInfo *CMS_add1_signer(CMS_ContentInfo *cms, X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, unsigned int flags);
151\&
152\& int CMS_SignerInfo_sign(CMS_SignerInfo *si);
153.Ve
154.SH "DESCRIPTION"
155.IX Header "DESCRIPTION"
156\&\fICMS_add1_signer()\fR adds a signer with certificate \fBsigncert\fR and private
157key \fBpkey\fR using message digest \fBmd\fR to CMS_ContentInfo SignedData
158structure \fBcms\fR.
159.PP
160The CMS_ContentInfo structure should be obtained from an initial call to
161\&\fICMS_sign()\fR with the flag \fB\s-1CMS_PARTIAL\s0\fR set or in the case or re-signing a
162valid CMS_ContentInfo SignedData structure.
163.PP
164If the \fBmd\fR parameter is \fB\s-1NULL\s0\fR then the default digest for the public
165key algorithm will be used.
166.PP
167Unless the \fB\s-1CMS_REUSE_DIGEST\s0\fR flag is set the returned CMS_ContentInfo
168structure is not complete and must be finalized either by streaming (if
169applicable) or a call to \fICMS_final()\fR.
170.PP
171The \fICMS_SignerInfo_sign()\fR function will explicitly sign a CMS_SignerInfo
172structure, its main use is when \fB\s-1CMS_REUSE_DIGEST\s0\fR and \fB\s-1CMS_PARTIAL\s0\fR flags
173are both set.
174.SH "NOTES"
175.IX Header "NOTES"
176The main purpose of \fICMS_add1_signer()\fR is to provide finer control
177over a \s-1CMS\s0 signed data structure where the simpler \fICMS_sign()\fR function defaults
178are not appropriate. For example if multiple signers or non default digest
179algorithms are needed. New attributes can also be added using the returned
180CMS_SignerInfo structure and the \s-1CMS\s0 attribute utility functions or the
181\&\s-1CMS\s0 signed receipt request functions.
182.PP
183Any of the following flags (ored together) can be passed in the \fBflags\fR
184parameter.
185.PP
186If \fB\s-1CMS_REUSE_DIGEST\s0\fR is set then an attempt is made to copy the content
187digest value from the CMS_ContentInfo structure: to add a signer to an existing
188structure. An error occurs if a matching digest value cannot be found to copy.
189The returned CMS_ContentInfo structure will be valid and finalized when this
190flag is set.
191.PP
192If \fB\s-1CMS_PARTIAL\s0\fR is set in addition to \fB\s-1CMS_REUSE_DIGEST\s0\fR then the
193CMS_SignerInfo structure will not be finalized so additional attributes
194can be added. In this case an explicit call to \fICMS_SignerInfo_sign()\fR is
195needed to finalize it.
196.PP
197If \fB\s-1CMS_NOCERTS\s0\fR is set the signer's certificate will not be included in the
198CMS_ContentInfo structure, the signer's certificate must still be supplied in
199the \fBsigncert\fR parameter though. This can reduce the size of the signature if
200the signers certificate can be obtained by other means: for example a
201previously signed message.
202.PP
203The SignedData structure includes several \s-1CMS\s0 signedAttributes including the
204signing time, the \s-1CMS\s0 content type and the supported list of ciphers in an
205SMIMECapabilities attribute. If \fB\s-1CMS_NOATTR\s0\fR is set then no signedAttributes
206will be used. If \fB\s-1CMS_NOSMIMECAP\s0\fR is set then just the SMIMECapabilities are
207omitted.
208.PP
209OpenSSL will by default identify signing certificates using issuer name
210and serial number. If \fB\s-1CMS_USE_KEYID\s0\fR is set it will use the subject key
211identifier value instead. An error occurs if the signing certificate does not
212have a subject key identifier extension.
213.PP
214If present the SMIMECapabilities attribute indicates support for the following
5a44c043
SW
215algorithms in preference order: 256 bit \s-1AES,\s0 Gost R3411\-94, Gost 28147\-89, 192
216bit \s-1AES, 128\s0 bit \s-1AES,\s0 triple \s-1DES, 128\s0 bit \s-1RC2, 64\s0 bit \s-1RC2, DES\s0 and 40 bit \s-1RC2.\s0
217If any of these algorithms is not available then it will not be included: for example the \s-1GOST\s0 algorithms will not be included if the \s-1GOST ENGINE\s0 is
d95b477a
SW
218not loaded.
219.PP
220\&\fICMS_add1_signer()\fR returns an internal pointer to the CMS_SignerInfo
221structure just added, this can be used to set additional attributes
222before it is finalized.
223.SH "RETURN VALUES"
224.IX Header "RETURN VALUES"
225\&\fICMS_add1_signer()\fR returns an internal pointer to the CMS_SignerInfo
226structure just added or \s-1NULL\s0 if an error occurs.
227.SH "SEE ALSO"
228.IX Header "SEE ALSO"
229\&\fIERR_get_error\fR\|(3), \fICMS_sign\fR\|(3),
230\&\fICMS_final\fR\|(3),
231.SH "HISTORY"
232.IX Header "HISTORY"
233\&\fICMS_add1_signer()\fR was added to OpenSSL 0.9.8