Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
doc: fix createDiffieHellman generator type
OpenSSL does not provide a straight-forward way to implement a
non-integer generator, so createDiffieHellman never supported anything
other than a number as the generator. (This only applies to the
signature where the first argument is the size of the prime, and
therefore a number.)

Refs: nodejs/node-v0.x-archive#7086
Refs: #21782

PR-URL: #31121
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
  • Loading branch information
tniessen authored and BethGriggs committed Feb 6, 2020
1 parent 465a1cf commit 2d9d59f
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions doc/api/crypto.md
Expand Up @@ -1855,8 +1855,7 @@ added: v0.5.0
-->

* `primeLength` {number}
* `generator` {number | string | Buffer | TypedArray | DataView} **Default:**
`2`
* `generator` {number} **Default:** `2`
* Returns: {DiffieHellman}

Creates a `DiffieHellman` key exchange object and generates a prime of
Expand Down

0 comments on commit 2d9d59f

Please sign in to comment.