Skip to content
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

doc: add note about available ECC curves #1913

Closed
wants to merge 4 commits into from
Closed

doc: add note about available ECC curves #1913

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6f7d93
doc: add note about available ECC curves
petschekr Jun 7, 2015
0dc385d
doc: add note about ECC curves in TLS server docs
petschekr Jun 7, 2015
bf3ee33
doc: revise description of TLS server ecdhCurve
petschekr Jun 7, 2015
b116c6f
Removed trailing whitespace
petschekr Jun 7, 2015
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
6 changes: 4 additions & 2 deletions doc/api/crypto.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

@petschekr trailing whitespace on this line, could you remove that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@silverwind Just fixed it in b116c6f

available elliptic curve.

## Class: ECDH

Expand Down
4 changes: 3 additions & 1 deletion doc/api/tls.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down