@haxall/haxall
    Preparing search index...

    Class ECDH

    The ECDH class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH) key exchanges.

    Instances of the ECDH class can be created using the createECDH function.

    import assert from 'node:assert';

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

    // Generate Alice's keys...
    const alice = createECDH('secp521r1');
    const aliceKey = alice.generateKeys();

    // Generate Bob's keys...
    const bob = createECDH('secp521r1');
    const bobKey = bob.generateKeys();

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

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

    v0.11.14

    Index

    Constructors

    constructor

    Methods

    computeSecret generateKeys getPrivateKey getPublicKey setPrivateKey convertKey

    Constructors

    • Returns ECDH

    Methods

    • 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 specified inputEncoding, and the returned secret is encoded using the specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

      If outputEncoding is given a string will be returned; otherwise a Buffer is returned.

      ecdh.computeSecret will throw anERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY error when otherPublicKey lies outside of the elliptic curve. Since otherPublicKey is usually supplied from a remote user over an insecure network, be sure to handle this exception accordingly.

      Parameters

      • otherPublicKey: ArrayBufferView

      Returns Buffer

      v0.11.14

    • 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 specified inputEncoding, and the returned secret is encoded using the specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

      If outputEncoding is given a string will be returned; otherwise a Buffer is returned.

      ecdh.computeSecret will throw anERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY error when otherPublicKey lies outside of the elliptic curve. Since otherPublicKey is usually supplied from a remote user over an insecure network, be sure to handle this exception accordingly.

      Parameters

      • otherPublicKey: string
      • inputEncoding: BinaryToTextEncoding

        The encoding of the otherPublicKey string.

      Returns Buffer

      v0.11.14

    • 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 specified inputEncoding, and the returned secret is encoded using the specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

      If outputEncoding is given a string will be returned; otherwise a Buffer is returned.

      ecdh.computeSecret will throw anERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY error when otherPublicKey lies outside of the elliptic curve. Since otherPublicKey is usually supplied from a remote user over an insecure network, be sure to handle this exception accordingly.

      Parameters

      • otherPublicKey: ArrayBufferView
      • outputEncoding: BinaryToTextEncoding

        The encoding of the return value.

      Returns string

      v0.11.14

    • 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 specified inputEncoding, and the returned secret is encoded using the specified outputEncoding. If the inputEncoding is not provided, otherPublicKey is expected to be a Buffer, TypedArray, or DataView.

      If outputEncoding is given a string will be returned; otherwise a Buffer is returned.

      ecdh.computeSecret will throw anERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY error when otherPublicKey lies outside of the elliptic curve. Since otherPublicKey is usually supplied from a remote user over an insecure network, be sure to handle this exception accordingly.

      Parameters

      Returns string

      v0.11.14

    • Generates private and public EC Diffie-Hellman key values, and returns the public key in the specified format and encoding. This key should be transferred to the other party.

      The format argument specifies point encoding and can be 'compressed' or 'uncompressed'. If format is not specified, the point will be returned in'uncompressed' format.

      If encoding is provided a string is returned; otherwise a Buffer is returned.

      Returns Buffer

      v0.11.14

    • Generates private and public EC Diffie-Hellman key values, and returns the public key in the specified format and encoding. This key should be transferred to the other party.

      The format argument specifies point encoding and can be 'compressed' or 'uncompressed'. If format is not specified, the point will be returned in'uncompressed' format.

      If encoding is provided a string is returned; otherwise a Buffer is returned.

      Parameters

      Returns string

      v0.11.14

    • If encoding is specified, a string is returned; otherwise a Buffer is returned.

      Returns Buffer

      The EC Diffie-Hellman in the specified encoding.

      v0.11.14

    • If encoding is specified, a string is returned; otherwise a Buffer is returned.

      Parameters

      Returns string

      The EC Diffie-Hellman in the specified encoding.

      v0.11.14

    • The format argument specifies point encoding and can be 'compressed' or 'uncompressed'. If format is not specified the point will be returned in'uncompressed' format.

      If encoding is specified, a string is returned; otherwise a Buffer is returned.

      Parameters

      • Optionalencoding: null

        The encoding of the return value.

      • Optionalformat: ECDHKeyFormat

      Returns Buffer

      The EC Diffie-Hellman public key in the specified encoding and format.

      v0.11.14

    • The format argument specifies point encoding and can be 'compressed' or 'uncompressed'. If format is not specified the point will be returned in'uncompressed' format.

      If encoding is specified, a string is returned; otherwise a Buffer is returned.

      Parameters

      Returns string

      The EC Diffie-Hellman public key in the specified encoding and format.

      v0.11.14

    • Sets the EC Diffie-Hellman private key. If encoding is provided, privateKey is expected to be a string; otherwise privateKey is expected to be a Buffer, TypedArray, or DataView.

      If privateKey is not valid for the curve specified when the ECDH object was created, an error is thrown. Upon setting the private key, the associated public point (key) is also generated and set in the ECDH object.

      Parameters

      • privateKey: ArrayBufferView

      Returns void

      v0.11.14

    • Sets the EC Diffie-Hellman private key. If encoding is provided, privateKey is expected to be a string; otherwise privateKey is expected to be a Buffer, TypedArray, or DataView.

      If privateKey is not valid for the curve specified when the ECDH object was created, an error is thrown. Upon setting the private key, the associated public point (key) is also generated and set in the ECDH object.

      Parameters

      Returns void

      v0.11.14

    • Converts the EC Diffie-Hellman public key specified by key and curve to the format specified by format. The format argument specifies point encoding and can be 'compressed', 'uncompressed' or 'hybrid'. The supplied key is interpreted using the specified inputEncoding, and the returned key is encoded using the specified outputEncoding.

      Use getCurves to obtain a list of available curve names. On recent OpenSSL releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve.

      If format is not specified the point will be returned in 'uncompressed' format.

      If the inputEncoding is not provided, key is expected to be a Buffer, TypedArray, or DataView.

      Example (uncompressing a key):

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

      const ecdh = createECDH('secp256k1');
      ecdh.generateKeys();

      const compressedKey = ecdh.getPublicKey('hex', 'compressed');

      const uncompressedKey = ECDH.convertKey(compressedKey,
                                              'secp256k1',
                                              'hex',
                                              'hex',
                                              'uncompressed');

      // The converted key and the uncompressed public key should be the same
      console.log(uncompressedKey === ecdh.getPublicKey('hex'));

      Parameters

      • key: BinaryLike
      • curve: string
      • OptionalinputEncoding: BinaryToTextEncoding

        The encoding of the key string.

      • OptionaloutputEncoding: "base64" | "base64url" | "latin1" | "hex"

        The encoding of the return value.

      • Optionalformat: "uncompressed" | "compressed" | "hybrid"

      Returns string | Buffer<ArrayBufferLike>

      v10.0.0

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods