lib/libssl/man/SSL_CTX_set_cert_store.3

   1 .\"     $OpenBSD: SSL_CTX_set_cert_store.3,v 1.3 2016/12/16 15:39:08 jmc 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: December 16 2016 $
  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
  75 .Xr X509_STORE_free 3 Ns ed .
  76 .Pp
  77 .Fn SSL_CTX_get_cert_store
  78 returns a pointer to the current certificate verification storage.
  79 .Pp
  80 In order to verify the certificates presented by the peer, trusted CA
  81 certificates must be accessed.
  82 These CA certificates are made available via lookup methods, handled inside the
  83 .Vt X509_STORE .
  84 From the
  85 .Vt X509_STORE
  86 the
  87 .Vt X509_STORE_CTX
  88 used when verifying certificates is created.
  89 .Pp
  90 Typically the trusted certificate store is handled indirectly via using
  91 .Xr SSL_CTX_load_verify_locations 3 .
  92 Using the
  93 .Fn SSL_CTX_set_cert_store
  94 and
  95 .Fn SSL_CTX_get_cert_store
  96 functions it is possible to manipulate the
  97 .Vt X509_STORE
  98 object beyond the
  99 .Xr SSL_CTX_load_verify_locations 3
 100 call.
 101 .Pp
 102 Currently no detailed documentation on how to use the
 103 .Vt X509_STORE
 104 object is available.
 105 Not all members of the
 106 .Vt X509_STORE
 107 are used when the verification takes place.
 108 So will, for example, the
 109 .Fn verify_callback
 110 be overridden with the
 111 .Fn verify_callback
 112 set via the
 113 .Xr SSL_CTX_set_verify 3
 114 family of functions.
 115 This document must therefore be updated when documentation about the
 116 .Vt X509_STORE
 117 object and its handling becomes available.
 118 .Sh RETURN VALUES
 119 .Fn SSL_CTX_get_cert_store
 120 returns the current setting.
 121 .Sh SEE ALSO
 122 .Xr ssl 3 ,
 123 .Xr SSL_CTX_load_verify_locations 3 ,
 124 .Xr SSL_CTX_set_verify 3