package node.crypto; /** The `DiffieHellmanGroup` class takes a well-known modp group as its argument. It works the same as `DiffieHellman`, except that it does not allow changing its keys after creation. In other words, it does not implement `setPublicKey()` or `setPrivateKey()` methods. ```js const { createDiffieHellmanGroup } = await import('node:crypto'); const dh = createDiffieHellmanGroup('modp1'); ``` The name (e.g. `'modp1'`) is taken from [RFC 2412](https://www.rfc-editor.org/rfc/rfc2412.txt) (modp1 and 2) and [RFC 3526](https://www.rfc-editor.org/rfc/rfc3526.txt): ```bash $ 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 ``` **/ @:jsRequire("crypto", "DiffieHellmanGroup") @:forward @:forwardStatics extern abstract DiffieHellmanGroup({ /** Generates private and public Diffie-Hellman key values unless they have beengenerated or computed already, and returnsthe public key in the specified `encoding`. This key should betransferred 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()`](https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html). In particular,once a private key has been generated or set, calling this function only updatesthe public key but does not generate a new private key. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function generateKeys():node.buffer.Buffer; /** Computes the shared secret using `otherPublicKey` as the otherparty's public key and returns the computed shared secret. The suppliedkey is interpreted using the specified `inputEncoding`, and secret isencoded using specified `outputEncoding`.If the `inputEncoding` is notprovided, `otherPublicKey` is expected to be a `Buffer`,`TypedArray`, or `DataView`.If `outputEncoding` is given a string is returned; otherwise, a `Buffer` is returned. **/ @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, ?outputEncoding:Any):node.buffer.Buffer { }) @:overload(function(otherPublicKey:global.nodejs.ArrayBufferView, inputEncoding:Dynamic, outputEncoding:BinaryToTextEncoding):String { }) @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, outputEncoding:BinaryToTextEncoding):String { }) dynamic function computeSecret(otherPublicKey:global.nodejs.ArrayBufferView, ?inputEncoding:Any, ?outputEncoding:Any):node.buffer.Buffer; /** Returns the Diffie-Hellman prime in the specified `encoding`.If `encoding` is provided a string isreturned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrime():node.buffer.Buffer; /** Returns the Diffie-Hellman generator in the specified `encoding`.If `encoding` is provided a string isreturned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getGenerator():node.buffer.Buffer; /** Returns the Diffie-Hellman public key in the specified `encoding`.If `encoding` is provided astring is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPublicKey():node.buffer.Buffer; /** Returns the Diffie-Hellman private key in the specified `encoding`.If `encoding` is provided astring is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrivateKey():node.buffer.Buffer; /** A bit field containing any warnings and/or errors resulting from a checkperformed 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` **/ var verifyError : Float; }) from { /** Generates private and public Diffie-Hellman key values unless they have beengenerated or computed already, and returnsthe public key in the specified `encoding`. This key should betransferred 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()`](https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html). In particular,once a private key has been generated or set, calling this function only updatesthe public key but does not generate a new private key. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function generateKeys():node.buffer.Buffer; /** Computes the shared secret using `otherPublicKey` as the otherparty's public key and returns the computed shared secret. The suppliedkey is interpreted using the specified `inputEncoding`, and secret isencoded using specified `outputEncoding`.If the `inputEncoding` is notprovided, `otherPublicKey` is expected to be a `Buffer`,`TypedArray`, or `DataView`.If `outputEncoding` is given a string is returned; otherwise, a `Buffer` is returned. **/ @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, ?outputEncoding:Any):node.buffer.Buffer { }) @:overload(function(otherPublicKey:global.nodejs.ArrayBufferView, inputEncoding:Dynamic, outputEncoding:BinaryToTextEncoding):String { }) @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, outputEncoding:BinaryToTextEncoding):String { }) dynamic function computeSecret(otherPublicKey:global.nodejs.ArrayBufferView, ?inputEncoding:Any, ?outputEncoding:Any):node.buffer.Buffer; /** Returns the Diffie-Hellman prime in the specified `encoding`.If `encoding` is provided a string isreturned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrime():node.buffer.Buffer; /** Returns the Diffie-Hellman generator in the specified `encoding`.If `encoding` is provided a string isreturned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getGenerator():node.buffer.Buffer; /** Returns the Diffie-Hellman public key in the specified `encoding`.If `encoding` is provided astring is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPublicKey():node.buffer.Buffer; /** Returns the Diffie-Hellman private key in the specified `encoding`.If `encoding` is provided astring is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrivateKey():node.buffer.Buffer; /** A bit field containing any warnings and/or errors resulting from a checkperformed 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` **/ var verifyError : Float; } to { /** Generates private and public Diffie-Hellman key values unless they have beengenerated or computed already, and returnsthe public key in the specified `encoding`. This key should betransferred 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()`](https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html). In particular,once a private key has been generated or set, calling this function only updatesthe public key but does not generate a new private key. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function generateKeys():node.buffer.Buffer; /** Computes the shared secret using `otherPublicKey` as the otherparty's public key and returns the computed shared secret. The suppliedkey is interpreted using the specified `inputEncoding`, and secret isencoded using specified `outputEncoding`.If the `inputEncoding` is notprovided, `otherPublicKey` is expected to be a `Buffer`,`TypedArray`, or `DataView`.If `outputEncoding` is given a string is returned; otherwise, a `Buffer` is returned. **/ @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, ?outputEncoding:Any):node.buffer.Buffer { }) @:overload(function(otherPublicKey:global.nodejs.ArrayBufferView, inputEncoding:Dynamic, outputEncoding:BinaryToTextEncoding):String { }) @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, outputEncoding:BinaryToTextEncoding):String { }) dynamic function computeSecret(otherPublicKey:global.nodejs.ArrayBufferView, ?inputEncoding:Any, ?outputEncoding:Any):node.buffer.Buffer; /** Returns the Diffie-Hellman prime in the specified `encoding`.If `encoding` is provided a string isreturned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrime():node.buffer.Buffer; /** Returns the Diffie-Hellman generator in the specified `encoding`.If `encoding` is provided a string isreturned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getGenerator():node.buffer.Buffer; /** Returns the Diffie-Hellman public key in the specified `encoding`.If `encoding` is provided astring is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPublicKey():node.buffer.Buffer; /** Returns the Diffie-Hellman private key in the specified `encoding`.If `encoding` is provided astring is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrivateKey():node.buffer.Buffer; /** A bit field containing any warnings and/or errors resulting from a checkperformed 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` **/ var verifyError : Float; } { function new(name:String); @:selfCall static function call(name: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()`](https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html). 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. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function generateKeys():node.buffer.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. **/ @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, ?outputEncoding:Any):node.buffer.Buffer { }) @:overload(function(otherPublicKey:global.nodejs.ArrayBufferView, inputEncoding:Dynamic, outputEncoding:BinaryToTextEncoding):String { }) @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, outputEncoding:BinaryToTextEncoding):String { }) dynamic function computeSecret(otherPublicKey:global.nodejs.ArrayBufferView, ?inputEncoding:Any, ?outputEncoding:Any):node.buffer.Buffer; /** Returns the Diffie-Hellman prime in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrime():node.buffer.Buffer; /** Returns the Diffie-Hellman generator in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getGenerator():node.buffer.Buffer; /** Returns the Diffie-Hellman public key in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPublicKey():node.buffer.Buffer; /** Returns the Diffie-Hellman private key in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrivateKey():node.buffer.Buffer; /** 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` **/ var verifyError : Float; }; static final prototype : { /** 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()`](https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html). 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. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function generateKeys():node.buffer.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. **/ @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, ?outputEncoding:Any):node.buffer.Buffer { }) @:overload(function(otherPublicKey:global.nodejs.ArrayBufferView, inputEncoding:Dynamic, outputEncoding:BinaryToTextEncoding):String { }) @:overload(function(otherPublicKey:String, inputEncoding:BinaryToTextEncoding, outputEncoding:BinaryToTextEncoding):String { }) dynamic function computeSecret(otherPublicKey:global.nodejs.ArrayBufferView, ?inputEncoding:Any, ?outputEncoding:Any):node.buffer.Buffer; /** Returns the Diffie-Hellman prime in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrime():node.buffer.Buffer; /** Returns the Diffie-Hellman generator in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getGenerator():node.buffer.Buffer; /** Returns the Diffie-Hellman public key in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPublicKey():node.buffer.Buffer; /** Returns the Diffie-Hellman private key in the specified `encoding`. If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. **/ @:overload(function(encoding:BinaryToTextEncoding):String { }) dynamic function getPrivateKey():node.buffer.Buffer; /** 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` **/ var verifyError : Float; }; }