304e27102a5aeebee528f971193f3ce26cfd584f
[dragonfly.git] / secure / lib / libcrypto / man / CMS_verify.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
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" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "CMS_verify 3"
127 .TH CMS_verify 3 "2012-04-19" "1.0.1a" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 .Vb 1
134 \& CMS_verify \- verify a CMS SignedData structure
135 .Ve
136 .SH "SYNOPSIS"
137 .IX Header "SYNOPSIS"
138 .Vb 1
139 \& #include <openssl/cms.h>
140 \&
141 \& int CMS_verify(CMS_ContentInfo *cms, STACK_OF(X509) *certs, X509_STORE *store, BIO *indata, BIO *out, unsigned int flags);
142 \&
143 \& STACK_OF(X509) *CMS_get0_signers(CMS_ContentInfo *cms);
144 .Ve
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 \&\fICMS_verify()\fR verifies a \s-1CMS\s0 SignedData structure. \fBcms\fR is the CMS_ContentInfo
148 structure to verify. \fBcerts\fR is a set of certificates in which to search for
149 the signing certificate(s). \fBstore\fR is a trusted certificate store used for
150 chain verification. \fBindata\fR is the detached content if the content is not
151 present in \fBcms\fR. The content is written to \fBout\fR if it is not \s-1NULL\s0.
152 .PP
153 \&\fBflags\fR is an optional set of flags, which can be used to modify the verify
154 operation.
155 .PP
156 \&\fICMS_get0_signers()\fR retrieves the signing certificate(s) from \fBcms\fR, it must
157 be called after a successful \fICMS_verify()\fR operation.
158 .SH "VERIFY PROCESS"
159 .IX Header "VERIFY PROCESS"
160 Normally the verify process proceeds as follows.
161 .PP
162 Initially some sanity checks are performed on \fBcms\fR. The type of \fBcms\fR must
163 be SignedData. There must be at least one signature on the data and if
164 the content is detached \fBindata\fR cannot be \fB\s-1NULL\s0\fR.
165 .PP
166 An attempt is made to locate all the signing certificate(s), first looking in
167 the \fBcerts\fR parameter (if it is not \s-1NULL\s0) and then looking in any
168 certificates contained in the \fBcms\fR structure itself. If any signing
169 certificate cannot be located the operation fails.
170 .PP
171 Each signing certificate is chain verified using the \fBsmimesign\fR purpose and
172 the supplied trusted certificate store. Any internal certificates in the message
173 are used as untrusted CAs. If \s-1CRL\s0 checking is enabled in \fBstore\fR any internal
174 CRLs are used in addition to attempting to look them up in \fBstore\fR. If any
175 chain verify fails an error code is returned.
176 .PP
177 Finally the signed content is read (and written to \fBout\fR is it is not \s-1NULL\s0)
178 and the signature's checked.
179 .PP
180 If all signature's verify correctly then the function is successful.
181 .PP
182 Any of the following flags (ored together) can be passed in the \fBflags\fR
183 parameter to change the default verify behaviour.
184 .PP
185 If \fB\s-1CMS_NOINTERN\s0\fR is set the certificates in the message itself are not
186 searched when locating the signing certificate(s). This means that all the
187 signing certificates must be in the \fBcerts\fR parameter.
188 .PP
189 If \fB\s-1CMS_NOCRL\s0\fR is set and \s-1CRL\s0 checking is enabled in \fBstore\fR then any
190 CRLs in the message itself are ignored.
191 .PP
192 If the \fB\s-1CMS_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are deleted
193 from the content. If the content is not of type \fBtext/plain\fR then an error is
194 returned.
195 .PP
196 If \fB\s-1CMS_NO_SIGNER_CERT_VERIFY\s0\fR is set the signing certificates are not
197 verified.
198 .PP
199 If \fB\s-1CMS_NO_ATTR_VERIFY\s0\fR is set the signed attributes signature is not 
200 verified.
201 .PP
202 If \fB\s-1CMS_NO_CONTENT_VERIFY\s0\fR is set then the content digest is not checked.
203 .SH "NOTES"
204 .IX Header "NOTES"
205 One application of \fB\s-1CMS_NOINTERN\s0\fR is to only accept messages signed by
206 a small number of certificates. The acceptable certificates would be passed
207 in the \fBcerts\fR parameter. In this case if the signer is not one of the
208 certificates supplied in \fBcerts\fR then the verify will fail because the
209 signer cannot be found.
210 .PP
211 In some cases the standard techniques for looking up and validating
212 certificates are not appropriate: for example an application may wish to 
213 lookup certificates in a database or perform customised verification. This
214 can be achieved by setting and verifying the signers certificates manually 
215 using the signed data utility functions.
216 .PP
217 Care should be taken when modifying the default verify behaviour, for example
218 setting \fB\s-1CMS_NO_CONTENT_VERIFY\s0\fR will totally disable all content verification 
219 and any modified content will be considered valid. This combination is however
220 useful if one merely wishes to write the content to \fBout\fR and its validity
221 is not considered important.
222 .PP
223 Chain verification should arguably be performed using the signing time rather
224 than the current time. However since the signing time is supplied by the
225 signer it cannot be trusted without additional evidence (such as a trusted
226 timestamp).
227 .SH "RETURN VALUES"
228 .IX Header "RETURN VALUES"
229 \&\fICMS_verify()\fR returns 1 for a successful verification and zero if an error
230 occurred.
231 .PP
232 \&\fICMS_get0_signers()\fR returns all signers or \s-1NULL\s0 if an error occurred.
233 .PP
234 The error can be obtained from \fIERR_get_error\fR\|(3)
235 .SH "BUGS"
236 .IX Header "BUGS"
237 The trusted certificate store is not searched for the signing certificate,
238 this is primarily due to the inadequacies of the current \fBX509_STORE\fR
239 functionality.
240 .PP
241 The lack of single pass processing means that the signed content must all
242 be held in memory if it is not detached.
243 .SH "SEE ALSO"
244 .IX Header "SEE ALSO"
245 \&\fIERR_get_error\fR\|(3), \fICMS_sign\fR\|(3)
246 .SH "HISTORY"
247 .IX Header "HISTORY"
248 \&\fICMS_verify()\fR was added to OpenSSL 0.9.8