Skip to content

Commit 9f3a03f

Browse files
committed
doc: add references to crypto.getCurves()
This adds references to the newly available crypto.getCurves method where appropriate. PR-URL: #1918 Reviewed-By: Brian White <[email protected]>
1 parent 9c0a1b8 commit 9f3a03f

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

doc/api/crypto.markdown

+5-3
Original file line numberDiff line numberDiff line change
@@ -539,9 +539,10 @@ Example (obtaining a shared secret):
539539
## crypto.createECDH(curve_name)
540540

541541
Creates an Elliptic Curve (EC) Diffie-Hellman key exchange object using a
542-
predefined curve specified by the `curve_name` string. On recent releases,
543-
`openssl ecparam -list_curves` will display the name and description of each
544-
available elliptic curve.
542+
predefined curve specified by the `curve_name` string. Use [getCurves()][] to
543+
obtain a list of available curve names. On recent releases,
544+
`openssl ecparam -list_curves` will also display the name and description of
545+
each available elliptic curve.
545546

546547
## Class: ECDH
547548

@@ -775,6 +776,7 @@ temporary measure.
775776

776777
[createCipher()]: #crypto_crypto_createcipher_algorithm_password
777778
[createCipheriv()]: #crypto_crypto_createcipheriv_algorithm_key_iv
779+
[getCurves()]: #crypto_crypto_getcurves
778780
[crypto.createDiffieHellman()]: #crypto_crypto_creatediffiehellman_prime_prime_encoding_generator_generator_encoding
779781
[tls.createSecureContext]: tls.html#tls_tls_createsecurecontext_details
780782
[diffieHellman.setPublicKey()]: #crypto_diffiehellman_setpublickey_public_key_encoding

doc/api/tls.markdown

+5-3
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,10 @@ 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` (NIST P-256). On recent releases, `openssl ecparam
183-
-list_curves` will display the name and description of each available elliptic
184-
curve.
182+
Defaults to `prime256v1` (NIST P-256). Use [crypto.getCurves()][] to obtain
183+
a list of available curve names. On recent releases,
184+
`openssl ecparam -list_curves` will also display the name and description of
185+
each available elliptic curve.
185186

186187
- `dhparam`: A string or `Buffer` containing Diffie Hellman parameters,
187188
required for Perfect Forward Secrecy. Use `openssl dhparam` to create it.
@@ -814,6 +815,7 @@ The numeric representation of the local port.
814815
[Chrome's 'modern cryptography' setting]: http://www.chromium.org/Home/chromium-security/education/tls#TOC-Deprecation-of-TLS-Features-Algorithms-in-Chrome
815816
[specific attacks affecting larger AES key sizes]: https://www.schneier.com/blog/archives/2009/07/another_new_aes.html
816817
[BEAST attacks]: http://blog.ivanristic.com/2011/10/mitigating-the-beast-attack-on-tls.html
818+
[crypto.getCurves()]: crypto.html#crypto_crypto_getcurves
817819
[tls.createServer]: #tls_tls_createserver_options_secureconnectionlistener
818820
[tls.createSecurePair]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized
819821
[tls.TLSSocket]: #tls_class_tls_tlssocket

0 commit comments

Comments
 (0)