lib/libssl/man/SSL_CTX_set_cert_store.3

   1 .\"     $OpenBSD: SSL_CTX_set_cert_store.3,v 1.7 2018/03/27 17:35:50 schwarze Exp $
   2 .\"     OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   5 .\" Copyright (c) 2001, 2002, 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 27 2018 $
  52 .Dt SSL_CTX_SET_CERT_STORE 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_CTX_set_cert_store ,
  56 .Nm SSL_CTX_get_cert_store
  57 .Nd manipulate X509 certificate verification storage
  58 .Sh SYNOPSIS
  59 .In openssl/ssl.h
  60 .Ft void
  61 .Fn SSL_CTX_set_cert_store "SSL_CTX *ctx" "X509_STORE *store"
  62 .Ft X509_STORE *
  63 .Fn SSL_CTX_get_cert_store "const SSL_CTX *ctx"
  64 .Sh DESCRIPTION
  65 .Fn SSL_CTX_set_cert_store
  66 sets the verification storage of
  67 .Fa ctx
  68 to or replaces it with
  69 .Fa store .
  70 If another
  71 .Vt X509_STORE
  72 object is currently set in
  73 .Fa ctx ,
  74 it will be freed.
  75 .Pp
  76 .Fn SSL_CTX_get_cert_store
  77 returns a pointer to the current certificate verification storage.
  78 .Pp
  79 In order to verify the certificates presented by the peer, trusted CA
  80 certificates must be accessed.
  81 These CA certificates are made available via lookup methods, handled inside the
  82 .Vt X509_STORE .
  83 From the
  84 .Vt X509_STORE
  85 the
  86 .Vt X509_STORE_CTX
  87 used when verifying certificates is created.
  88 .Pp
  89 Typically the trusted certificate store is handled indirectly via using
  90 .Xr SSL_CTX_load_verify_locations 3 .
  91 Using the
  92 .Fn SSL_CTX_set_cert_store
  93 and
  94 .Fn SSL_CTX_get_cert_store
  95 functions it is possible to manipulate the
  96 .Vt X509_STORE
  97 object beyond the
  98 .Xr SSL_CTX_load_verify_locations 3
  99 call.
 100 .Pp
 101 Currently no detailed documentation on how to use the
 102 .Vt X509_STORE
 103 object is available.
 104 Not all members of the
 105 .Vt X509_STORE
 106 are used when the verification takes place.
 107 So will, for example, the
 108 .Fn verify_callback
 109 be overridden with the
 110 .Fn verify_callback
 111 set via the
 112 .Xr SSL_CTX_set_verify 3
 113 family of functions.
 114 This document must therefore be updated when documentation about the
 115 .Vt X509_STORE
 116 object and its handling becomes available.
 117 .Sh RETURN VALUES
 118 .Fn SSL_CTX_get_cert_store
 119 returns the current setting.
 120 .Sh SEE ALSO
 121 .Xr ssl 3 ,
 122 .Xr SSL_CTX_load_verify_locations 3 ,
 123 .Xr SSL_CTX_set_verify 3 ,
 124 .Xr X509_STORE_new 3
 125 .Sh HISTORY
 126 .Fn SSL_CTX_set_cert_store
 127 and
 128 .Fn SSL_CTX_get_cert_store
 129 first appeared in SSLeay 0.8.1 and have been available since
 130 .Ox 2.4 .