From deb8b87dc93718c5b27958accae1ff326c84d1b3 Mon Sep 17 00:00:00 2001 From: Ryan Petschek Date: Sun, 7 Jun 2015 13:00:16 -0400 Subject: [PATCH] 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 --- doc/api/crypto.markdown | 6 ++++-- doc/api/tls.markdown | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown index 1a181e7e69f3eb..df5f28e5f91fd4 100644 --- a/doc/api/crypto.markdown +++ b/doc/api/crypto.markdown @@ -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 diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown index a00b27dab91c94..cdb1a0811de571 100644 --- a/doc/api/tls.markdown +++ b/doc/api/tls.markdown @@ -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.