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