Update per latest manual pages.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_max_cert_list.3
CommitLineData
984263bc
MD
1.\" Automatically generated by Pod::Man version 1.15
2.\" Wed Feb 19 16:47:41 2003
3.\"
4.\" Standard preamble:
5.\" ======================================================================
6.de Sh \" Subsection heading
7.br
8.if t .Sp
9.ne 5
10.PP
11\fB\\$1\fR
12.PP
13..
14.de Sp \" Vertical space (when we can't use .PP)
15.if t .sp .5v
16.if n .sp
17..
18.de Ip \" List item
19.br
20.ie \\n(.$>=3 .ne \\$3
21.el .ne 3
22.IP "\\$1" \\$2
23..
24.de Vb \" Begin verbatim text
25.ft CW
26.nf
27.ne \\$1
28..
29.de Ve \" End verbatim text
30.ft R
31
32.fi
33..
34.\" Set up some character translations and predefined strings. \*(-- will
35.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36.\" double quote, and \*(R" will give a right double quote. | will give a
37.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38.\" to do unbreakable dashes and therefore won't be available. \*(C` and
39.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
40.tr \(*W-|\(bv\*(Tr
41.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
42.ie n \{\
43. ds -- \(*W-
44. ds PI pi
45. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
47. ds L" ""
48. ds R" ""
49. ds C` ""
50. ds C' ""
51'br\}
52.el\{\
53. ds -- \|\(em\|
54. ds PI \(*p
55. ds L" ``
56. ds R" ''
57'br\}
58.\"
59.\" If the F register is turned on, we'll generate index entries on stderr
60.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61.\" index entries marked with X<> in POD. Of course, you'll have to process
62.\" the output yourself in some meaningful fashion.
63.if \nF \{\
64. de IX
65. tm Index:\\$1\t\\n%\t"\\$2"
66..
67. nr % 0
68. rr F
69.\}
70.\"
71.\" For nroff, turn off justification. Always turn off hyphenation; it
72.\" makes way too many mistakes in technical documents.
73.hy 0
74.if n .na
75.\"
76.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77.\" Fear. Run. Save yourself. No user-serviceable parts.
78.bd B 3
79. \" fudge factors for nroff and troff
80.if n \{\
81. ds #H 0
82. ds #V .8m
83. ds #F .3m
84. ds #[ \f1
85. ds #] \fP
86.\}
87.if t \{\
88. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89. ds #V .6m
90. ds #F 0
91. ds #[ \&
92. ds #] \&
93.\}
94. \" simple accents for nroff and troff
95.if n \{\
96. ds ' \&
97. ds ` \&
98. ds ^ \&
99. ds , \&
100. ds ~ ~
101. ds /
102.\}
103.if t \{\
104. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
110.\}
111. \" troff and (daisy-wheel) nroff accents
112.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119.ds ae a\h'-(\w'a'u*4/10)'e
120.ds Ae A\h'-(\w'A'u*4/10)'E
121. \" corrections for vroff
122.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124. \" for low resolution devices (crt and lpr)
125.if \n(.H>23 .if \n(.V>19 \
126\{\
127. ds : e
128. ds 8 ss
129. ds o a
130. ds d- d\h'-1'\(ga
131. ds D- D\h'-1'\(hy
132. ds th \o'bp'
133. ds Th \o'LP'
134. ds ae ae
135. ds Ae AE
136.\}
137.rm #[ #] #H #V #F C
138.\" ======================================================================
139.\"
140.IX Title "SSL_CTX_set_max_cert_list 3"
141.TH SSL_CTX_set_max_cert_list 3 "0.9.7a" "2003-02-19" "OpenSSL"
142.UC
143.SH "NAME"
144SSL_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
145.SH "SYNOPSIS"
146.IX Header "SYNOPSIS"
147.Vb 1
148\& #include <openssl/ssl.h>
149.Ve
150.Vb 2
151\& long SSL_CTX_set_max_cert_list(SSL_CTX *ctx, long size);
152\& long SSL_CTX_get_max_cert_list(SSL_CTX *ctx);
153.Ve
154.Vb 2
155\& long SSL_set_max_cert_list(SSL *ssl, long size);
156\& long SSL_get_max_cert_list(SSL *ctx);
157.Ve
158.SH "DESCRIPTION"
159.IX Header "DESCRIPTION"
160\&\fISSL_CTX_set_max_cert_list()\fR sets the maximum size allowed for the peer's
161certificate chain for all \s-1SSL\s0 objects created from \fBctx\fR to be <size> bytes.
162The \s-1SSL\s0 objects inherit the setting valid for \fBctx\fR at the time
163SSL_new(3) is being called.
164.PP
165\&\fISSL_CTX_get_max_cert_list()\fR returns the currently set maximum size for \fBctx\fR.
166.PP
167\&\fISSL_set_max_cert_list()\fR sets the maximum size allowed for the peer's
168certificate chain for \fBssl\fR to be <size> bytes. This setting stays valid
169until a new value is set.
170.PP
171\&\fISSL_get_max_cert_list()\fR returns the currently set maximum size for \fBssl\fR.
172.SH "NOTES"
173.IX Header "NOTES"
174During the handshake process, the peer may send a certificate chain.
175The \s-1TLS/SSL\s0 standard does not give any maximum size of the certificate chain.
176The OpenSSL library handles incoming data by a dynamically allocated buffer.
177In order to prevent this buffer from growing without bounds due to data
178received from a faulty or malicious peer, a maximum size for the certificate
179chain is set.
180.PP
181The default value for the maximum certificate chain size is 100kB (30kB
182on the 16bit \s-1DOS\s0 platform). This should be sufficient for usual certificate
183chains (OpenSSL's default maximum chain length is 10, see
184SSL_CTX_set_verify(3), and certificates
185without special extensions have a typical size of 1\-2kB).
186.PP
187For special applications it can be necessary to extend the maximum certificate
188chain size allowed to be sent by the peer, see e.g. the work on
189\&\*(L"Internet X.509 Public Key Infrastructure Proxy Certificate Profile\*(R"
190and \*(L"\s-1TLS\s0 Delegation Protocol\*(R" at http://www.ietf.org/ and
191http://www.globus.org/ .
192.PP
193Under normal conditions it should never be necessary to set a value smaller
194than the default, as the buffer is handled dynamically and only uses the
195memory actually required by the data sent by the peer.
196.PP
197If the maximum certificate chain size allowed is exceeded, the handshake will
198fail with a \s-1SSL_R_EXCESSIVE_MESSAGE_SIZE\s0 error.
199.SH "RETURN VALUES"
200.IX Header "RETURN VALUES"
201\&\fISSL_CTX_set_max_cert_list()\fR and \fISSL_set_max_cert_list()\fR return the previously
202set value.
203.PP
204\&\fISSL_CTX_get_max_cert_list()\fR and \fISSL_get_max_cert_list()\fR return the currently
205set value.
206.SH "SEE ALSO"
207.IX Header "SEE ALSO"
208ssl(3), SSL_new(3),
209SSL_CTX_set_verify(3)
210.SH "HISTORY"
211.IX Header "HISTORY"
212SSL*_set/\fIget_max_cert_list()\fR have been introduced in OpenSSL 0.9.7.