secure/lib/libssl/man/SSL_CTX_load_verify_locations.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_load_verify_locations 3"
 132 .TH SSL_CTX_load_verify_locations 3 "2018-08-14" "1.0.2p" "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_load_verify_locations \- set default locations for trusted CA
 139 certificates
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 .Vb 1
 143 \& #include <openssl/ssl.h>
 144 \&
 145 \& int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
 146 \&                                   const char *CApath);
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 \&\fISSL_CTX_load_verify_locations()\fR specifies the locations for \fBctx\fR, at
 151 which \s-1CA\s0 certificates for verification purposes are located. The certificates
 152 available via \fBCAfile\fR and \fBCApath\fR are trusted.
 153 .SH "NOTES"
 154 .IX Header "NOTES"
 155 If \fBCAfile\fR is not \s-1NULL,\s0 it points to a file of \s-1CA\s0 certificates in \s-1PEM\s0
 156 format. The file can contain several \s-1CA\s0 certificates identified by
 157 .PP
 158 .Vb 3
 159 \& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
 160 \& ... (CA certificate in base64 encoding) ...
 161 \& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
 162 .Ve
 163 .PP
 164 sequences. Before, between, and after the certificates text is allowed
 165 which can be used e.g. for descriptions of the certificates.
 166 .PP
 167 The \fBCAfile\fR is processed on execution of the \fISSL_CTX_load_verify_locations()\fR
 168 function.
 169 .PP
 170 If \fBCApath\fR is not \s-1NULL,\s0 it points to a directory containing \s-1CA\s0 certificates
 171 in \s-1PEM\s0 format. The files each contain one \s-1CA\s0 certificate. The files are
 172 looked up by the \s-1CA\s0 subject name hash value, which must hence be available.
 173 If more than one \s-1CA\s0 certificate with the same name hash value exist, the
 174 extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). The search
 175 is performed in the ordering of the extension number, regardless of other
 176 properties of the certificates.
 177 Use the \fBc_rehash\fR utility to create the necessary links.
 178 .PP
 179 The certificates in \fBCApath\fR are only looked up when required, e.g. when
 180 building the certificate chain or when actually performing the verification
 181 of a peer certificate.
 182 .PP
 183 When looking up \s-1CA\s0 certificates, the OpenSSL library will first search the
 184 certificates in \fBCAfile\fR, then those in \fBCApath\fR. Certificate matching
 185 is done based on the subject name, the key identifier (if present), and the
 186 serial number as taken from the certificate to be verified. If these data
 187 do not match, the next certificate will be tried. If a first certificate
 188 matching the parameters is found, the verification process will be performed;
 189 no other certificates for the same parameters will be searched in case of
 190 failure.
 191 .PP
 192 In server mode, when requesting a client certificate, the server must send
 193 the list of CAs of which it will accept client certificates. This list
 194 is not influenced by the contents of \fBCAfile\fR or \fBCApath\fR and must
 195 explicitly be set using the
 196 \&\fISSL_CTX_set_client_CA_list\fR\|(3)
 197 family of functions.
 198 .PP
 199 When building its own certificate chain, an OpenSSL client/server will
 200 try to fill in missing certificates from \fBCAfile\fR/\fBCApath\fR, if the
 201 certificate chain was not explicitly specified (see
 202 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3),
 203 \&\fISSL_CTX_use_certificate\fR\|(3).
 204 .SH "WARNINGS"
 205 .IX Header "WARNINGS"
 206 If several \s-1CA\s0 certificates matching the name, key identifier, and serial
 207 number condition are available, only the first one will be examined. This
 208 may lead to unexpected results if the same \s-1CA\s0 certificate is available
 209 with different expiration dates. If a \*(L"certificate expired\*(R" verification
 210 error occurs, no other certificate will be searched. Make sure to not
 211 have expired certificates mixed with valid ones.
 212 .SH "EXAMPLES"
 213 .IX Header "EXAMPLES"
 214 Generate a \s-1CA\s0 certificate file with descriptive text from the \s-1CA\s0 certificates
 215 ca1.pem ca2.pem ca3.pem:
 216 .PP
 217 .Vb 5
 218 \& #!/bin/sh
 219 \& rm CAfile.pem
 220 \& for i in ca1.pem ca2.pem ca3.pem ; do
 221 \&   openssl x509 \-in $i \-text >> CAfile.pem
 222 \& done
 223 .Ve
 224 .PP
 225 Prepare the directory /some/where/certs containing several \s-1CA\s0 certificates
 226 for use as \fBCApath\fR:
 227 .PP
 228 .Vb 2
 229 \& cd /some/where/certs
 230 \& c_rehash .
 231 .Ve
 232 .SH "RETURN VALUES"
 233 .IX Header "RETURN VALUES"
 234 The following return values can occur:
 235 .IP "0" 4
 236 The operation failed because \fBCAfile\fR and \fBCApath\fR are \s-1NULL\s0 or the
 237 processing at one of the locations specified failed. Check the error
 238 stack to find out the reason.
 239 .IP "1" 4
 240 .IX Item "1"
 241 The operation succeeded.
 242 .SH "SEE ALSO"
 243 .IX Header "SEE ALSO"
 244 \&\fIssl\fR\|(3),
 245 \&\fISSL_CTX_set_client_CA_list\fR\|(3),
 246 \&\fISSL_get_client_CA_list\fR\|(3),
 247 \&\fISSL_CTX_use_certificate\fR\|(3),
 248 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3),
 249 \&\fISSL_CTX_set_cert_store\fR\|(3)