secure/lib/libcrypto/man/man3/X509_STORE_set_verify_cb_func.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   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_SET_VERIFY_CB_FUNC 3"
 136 .TH X509_STORE_SET_VERIFY_CB_FUNC 3 "2022-05-03" "1.1.1o" "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_set_lookup_crls_cb, X509_STORE_set_verify_func, X509_STORE_get_cleanup, X509_STORE_set_cleanup, X509_STORE_get_lookup_crls, X509_STORE_set_lookup_crls, X509_STORE_get_lookup_certs, X509_STORE_set_lookup_certs, X509_STORE_get_check_policy, X509_STORE_set_check_policy, X509_STORE_get_cert_crl, X509_STORE_set_cert_crl, X509_STORE_get_check_crl, X509_STORE_set_check_crl, X509_STORE_get_get_crl, X509_STORE_set_get_crl, X509_STORE_get_check_revocation, X509_STORE_set_check_revocation, X509_STORE_get_check_issued, X509_STORE_set_check_issued, X509_STORE_get_get_issuer, X509_STORE_set_get_issuer, X509_STORE_CTX_get_verify, X509_STORE_set_verify, X509_STORE_get_verify_cb, X509_STORE_set_verify_cb_func, X509_STORE_set_verify_cb, X509_STORE_CTX_cert_crl_fn, X509_STORE_CTX_check_crl_fn, X509_STORE_CTX_check_issued_fn, X509_STORE_CTX_check_policy_fn, X509_STORE_CTX_check_revocation_fn, X509_STORE_CTX_cleanup_fn, X509_STORE_CTX_get_crl_fn, X509_STORE_CTX_get_issuer_fn, X509_STORE_CTX_lookup_certs_fn, X509_STORE_CTX_lookup_crls_fn \&\- 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_get_issuer_fn)(X509 **issuer,
 149 \&                                             X509_STORE_CTX *ctx, X509 *x);
 150 \& typedef int (*X509_STORE_CTX_check_issued_fn)(X509_STORE_CTX *ctx,
 151 \&                                               X509 *x, X509 *issuer);
 152 \& typedef int (*X509_STORE_CTX_check_revocation_fn)(X509_STORE_CTX *ctx);
 153 \& typedef int (*X509_STORE_CTX_get_crl_fn)(X509_STORE_CTX *ctx,
 154 \&                                          X509_CRL **crl, X509 *x);
 155 \& typedef int (*X509_STORE_CTX_check_crl_fn)(X509_STORE_CTX *ctx, X509_CRL *crl);
 156 \& typedef int (*X509_STORE_CTX_cert_crl_fn)(X509_STORE_CTX *ctx,
 157 \&                                           X509_CRL *crl, X509 *x);
 158 \& typedef int (*X509_STORE_CTX_check_policy_fn)(X509_STORE_CTX *ctx);
 159 \& typedef STACK_OF(X509) *(*X509_STORE_CTX_lookup_certs_fn)(X509_STORE_CTX *ctx,
 160 \&                                                           X509_NAME *nm);
 161 \& typedef STACK_OF(X509_CRL) *(*X509_STORE_CTX_lookup_crls_fn)(X509_STORE_CTX *ctx,
 162 \&                                                              X509_NAME *nm);
 163 \& typedef int (*X509_STORE_CTX_cleanup_fn)(X509_STORE_CTX *ctx);
 164 \&
 165 \& void X509_STORE_set_verify_cb(X509_STORE *ctx,
 166 \&                               X509_STORE_CTX_verify_cb verify_cb);
 167 \& X509_STORE_CTX_verify_cb X509_STORE_get_verify_cb(X509_STORE_CTX *ctx);
 168 \&
 169 \& void X509_STORE_set_verify(X509_STORE *ctx, X509_STORE_CTX_verify_fn verify);
 170 \& X509_STORE_CTX_verify_fn X509_STORE_CTX_get_verify(X509_STORE_CTX *ctx);
 171 \&
 172 \& void X509_STORE_set_get_issuer(X509_STORE *ctx,
 173 \&                                X509_STORE_CTX_get_issuer_fn get_issuer);
 174 \& X509_STORE_CTX_get_issuer_fn X509_STORE_get_get_issuer(X509_STORE_CTX *ctx);
 175 \&
 176 \& void X509_STORE_set_check_issued(X509_STORE *ctx,
 177 \&                                  X509_STORE_CTX_check_issued_fn check_issued);
 178 \& X509_STORE_CTX_check_issued_fn X509_STORE_get_check_issued(X509_STORE_CTX *ctx);
 179 \&
 180 \& void X509_STORE_set_check_revocation(X509_STORE *ctx,
 181 \&                                      X509_STORE_CTX_check_revocation_fn check_revocation);
 182 \& X509_STORE_CTX_check_revocation_fn X509_STORE_get_check_revocation(X509_STORE_CTX *ctx);
 183 \&
 184 \& void X509_STORE_set_get_crl(X509_STORE *ctx,
 185 \&                             X509_STORE_CTX_get_crl_fn get_crl);
 186 \& X509_STORE_CTX_get_crl_fn X509_STORE_get_get_crl(X509_STORE_CTX *ctx);
 187 \&
 188 \& void X509_STORE_set_check_crl(X509_STORE *ctx,
 189 \&                               X509_STORE_CTX_check_crl_fn check_crl);
 190 \& X509_STORE_CTX_check_crl_fn X509_STORE_get_check_crl(X509_STORE_CTX *ctx);
 191 \&
 192 \& void X509_STORE_set_cert_crl(X509_STORE *ctx,
 193 \&                              X509_STORE_CTX_cert_crl_fn cert_crl);
 194 \& X509_STORE_CTX_cert_crl_fn X509_STORE_get_cert_crl(X509_STORE_CTX *ctx);
 195 \&
 196 \& void X509_STORE_set_check_policy(X509_STORE *ctx,
 197 \&                                  X509_STORE_CTX_check_policy_fn check_policy);
 198 \& X509_STORE_CTX_check_policy_fn X509_STORE_get_check_policy(X509_STORE_CTX *ctx);
 199 \&
 200 \& void X509_STORE_set_lookup_certs(X509_STORE *ctx,
 201 \&                                  X509_STORE_CTX_lookup_certs_fn lookup_certs);
 202 \& X509_STORE_CTX_lookup_certs_fn X509_STORE_get_lookup_certs(X509_STORE_CTX *ctx);
 203 \&
 204 \& void X509_STORE_set_lookup_crls(X509_STORE *ctx,
 205 \&                                 X509_STORE_CTX_lookup_crls_fn lookup_crls);
 206 \& X509_STORE_CTX_lookup_crls_fn X509_STORE_get_lookup_crls(X509_STORE_CTX *ctx);
 207 \&
 208 \& void X509_STORE_set_cleanup(X509_STORE *ctx,
 209 \&                             X509_STORE_CTX_cleanup_fn cleanup);
 210 \& X509_STORE_CTX_cleanup_fn X509_STORE_get_cleanup(X509_STORE_CTX *ctx);
 211 \&
 212 \& /* Aliases */
 213 \& void X509_STORE_set_verify_cb_func(X509_STORE *st,
 214 \&                                    X509_STORE_CTX_verify_cb verify_cb);
 215 \& void X509_STORE_set_verify_func(X509_STORE *ctx,
 216 \&                                 X509_STORE_CTX_verify_fn verify);
 217 \& void X509_STORE_set_lookup_crls_cb(X509_STORE *ctx,
 218 \&                                    X509_STORE_CTX_lookup_crls_fn lookup_crls);
 219 .Ve
 220 .SH "DESCRIPTION"
 221 .IX Header "DESCRIPTION"
 222 \&\fBX509_STORE_set_verify_cb()\fR sets the verification callback of \fBctx\fR to
 223 \&\fBverify_cb\fR overwriting the previous callback.
 224 The callback assigned with this function becomes a default for the one
 225 that can be assigned directly to the corresponding \fBX509_STORE_CTX\fR,
 226 please see \fBX509_STORE_CTX_set_verify_cb\fR\|(3) for further information.
 227 .PP
 228 \&\fBX509_STORE_set_verify()\fR sets the final chain verification function for
 229 \&\fBctx\fR to \fBverify\fR.
 230 Its purpose is to go through the chain of certificates and check that
 231 all signatures are valid and that the current time is within the
 232 limits of each certificate's first and last validity time.
 233 The final chain verification functions must return 0 on failure and 1
 234 on success.
 235 \&\fIIf no chain verification function is provided, the internal default
 236 function will be used instead.\fR
 237 .PP
 238 \&\fBX509_STORE_set_get_issuer()\fR sets the function to get the issuer
 239 certificate that verifies the given certificate \fBx\fR.
 240 When found, the issuer certificate must be assigned to \fB*issuer\fR.
 241 This function must return 0 on failure and 1 on success.
 242 \&\fIIf no function to get the issuer is provided, the internal default
 243 function will be used instead.\fR
 244 .PP
 245 \&\fBX509_STORE_set_check_issued()\fR sets the function to check that a given
 246 certificate \fBx\fR is issued by the issuer certificate \fBissuer\fR.
 247 This function must return 0 on failure (among others if \fBx\fR hasn't
 248 been issued with \fBissuer\fR) and 1 on success.
 249 \&\fIIf no function to get the issuer is provided, the internal default
 250 function will be used instead.\fR
 251 .PP
 252 \&\fBX509_STORE_set_check_revocation()\fR sets the revocation checking
 253 function.
 254 Its purpose is to look through the final chain and check the
 255 revocation status for each certificate.
 256 It must return 0 on failure and 1 on success.
 257 \&\fIIf no function to get the issuer is provided, the internal default
 258 function will be used instead.\fR
 259 .PP
 260 \&\fBX509_STORE_set_get_crl()\fR sets the function to get the crl for a given
 261 certificate \fBx\fR.
 262 When found, the crl must be assigned to \fB*crl\fR.
 263 This function must return 0 on failure and 1 on success.
 264 \&\fIIf no function to get the issuer is provided, the internal default
 265 function will be used instead.\fR
 266 .PP
 267 \&\fBX509_STORE_set_check_crl()\fR sets the function to check the validity of
 268 the given \fBcrl\fR.
 269 This function must return 0 on failure and 1 on success.
 270 \&\fIIf no function to get the issuer is provided, the internal default
 271 function will be used instead.\fR
 272 .PP
 273 \&\fBX509_STORE_set_cert_crl()\fR sets the function to check the revocation
 274 status of the given certificate \fBx\fR against the given \fBcrl\fR.
 275 This function must return 0 on failure and 1 on success.
 276 \&\fIIf no function to get the issuer is provided, the internal default
 277 function will be used instead.\fR
 278 .PP
 279 \&\fBX509_STORE_set_check_policy()\fR sets the function to check the policies
 280 of all the certificates in the final chain..
 281 This function must return 0 on failure and 1 on success.
 282 \&\fIIf no function to get the issuer is provided, the internal default
 283 function will be used instead.\fR
 284 .PP
 285 \&\fBX509_STORE_set_lookup_certs()\fR and \fBX509_STORE_set_lookup_crls()\fR set the
 286 functions to look up all the certs or all the CRLs that match the
 287 given name \fBnm\fR.
 288 These functions return \s-1NULL\s0 on failure and a pointer to a stack of
 289 certificates (\fBX509\fR) or to a stack of CRLs (\fBX509_CRL\fR) on
 290 success.
 291 \&\fIIf no function to get the issuer is provided, the internal default
 292 function will be used instead.\fR
 293 .PP
 294 \&\fBX509_STORE_set_cleanup()\fR sets the final cleanup function, which is
 295 called when the context (\fBX509_STORE_CTX\fR) is being torn down.
 296 This function doesn't return any value.
 297 \&\fIIf no function to get the issuer is provided, the internal default
 298 function will be used instead.\fR
 299 .PP
 300 \&\fBX509_STORE_get_verify_cb()\fR, \fBX509_STORE_CTX_get_verify()\fR,
 301 \&\fBX509_STORE_get_get_issuer()\fR, \fBX509_STORE_get_check_issued()\fR,
 302 \&\fBX509_STORE_get_check_revocation()\fR, \fBX509_STORE_get_get_crl()\fR,
 303 \&\fBX509_STORE_get_check_crl()\fR, \fBX509_STORE_set_verify()\fR,
 304 \&\fBX509_STORE_set_get_issuer()\fR, \fBX509_STORE_get_cert_crl()\fR,
 305 \&\fBX509_STORE_get_check_policy()\fR, \fBX509_STORE_get_lookup_certs()\fR,
 306 \&\fBX509_STORE_get_lookup_crls()\fR and \fBX509_STORE_get_cleanup()\fR all return
 307 the function pointer assigned with \fBX509_STORE_set_check_issued()\fR,
 308 \&\fBX509_STORE_set_check_revocation()\fR, \fBX509_STORE_set_get_crl()\fR,
 309 \&\fBX509_STORE_set_check_crl()\fR, \fBX509_STORE_set_cert_crl()\fR,
 310 \&\fBX509_STORE_set_check_policy()\fR, \fBX509_STORE_set_lookup_certs()\fR,
 311 \&\fBX509_STORE_set_lookup_crls()\fR and \fBX509_STORE_set_cleanup()\fR, or \s-1NULL\s0 if
 312 no assignment has been made.
 313 .PP
 314 \&\fBX509_STORE_set_verify_cb_func()\fR, \fBX509_STORE_set_verify_func()\fR and
 315 \&\fBX509_STORE_set_lookup_crls_cb()\fR are aliases for
 316 \&\fBX509_STORE_set_verify_cb()\fR, \fBX509_STORE_set_verify()\fR and
 317 X509_STORE_set_lookup_crls, available as macros for backward
 318 compatibility.
 319 .SH "NOTES"
 320 .IX Header "NOTES"
 321 All the callbacks from a \fBX509_STORE\fR are inherited by the
 322 corresponding \fBX509_STORE_CTX\fR structure when it is initialized.
 323 See \fBX509_STORE_CTX_set_verify_cb\fR\|(3) for further details.
 324 .SH "BUGS"
 325 .IX Header "BUGS"
 326 The macro version of this function was the only one available before
 327 OpenSSL 1.0.0.
 328 .SH "RETURN VALUES"
 329 .IX Header "RETURN VALUES"
 330 The X509_STORE_set_*() functions do not return a value.
 331 .PP
 332 The X509_STORE_get_*() functions return a pointer of the appropriate
 333 function type.
 334 .SH "SEE ALSO"
 335 .IX Header "SEE ALSO"
 336 \&\fBX509_STORE_CTX_set_verify_cb\fR\|(3), \fBX509_STORE_CTX_get0_chain\fR\|(3),
 337 \&\fBX509_STORE_CTX_verify_cb\fR\|(3), \fBX509_STORE_CTX_verify_fn\fR\|(3),
 338 \&\fBCMS_verify\fR\|(3)
 339 .SH "HISTORY"
 340 .IX Header "HISTORY"
 341 The \fBX509_STORE_set_verify_cb()\fR function was added in OpenSSL 1.0.0.
 342 .PP
 343 The functions
 344 \&\fBX509_STORE_set_verify_cb()\fR, \fBX509_STORE_get_verify_cb()\fR,
 345 \&\fBX509_STORE_set_verify()\fR, \fBX509_STORE_CTX_get_verify()\fR,
 346 \&\fBX509_STORE_set_get_issuer()\fR, \fBX509_STORE_get_get_issuer()\fR,
 347 \&\fBX509_STORE_set_check_issued()\fR, \fBX509_STORE_get_check_issued()\fR,
 348 \&\fBX509_STORE_set_check_revocation()\fR, \fBX509_STORE_get_check_revocation()\fR,
 349 \&\fBX509_STORE_set_get_crl()\fR, \fBX509_STORE_get_get_crl()\fR,
 350 \&\fBX509_STORE_set_check_crl()\fR, \fBX509_STORE_get_check_crl()\fR,
 351 \&\fBX509_STORE_set_cert_crl()\fR, \fBX509_STORE_get_cert_crl()\fR,
 352 \&\fBX509_STORE_set_check_policy()\fR, \fBX509_STORE_get_check_policy()\fR,
 353 \&\fBX509_STORE_set_lookup_certs()\fR, \fBX509_STORE_get_lookup_certs()\fR,
 354 \&\fBX509_STORE_set_lookup_crls()\fR, \fBX509_STORE_get_lookup_crls()\fR,
 355 \&\fBX509_STORE_set_cleanup()\fR and \fBX509_STORE_get_cleanup()\fR
 356 were added in OpenSSL 1.1.0.
 357 .SH "COPYRIGHT"
 358 .IX Header "COPYRIGHT"
 359 Copyright 2009\-2020 The OpenSSL Project Authors. All Rights Reserved.
 360 .PP
 361 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 362 this file except in compliance with the License.  You can obtain a copy
 363 in the file \s-1LICENSE\s0 in the source distribution or at
 364 <https://www.openssl.org/source/license.html>.