doc: add note about available ECC curves
authorRyan Petschek <petschekr@gmail.com>
Sun, 7 Jun 2015 17:00:16 +0000 (13:00 -0400)
committerRoman Reiss <me@silverwind.io>
Sun, 7 Jun 2015 18:47:55 +0000 (20:47 +0200)
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>
doc/api/crypto.markdown
doc/api/tls.markdown

index 1a181e7..df5f28e 100644 (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
 
index a00b27d..cdb1a08 100644 (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.