Merge branch 'master' into net80211-update
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_max_cert_list.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_set_max_cert_list 3"
135 .TH SSL_CTX_set_max_cert_list 3 "2010-02-27" "0.9.8m" "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_set_max_cert_list, SSL_CTX_get_max_cert_list, SSL_set_max_cert_list, SSL_get_max_cert_list, \- manipulate allowed for the peer's certificate chain
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 .Vb 1
145 \& #include <openssl/ssl.h>
146 \&
147 \& long SSL_CTX_set_max_cert_list(SSL_CTX *ctx, long size);
148 \& long SSL_CTX_get_max_cert_list(SSL_CTX *ctx);
149 \&
150 \& long SSL_set_max_cert_list(SSL *ssl, long size);
151 \& long SSL_get_max_cert_list(SSL *ctx);
152 .Ve
153 .SH "DESCRIPTION"
154 .IX Header "DESCRIPTION"
155 \&\fISSL_CTX_set_max_cert_list()\fR sets the maximum size allowed for the peer's
156 certificate chain for all \s-1SSL\s0 objects created from \fBctx\fR to be <size> bytes.
157 The \s-1SSL\s0 objects inherit the setting valid for \fBctx\fR at the time
158 \&\fISSL_new\fR\|(3) is being called.
159 .PP
160 \&\fISSL_CTX_get_max_cert_list()\fR returns the currently set maximum size for \fBctx\fR.
161 .PP
162 \&\fISSL_set_max_cert_list()\fR sets the maximum size allowed for the peer's
163 certificate chain for \fBssl\fR to be <size> bytes. This setting stays valid
164 until a new value is set.
165 .PP
166 \&\fISSL_get_max_cert_list()\fR returns the currently set maximum size for \fBssl\fR.
167 .SH "NOTES"
168 .IX Header "NOTES"
169 During the handshake process, the peer may send a certificate chain.
170 The \s-1TLS/SSL\s0 standard does not give any maximum size of the certificate chain.
171 The OpenSSL library handles incoming data by a dynamically allocated buffer.
172 In order to prevent this buffer from growing without bounds due to data
173 received from a faulty or malicious peer, a maximum size for the certificate
174 chain is set.
175 .PP
176 The default value for the maximum certificate chain size is 100kB (30kB
177 on the 16bit \s-1DOS\s0 platform). This should be sufficient for usual certificate
178 chains (OpenSSL's default maximum chain length is 10, see
179 \&\fISSL_CTX_set_verify\fR\|(3), and certificates
180 without special extensions have a typical size of 1\-2kB).
181 .PP
182 For special applications it can be necessary to extend the maximum certificate
183 chain size allowed to be sent by the peer, see e.g. the work on
184 \&\*(L"Internet X.509 Public Key Infrastructure Proxy Certificate Profile\*(R"
185 and \*(L"\s-1TLS\s0 Delegation Protocol\*(R" at http://www.ietf.org/ and
186 http://www.globus.org/ .
187 .PP
188 Under normal conditions it should never be necessary to set a value smaller
189 than the default, as the buffer is handled dynamically and only uses the
190 memory actually required by the data sent by the peer.
191 .PP
192 If the maximum certificate chain size allowed is exceeded, the handshake will
193 fail with a \s-1SSL_R_EXCESSIVE_MESSAGE_SIZE\s0 error.
194 .SH "RETURN VALUES"
195 .IX Header "RETURN VALUES"
196 \&\fISSL_CTX_set_max_cert_list()\fR and \fISSL_set_max_cert_list()\fR return the previously
197 set value.
198 .PP
199 \&\fISSL_CTX_get_max_cert_list()\fR and \fISSL_get_max_cert_list()\fR return the currently
200 set value.
201 .SH "SEE ALSO"
202 .IX Header "SEE ALSO"
203 \&\fIssl\fR\|(3), \fISSL_new\fR\|(3),
204 \&\fISSL_CTX_set_verify\fR\|(3)
205 .SH "HISTORY"
206 .IX Header "HISTORY"
207 SSL*_set/\fIget_max_cert_list()\fR have been introduced in OpenSSL 0.9.7.