secure/lib/libssl/man/SSL_CTX_set_max_cert_list.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   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.  | 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
  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 .\" 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"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  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 .\"
  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
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  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'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 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
 112 .    \" corrections for vroff
 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'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 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
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_set_max_cert_list 3"
 132 .TH SSL_CTX_set_max_cert_list 3 "2007-03-28" "0.9.8e" "OpenSSL"
 133 .SH "NAME"
 134 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
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/ssl.h>
 139 .Ve
 140 .PP
 141 .Vb 2
 142 \& long SSL_CTX_set_max_cert_list(SSL_CTX *ctx, long size);
 143 \& long SSL_CTX_get_max_cert_list(SSL_CTX *ctx);
 144 .Ve
 145 .PP
 146 .Vb 2
 147 \& long SSL_set_max_cert_list(SSL *ssl, long size);
 148 \& long SSL_get_max_cert_list(SSL *ctx);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fISSL_CTX_set_max_cert_list()\fR sets the maximum size allowed for the peer's
 153 certificate chain for all \s-1SSL\s0 objects created from \fBctx\fR to be <size> bytes.
 154 The \s-1SSL\s0 objects inherit the setting valid for \fBctx\fR at the time
 155 \&\fISSL_new\fR\|(3) is being called.
 156 .PP
 157 \&\fISSL_CTX_get_max_cert_list()\fR returns the currently set maximum size for \fBctx\fR.
 158 .PP
 159 \&\fISSL_set_max_cert_list()\fR sets the maximum size allowed for the peer's
 160 certificate chain for \fBssl\fR to be <size> bytes. This setting stays valid
 161 until a new value is set.
 162 .PP
 163 \&\fISSL_get_max_cert_list()\fR returns the currently set maximum size for \fBssl\fR.
 164 .SH "NOTES"
 165 .IX Header "NOTES"
 166 During the handshake process, the peer may send a certificate chain.
 167 The \s-1TLS/SSL\s0 standard does not give any maximum size of the certificate chain.
 168 The OpenSSL library handles incoming data by a dynamically allocated buffer.
 169 In order to prevent this buffer from growing without bounds due to data
 170 received from a faulty or malicious peer, a maximum size for the certificate
 171 chain is set.
 172 .PP
 173 The default value for the maximum certificate chain size is 100kB (30kB
 174 on the 16bit \s-1DOS\s0 platform). This should be sufficient for usual certificate
 175 chains (OpenSSL's default maximum chain length is 10, see
 176 \&\fISSL_CTX_set_verify\fR\|(3), and certificates
 177 without special extensions have a typical size of 1\-2kB).
 178 .PP
 179 For special applications it can be necessary to extend the maximum certificate
 180 chain size allowed to be sent by the peer, see e.g. the work on
 181 \&\*(L"Internet X.509 Public Key Infrastructure Proxy Certificate Profile\*(R"
 182 and \*(L"\s-1TLS\s0 Delegation Protocol\*(R" at http://www.ietf.org/ and
 183 http://www.globus.org/ .
 184 .PP
 185 Under normal conditions it should never be necessary to set a value smaller
 186 than the default, as the buffer is handled dynamically and only uses the
 187 memory actually required by the data sent by the peer.
 188 .PP
 189 If the maximum certificate chain size allowed is exceeded, the handshake will
 190 fail with a \s-1SSL_R_EXCESSIVE_MESSAGE_SIZE\s0 error.
 191 .SH "RETURN VALUES"
 192 .IX Header "RETURN VALUES"
 193 \&\fISSL_CTX_set_max_cert_list()\fR and \fISSL_set_max_cert_list()\fR return the previously
 194 set value.
 195 .PP
 196 \&\fISSL_CTX_get_max_cert_list()\fR and \fISSL_get_max_cert_list()\fR return the currently
 197 set value.
 198 .SH "SEE ALSO"
 199 .IX Header "SEE ALSO"
 200 \&\fIssl\fR\|(3), \fISSL_new\fR\|(3),
 201 \&\fISSL_CTX_set_verify\fR\|(3)
 202 .SH "HISTORY"
 203 .IX Header "HISTORY"
 204 SSL*_set/\fIget_max_cert_list()\fR have been introduced in OpenSSL 0.9.7.