Class DiffieHellman

The DiffieHellman class is a utility for creating Diffie-Hellman key exchanges.

Instances of the DiffieHellman class can be created using the createDiffieHellman function.

import assert from 'node:assert';

const {
  createDiffieHellman,
} = await import('node:crypto');

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

// Generate Bob's keys...
const bob = createDiffieHellman(alice.getPrime(), alice.getGenerator());
const bobKey = bob.generateKeys();

// Exchange and generate the secret...
const aliceSecret = alice.computeSecret(bobKey);
const bobSecret = bob.computeSecret(aliceKey);

// OK
assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));

Since

v0.5.0

Index

Constructors

`Private`constructor

new DiffieHellman(): DiffieHellman
Returns DiffieHellman
- Defined in node_modules/@types/node/crypto.d.ts:1578

Properties

verifyError

verifyError: number

A bit field containing any warnings and/or errors resulting from a check performed during initialization of the DiffieHellman object.

The following values are valid for this property (as defined in node:constants module):

DH_CHECK_P_NOT_SAFE_PRIME
DH_CHECK_P_NOT_PRIME
DH_UNABLE_TO_CHECK_GENERATOR
DH_NOT_SUITABLE_GENERATOR

Since

v0.11.12

Methods

computeSecret

computeSecret(
    otherPublicKey: ArrayBufferView,
    inputEncoding?: null,
    outputEncoding?: null,
): Buffer
Computes the shared secret using otherPublicKey as the other party's public key and returns the computed shared secret. The supplied key is interpreted using the specified inputEncoding, and secret is encoded using specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

If outputEncoding is given a string is returned; otherwise, a Buffer is returned.
Parameters
- otherPublicKey: ArrayBufferView
- OptionalinputEncoding: null
  The encoding of an otherPublicKey string.
- OptionaloutputEncoding: null
  The encoding of the return value.
Returns Buffer
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1607
computeSecret(
    otherPublicKey: string,
    inputEncoding: BinaryToTextEncoding,
    outputEncoding?: null,
): Buffer
Computes the shared secret using otherPublicKey as the other party's public key and returns the computed shared secret. The supplied key is interpreted using the specified inputEncoding, and secret is encoded using specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

If outputEncoding is given a string is returned; otherwise, a Buffer is returned.
Parameters
- otherPublicKey: string
- inputEncoding: BinaryToTextEncoding
  The encoding of an otherPublicKey string.
- OptionaloutputEncoding: null
  The encoding of the return value.
Returns Buffer
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1608
computeSecret(
    otherPublicKey: ArrayBufferView,
    inputEncoding: null,
    outputEncoding: BinaryToTextEncoding,
): string
Computes the shared secret using otherPublicKey as the other party's public key and returns the computed shared secret. The supplied key is interpreted using the specified inputEncoding, and secret is encoded using specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

If outputEncoding is given a string is returned; otherwise, a Buffer is returned.
Parameters
- otherPublicKey: ArrayBufferView
- inputEncoding: null
  The encoding of an otherPublicKey string.
- outputEncoding: BinaryToTextEncoding
  The encoding of the return value.
Returns string
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1609
computeSecret(
    otherPublicKey: string,
    inputEncoding: BinaryToTextEncoding,
    outputEncoding: BinaryToTextEncoding,
): string
Computes the shared secret using otherPublicKey as the other party's public key and returns the computed shared secret. The supplied key is interpreted using the specified inputEncoding, and secret is encoded using specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

If outputEncoding is given a string is returned; otherwise, a Buffer is returned.
Parameters
- otherPublicKey: string
- inputEncoding: BinaryToTextEncoding
  The encoding of an otherPublicKey string.
- outputEncoding: BinaryToTextEncoding
  The encoding of the return value.
Returns string
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1614

generateKeys

generateKeys(): Buffer
Generates private and public Diffie-Hellman key values unless they have been generated or computed already, and returns the public key in the specified encoding. This key should be transferred to the other party. If encoding is provided a string is returned; otherwise a Buffer is returned.

This function is a thin wrapper around DH_generate_key(). In particular, once a private key has been generated or set, calling this function only updates the public key but does not generate a new private key.

Returns Buffer
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1592
generateKeys(encoding: BinaryToTextEncoding): string
Generates private and public Diffie-Hellman key values unless they have been generated or computed already, and returns the public key in the specified encoding. This key should be transferred to the other party. If encoding is provided a string is returned; otherwise a Buffer is returned.

This function is a thin wrapper around DH_generate_key(). In particular, once a private key has been generated or set, calling this function only updates the public key but does not generate a new private key.
Parameters
- encoding: BinaryToTextEncoding
  The encoding of the return value.
Returns string
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1593

getGenerator

getGenerator(): Buffer
Returns the Diffie-Hellman generator in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.

Returns Buffer
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1635
getGenerator(encoding: BinaryToTextEncoding): string
Returns the Diffie-Hellman generator in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.
Parameters
- encoding: BinaryToTextEncoding
  The encoding of the return value.
Returns string
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1636

getPrime

getPrime(): Buffer
Returns the Diffie-Hellman prime in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.

Returns Buffer
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1626
getPrime(encoding: BinaryToTextEncoding): string
Returns the Diffie-Hellman prime in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.
Parameters
- encoding: BinaryToTextEncoding
  The encoding of the return value.
Returns string
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1627

getPrivateKey

getPrivateKey(): Buffer
Returns the Diffie-Hellman private key in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.

Returns Buffer
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1653
getPrivateKey(encoding: BinaryToTextEncoding): string
Returns the Diffie-Hellman private key in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.
Parameters
- encoding: BinaryToTextEncoding
  The encoding of the return value.
Returns string
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1654

getPublicKey

getPublicKey(): Buffer
Returns the Diffie-Hellman public key in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.

Returns Buffer
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1644
getPublicKey(encoding: BinaryToTextEncoding): string
Returns the Diffie-Hellman public key in the specified encoding. If encoding is provided a string is returned; otherwise a Buffer is returned.
Parameters
- encoding: BinaryToTextEncoding
  The encoding of the return value.
Returns string
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1645

setPrivateKey

setPrivateKey(privateKey: ArrayBufferView): void
Sets the Diffie-Hellman private key. If the encoding argument is provided,privateKey is expected to be a string. If no encoding is provided, privateKey is expected to be a Buffer, TypedArray, or DataView.

This function does not automatically compute the associated public key. Either diffieHellman.setPublicKey() or diffieHellman.generateKeys() can be used to manually provide the public key or to automatically derive it.
Parameters
- privateKey: ArrayBufferView
Returns void
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1674
setPrivateKey(privateKey: string, encoding: BufferEncoding): void
Sets the Diffie-Hellman private key. If the encoding argument is provided,privateKey is expected to be a string. If no encoding is provided, privateKey is expected to be a Buffer, TypedArray, or DataView.

This function does not automatically compute the associated public key. Either diffieHellman.setPublicKey() or diffieHellman.generateKeys() can be used to manually provide the public key or to automatically derive it.
Parameters
- privateKey: string
- encoding: BufferEncoding
  The encoding of the privateKey string.
Returns void
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1675

setPublicKey

setPublicKey(publicKey: ArrayBufferView): void
Sets the Diffie-Hellman public key. If the encoding argument is provided, publicKey is expected to be a string. If no encoding is provided, publicKey is expected to be a Buffer, TypedArray, or DataView.
Parameters
- publicKey: ArrayBufferView
Returns void
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1662
setPublicKey(publicKey: string, encoding: BufferEncoding): void
Sets the Diffie-Hellman public key. If the encoding argument is provided, publicKey is expected to be a string. If no encoding is provided, publicKey is expected to be a Buffer, TypedArray, or DataView.
Parameters
- publicKey: string
- encoding: BufferEncoding
  The encoding of the publicKey string.
Returns void
Since
v0.5.0
- Defined in node_modules/@types/node/crypto.d.ts:1663

Class DiffieHellman

Since

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns DiffieHellman

Properties

verifyError

Since

Methods

computeSecret

Parameters

Returns Buffer

Since

Parameters

Returns Buffer

Since

Parameters

Returns string

Since

Parameters

Returns string

Since

generateKeys

Returns Buffer

Since

Parameters

Returns string

Since

getGenerator

Returns Buffer

Since

Parameters

Returns string

Since

getPrime

Returns Buffer

Since

Parameters

Returns string

Since

getPrivateKey

Returns Buffer

Since

Parameters

Returns string

Since

getPublicKey

Returns Buffer

Since

Parameters

Returns string

Since

setPrivateKey

Parameters

Returns void

Since

Parameters

Returns void

Since

setPublicKey

Parameters

Returns void

Since

Parameters

Returns void

Since

Settings

On This Page

`Private`constructor