Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_load_verify_locations.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "SSL_CTX_load_verify_locations 3"
135 .TH SSL_CTX_load_verify_locations 3 "2009-01-11" "0.9.8j" "OpenSSL"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 SSL_CTX_load_verify_locations \- set default locations for trusted CA
142 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 .Ve
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 \&\fISSL_CTX_load_verify_locations()\fR specifies the locations for \fBctx\fR, at
154 which \s-1CA\s0 certificates for verification purposes are located. The certificates
155 available via \fBCAfile\fR and \fBCApath\fR are trusted.
156 .SH "NOTES"
157 .IX Header "NOTES"
158 If \fBCAfile\fR is not \s-1NULL\s0, it points to a file of \s-1CA\s0 certificates in \s-1PEM\s0
159 format. The file can contain several \s-1CA\s0 certificates identified by
160 .PP
161 .Vb 3
162 \& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
163 \& ... (CA certificate in base64 encoding) ...
164 \& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
165 .Ve
166 .PP
167 sequences. Before, between, and after the certificates text is allowed
168 which can be used e.g. for descriptions of the certificates.
169 .PP
170 The \fBCAfile\fR is processed on execution of the \fISSL_CTX_load_verify_locations()\fR
171 function.
172 .PP
173 If \fBCApath\fR is not \s-1NULL\s0, it points to a directory containing \s-1CA\s0 certificates
174 in \s-1PEM\s0 format. The files each contain one \s-1CA\s0 certificate. The files are
175 looked up by the \s-1CA\s0 subject name hash value, which must hence be available.
176 If more than one \s-1CA\s0 certificate with the same name hash value exist, the
177 extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). The search
178 is performed in the ordering of the extension number, regardless of other
179 properties of the certificates.
180 Use the \fBc_rehash\fR utility to create the necessary links.
181 .PP
182 The certificates in \fBCApath\fR are only looked up when required, e.g. when
183 building the certificate chain or when actually performing the verification
184 of a peer certificate.
185 .PP
186 When looking up \s-1CA\s0 certificates, the OpenSSL library will first search the
187 certificates in \fBCAfile\fR, then those in \fBCApath\fR. Certificate matching
188 is done based on the subject name, the key identifier (if present), and the
189 serial number as taken from the certificate to be verified. If these data
190 do not match, the next certificate will be tried. If a first certificate
191 matching the parameters is found, the verification process will be performed;
192 no other certificates for the same parameters will be searched in case of
193 failure.
194 .PP
195 In server mode, when requesting a client certificate, the server must send
196 the list of CAs of which it will accept client certificates. This list
197 is not influenced by the contents of \fBCAfile\fR or \fBCApath\fR and must
198 explicitly be set using the
199 \&\fISSL_CTX_set_client_CA_list\fR\|(3)
200 family of functions.
201 .PP
202 When building its own certificate chain, an OpenSSL client/server will
203 try to fill in missing certificates from \fBCAfile\fR/\fBCApath\fR, if the
204 certificate chain was not explicitly specified (see
205 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3),
206 \&\fISSL_CTX_use_certificate\fR\|(3).
207 .SH "WARNINGS"
208 .IX Header "WARNINGS"
209 If several \s-1CA\s0 certificates matching the name, key identifier, and serial
210 number condition are available, only the first one will be examined. This
211 may lead to unexpected results if the same \s-1CA\s0 certificate is available
212 with different expiration dates. If a \*(L"certificate expired\*(R" verification
213 error occurs, no other certificate will be searched. Make sure to not
214 have expired certificates mixed with valid ones.
215 .SH "EXAMPLES"
216 .IX Header "EXAMPLES"
217 Generate a \s-1CA\s0 certificate file with descriptive text from the \s-1CA\s0 certificates
218 ca1.pem ca2.pem ca3.pem:
219 .PP
220 .Vb 5
221 \& #!/bin/sh
222 \& rm CAfile.pem
223 \& for i in ca1.pem ca2.pem ca3.pem ; do
224 \&   openssl x509 \-in $i \-text >> CAfile.pem
225 \& done
226 .Ve
227 .PP
228 Prepare the directory /some/where/certs containing several \s-1CA\s0 certificates
229 for use as \fBCApath\fR:
230 .PP
231 .Vb 2
232 \& cd /some/where/certs
233 \& c_rehash .
234 .Ve
235 .SH "RETURN VALUES"
236 .IX Header "RETURN VALUES"
237 The following return values can occur:
238 .IP "0" 4
239 The operation failed because \fBCAfile\fR and \fBCApath\fR are \s-1NULL\s0 or the
240 processing at one of the locations specified failed. Check the error
241 stack to find out the reason.
242 .IP "1" 4
243 .IX Item "1"
244 The operation succeeded.
245 .SH "SEE ALSO"
246 .IX Header "SEE ALSO"
247 \&\fIssl\fR\|(3),
248 \&\fISSL_CTX_set_client_CA_list\fR\|(3),
249 \&\fISSL_get_client_CA_list\fR\|(3),
250 \&\fISSL_CTX_use_certificate\fR\|(3),
251 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3),
252 \&\fISSL_CTX_set_cert_store\fR\|(3)