Skip to content

Commit eb54e70

Browse files
kovanclaude
andauthored
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 53b8d3c commit eb54e70

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/api/crypto.md

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

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

13951397
### `diffieHellman.getGenerator([encoding])`
13961398

@@ -6936,6 +6938,7 @@ See the [list of SSL OP Flags][] for details.
69366938
[`decipher.final()`]: #decipherfinaloutputencoding
69376939
[`decipher.update()`]: #decipherupdatedata-inputencoding-outputencoding
69386940
[`diffieHellman.generateKeys()`]: #diffiehellmangeneratekeysencoding
6941+
[`diffieHellman.setPrivateKey()`]: #diffiehellmansetprivatekeyprivatekey-encoding
69396942
[`diffieHellman.setPublicKey()`]: #diffiehellmansetpublickeypublickey-encoding
69406943
[`ecdh.generateKeys()`]: #ecdhgeneratekeysencoding-format
69416944
[`ecdh.setPrivateKey()`]: #ecdhsetprivatekeyprivatekey-encoding

0 commit comments

Comments
 (0)