secure/lib/libcrypto/man/SSL_CTX_set_cert_store.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_SET_CERT_STORE 3"
 132 .TH SSL_CTX_SET_CERT_STORE 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 SSL_CTX_set_cert_store, SSL_CTX_set1_cert_store, SSL_CTX_get_cert_store \- manipulate X509 certificate verification storage
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store);
 145 \& void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store);
 146 \& X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx);
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 \&\fISSL_CTX_set_cert_store()\fR sets/replaces the certificate verification storage
 151 of \fBctx\fR to/with \fBstore\fR. If another X509_STORE object is currently
 152 set in \fBctx\fR, it will be \fIX509_STORE_free()\fRed.
 153 .PP
 154 \&\fISSL_CTX_set1_cert_store()\fR sets/replaces the certificate verification storage
 155 of \fBctx\fR to/with \fBstore\fR. The \fBstore\fR's reference count is incremented.
 156 If another X509_STORE object is currently set in \fBctx\fR, it will be \fIX509_STORE_free()\fRed.
 157 .PP
 158 \&\fISSL_CTX_get_cert_store()\fR returns a pointer to the current certificate
 159 verification storage.
 160 .SH "NOTES"
 161 .IX Header "NOTES"
 162 In order to verify the certificates presented by the peer, trusted \s-1CA\s0
 163 certificates must be accessed. These \s-1CA\s0 certificates are made available
 164 via lookup methods, handled inside the X509_STORE. From the X509_STORE
 165 the X509_STORE_CTX used when verifying certificates is created.
 166 .PP
 167 Typically the trusted certificate store is handled indirectly via using
 168 \&\fISSL_CTX_load_verify_locations\fR\|(3).
 169 Using the \fISSL_CTX_set_cert_store()\fR and \fISSL_CTX_get_cert_store()\fR functions
 170 it is possible to manipulate the X509_STORE object beyond the
 171 \&\fISSL_CTX_load_verify_locations\fR\|(3)
 172 call.
 173 .PP
 174 Currently no detailed documentation on how to use the X509_STORE
 175 object is available. Not all members of the X509_STORE are used when
 176 the verification takes place. So will e.g. the \fIverify_callback()\fR be
 177 overridden with the \fIverify_callback()\fR set via the
 178 \&\fISSL_CTX_set_verify\fR\|(3) family of functions.
 179 This document must therefore be updated when documentation about the
 180 X509_STORE object and its handling becomes available.
 181 .PP
 182 \&\fISSL_CTX_set_cert_store()\fR does not increment the \fBstore\fR's reference
 183 count, so it should not be used to assign an X509_STORE that is owned
 184 by another \s-1SSL_CTX.\s0
 185 .PP
 186 To share X509_STOREs between two SSL_CTXs, use \fISSL_CTX_get_cert_store()\fR
 187 to get the X509_STORE from the first \s-1SSL_CTX,\s0 and then use
 188 \&\fISSL_CTX_set1_cert_store()\fR to assign to the second \s-1SSL_CTX\s0 and
 189 increment the reference count of the X509_STORE.
 190 .SH "RESTRICTIONS"
 191 .IX Header "RESTRICTIONS"
 192 The X509_STORE structure used by an \s-1SSL_CTX\s0 is used for verifying peer
 193 certificates and building certificate chains, it is also shared by
 194 every child \s-1SSL\s0 structure. Applications wanting finer control can use
 195 functions such as \fISSL_CTX_set1_verify_cert_store()\fR instead.
 196 .SH "RETURN VALUES"
 197 .IX Header "RETURN VALUES"
 198 \&\fISSL_CTX_set_cert_store()\fR does not return diagnostic output.
 199 .PP
 200 \&\fISSL_CTX_set1_cert_store()\fR does not return diagnostic output.
 201 .PP
 202 \&\fISSL_CTX_get_cert_store()\fR returns the current setting.
 203 .SH "SEE ALSO"
 204 .IX Header "SEE ALSO"
 205 \&\fIssl\fR\|(7),
 206 \&\fISSL_CTX_load_verify_locations\fR\|(3),
 207 \&\fISSL_CTX_set_verify\fR\|(3)
 208 .SH "COPYRIGHT"
 209 .IX Header "COPYRIGHT"
 210 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
 211 .PP
 212 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 213 this file except in compliance with the License.  You can obtain a copy
 214 in the file \s-1LICENSE\s0 in the source distribution or at
 215 <https://www.openssl.org/source/license.html>.