doc: fix 'dhparam' description of tls.createServer

fixes #958 Fixes: #958 PR-URL: #968 Reviewed-By: Shigeki Ohtsu <[email protected]>
nodejs · Feb 26, 2015 · c5050d8 · c5050d8 · indutny · Feb 26, 2015
1 parent b2a0d8f
commit c5050d8
Showing 1 changed file with 4 additions and 3 deletions.
diff --git 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.