0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00

doc: add note about available ECC curves

Added instructions on how to get the elliptic curves supported by the
OpenSSL installation in the crypto.createECDH() constructor. Also made
a few minor grammar fixes within the same paragraph.

PR-URL: https://github.com/nodejs/io.js/pull/1913
Reviewed-By: Roman Reiss <me@silverwind.io>
This commit is contained in:
Ryan Petschek 2015-06-07 13:00:16 -04:00 committed by Roman Reiss
parent 4b3d493c4b
commit deb8b87dc9
2 changed files with 7 additions and 3 deletions

View File

@ -528,8 +528,10 @@ Example (obtaining a shared secret):
## crypto.createECDH(curve_name)
Creates a Elliptic Curve (EC) Diffie-Hellman key exchange object using a
predefined curve specified by `curve_name` string.
Creates an Elliptic Curve (EC) Diffie-Hellman key exchange object using a
predefined curve specified by the `curve_name` string. On recent releases,
`openssl ecparam -list_curves` will display the name and description of each
available elliptic curve.
## Class: ECDH

View File

@ -179,7 +179,9 @@ automatically set as a listener for the [secureConnection][] event. The
- `ecdhCurve`: A string describing a named curve to use for ECDH key agreement
or false to disable ECDH.
Defaults to `prime256v1`. Consult [RFC 4492] for more details.
Defaults to `prime256v1` (NIST P-256). On recent releases, `openssl ecparam
-list_curves` will display the name and description of each available elliptic
curve.
- `dhparam`: A string or `Buffer` containing Diffie Hellman parameters,
required for Perfect Forward Secrecy. Use `openssl dhparam` to create it.