doc: crypto.createDiffieHellmanGroup() not documented

[bnoordhuis]

See title. Class DiffieHellmanGroup isn't documented either.

Usage:

const name = 'modp1';
const dh = crypto.createDiffieHellmanGroup(name);

It takes a well-known modp group as its argument but otherwise works the same as DiffieHellman.

name is taken from RFC 2412 (modp1 and 2) and RFC 3526:

$ perl -ne 'print "$1\n" if /"(modp\d+)"/' src/node_crypto_groups.h
modp1  #  768 bits
modp2  # 1024 bits
modp5  # 1536 bits
modp14 # 2048 bits
modp15 # etc.
modp16
modp17
modp18

[someone-1]

Hi
is this issue fixed ?
can i take it up ?

[bnoordhuis]

@someone-1 You're welcome to take it.

[someone-1]

hi @bnoordhuis

in the file crypto.js
module.exports = {
getDiffieHellman: createDiffieHellmanGroup,
createDiffieHellmanGroup,
}
i think there is 2 things exported with different name.
and documentation for getDiffieHellman is already present in

getDiffieHellman in crypto.js
createDiffieHellmanGroup in crypto.js

could you suggest me how to proceed ?

Thank you

[bnoordhuis]

Oh, that's a good point. You could add a section explaining it's an alias and link to crypto.getDiffieHellman().

Important to note that crypto.createDiffieHellmanGroup() was added in v0.9.3. (Class DiffieHellmanGroup was added in v0.7.5 though.)

[joe9111]

Hi, I am working on this as well!

[olingern]

I believe @Trott merged #28585 in 11c52d9 so it looks like this can be closed