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