Skip to content

Commit c5050d8

Browse files
silverwindShigeki Ohtsu
authored and
Shigeki Ohtsu
committed
doc: fix 'dhparam' description of tls.createServer
fixes #958 Fixes: #958 PR-URL: #968 Reviewed-By: Shigeki Ohtsu <[email protected]>
1 parent b2a0d8f commit c5050d8

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/api/tls.markdown

+4-3
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,10 @@ automatically set as a listener for the [secureConnection][] event. The
158158

159159
Defaults to `prime256v1`. Consult [RFC 4492] for more details.
160160

161-
- `dhparam`: DH parameter file to use for DHE key agreement. Use
162-
`openssl dhparam` command to create it. If the file is invalid to
163-
load, it is silently discarded.
161+
- `dhparam`: A string or `Buffer` containing Diffie Hellman parameters,
162+
required for Perfect Forward Secrecy. Use `openssl dhparam` to create it.
163+
If omitted or invalid, it is silently discarded and DHE ciphers won't be
164+
available.
164165

165166
- `handshakeTimeout`: Abort the connection if the SSL/TLS handshake does not
166167
finish in this many milliseconds. The default is 120 seconds.

0 commit comments

Comments
 (0)