Skip to content

Improvements to tls API documentation, batch 1 #9800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sam-github wants to merge 19 commits into from
Closed

Improvements to tls API documentation, batch 1 #9800

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
8ea758c
tls: fix/annotate connect arg comments
sam-github Nov 18, 2016
516a9d9
tls: document and test option-less createServer
sam-github Nov 21, 2016
cd1fdfb
test: tls key/cert ordering not necessary
sam-github Nov 22, 2016
28a3045
tls: do not refer to secureOptions as flags
sam-github Nov 22, 2016
53cfdb0
doc: document all TLSSocket options
sam-github Nov 23, 2016
43b8c9e
doc: describe all tls.connect() variants
sam-github Nov 23, 2016
c94b954
doc: socket passed to tls.connect is user managed
sam-github Nov 24, 2016
b9a6642
doc: describe tls passphrase use with pfx and key
sam-github Nov 24, 2016
8c25224
doc: describe tls cert and ca options
sam-github Nov 24, 2016
90e01ff
doc: describe buffer forms of tls crl option
sam-github Nov 24, 2016
706efcd
doc: describe tls cipher option and defaults
sam-github Nov 24, 2016
be11388
doc: fix link to Crypto Constants
sam-github Nov 25, 2016
17405b6
doc: honorCipherOrder sets CIPHER_SERVER_PREFERENCE
sam-github Nov 25, 2016
5c078e5
doc: describe tls ecdhCurve/dhparam options
sam-github Nov 25, 2016
e8e59e4
doc: describe tls secureProtocol option
sam-github Nov 25, 2016
797b334
doc: describe tls secureOptions
sam-github Nov 25, 2016
5a85e08
doc: describe tls sessionIdContext
sam-github Nov 25, 2016
bb89227
doc: de-deduplicate secure context docs
sam-github Nov 25, 2016
a52555e
test: var to const in tls-no-cert-required
sam-github Dec 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: describe tls ecdhCurve/dhparam options
  • Loading branch information
@sam-github
sam-github committed Dec 9, 2016
commit 5c078e556fbecb74df4e623831d65fb8206dfad0
16 changes: 14 additions & 2 deletions doc/api/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,9 @@ Ephemeral methods may have some performance drawbacks, because key generation
is expensive.

To use Perfect Forward Secrecy using `DHE` with the `tls` module, it is required
to generate Diffie-Hellman parameters. The following illustrates the use of the
OpenSSL command-line interface to generate such parameters:
to generate Diffie-Hellman parameters and specify them with the `dhparam`
option to [`tls.createSecureContext()`][]. The following illustrates the use of
the OpenSSL command-line interface to generate such parameters:

```sh
openssl dhparam -outform PEM -out dhparam.pem 2048
Expand Down Expand Up @@ -926,6 +927,17 @@ added: v0.11.13
[OpenSSL Options][] for more information.
*Note*: [`tls.createServer()`][] sets the default value to `true`, other
APIs that create secure contexts leave it unset.
* `ecdhCurve` {string} A string describing a named curve to use for ECDH key
agreement or `false` to disable ECDH. Defaults to `prime256v1` (NIST P-256).
Use [`crypto.getCurves()`][] to obtain a list of available curve names. On
recent releases, `openssl ecparam -list_curves` will also display the name
and description of each available elliptic curve.
* `dhparam` {string|Buffer} Diffie Hellman parameters, required for
[Perfect Forward Secrecy][]. Use `openssl dhparam` to create the parameters.
The key length must be greater than or equal to 1024 bits, otherwise an
error will be thrown. It is strongly recommended to use 2048 bits or larger
for stronger security. If omitted or invalid, the parameters are silently
Copy link
Copy Markdown
Contributor

@silverwind silverwind Nov 25, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adequate security?

Copy link
Copy Markdown
Contributor Author

@sam-github sam-github Nov 25, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verbatim copy of existing text: https://github.com/nodejs/node/blob/1f45d7aa41291383ce63cca5f80fd2a2a73d7603/doc/api/tls.md#tlscreateserveroptions-secureconnectionlistener

discarded and DHE ciphers will not be available.

The `tls.createSecureContext()` method creates a credentials object.

Expand Down