secure/lib/libcrypto/man/man3/SSL_CTX_set_cert_store.3

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