Skip to content

Commit

Permalink
doc: add tls.DEFAULT_ECDH_CURVE
Browse files Browse the repository at this point in the history
A user can change the default curve for ECDH key agreement by
using tls.DEFAULT_ECDH_CURVE.
  • Loading branch information
Shigeki Ohtsu committed Apr 23, 2015
1 parent 2f6986e commit 02a51cf
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/api/tls.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ the character "E" appended to the traditional abbreviations):
Ephemeral methods may have some performance drawbacks, because key generation
is expensive.

## tls.DEFAULT_ECDH_CURVE

The default curve name to use for ECDH key agreement. The default
value is `'prime256v1'`. Consult [RFC 4492] for more details.

## tls.getCiphers()

Expand Down Expand Up @@ -154,9 +158,7 @@ automatically set as a listener for the [secureConnection][] event. The
on the format, see the [OpenSSL cipher list format documentation].

- `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.
or false to disable ECDH. The default is set by [tls.DEFAULT_ECDH_CURVE].

- `dhparam`: A string or `Buffer` containing Diffie Hellman parameters,
required for Perfect Forward Secrecy. Use `openssl dhparam` to create it.
Expand Down Expand Up @@ -785,6 +787,7 @@ The numeric representation of the local port.

[OpenSSL cipher list format documentation]: http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT
[BEAST attacks]: http://blog.ivanristic.com/2011/10/mitigating-the-beast-attack-on-tls.html
[tls.DEFAULT_ECDH_CURVE]: #tls_tls_default_ecdh_curve
[tls.createServer]: #tls_tls_createserver_options_secureconnectionlistener
[tls.createSecurePair]: #tls_tls_createsecurepair_credentials_isserver_requestcert_rejectunauthorized
[tls.TLSSocket]: #tls_class_tls_tlssocket
Expand Down

0 comments on commit 02a51cf

Please sign in to comment.