Skip to content

Commit

Permalink
doc: clarify DiffieHellmanGroup class docs
Browse files Browse the repository at this point in the history
Make it clearer in the docs that DiffieHellmanGroup does
not support changing the keys after creation.
  • Loading branch information
Linkgoron committed Apr 22, 2021
1 parent bc31dc0 commit 13c55c3
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -1114,8 +1114,10 @@ module):
added: v0.7.5
-->

The `DiffieHellmanGroup` class takes a well-known modp group as its argument but
otherwise works the same as `DiffieHellman`.
The `DiffieHellmanGroup` class takes a well-known modp group as its argument.
Works the same as `DiffieHellman`, except that it does not allow changing its
keys after creation - i.e. does not implement `setPublicKey` or `setPrivateKey`
methods.

```mjs
const { createDiffieHellmanGroup } = await import('crypto');
Expand Down

0 comments on commit 13c55c3

Please sign in to comment.