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