Skip to content

Commit 9a3a190

Browse files
kovanclaude
authored andcommitted
doc: clarify diffieHellman.generateKeys recomputes same key
Clarify that calling generateKeys() after a private key has been set recomputes the same public key deterministically, rather than implying the public key changes. The public key is fully determined by the private key, so the result is identical unless the private key was changed via setPrivateKey(). Fixes: #56990 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> PR-URL: #62205 Fixes: #56990 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day>
1 parent ef7ffce commit 9a3a190

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

doc/api/crypto.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1393,8 +1393,10 @@ If `encoding` is provided a string is returned; otherwise a
13931393
[`Buffer`][] is returned.
13941394

13951395
This function is a thin wrapper around [`DH_generate_key()`][]. In particular,
1396-
once a private key has been generated or set, calling this function only updates
1397-
the public key but does not generate a new private key.
1396+
once a private key has been generated or set, calling this function only
1397+
recomputes the public key from the existing private key. Since the public key is
1398+
determined by the private key, the result will be the same unless the private key
1399+
has been changed via [`diffieHellman.setPrivateKey()`][].
13981400

13991401
### `diffieHellman.getGenerator([encoding])`
14001402

@@ -6907,6 +6909,7 @@ See the [list of SSL OP Flags][] for details.
69076909
[`decipher.final()`]: #decipherfinaloutputencoding
69086910
[`decipher.update()`]: #decipherupdatedata-inputencoding-outputencoding
69096911
[`diffieHellman.generateKeys()`]: #diffiehellmangeneratekeysencoding
6912+
[`diffieHellman.setPrivateKey()`]: #diffiehellmansetprivatekeyprivatekey-encoding
69106913
[`diffieHellman.setPublicKey()`]: #diffiehellmansetpublickeypublickey-encoding
69116914
[`ecdh.generateKeys()`]: #ecdhgeneratekeysencoding-format
69126915
[`ecdh.setPrivateKey()`]: #ecdhsetprivatekeyprivatekey-encoding

0 commit comments

Comments
 (0)