Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / X509_STORE_CTX_set_verify_cb.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 "X509_STORE_CTX_set_verify_cb 3"
127 .TH X509_STORE_CTX_set_verify_cb 3 "2012-01-04" "1.0.0f" "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 X509_STORE_CTX_set_verify_cb \- set verification callback
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/x509_vfy.h>
138 \&
139 \& void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX *ctx,
140 \&                                int (*verify_cb)(int ok, X509_STORE_CTX *ctx));
141 .Ve
142 .SH "DESCRIPTION"
143 .IX Header "DESCRIPTION"
144 \&\fIX509_STORE_CTX_set_verify_cb()\fR sets the verification callback of \fBctx\fR to
145 \&\fBverify_cb\fR overwriting any existing callback.
146 .PP
147 The verification callback can be used to customise the operation of certificate
148 verification, either by overriding error conditions or logging errors for
149 debugging purposes.
150 .PP
151 However a verification callback is \fBnot\fR essential and the default operation
152 is often sufficient.
153 .PP
154 The \fBok\fR parameter to the callback indicates the value the callback should
155 return to retain the default behaviour. If it is zero then and error condition
156 is indicated. If it is 1 then no error occurred. If the flag
157 \&\fBX509_V_FLAG_NOTIFY_POLICY\fR is set then \fBok\fR is set to 2 to indicate the
158 policy checking is complete.
159 .PP
160 The \fBctx\fR parameter to the callback is the \fBX509_STORE_CTX\fR structure that
161 is performing the verification operation. A callback can examine this
162 structure and receive additional information about the error, for example
163 by calling \fIX509_STORE_CTX_get_current_cert()\fR. Additional application data can
164 be passed to the callback via the \fBex_data\fR mechanism.
165 .SH "WARNING"
166 .IX Header "WARNING"
167 In general a verification callback should \fB\s-1NOT\s0\fR unconditionally return 1 in
168 all circumstances because this will allow verification to succeed no matter
169 what the error. This effectively removes all security from the application
170 because \fBany\fR certificate (including untrusted generated ones) will be
171 accepted.
172 .SH "NOTES"
173 .IX Header "NOTES"
174 The verification callback can be set and inherited from the parent structure
175 performing the operation. In some cases (such as S/MIME verification) the
176 \&\fBX509_STORE_CTX\fR structure is created and destroyed internally and the
177 only way to set a custom verification callback is by inheriting it from the
178 associated \fBX509_STORE\fR.
179 .SH "RETURN VALUES"
180 .IX Header "RETURN VALUES"
181 \&\fIX509_STORE_CTX_set_verify_cb()\fR does not return a value.
182 .SH "EXAMPLES"
183 .IX Header "EXAMPLES"
184 Default callback operation:
185 .PP
186 .Vb 4
187 \& int verify_callback(int ok, X509_STORE_CTX *ctx)
188 \&        {
189 \&        return ok;
190 \&        }
191 .Ve
192 .PP
193 Simple example, suppose a certificate in the chain is expired and we wish
194 to continue after this error:
195 .PP
196 .Vb 8
197 \& int verify_callback(int ok, X509_STORE_CTX *ctx)
198 \&        {
199 \&        /* Tolerate certificate expiration */
200 \&        if (X509_STORE_CTX_get_error(ctx) == X509_V_ERR_CERT_HAS_EXPIRED)
201 \&                        return 1;
202 \&        /* Otherwise don\*(Aqt override */
203 \&        return ok;
204 \&        }
205 .Ve
206 .PP
207 More complex example, we don't wish to continue after \fBany\fR certificate has
208 expired just one specific case:
209 .PP
210 .Vb 11
211 \& int verify_callback(int ok, X509_STORE_CTX *ctx)
212 \&        {
213 \&        int err = X509_STORE_CTX_get_error(ctx);
214 \&        X509 *err_cert = X509_STORE_CTX_get_current_cert(ctx);
215 \&        if (err == X509_V_ERR_CERT_HAS_EXPIRED)
216 \&                {
217 \&                if (check_is_acceptable_expired_cert(err_cert)
218 \&                        return 1;
219 \&                }
220 \&        return ok;
221 \&        }
222 .Ve
223 .PP
224 Full featured logging callback. In this case the \fBbio_err\fR is assumed to be
225 a global logging \fB\s-1BIO\s0\fR, an alternative would to store a \s-1BIO\s0 in \fBctx\fR using
226 \&\fBex_data\fR.
227 .PP
228 .Vb 4
229 \& int verify_callback(int ok, X509_STORE_CTX *ctx)
230 \&        {
231 \&        X509 *err_cert;
232 \&        int err,depth;
233 \&
234 \&        err_cert = X509_STORE_CTX_get_current_cert(ctx);
235 \&        err =   X509_STORE_CTX_get_error(ctx);
236 \&        depth = X509_STORE_CTX_get_error_depth(ctx);
237 \&
238 \&        BIO_printf(bio_err,"depth=%d ",depth);
239 \&        if (err_cert)
240 \&                {
241 \&                X509_NAME_print_ex(bio_err, X509_get_subject_name(err_cert),
242 \&                                        0, XN_FLAG_ONELINE);
243 \&                BIO_puts(bio_err, "\en");
244 \&                }
245 \&        else
246 \&                BIO_puts(bio_err, "<no cert>\en");
247 \&        if (!ok)
248 \&                BIO_printf(bio_err,"verify error:num=%d:%s\en",err,
249 \&                        X509_verify_cert_error_string(err));
250 \&        switch (err)
251 \&                {
252 \&        case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
253 \&                BIO_puts(bio_err,"issuer= ");
254 \&                X509_NAME_print_ex(bio_err, X509_get_issuer_name(err_cert),
255 \&                                        0, XN_FLAG_ONELINE);
256 \&                BIO_puts(bio_err, "\en");
257 \&                break;
258 \&        case X509_V_ERR_CERT_NOT_YET_VALID:
259 \&        case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
260 \&                BIO_printf(bio_err,"notBefore=");
261 \&                ASN1_TIME_print(bio_err,X509_get_notBefore(err_cert));
262 \&                BIO_printf(bio_err,"\en");
263 \&                break;
264 \&        case X509_V_ERR_CERT_HAS_EXPIRED:
265 \&        case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
266 \&                BIO_printf(bio_err,"notAfter=");
267 \&                ASN1_TIME_print(bio_err,X509_get_notAfter(err_cert));
268 \&                BIO_printf(bio_err,"\en");
269 \&                break;
270 \&        case X509_V_ERR_NO_EXPLICIT_POLICY:
271 \&                policies_print(bio_err, ctx);
272 \&                break;
273 \&                }
274 \&        if (err == X509_V_OK && ok == 2)
275 \&                /* print out policies */
276 \&
277 \&        BIO_printf(bio_err,"verify return:%d\en",ok);
278 \&        return(ok);
279 \&        }
280 .Ve
281 .SH "SEE ALSO"
282 .IX Header "SEE ALSO"
283 \&\fIX509_STORE_CTX_get_error\fR\|(3)
284 \&\fIX509_STORE_set_verify_cb_func\fR\|(3)
285 \&\fIX509_STORE_CTX_get_ex_new_index\fR\|(3)
286 .SH "HISTORY"
287 .IX Header "HISTORY"
288 \&\fIX509_STORE_CTX_set_verify_cb()\fR is available in all versions of SSLeay and
289 OpenSSL.