Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: crypto docs updated to use good defaults for createDiffieHellman #5505

Closed
wants to merge 3 commits into from
Closed

doc: crypto docs updated to use good defaults for createDiffieHellman #5505

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2193e70
crypto docs updated to use good defaults
billautomata Mar 1, 2016
f3a94e3
removed unnecessary encodings
billautomata Mar 1, 2016
0fb7df7
removed newline
billautomata Mar 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions doc/api/crypto.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,19 +325,20 @@ const crypto = require('crypto');
const assert = require('assert');

// Generate Alice's keys...
const alice = crypto.createDiffieHellman(11);
const alice = crypto.createDiffieHellman(2048);
const alice_key = alice.generateKeys();

// Generate Bob's keys...
const bob = crypto.createDiffieHellman(11);
const bob = crypto.createDiffieHellman(alice.getPrime(), 'binary', alice.getGenerator(), 'binary');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'binary' arguments are not necessary here and can be removed since the prime and generator are Buffers.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 changing now

const bob_key = bob.generateKeys();

// Exchange and generate the secret...
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

assert(alice_secret, bob_secret);
// OK
// OK
assert.equal(alice_secret.toString('hex'), bob_secret.toString('hex'));

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excessive newline

```

### diffieHellman.computeSecret(other_public_key[, input_encoding][, output_encoding])
Expand Down