1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add documentation for createDiffieHellmanGroup

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/28585
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Ojasvi Monga 2019-07-07 16:33:18 +09:00 committed by Rich Trott
parent 6c430b48b9
commit 11c52d9e9f
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/api/crypto.md
View File

@ -698,6 +698,32 @@ module):
* `DH_UNABLE_TO_CHECK_GENERATOR`
* `DH_NOT_SUITABLE_GENERATOR`
## Class: DiffieHellmanGroup
<!-- YAML
added: v0.7.5
-->
The `DiffieHellmanGroup` class takes a well-known modp group as its argument but
otherwise works the same as `DiffieHellman`.
```js
const name = 'modp1';
const dh = crypto.createDiffieHellmanGroup(name);
```
`name` is taken from [RFC 2412][] (modp1 and 2) and [RFC 3526][]:
```console
$ perl -ne 'print "$1\n" if /"(modp\d+)"/' src/node_crypto_groups.h
modp1 # 768 bits
modp2 # 1024 bits
modp5 # 1536 bits
modp14 # 2048 bits
modp15 # etc.
modp16
modp17
modp18
```
## Class: ECDH
<!-- YAML
added: v0.11.14
@ -1733,6 +1759,16 @@ Creates a `DiffieHellman` key exchange object and generates a prime of
`primeLength` bits using an optional specific numeric `generator`.
If `generator` is not specified, the value `2` is used.
### crypto.createDiffieHellmanGroup(name)
<!-- YAML
added: v0.9.3
-->
* `name` {string}
* Returns: {DiffieHellman}
An alias for [`crypto.getDiffieHellman()`][]
### crypto.createECDH(curveName)
<!-- YAML
added: v0.11.14
@ -3226,6 +3262,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
[`crypto.createSign()`]: #crypto_crypto_createsign_algorithm_options
[`crypto.createVerify()`]: #crypto_crypto_createverify_algorithm_options
[`crypto.getCurves()`]: #crypto_crypto_getcurves
[`crypto.getDiffieHellman()`]: #crypto_crypto_getdiffiehellman_groupname
[`crypto.getHashes()`]: #crypto_crypto_gethashes
[`crypto.privateDecrypt()`]: #crypto_crypto_privatedecrypt_privatekey_buffer
[`crypto.privateEncrypt()`]: #crypto_crypto_privateencrypt_privatekey_buffer