secure/lib/libcrypto/man/X509_STORE_CTX_set_verify_cb.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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 >0, 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 "2019-09-10" "1.1.1d" "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_get_cleanup, X509_STORE_CTX_get_lookup_crls, X509_STORE_CTX_get_lookup_certs, X509_STORE_CTX_get_check_policy, X509_STORE_CTX_get_cert_crl, X509_STORE_CTX_get_check_crl, X509_STORE_CTX_get_get_crl, X509_STORE_CTX_get_check_revocation, X509_STORE_CTX_get_check_issued, X509_STORE_CTX_get_get_issuer, X509_STORE_CTX_get_verify_cb, X509_STORE_CTX_set_verify_cb, X509_STORE_CTX_verify_cb \&\- get and set verification callback
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/x509_vfy.h>
 147 \&
 148 \& typedef int (*X509_STORE_CTX_verify_cb)(int, X509_STORE_CTX *);
 149 \&
 150 \& X509_STORE_CTX_verify_cb X509_STORE_CTX_get_verify_cb(X509_STORE_CTX *ctx);
 151 \&
 152 \& void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX *ctx,
 153 \&                                   X509_STORE_CTX_verify_cb verify_cb);
 154 \&
 155 \& X509_STORE_CTX_get_issuer_fn X509_STORE_CTX_get_get_issuer(X509_STORE_CTX *ctx);
 156 \& X509_STORE_CTX_check_issued_fn X509_STORE_CTX_get_check_issued(X509_STORE_CTX *ctx);
 157 \& X509_STORE_CTX_check_revocation_fn X509_STORE_CTX_get_check_revocation(X509_STORE_CTX *ctx);
 158 \& X509_STORE_CTX_get_crl_fn X509_STORE_CTX_get_get_crl(X509_STORE_CTX *ctx);
 159 \& X509_STORE_CTX_check_crl_fn X509_STORE_CTX_get_check_crl(X509_STORE_CTX *ctx);
 160 \& X509_STORE_CTX_cert_crl_fn X509_STORE_CTX_get_cert_crl(X509_STORE_CTX *ctx);
 161 \& X509_STORE_CTX_check_policy_fn X509_STORE_CTX_get_check_policy(X509_STORE_CTX *ctx);
 162 \& X509_STORE_CTX_lookup_certs_fn X509_STORE_CTX_get_lookup_certs(X509_STORE_CTX *ctx);
 163 \& X509_STORE_CTX_lookup_crls_fn X509_STORE_CTX_get_lookup_crls(X509_STORE_CTX *ctx);
 164 \& X509_STORE_CTX_cleanup_fn X509_STORE_CTX_get_cleanup(X509_STORE_CTX *ctx);
 165 .Ve
 166 .SH "DESCRIPTION"
 167 .IX Header "DESCRIPTION"
 168 \&\fBX509_STORE_CTX_set_verify_cb()\fR sets the verification callback of \fBctx\fR to
 169 \&\fBverify_cb\fR overwriting any existing callback.
 170 .PP
 171 The verification callback can be used to customise the operation of certificate
 172 verification, either by overriding error conditions or logging errors for
 173 debugging purposes.
 174 .PP
 175 However a verification callback is \fBnot\fR essential and the default operation
 176 is often sufficient.
 177 .PP
 178 The \fBok\fR parameter to the callback indicates the value the callback should
 179 return to retain the default behaviour. If it is zero then an error condition
 180 is indicated. If it is 1 then no error occurred. If the flag
 181 \&\fBX509_V_FLAG_NOTIFY_POLICY\fR is set then \fBok\fR is set to 2 to indicate the
 182 policy checking is complete.
 183 .PP
 184 The \fBctx\fR parameter to the callback is the \fBX509_STORE_CTX\fR structure that
 185 is performing the verification operation. A callback can examine this
 186 structure and receive additional information about the error, for example
 187 by calling \fBX509_STORE_CTX_get_current_cert()\fR. Additional application data can
 188 be passed to the callback via the \fBex_data\fR mechanism.
 189 .PP
 190 \&\fBX509_STORE_CTX_get_verify_cb()\fR returns the value of the current callback
 191 for the specific \fBctx\fR.
 192 .PP
 193 \&\fBX509_STORE_CTX_get_get_issuer()\fR,
 194 \&\fBX509_STORE_CTX_get_check_issued()\fR, \fBX509_STORE_CTX_get_check_revocation()\fR,
 195 \&\fBX509_STORE_CTX_get_get_crl()\fR, \fBX509_STORE_CTX_get_check_crl()\fR,
 196 \&\fBX509_STORE_CTX_get_cert_crl()\fR, \fBX509_STORE_CTX_get_check_policy()\fR,
 197 \&\fBX509_STORE_CTX_get_lookup_certs()\fR, \fBX509_STORE_CTX_get_lookup_crls()\fR
 198 and \fBX509_STORE_CTX_get_cleanup()\fR return the function pointers cached
 199 from the corresponding \fBX509_STORE\fR, please see
 200 \&\fBX509_STORE_set_verify\fR\|(3) for more information.
 201 .SH "WARNINGS"
 202 .IX Header "WARNINGS"
 203 In general a verification callback should \fB\s-1NOT\s0\fR unconditionally return 1 in
 204 all circumstances because this will allow verification to succeed no matter
 205 what the error. This effectively removes all security from the application
 206 because \fBany\fR certificate (including untrusted generated ones) will be
 207 accepted.
 208 .SH "NOTES"
 209 .IX Header "NOTES"
 210 The verification callback can be set and inherited from the parent structure
 211 performing the operation. In some cases (such as S/MIME verification) the
 212 \&\fBX509_STORE_CTX\fR structure is created and destroyed internally and the
 213 only way to set a custom verification callback is by inheriting it from the
 214 associated \fBX509_STORE\fR.
 215 .SH "RETURN VALUES"
 216 .IX Header "RETURN VALUES"
 217 \&\fBX509_STORE_CTX_set_verify_cb()\fR does not return a value.
 218 .SH "EXAMPLES"
 219 .IX Header "EXAMPLES"
 220 Default callback operation:
 221 .PP
 222 .Vb 3
 223 \& int verify_callback(int ok, X509_STORE_CTX *ctx) {
 224 \&     return ok;
 225 \& }
 226 .Ve
 227 .PP
 228 Simple example, suppose a certificate in the chain is expired and we wish
 229 to continue after this error:
 230 .PP
 231 .Vb 7
 232 \& int verify_callback(int ok, X509_STORE_CTX *ctx) {
 233 \&     /* Tolerate certificate expiration */
 234 \&     if (X509_STORE_CTX_get_error(ctx) == X509_V_ERR_CERT_HAS_EXPIRED)
 235 \&         return 1;
 236 \&     /* Otherwise don\*(Aqt override */
 237 \&     return ok;
 238 \& }
 239 .Ve
 240 .PP
 241 More complex example, we don't wish to continue after \fBany\fR certificate has
 242 expired just one specific case:
 243 .PP
 244 .Vb 4
 245 \& int verify_callback(int ok, X509_STORE_CTX *ctx)
 246 \& {
 247 \&     int err = X509_STORE_CTX_get_error(ctx);
 248 \&     X509 *err_cert = X509_STORE_CTX_get_current_cert(ctx);
 249 \&
 250 \&     if (err == X509_V_ERR_CERT_HAS_EXPIRED) {
 251 \&         if (check_is_acceptable_expired_cert(err_cert)
 252 \&             return 1;
 253 \&     }
 254 \&     return ok;
 255 \& }
 256 .Ve
 257 .PP
 258 Full featured logging callback. In this case the \fBbio_err\fR is assumed to be
 259 a global logging \fB\s-1BIO\s0\fR, an alternative would to store a \s-1BIO\s0 in \fBctx\fR using
 260 \&\fBex_data\fR.
 261 .PP
 262 .Vb 4
 263 \& int verify_callback(int ok, X509_STORE_CTX *ctx)
 264 \& {
 265 \&     X509 *err_cert;
 266 \&     int err, depth;
 267 \&
 268 \&     err_cert = X509_STORE_CTX_get_current_cert(ctx);
 269 \&     err = X509_STORE_CTX_get_error(ctx);
 270 \&     depth = X509_STORE_CTX_get_error_depth(ctx);
 271 \&
 272 \&     BIO_printf(bio_err, "depth=%d ", depth);
 273 \&     if (err_cert) {
 274 \&         X509_NAME_print_ex(bio_err, X509_get_subject_name(err_cert),
 275 \&                            0, XN_FLAG_ONELINE);
 276 \&         BIO_puts(bio_err, "\en");
 277 \&     }
 278 \&     else
 279 \&         BIO_puts(bio_err, "<no cert>\en");
 280 \&     if (!ok)
 281 \&         BIO_printf(bio_err, "verify error:num=%d:%s\en", err,
 282 \&                    X509_verify_cert_error_string(err));
 283 \&     switch (err) {
 284 \&     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
 285 \&         BIO_puts(bio_err, "issuer= ");
 286 \&         X509_NAME_print_ex(bio_err, X509_get_issuer_name(err_cert),
 287 \&                            0, XN_FLAG_ONELINE);
 288 \&         BIO_puts(bio_err, "\en");
 289 \&         break;
 290 \&     case X509_V_ERR_CERT_NOT_YET_VALID:
 291 \&     case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
 292 \&         BIO_printf(bio_err, "notBefore=");
 293 \&         ASN1_TIME_print(bio_err, X509_get_notBefore(err_cert));
 294 \&         BIO_printf(bio_err, "\en");
 295 \&         break;
 296 \&     case X509_V_ERR_CERT_HAS_EXPIRED:
 297 \&     case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
 298 \&         BIO_printf(bio_err, "notAfter=");
 299 \&         ASN1_TIME_print(bio_err, X509_get_notAfter(err_cert));
 300 \&         BIO_printf(bio_err, "\en");
 301 \&         break;
 302 \&     case X509_V_ERR_NO_EXPLICIT_POLICY:
 303 \&         policies_print(bio_err, ctx);
 304 \&         break;
 305 \&     }
 306 \&     if (err == X509_V_OK && ok == 2)
 307 \&         /* print out policies */
 308 \&
 309 \&     BIO_printf(bio_err, "verify return:%d\en", ok);
 310 \&     return(ok);
 311 \& }
 312 .Ve
 313 .SH "SEE ALSO"
 314 .IX Header "SEE ALSO"
 315 \&\fBX509_STORE_CTX_get_error\fR\|(3)
 316 \&\fBX509_STORE_set_verify_cb_func\fR\|(3)
 317 \&\fBX509_STORE_CTX_get_ex_new_index\fR\|(3)
 318 .SH "HISTORY"
 319 .IX Header "HISTORY"
 320 The
 321 \&\fBX509_STORE_CTX_get_get_issuer()\fR,
 322 \&\fBX509_STORE_CTX_get_check_issued()\fR, \fBX509_STORE_CTX_get_check_revocation()\fR,
 323 \&\fBX509_STORE_CTX_get_get_crl()\fR, \fBX509_STORE_CTX_get_check_crl()\fR,
 324 \&\fBX509_STORE_CTX_get_cert_crl()\fR, \fBX509_STORE_CTX_get_check_policy()\fR,
 325 \&\fBX509_STORE_CTX_get_lookup_certs()\fR, \fBX509_STORE_CTX_get_lookup_crls()\fR
 326 and \fBX509_STORE_CTX_get_cleanup()\fR functions were added in OpenSSL 1.1.0.
 327 .SH "COPYRIGHT"
 328 .IX Header "COPYRIGHT"
 329 Copyright 2009\-2019 The OpenSSL Project Authors. All Rights Reserved.
 330 .PP
 331 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 332 this file except in compliance with the License.  You can obtain a copy
 333 in the file \s-1LICENSE\s0 in the source distribution or at
 334 <https://www.openssl.org/source/license.html>.