From c5050d8e4d16e59a2bf24da420f84192d6f3d872 Mon Sep 17 00:00:00 2001 From: silverwind Date: Thu, 26 Feb 2015 15:36:41 +0100 Subject: [PATCH] doc: fix 'dhparam' description of tls.createServer fixes #958 Fixes: https://github.com/iojs/io.js/issues/958 PR-URL: https://github.com/iojs/io.js/pull/968 Reviewed-By: Shigeki Ohtsu --- doc/api/tls.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown index 910ca5e7b55..ea9b6cd08a2 100644 --- a/doc/api/tls.markdown +++ b/doc/api/tls.markdown @@ -158,9 +158,10 @@ automatically set as a listener for the [secureConnection][] event. The Defaults to `prime256v1`. Consult [RFC 4492] for more details. - - `dhparam`: DH parameter file to use for DHE key agreement. Use - `openssl dhparam` command to create it. If the file is invalid to - load, it is silently discarded. + - `dhparam`: A string or `Buffer` containing Diffie Hellman parameters, + required for Perfect Forward Secrecy. Use `openssl dhparam` to create it. + If omitted or invalid, it is silently discarded and DHE ciphers won't be + available. - `handshakeTimeout`: Abort the connection if the SSL/TLS handshake does not finish in this many milliseconds. The default is 120 seconds.