lib/libssl/man/SSL_CTX_get_verify_mode.3

   1 .\"     $OpenBSD: SSL_CTX_get_verify_mode.3,v 1.4 2018/03/21 17:58:58 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   5 .\" Copyright (c) 2000, 2005 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: March 21 2018 $
  52 .Dt SSL_CTX_GET_VERIFY_MODE 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_CTX_get_verify_mode ,
  56 .Nm SSL_get_verify_mode ,
  57 .Nm SSL_CTX_get_verify_depth ,
  58 .Nm SSL_get_verify_depth ,
  59 .Nm SSL_get_verify_callback ,
  60 .Nm SSL_CTX_get_verify_callback
  61 .Nd get currently set verification parameters
  62 .Sh SYNOPSIS
  63 .In openssl/ssl.h
  64 .Ft int
  65 .Fn SSL_CTX_get_verify_mode "const SSL_CTX *ctx"
  66 .Ft int
  67 .Fn SSL_get_verify_mode "const SSL *ssl"
  68 .Ft int
  69 .Fn SSL_CTX_get_verify_depth "const SSL_CTX *ctx"
  70 .Ft int
  71 .Fn SSL_get_verify_depth "const SSL *ssl"
  72 .Ft int
  73 .Fo "(*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))"
  74 .Fa int "X509_STORE_CTX *"
  75 .Fc
  76 .Ft int
  77 .Fo "(*SSL_get_verify_callback(const SSL *ssl))"
  78 .Fa int "X509_STORE_CTX *"
  79 .Fc
  80 .Sh DESCRIPTION
  81 .Fn SSL_CTX_get_verify_mode
  82 returns the verification mode currently set in
  83 .Fa ctx .
  84 .Pp
  85 .Fn SSL_get_verify_mode
  86 returns the verification mode currently set in
  87 .Fa ssl .
  88 .Pp
  89 .Fn SSL_CTX_get_verify_depth
  90 returns the verification depth limit currently set
  91 in
  92 .Fa ctx .
  93 If no limit has been explicitly set,
  94 \(mi1 is returned and the default value will be used.
  95 .Pp
  96 .Fn SSL_get_verify_depth
  97 returns the verification depth limit currently set in
  98 .Fa ssl .
  99 If no limit has been explicitly set,
 100 \(mi1 is returned and the default value will be used.
 101 .Pp
 102 .Fn SSL_CTX_get_verify_callback
 103 returns a function pointer to the verification callback currently set in
 104 .Fa ctx .
 105 If no callback was explicitly set, the
 106 .Dv NULL
 107 pointer is returned and the default callback will be used.
 108 .Pp
 109 .Fn SSL_get_verify_callback
 110 returns a function pointer to the verification callback currently set in
 111 .Fa ssl .
 112 If no callback was explicitly set, the
 113 .Dv NULL
 114 pointer is returned and the default callback will be used.
 115 .Sh SEE ALSO
 116 .Xr ssl 3 ,
 117 .Xr SSL_CTX_set_verify 3
 118 .Sh HISTORY
 119 .Fn SSL_CTX_get_verify_mode ,
 120 .Fn SSL_get_verify_mode ,
 121 .Fn SSL_get_verify_callback ,
 122 and
 123 .Fn SSL_CTX_get_verify_callback
 124 appeared before SSLeay 0.8 and have been available since
 125 .Ox 2.4 .
 126 .Pp
 127 .Fn SSL_CTX_get_verify_depth
 128 and
 129 .Fn SSL_get_verify_depth
 130 first appeared in OpenSSL 0.9.3 and have been available since
 131 .Ox 2.6 .