secure/lib/libcrypto/man/SSL_CTX_set1_verify_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_SET1_VERIFY_CERT_STORE 3"
 132 .TH SSL_CTX_SET1_VERIFY_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_set0_verify_cert_store, SSL_CTX_set1_verify_cert_store, SSL_CTX_set0_chain_cert_store, SSL_CTX_set1_chain_cert_store, SSL_set0_verify_cert_store, SSL_set1_verify_cert_store, SSL_set0_chain_cert_store, SSL_set1_chain_cert_store \- set certificate verification or chain store
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_CTX_set0_verify_cert_store(SSL_CTX *ctx, X509_STORE *st);
 145 \& int SSL_CTX_set1_verify_cert_store(SSL_CTX *ctx, X509_STORE *st);
 146 \& int SSL_CTX_set0_chain_cert_store(SSL_CTX *ctx, X509_STORE *st);
 147 \& int SSL_CTX_set1_chain_cert_store(SSL_CTX *ctx, X509_STORE *st);
 148 \&
 149 \& int SSL_set0_verify_cert_store(SSL *ctx, X509_STORE *st);
 150 \& int SSL_set1_verify_cert_store(SSL *ctx, X509_STORE *st);
 151 \& int SSL_set0_chain_cert_store(SSL *ctx, X509_STORE *st);
 152 \& int SSL_set1_chain_cert_store(SSL *ctx, X509_STORE *st);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fISSL_CTX_set0_verify_cert_store()\fR and \fISSL_CTX_set1_verify_cert_store()\fR
 157 set the certificate store used for certificate verification to \fBst\fR.
 158 .PP
 159 \&\fISSL_CTX_set0_chain_cert_store()\fR and \fISSL_CTX_set1_chain_cert_store()\fR
 160 set the certificate store used for certificate chain building to \fBst\fR.
 161 .PP
 162 \&\fISSL_set0_verify_cert_store()\fR, \fISSL_set1_verify_cert_store()\fR,
 163 \&\fISSL_set0_chain_cert_store()\fR and \fISSL_set1_chain_cert_store()\fR are similar
 164 except they apply to \s-1SSL\s0 structure \fBssl\fR.
 165 .PP
 166 All these functions are implemented as macros. Those containing a \fB1\fR
 167 increment the reference count of the supplied store so it must
 168 be freed at some point after the operation. Those containing a \fB0\fR do
 169 not increment reference counts and the supplied store \fB\s-1MUST NOT\s0\fR be freed
 170 after the operation.
 171 .SH "NOTES"
 172 .IX Header "NOTES"
 173 The stores pointers associated with an \s-1SSL_CTX\s0 structure are copied to any \s-1SSL\s0
 174 structures when \fISSL_new()\fR is called. As a result \s-1SSL\s0 structures will not be
 175 affected if the parent \s-1SSL_CTX\s0 store pointer is set to a new value.
 176 .PP
 177 The verification store is used to verify the certificate chain sent by the
 178 peer: that is an \s-1SSL/TLS\s0 client will use the verification store to verify
 179 the server's certificate chain and a \s-1SSL/TLS\s0 server will use it to verify
 180 any client certificate chain.
 181 .PP
 182 The chain store is used to build the certificate chain.
 183 .PP
 184 If the mode \fB\s-1SSL_MODE_NO_AUTO_CHAIN\s0\fR is set or a certificate chain is
 185 configured already (for example using the functions such as
 186 \&\fISSL_CTX_add1_chain_cert\fR\|(3) or
 187 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3)) then
 188 automatic chain building is disabled.
 189 .PP
 190 If the mode \fB\s-1SSL_MODE_NO_AUTO_CHAIN\s0\fR is set then automatic chain building
 191 is disabled.
 192 .PP
 193 If the chain or the verification store is not set then the store associated
 194 with the parent \s-1SSL_CTX\s0 is used instead to retain compatibility with previous
 195 versions of OpenSSL.
 196 .SH "RETURN VALUES"
 197 .IX Header "RETURN VALUES"
 198 All these functions return 1 for success and 0 for failure.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3)
 202 \&\fISSL_CTX_set0_chain\fR\|(3)
 203 \&\fISSL_CTX_set1_chain\fR\|(3)
 204 \&\fISSL_CTX_add0_chain_cert\fR\|(3)
 205 \&\fISSL_CTX_add1_chain_cert\fR\|(3)
 206 \&\fISSL_set0_chain\fR\|(3)
 207 \&\fISSL_set1_chain\fR\|(3)
 208 \&\fISSL_add0_chain_cert\fR\|(3)
 209 \&\fISSL_add1_chain_cert\fR\|(3)
 210 \&\fISSL_CTX_build_cert_chain\fR\|(3)
 211 \&\fISSL_build_cert_chain\fR\|(3)
 212 .SH "HISTORY"
 213 .IX Header "HISTORY"
 214 These functions were first added to OpenSSL 1.0.2.
 215 .SH "COPYRIGHT"
 216 .IX Header "COPYRIGHT"
 217 Copyright 2013\-2016 The OpenSSL Project Authors. All Rights Reserved.
 218 .PP
 219 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 220 this file except in compliance with the License.  You can obtain a copy
 221 in the file \s-1LICENSE\s0 in the source distribution or at
 222 <https://www.openssl.org/source/license.html>.