aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc
diff options
context:
space:
mode:
authorFred Hebert <[email protected]>2015-06-02 10:51:22 -0400
committerFred Hebert <[email protected]>2015-06-03 11:58:41 -0400
commit916226427901f40d695d0d7d91106b0188900055 (patch)
tree73be5bfe291c530a46dd6486a07724c287d80087 /lib/ssl/doc
parent21b8941d83516e381000387c47758bc7f040ae8b (diff)
downloadotp-916226427901f40d695d0d7d91106b0188900055.tar.gz
otp-916226427901f40d695d0d7d91106b0188900055.tar.bz2
otp-916226427901f40d695d0d7d91106b0188900055.zip
Add disable client-initiated renegotiation option
Client-initiated renegotiation is more costly for the server than the client, and this feature can be abused in denial of service attempts. Although the ssl application already takes counter-measure for these (via cooldown periods between renegotiations), it can be useful to disable the feature entirely. This patch adds the `{client_renegotiation, boolean()}' option to the server-side of the SSL application (defaulting to `true' to be compatible with the current behaviour). The option disables the ability to do any renegotiation at all in the protocol's state, reusing the existing denial code, but without opening the code path that sets up a timed message to eventually reopen it up.
Diffstat (limited to 'lib/ssl/doc')
-rw-r--r--lib/ssl/doc/src/ssl.xml12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 0c042f8571..923ecdd618 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -514,6 +514,18 @@ fun(srp, Username :: string(), UserState :: term()) ->
using <c>negotiated_next_protocol/1</c> method.
</item>
+ <tag>{client_renegotiation, boolean()}</tag>
+ <item>In protocols that support client-initiated renegotiation, the cost
+ of resources of such an operation is higher for the server than the
+ client. This can act as a vector for denial of service attacks. The SSL
+ application already takes measures to counter-act such attempts,
+ but client-initiated renegotiation can be stricly disabled by setting
+ this option to <c>false</c>. The default value is <c>true</c>.
+ Note that disabling renegotiation can result in long-lived connections
+ becoming unusable due to limits on the number of messages the underlying
+ cipher suite can encipher.
+ </item>
+
<tag>{psk_identity, string()}</tag>
<item>Specifies the server identity hint the server presents to the client.
</item>