Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_load_verify_locations.3
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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
e257b235
PA
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-
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 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
e056f0e0
JR
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.
e257b235 59.ie \nF \{\
e056f0e0
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
e056f0e0
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
e056f0e0
JR
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
984263bc 74.if n \{\
e056f0e0
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
e056f0e0
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
e056f0e0 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
e056f0e0
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
e056f0e0
JR
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'
984263bc 104.\}
e056f0e0 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
e056f0e0 115. \" corrections for vroff
984263bc
MD
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'
e056f0e0 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
e056f0e0
JR
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
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
e056f0e0
JR
132.\" ========================================================================
133.\"
134.IX Title "SSL_CTX_load_verify_locations 3"
e257b235
PA
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
984263bc 140.SH "NAME"
a7d27d5a 141SSL_CTX_load_verify_locations \- set default locations for trusted CA
984263bc
MD
142certificates
143.SH "SYNOPSIS"
e056f0e0 144.IX Header "SYNOPSIS"
984263bc
MD
145.Vb 1
146\& #include <openssl/ssl.h>
e257b235 147\&
984263bc
MD
148\& int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
149\& const char *CApath);
150.Ve
151.SH "DESCRIPTION"
e056f0e0
JR
152.IX Header "DESCRIPTION"
153\&\fISSL_CTX_load_verify_locations()\fR specifies the locations for \fBctx\fR, at
154which \s-1CA\s0 certificates for verification purposes are located. The certificates
984263bc
MD
155available via \fBCAfile\fR and \fBCApath\fR are trusted.
156.SH "NOTES"
e056f0e0
JR
157.IX Header "NOTES"
158If \fBCAfile\fR is not \s-1NULL\s0, it points to a file of \s-1CA\s0 certificates in \s-1PEM\s0
159format. The file can contain several \s-1CA\s0 certificates identified by
984263bc
MD
160.PP
161.Vb 3
e257b235 162\& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
984263bc 163\& ... (CA certificate in base64 encoding) ...
e257b235 164\& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
984263bc 165.Ve
e056f0e0 166.PP
984263bc
MD
167sequences. Before, between, and after the certificates text is allowed
168which can be used e.g. for descriptions of the certificates.
169.PP
170The \fBCAfile\fR is processed on execution of the \fISSL_CTX_load_verify_locations()\fR
171function.
172.PP
e056f0e0
JR
173If \fBCApath\fR is not \s-1NULL\s0, it points to a directory containing \s-1CA\s0 certificates
174in \s-1PEM\s0 format. The files each contain one \s-1CA\s0 certificate. The files are
175looked up by the \s-1CA\s0 subject name hash value, which must hence be available.
176If more than one \s-1CA\s0 certificate with the same name hash value exist, the
984263bc
MD
177extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). The search
178is performed in the ordering of the extension number, regardless of other
179properties of the certificates.
180Use the \fBc_rehash\fR utility to create the necessary links.
181.PP
182The certificates in \fBCApath\fR are only looked up when required, e.g. when
183building the certificate chain or when actually performing the verification
184of a peer certificate.
185.PP
e056f0e0 186When looking up \s-1CA\s0 certificates, the OpenSSL library will first search the
984263bc
MD
187certificates in \fBCAfile\fR, then those in \fBCApath\fR. Certificate matching
188is done based on the subject name, the key identifier (if present), and the
189serial number as taken from the certificate to be verified. If these data
190do not match, the next certificate will be tried. If a first certificate
191matching the parameters is found, the verification process will be performed;
192no other certificates for the same parameters will be searched in case of
193failure.
194.PP
195In server mode, when requesting a client certificate, the server must send
196the list of CAs of which it will accept client certificates. This list
197is not influenced by the contents of \fBCAfile\fR or \fBCApath\fR and must
198explicitly be set using the
e056f0e0 199\&\fISSL_CTX_set_client_CA_list\fR\|(3)
984263bc
MD
200family of functions.
201.PP
202When building its own certificate chain, an OpenSSL client/server will
203try to fill in missing certificates from \fBCAfile\fR/\fBCApath\fR, if the
204certificate chain was not explicitly specified (see
e056f0e0
JR
205\&\fISSL_CTX_add_extra_chain_cert\fR\|(3),
206\&\fISSL_CTX_use_certificate\fR\|(3).
984263bc 207.SH "WARNINGS"
e056f0e0
JR
208.IX Header "WARNINGS"
209If several \s-1CA\s0 certificates matching the name, key identifier, and serial
984263bc 210number condition are available, only the first one will be examined. This
e056f0e0 211may lead to unexpected results if the same \s-1CA\s0 certificate is available
984263bc
MD
212with different expiration dates. If a \*(L"certificate expired\*(R" verification
213error occurs, no other certificate will be searched. Make sure to not
214have expired certificates mixed with valid ones.
215.SH "EXAMPLES"
e056f0e0
JR
216.IX Header "EXAMPLES"
217Generate a \s-1CA\s0 certificate file with descriptive text from the \s-1CA\s0 certificates
984263bc
MD
218ca1.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
e257b235 224\& openssl x509 \-in $i \-text >> CAfile.pem
984263bc
MD
225\& done
226.Ve
e056f0e0
JR
227.PP
228Prepare the directory /some/where/certs containing several \s-1CA\s0 certificates
984263bc
MD
229for use as \fBCApath\fR:
230.PP
231.Vb 2
232\& cd /some/where/certs
233\& c_rehash .
234.Ve
235.SH "RETURN VALUES"
e056f0e0 236.IX Header "RETURN VALUES"
984263bc 237The following return values can occur:
e056f0e0 238.IP "0" 4
984263bc
MD
239The operation failed because \fBCAfile\fR and \fBCApath\fR are \s-1NULL\s0 or the
240processing at one of the locations specified failed. Check the error
241stack to find out the reason.
e056f0e0
JR
242.IP "1" 4
243.IX Item "1"
984263bc
MD
244The operation succeeded.
245.SH "SEE ALSO"
a7d27d5a 246.IX Header "SEE ALSO"
e056f0e0
JR
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)