lib/libssl/man/SSL_CTX_set1_verify_cert_store.3

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