secure/lib/libssl/man/SSL_CTX_load_verify_locations.3

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