Skip to content

Commit deb8b87

Browse files
petschekrsilverwind
authored andcommitted
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: #1913 Reviewed-By: Roman Reiss <[email protected]>
1 parent 4b3d493 commit deb8b87

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

doc/api/crypto.markdown

+4-2
Original file line numberDiff line numberDiff line change
@@ -528,8 +528,10 @@ Example (obtaining a shared secret):
528528

529529
## crypto.createECDH(curve_name)
530530

531-
Creates a Elliptic Curve (EC) Diffie-Hellman key exchange object using a
532-
predefined curve specified by `curve_name` string.
531+
Creates an Elliptic Curve (EC) Diffie-Hellman key exchange object using a
532+
predefined curve specified by the `curve_name` string. On recent releases,
533+
`openssl ecparam -list_curves` will display the name and description of each
534+
available elliptic curve.
533535

534536
## Class: ECDH
535537

doc/api/tls.markdown

+3-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,9 @@ automatically set as a listener for the [secureConnection][] event. The
179179
- `ecdhCurve`: A string describing a named curve to use for ECDH key agreement
180180
or false to disable ECDH.
181181

182-
Defaults to `prime256v1`. Consult [RFC 4492] for more details.
182+
Defaults to `prime256v1` (NIST P-256). On recent releases, `openssl ecparam
183+
-list_curves` will display the name and description of each available elliptic
184+
curve.
183185

184186
- `dhparam`: A string or `Buffer` containing Diffie Hellman parameters,
185187
required for Perfect Forward Secrecy. Use `openssl dhparam` to create it.

0 commit comments

Comments
 (0)