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

   1 .\" Automatically generated by Pod::Man 4.11 (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_LOAD_VERIFY_LOCATIONS 3"
 136 .TH SSL_CTX_LOAD_VERIFY_LOCATIONS 3 "2020-04-21" "1.1.1g" "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_load_verify_locations, SSL_CTX_set_default_verify_paths, SSL_CTX_set_default_verify_dir, SSL_CTX_set_default_verify_file \- set default locations for trusted CA certificates
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
 149 \&                                   const char *CApath);
 150 \&
 151 \& int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
 152 \&
 153 \& int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx);
 154 \&
 155 \& int SSL_CTX_set_default_verify_file(SSL_CTX *ctx);
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fBSSL_CTX_load_verify_locations()\fR specifies the locations for \fBctx\fR, at
 160 which \s-1CA\s0 certificates for verification purposes are located. The certificates
 161 available via \fBCAfile\fR and \fBCApath\fR are trusted.
 162 .PP
 163 \&\fBSSL_CTX_set_default_verify_paths()\fR specifies that the default locations from
 164 which \s-1CA\s0 certificates are loaded should be used. There is one default directory
 165 and one default file. The default \s-1CA\s0 certificates directory is called \*(L"certs\*(R" in
 166 the default OpenSSL directory. Alternatively the \s-1SSL_CERT_DIR\s0 environment
 167 variable can be defined to override this location. The default \s-1CA\s0 certificates
 168 file is called \*(L"cert.pem\*(R" in the default OpenSSL directory. Alternatively the
 169 \&\s-1SSL_CERT_FILE\s0 environment variable can be defined to override this location.
 170 .PP
 171 \&\fBSSL_CTX_set_default_verify_dir()\fR is similar to
 172 \&\fBSSL_CTX_set_default_verify_paths()\fR except that just the default directory is
 173 used.
 174 .PP
 175 \&\fBSSL_CTX_set_default_verify_file()\fR is similar to
 176 \&\fBSSL_CTX_set_default_verify_paths()\fR except that just the default file is
 177 used.
 178 .SH "NOTES"
 179 .IX Header "NOTES"
 180 If \fBCAfile\fR is not \s-1NULL,\s0 it points to a file of \s-1CA\s0 certificates in \s-1PEM\s0
 181 format. The file can contain several \s-1CA\s0 certificates identified by
 182 .PP
 183 .Vb 3
 184 \& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
 185 \& ... (CA certificate in base64 encoding) ...
 186 \& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
 187 .Ve
 188 .PP
 189 sequences. Before, between, and after the certificates text is allowed
 190 which can be used e.g. for descriptions of the certificates.
 191 .PP
 192 The \fBCAfile\fR is processed on execution of the \fBSSL_CTX_load_verify_locations()\fR
 193 function.
 194 .PP
 195 If \fBCApath\fR is not \s-1NULL,\s0 it points to a directory containing \s-1CA\s0 certificates
 196 in \s-1PEM\s0 format. The files each contain one \s-1CA\s0 certificate. The files are
 197 looked up by the \s-1CA\s0 subject name hash value, which must hence be available.
 198 If more than one \s-1CA\s0 certificate with the same name hash value exist, the
 199 extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). The search
 200 is performed in the ordering of the extension number, regardless of other
 201 properties of the certificates.
 202 Use the \fBc_rehash\fR utility to create the necessary links.
 203 .PP
 204 The certificates in \fBCApath\fR are only looked up when required, e.g. when
 205 building the certificate chain or when actually performing the verification
 206 of a peer certificate.
 207 .PP
 208 When looking up \s-1CA\s0 certificates, the OpenSSL library will first search the
 209 certificates in \fBCAfile\fR, then those in \fBCApath\fR. Certificate matching
 210 is done based on the subject name, the key identifier (if present), and the
 211 serial number as taken from the certificate to be verified. If these data
 212 do not match, the next certificate will be tried. If a first certificate
 213 matching the parameters is found, the verification process will be performed;
 214 no other certificates for the same parameters will be searched in case of
 215 failure.
 216 .PP
 217 In server mode, when requesting a client certificate, the server must send
 218 the list of CAs of which it will accept client certificates. This list
 219 is not influenced by the contents of \fBCAfile\fR or \fBCApath\fR and must
 220 explicitly be set using the
 221 \&\fBSSL_CTX_set_client_CA_list\fR\|(3)
 222 family of functions.
 223 .PP
 224 When building its own certificate chain, an OpenSSL client/server will
 225 try to fill in missing certificates from \fBCAfile\fR/\fBCApath\fR, if the
 226 certificate chain was not explicitly specified (see
 227 \&\fBSSL_CTX_add_extra_chain_cert\fR\|(3),
 228 \&\fBSSL_CTX_use_certificate\fR\|(3).
 229 .SH "WARNINGS"
 230 .IX Header "WARNINGS"
 231 If several \s-1CA\s0 certificates matching the name, key identifier, and serial
 232 number condition are available, only the first one will be examined. This
 233 may lead to unexpected results if the same \s-1CA\s0 certificate is available
 234 with different expiration dates. If a \*(L"certificate expired\*(R" verification
 235 error occurs, no other certificate will be searched. Make sure to not
 236 have expired certificates mixed with valid ones.
 237 .SH "RETURN VALUES"
 238 .IX Header "RETURN VALUES"
 239 For SSL_CTX_load_verify_locations the following return values can occur:
 240 .IP "0" 4
 241 The operation failed because \fBCAfile\fR and \fBCApath\fR are \s-1NULL\s0 or the
 242 processing at one of the locations specified failed. Check the error
 243 stack to find out the reason.
 244 .IP "1" 4
 245 .IX Item "1"
 246 The operation succeeded.
 247 .PP
 248 \&\fBSSL_CTX_set_default_verify_paths()\fR, \fBSSL_CTX_set_default_verify_dir()\fR and
 249 \&\fBSSL_CTX_set_default_verify_file()\fR all return 1 on success or 0 on failure. A
 250 missing default location is still treated as a success.
 251 .SH "EXAMPLES"
 252 .IX Header "EXAMPLES"
 253 Generate a \s-1CA\s0 certificate file with descriptive text from the \s-1CA\s0 certificates
 254 ca1.pem ca2.pem ca3.pem:
 255 .PP
 256 .Vb 5
 257 \& #!/bin/sh
 258 \& rm CAfile.pem
 259 \& for i in ca1.pem ca2.pem ca3.pem ; do
 260 \&     openssl x509 \-in $i \-text >> CAfile.pem
 261 \& done
 262 .Ve
 263 .PP
 264 Prepare the directory /some/where/certs containing several \s-1CA\s0 certificates
 265 for use as \fBCApath\fR:
 266 .PP
 267 .Vb 2
 268 \& cd /some/where/certs
 269 \& c_rehash .
 270 .Ve
 271 .SH "SEE ALSO"
 272 .IX Header "SEE ALSO"
 273 \&\fBssl\fR\|(7),
 274 \&\fBSSL_CTX_set_client_CA_list\fR\|(3),
 275 \&\fBSSL_get_client_CA_list\fR\|(3),
 276 \&\fBSSL_CTX_use_certificate\fR\|(3),
 277 \&\fBSSL_CTX_add_extra_chain_cert\fR\|(3),
 278 \&\fBSSL_CTX_set_cert_store\fR\|(3),
 279 \&\fBSSL_CTX_set_client_CA_list\fR\|(3)
 280 .SH "COPYRIGHT"
 281 .IX Header "COPYRIGHT"
 282 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
 283 .PP
 284 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 285 this file except in compliance with the License.  You can obtain a copy
 286 in the file \s-1LICENSE\s0 in the source distribution or at
 287 <https://www.openssl.org/source/license.html>.