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