lib/libcrypto/man/X509_STORE_set_verify_cb_func.3

   1 .\"     $OpenBSD: X509_STORE_set_verify_cb_func.3,v 1.4 2016/12/10 20:34:57 schwarze Exp $
   2 .\"     OpenSSL 05ea606a May 20 20:52:46 2016 -0400
   3 .\"
   4 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
   5 .\" Copyright (c) 2009 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: December 10 2016 $
  52 .Dt X509_STORE_SET_VERIFY_CB_FUNC 3
  53 .Os
  54 .Sh NAME
  55 .Nm X509_STORE_set_verify_cb ,
  56 .Nm X509_STORE_set_verify_cb_func
  57 .Nd set verification callback
  58 .Sh SYNOPSIS
  59 .In openssl/x509_vfy.h
  60 .Ft void
  61 .Fo X509_STORE_set_verify_cb
  62 .Fa "X509_STORE *st"
  63 .Fa "int (*verify_cb)(int ok, X509_STORE_CTX *ctx)"
  64 .Fc
  65 .Ft void
  66 .Fo X509_STORE_set_verify_cb_func
  67 .Fa "X509_STORE *st"
  68 .Fa "int (*verify_cb)(int ok, X509_STORE_CTX *ctx)"
  69 .Fc
  70 .Sh DESCRIPTION
  71 .Fn X509_STORE_set_verify_cb
  72 sets the verification callback of
  73 .Sy ctx
  74 to
  75 .Sy verify_cb ,
  76 overwriting any existing callback.
  77 .Pp
  78 .Fn X509_STORE_set_verify_cb_func
  79 also sets the verification callback but it is implemented as a macro.
  80 .Pp
  81 The verification callback from an
  82 .Vt X509_STORE
  83 is inherited by the corresponding
  84 .Vt X509_STORE_CTX
  85 structure when it is initialized.
  86 This can be used to set the verification callback when the
  87 .Vt X509_STORE_CTX
  88 is otherwise inaccessible (for example during S/MIME verification).
  89 .Sh RETURN VALUES
  90 .Fn X509_STORE_set_verify_cb
  91 and
  92 .Fn X509_STORE_set_verify_cb_func
  93 do not return a value.
  94 .Sh SEE ALSO
  95 .Xr X509_STORE_CTX_set_verify_cb 3
  96 .Sh HISTORY
  97 .Fn X509_STORE_set_verify_cb_func
  98 is available in all versions of SSLeay and OpenSSL.
  99 .Pp
 100 .Fn X509_STORE_set_verify_cb
 101 was added to OpenSSL 1.0.0.
 102 .Sh BUGS
 103 The macro version of this function was the only one available before
 104 OpenSSL 1.0.0.