ikan Uploader :
Directory : /proc/self/root/proc/self/root/home/ubuntu/node-v16.18.1/doc/api/
Upload File : |
| Current File : //proc/self/root/proc/self/root/home/ubuntu/node-v16.18.1/doc/api/crypto.json |
{
"type": "module",
"source": "doc/api/crypto.md",
"modules": [
{
"textRaw": "Crypto",
"name": "crypto",
"introduced_in": "v0.3.6",
"stability": 2,
"stabilityText": "Stable",
"desc": "<p><strong>Source Code:</strong> <a href=\"https://github.com/nodejs/node/blob/v16.18.1/lib/crypto.js\">lib/crypto.js</a></p>\n<p>The <code>node:crypto</code> module provides cryptographic functionality that includes a\nset of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify\nfunctions.</p>\n<pre><code class=\"language-mjs\">const { createHmac } = await import('node:crypto');\n\nconst secret = 'abcdefg';\nconst hash = createHmac('sha256', secret)\n .update('I love cupcakes')\n .digest('hex');\nconsole.log(hash);\n// Prints:\n// c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e\n</code></pre>\n<pre><code class=\"language-cjs\">const crypto = require('node:crypto');\n\nconst secret = 'abcdefg';\nconst hash = crypto.createHmac('sha256', secret)\n .update('I love cupcakes')\n .digest('hex');\nconsole.log(hash);\n// Prints:\n// c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e\n</code></pre>",
"modules": [
{
"textRaw": "Determining if crypto support is unavailable",
"name": "determining_if_crypto_support_is_unavailable",
"desc": "<p>It is possible for Node.js to be built without including support for the\n<code>node:crypto</code> module. In such cases, attempting to <code>import</code> from <code>crypto</code> or\ncalling <code>require('node:crypto')</code> will result in an error being thrown.</p>\n<p>When using CommonJS, the error thrown can be caught using try/catch:</p>\n<!-- eslint-skip -->\n<pre><code class=\"language-cjs\">let crypto;\ntry {\n crypto = require('node:crypto');\n} catch (err) {\n console.log('crypto support is disabled!');\n}\n</code></pre>\n<p>When using the lexical ESM <code>import</code> keyword, the error can only be\ncaught if a handler for <code>process.on('uncaughtException')</code> is registered\n<em>before</em> any attempt to load the module is made (using, for instance,\na preload module).</p>\n<p>When using ESM, if there is a chance that the code may be run on a build\nof Node.js where crypto support is not enabled, consider using the\n<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import\"><code>import()</code></a> function instead of the lexical <code>import</code> keyword:</p>\n<pre><code class=\"language-mjs\">let crypto;\ntry {\n crypto = await import('node:crypto');\n} catch (err) {\n console.log('crypto support is disabled!');\n}\n</code></pre>",
"type": "module",
"displayName": "Determining if crypto support is unavailable"
},
{
"textRaw": "`node:crypto` module methods and properties",
"name": "`node:crypto`_module_methods_and_properties",
"properties": [
{
"textRaw": "`constants` {Object}",
"type": "Object",
"name": "constants",
"meta": {
"added": [
"v6.3.0"
],
"changes": []
},
"desc": "<p>An object containing commonly used constants for crypto and security related\noperations. The specific constants currently defined are described in\n<a href=\"#crypto-constants\">Crypto constants</a>.</p>"
},
{
"textRaw": "`crypto.DEFAULT_ENCODING`",
"name": "DEFAULT_ENCODING",
"meta": {
"added": [
"v0.9.3"
],
"deprecated": [
"v10.0.0"
],
"changes": []
},
"stability": 0,
"stabilityText": "Deprecated",
"desc": "<p>The default encoding to use for functions that can take either strings\nor <a href=\"buffer.html\">buffers</a>. The default value is <code>'buffer'</code>, which makes methods\ndefault to <a href=\"buffer.html\"><code>Buffer</code></a> objects.</p>\n<p>The <code>crypto.DEFAULT_ENCODING</code> mechanism is provided for backward compatibility\nwith legacy programs that expect <code>'latin1'</code> to be the default encoding.</p>\n<p>New applications should expect the default to be <code>'buffer'</code>.</p>\n<p>This property is deprecated.</p>"
},
{
"textRaw": "`crypto.fips`",
"name": "fips",
"meta": {
"added": [
"v6.0.0"
],
"deprecated": [
"v10.0.0"
],
"changes": []
},
"stability": 0,
"stabilityText": "Deprecated",
"desc": "<p>Property for checking and controlling whether a FIPS compliant crypto provider\nis currently in use. Setting to true requires a FIPS build of Node.js.</p>\n<p>This property is deprecated. Please use <code>crypto.setFips()</code> and\n<code>crypto.getFips()</code> instead.</p>"
},
{
"textRaw": "`crypto.webcrypto`",
"name": "webcrypto",
"meta": {
"added": [
"v15.0.0"
],
"changes": []
},
"desc": "<p>Type: <a href=\"webcrypto.html#class-crypto\" class=\"type\"><Crypto></a> An implementation of the Web Crypto API standard.</p>\n<p>See the <a href=\"webcrypto.html\">Web Crypto API documentation</a> for details.</p>"
}
],
"methods": [
{
"textRaw": "`crypto.checkPrime(candidate[, options], callback)`",
"type": "method",
"name": "checkPrime",
"meta": {
"added": [
"v15.8.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`candidate` {ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint} A possible prime encoded as a sequence of big endian octets of arbitrary length.",
"name": "candidate",
"type": "ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint",
"desc": "A possible prime encoded as a sequence of big endian octets of arbitrary length."
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`checks` {number} The number of Miller-Rabin probabilistic primality iterations to perform. When the value is `0` (zero), a number of checks is used that yields a false positive rate of at most 2<sup>-64</sup> for random input. Care must be used when selecting a number of checks. Refer to the OpenSSL documentation for the [`BN_is_prime_ex`][] function `nchecks` options for more details. **Default:** `0`",
"name": "checks",
"type": "number",
"default": "`0`",
"desc": "The number of Miller-Rabin probabilistic primality iterations to perform. When the value is `0` (zero), a number of checks is used that yields a false positive rate of at most 2<sup>-64</sup> for random input. Care must be used when selecting a number of checks. Refer to the OpenSSL documentation for the [`BN_is_prime_ex`][] function `nchecks` options for more details."
}
]
},
{
"textRaw": "`callback` {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err` {Error} Set to an {Error} object if an error occurred during check.",
"name": "err",
"type": "Error",
"desc": "Set to an {Error} object if an error occurred during check."
},
{
"textRaw": "`result` {boolean} `true` if the candidate is a prime with an error probability less than `0.25 ** options.checks`.",
"name": "result",
"type": "boolean",
"desc": "`true` if the candidate is a prime with an error probability less than `0.25 ** options.checks`."
}
]
}
]
}
],
"desc": "<p>Checks the primality of the <code>candidate</code>.</p>"
},
{
"textRaw": "`crypto.checkPrimeSync(candidate[, options])`",
"type": "method",
"name": "checkPrimeSync",
"meta": {
"added": [
"v15.8.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean} `true` if the candidate is a prime with an error probability less than `0.25 ** options.checks`.",
"name": "return",
"type": "boolean",
"desc": "`true` if the candidate is a prime with an error probability less than `0.25 ** options.checks`."
},
"params": [
{
"textRaw": "`candidate` {ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint} A possible prime encoded as a sequence of big endian octets of arbitrary length.",
"name": "candidate",
"type": "ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint",
"desc": "A possible prime encoded as a sequence of big endian octets of arbitrary length."
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`checks` {number} The number of Miller-Rabin probabilistic primality iterations to perform. When the value is `0` (zero), a number of checks is used that yields a false positive rate of at most 2<sup>-64</sup> for random input. Care must be used when selecting a number of checks. Refer to the OpenSSL documentation for the [`BN_is_prime_ex`][] function `nchecks` options for more details. **Default:** `0`",
"name": "checks",
"type": "number",
"default": "`0`",
"desc": "The number of Miller-Rabin probabilistic primality iterations to perform. When the value is `0` (zero), a number of checks is used that yields a false positive rate of at most 2<sup>-64</sup> for random input. Care must be used when selecting a number of checks. Refer to the OpenSSL documentation for the [`BN_is_prime_ex`][] function `nchecks` options for more details."
}
]
}
]
}
],
"desc": "<p>Checks the primality of the <code>candidate</code>.</p>"
},
{
"textRaw": "`crypto.createCipher(algorithm, password[, options])`",
"type": "method",
"name": "createCipher",
"meta": {
"added": [
"v0.1.94"
],
"deprecated": [
"v10.0.0"
],
"changes": [
{
"version": "v16.17.0",
"pr-url": "https://github.com/nodejs/node/pull/42427",
"description": "The `authTagLength` option is now optional when using the `chacha20-poly1305` cipher and defaults to 16 bytes."
},
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The password argument can be an ArrayBuffer and is limited to a maximum of 2 ** 31 - 1 bytes."
},
{
"version": "v10.10.0",
"pr-url": "https://github.com/nodejs/node/pull/21447",
"description": "Ciphers in OCB mode are now supported."
},
{
"version": "v10.2.0",
"pr-url": "https://github.com/nodejs/node/pull/20235",
"description": "The `authTagLength` option can now be used to produce shorter authentication tags in GCM mode and defaults to 16 bytes."
}
]
},
"stability": 0,
"stabilityText": "Deprecated: Use [`crypto.createCipheriv()`][] instead.",
"signatures": [
{
"return": {
"textRaw": "Returns: {Cipher}",
"name": "return",
"type": "Cipher"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`password` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "password",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]"
}
]
}
],
"desc": "<p>Creates and returns a <code>Cipher</code> object that uses the given <code>algorithm</code> and\n<code>password</code>.</p>\n<p>The <code>options</code> argument controls stream behavior and is optional except when a\ncipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the\n<code>authTagLength</code> option is required and specifies the length of the\nauthentication tag in bytes, see <a href=\"#ccm-mode\">CCM mode</a>. In GCM mode, the <code>authTagLength</code>\noption is not required but can be used to set the length of the authentication\ntag that will be returned by <code>getAuthTag()</code> and defaults to 16 bytes.\nFor <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p>\n<p>The <code>algorithm</code> is dependent on OpenSSL, examples are <code>'aes192'</code>, etc. On\nrecent OpenSSL releases, <code>openssl list -cipher-algorithms</code> will\ndisplay the available cipher algorithms.</p>\n<p>The <code>password</code> is used to derive the cipher key and initialization vector (IV).\nThe value must be either a <code>'latin1'</code> encoded string, a <a href=\"buffer.html\"><code>Buffer</code></a>, a\n<code>TypedArray</code>, or a <code>DataView</code>.</p>\n<p><strong class=\"critical\">This function is semantically insecure for all\nsupported ciphers and fatally flawed for ciphers in counter mode (such as CTR,\nGCM, or CCM).</strong></p>\n<p>The implementation of <code>crypto.createCipher()</code> derives keys using the OpenSSL\nfunction <a href=\"https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html\"><code>EVP_BytesToKey</code></a> with the digest algorithm set to MD5, one\niteration, and no salt. The lack of salt allows dictionary attacks as the same\npassword always creates the same key. The low iteration count and\nnon-cryptographically secure hash algorithm allow passwords to be tested very\nrapidly.</p>\n<p>In line with OpenSSL's recommendation to use a more modern algorithm instead of\n<a href=\"https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html\"><code>EVP_BytesToKey</code></a> it is recommended that developers derive a key and IV on\ntheir own using <a href=\"#cryptoscryptpassword-salt-keylen-options-callback\"><code>crypto.scrypt()</code></a> and to use <a href=\"#cryptocreatecipherivalgorithm-key-iv-options\"><code>crypto.createCipheriv()</code></a>\nto create the <code>Cipher</code> object. Users should not use ciphers with counter mode\n(e.g. CTR, GCM, or CCM) in <code>crypto.createCipher()</code>. A warning is emitted when\nthey are used in order to avoid the risk of IV reuse that causes\nvulnerabilities. For the case when IV is reused in GCM, see <a href=\"https://github.com/nonce-disrespect/nonce-disrespect\">Nonce-Disrespecting\nAdversaries</a> for details.</p>"
},
{
"textRaw": "`crypto.createCipheriv(algorithm, key, iv[, options])`",
"type": "method",
"name": "createCipheriv",
"meta": {
"added": [
"v0.1.94"
],
"changes": [
{
"version": "v16.17.0",
"pr-url": "https://github.com/nodejs/node/pull/42427",
"description": "The `authTagLength` option is now optional when using the `chacha20-poly1305` cipher and defaults to 16 bytes."
},
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The password and iv arguments can be an ArrayBuffer and are each limited to a maximum of 2 ** 31 - 1 bytes."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "The `key` argument can now be a `KeyObject`."
},
{
"version": [
"v11.2.0",
"v10.17.0"
],
"pr-url": "https://github.com/nodejs/node/pull/24081",
"description": "The cipher `chacha20-poly1305` (the IETF variant of ChaCha20-Poly1305) is now supported."
},
{
"version": "v10.10.0",
"pr-url": "https://github.com/nodejs/node/pull/21447",
"description": "Ciphers in OCB mode are now supported."
},
{
"version": "v10.2.0",
"pr-url": "https://github.com/nodejs/node/pull/20235",
"description": "The `authTagLength` option can now be used to produce shorter authentication tags in GCM mode and defaults to 16 bytes."
},
{
"version": "v9.9.0",
"pr-url": "https://github.com/nodejs/node/pull/18644",
"description": "The `iv` parameter may now be `null` for ciphers which do not need an initialization vector."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Cipher}",
"name": "return",
"type": "Cipher"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`key` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey}",
"name": "key",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey"
},
{
"textRaw": "`iv` {string|ArrayBuffer|Buffer|TypedArray|DataView|null}",
"name": "iv",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView|null"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]"
}
]
}
],
"desc": "<p>Creates and returns a <code>Cipher</code> object, with the given <code>algorithm</code>, <code>key</code> and\ninitialization vector (<code>iv</code>).</p>\n<p>The <code>options</code> argument controls stream behavior and is optional except when a\ncipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the\n<code>authTagLength</code> option is required and specifies the length of the\nauthentication tag in bytes, see <a href=\"#ccm-mode\">CCM mode</a>. In GCM mode, the <code>authTagLength</code>\noption is not required but can be used to set the length of the authentication\ntag that will be returned by <code>getAuthTag()</code> and defaults to 16 bytes.\nFor <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p>\n<p>The <code>algorithm</code> is dependent on OpenSSL, examples are <code>'aes192'</code>, etc. On\nrecent OpenSSL releases, <code>openssl list -cipher-algorithms</code> will\ndisplay the available cipher algorithms.</p>\n<p>The <code>key</code> is the raw key used by the <code>algorithm</code> and <code>iv</code> is an\n<a href=\"https://en.wikipedia.org/wiki/Initialization_vector\">initialization vector</a>. Both arguments must be <code>'utf8'</code> encoded strings,\n<a href=\"buffer.html\">Buffers</a>, <code>TypedArray</code>, or <code>DataView</code>s. The <code>key</code> may optionally be\na <a href=\"#class-keyobject\"><code>KeyObject</code></a> of type <code>secret</code>. If the cipher does not need\nan initialization vector, <code>iv</code> may be <code>null</code>.</p>\n<p>When passing strings for <code>key</code> or <code>iv</code>, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>\n<p>Initialization vectors should be unpredictable and unique; ideally, they will be\ncryptographically random. They do not have to be secret: IVs are typically just\nadded to ciphertext messages unencrypted. It may sound contradictory that\nsomething has to be unpredictable and unique, but does not have to be secret;\nremember that an attacker must not be able to predict ahead of time what a\ngiven IV will be.</p>"
},
{
"textRaw": "`crypto.createDecipher(algorithm, password[, options])`",
"type": "method",
"name": "createDecipher",
"meta": {
"added": [
"v0.1.94"
],
"deprecated": [
"v10.0.0"
],
"changes": [
{
"version": "v16.17.0",
"pr-url": "https://github.com/nodejs/node/pull/42427",
"description": "The `authTagLength` option is now optional when using the `chacha20-poly1305` cipher and defaults to 16 bytes."
},
{
"version": "v10.10.0",
"pr-url": "https://github.com/nodejs/node/pull/21447",
"description": "Ciphers in OCB mode are now supported."
}
]
},
"stability": 0,
"stabilityText": "Deprecated: Use [`crypto.createDecipheriv()`][] instead.",
"signatures": [
{
"return": {
"textRaw": "Returns: {Decipher}",
"name": "return",
"type": "Decipher"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`password` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "password",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]"
}
]
}
],
"desc": "<p>Creates and returns a <code>Decipher</code> object that uses the given <code>algorithm</code> and\n<code>password</code> (key).</p>\n<p>The <code>options</code> argument controls stream behavior and is optional except when a\ncipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the\n<code>authTagLength</code> option is required and specifies the length of the\nauthentication tag in bytes, see <a href=\"#ccm-mode\">CCM mode</a>.\nFor <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p>\n<p><strong class=\"critical\">This function is semantically insecure for all\nsupported ciphers and fatally flawed for ciphers in counter mode (such as CTR,\nGCM, or CCM).</strong></p>\n<p>The implementation of <code>crypto.createDecipher()</code> derives keys using the OpenSSL\nfunction <a href=\"https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html\"><code>EVP_BytesToKey</code></a> with the digest algorithm set to MD5, one\niteration, and no salt. The lack of salt allows dictionary attacks as the same\npassword always creates the same key. The low iteration count and\nnon-cryptographically secure hash algorithm allow passwords to be tested very\nrapidly.</p>\n<p>In line with OpenSSL's recommendation to use a more modern algorithm instead of\n<a href=\"https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html\"><code>EVP_BytesToKey</code></a> it is recommended that developers derive a key and IV on\ntheir own using <a href=\"#cryptoscryptpassword-salt-keylen-options-callback\"><code>crypto.scrypt()</code></a> and to use <a href=\"#cryptocreatedecipherivalgorithm-key-iv-options\"><code>crypto.createDecipheriv()</code></a>\nto create the <code>Decipher</code> object.</p>"
},
{
"textRaw": "`crypto.createDecipheriv(algorithm, key, iv[, options])`",
"type": "method",
"name": "createDecipheriv",
"meta": {
"added": [
"v0.1.94"
],
"changes": [
{
"version": "v16.17.0",
"pr-url": "https://github.com/nodejs/node/pull/42427",
"description": "The `authTagLength` option is now optional when using the `chacha20-poly1305` cipher and defaults to 16 bytes."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "The `key` argument can now be a `KeyObject`."
},
{
"version": [
"v11.2.0",
"v10.17.0"
],
"pr-url": "https://github.com/nodejs/node/pull/24081",
"description": "The cipher `chacha20-poly1305` (the IETF variant of ChaCha20-Poly1305) is now supported."
},
{
"version": "v10.10.0",
"pr-url": "https://github.com/nodejs/node/pull/21447",
"description": "Ciphers in OCB mode are now supported."
},
{
"version": "v10.2.0",
"pr-url": "https://github.com/nodejs/node/pull/20039",
"description": "The `authTagLength` option can now be used to restrict accepted GCM authentication tag lengths."
},
{
"version": "v9.9.0",
"pr-url": "https://github.com/nodejs/node/pull/18644",
"description": "The `iv` parameter may now be `null` for ciphers which do not need an initialization vector."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Decipher}",
"name": "return",
"type": "Decipher"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`key` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey}",
"name": "key",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey"
},
{
"textRaw": "`iv` {string|ArrayBuffer|Buffer|TypedArray|DataView|null}",
"name": "iv",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView|null"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]"
}
]
}
],
"desc": "<p>Creates and returns a <code>Decipher</code> object that uses the given <code>algorithm</code>, <code>key</code>\nand initialization vector (<code>iv</code>).</p>\n<p>The <code>options</code> argument controls stream behavior and is optional except when a\ncipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the\n<code>authTagLength</code> option is required and specifies the length of the\nauthentication tag in bytes, see <a href=\"#ccm-mode\">CCM mode</a>. In GCM mode, the <code>authTagLength</code>\noption is not required but can be used to restrict accepted authentication tags\nto those with the specified length.\nFor <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p>\n<p>The <code>algorithm</code> is dependent on OpenSSL, examples are <code>'aes192'</code>, etc. On\nrecent OpenSSL releases, <code>openssl list -cipher-algorithms</code> will\ndisplay the available cipher algorithms.</p>\n<p>The <code>key</code> is the raw key used by the <code>algorithm</code> and <code>iv</code> is an\n<a href=\"https://en.wikipedia.org/wiki/Initialization_vector\">initialization vector</a>. Both arguments must be <code>'utf8'</code> encoded strings,\n<a href=\"buffer.html\">Buffers</a>, <code>TypedArray</code>, or <code>DataView</code>s. The <code>key</code> may optionally be\na <a href=\"#class-keyobject\"><code>KeyObject</code></a> of type <code>secret</code>. If the cipher does not need\nan initialization vector, <code>iv</code> may be <code>null</code>.</p>\n<p>When passing strings for <code>key</code> or <code>iv</code>, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>\n<p>Initialization vectors should be unpredictable and unique; ideally, they will be\ncryptographically random. They do not have to be secret: IVs are typically just\nadded to ciphertext messages unencrypted. It may sound contradictory that\nsomething has to be unpredictable and unique, but does not have to be secret;\nremember that an attacker must not be able to predict ahead of time what a given\nIV will be.</p>"
},
{
"textRaw": "`crypto.createDiffieHellman(prime[, primeEncoding][, generator][, generatorEncoding])`",
"type": "method",
"name": "createDiffieHellman",
"meta": {
"added": [
"v0.11.12"
],
"changes": [
{
"version": "v8.0.0",
"pr-url": "https://github.com/nodejs/node/pull/12223",
"description": "The `prime` argument can be any `TypedArray` or `DataView` now."
},
{
"version": "v8.0.0",
"pr-url": "https://github.com/nodejs/node/pull/11983",
"description": "The `prime` argument can be a `Uint8Array` now."
},
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default for the encoding parameters changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {DiffieHellman}",
"name": "return",
"type": "DiffieHellman"
},
"params": [
{
"textRaw": "`prime` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "prime",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`primeEncoding` {string} The [encoding][] of the `prime` string.",
"name": "primeEncoding",
"type": "string",
"desc": "The [encoding][] of the `prime` string."
},
{
"textRaw": "`generator` {number|string|ArrayBuffer|Buffer|TypedArray|DataView} **Default:** `2`",
"name": "generator",
"type": "number|string|ArrayBuffer|Buffer|TypedArray|DataView",
"default": "`2`"
},
{
"textRaw": "`generatorEncoding` {string} The [encoding][] of the `generator` string.",
"name": "generatorEncoding",
"type": "string",
"desc": "The [encoding][] of the `generator` string."
}
]
}
],
"desc": "<p>Creates a <code>DiffieHellman</code> key exchange object using the supplied <code>prime</code> and an\noptional specific <code>generator</code>.</p>\n<p>The <code>generator</code> argument can be a number, string, or <a href=\"buffer.html\"><code>Buffer</code></a>. If\n<code>generator</code> is not specified, the value <code>2</code> is used.</p>\n<p>If <code>primeEncoding</code> is specified, <code>prime</code> is expected to be a string; otherwise\na <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code> is expected.</p>\n<p>If <code>generatorEncoding</code> is specified, <code>generator</code> is expected to be a string;\notherwise a number, <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code> is expected.</p>"
},
{
"textRaw": "`crypto.createDiffieHellman(primeLength[, generator])`",
"type": "method",
"name": "createDiffieHellman",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {DiffieHellman}",
"name": "return",
"type": "DiffieHellman"
},
"params": [
{
"textRaw": "`primeLength` {number}",
"name": "primeLength",
"type": "number"
},
{
"textRaw": "`generator` {number} **Default:** `2`",
"name": "generator",
"type": "number",
"default": "`2`"
}
]
}
],
"desc": "<p>Creates a <code>DiffieHellman</code> key exchange object and generates a prime of\n<code>primeLength</code> bits using an optional specific numeric <code>generator</code>.\nIf <code>generator</code> is not specified, the value <code>2</code> is used.</p>"
},
{
"textRaw": "`crypto.createDiffieHellmanGroup(name)`",
"type": "method",
"name": "createDiffieHellmanGroup",
"meta": {
"added": [
"v0.9.3"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {DiffieHellmanGroup}",
"name": "return",
"type": "DiffieHellmanGroup"
},
"params": [
{
"textRaw": "`name` {string}",
"name": "name",
"type": "string"
}
]
}
],
"desc": "<p>An alias for <a href=\"#cryptogetdiffiehellmangroupname\"><code>crypto.getDiffieHellman()</code></a></p>"
},
{
"textRaw": "`crypto.createECDH(curveName)`",
"type": "method",
"name": "createECDH",
"meta": {
"added": [
"v0.11.14"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {ECDH}",
"name": "return",
"type": "ECDH"
},
"params": [
{
"textRaw": "`curveName` {string}",
"name": "curveName",
"type": "string"
}
]
}
],
"desc": "<p>Creates an Elliptic Curve Diffie-Hellman (<code>ECDH</code>) key exchange object using a\npredefined curve specified by the <code>curveName</code> string. Use\n<a href=\"#cryptogetcurves\"><code>crypto.getCurves()</code></a> to obtain a list of available curve names. On recent\nOpenSSL releases, <code>openssl ecparam -list_curves</code> will also display the name\nand description of each available elliptic curve.</p>"
},
{
"textRaw": "`crypto.createHash(algorithm[, options])`",
"type": "method",
"name": "createHash",
"meta": {
"added": [
"v0.1.92"
],
"changes": [
{
"version": "v12.8.0",
"pr-url": "https://github.com/nodejs/node/pull/28805",
"description": "The `outputLength` option was added for XOF hash functions."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Hash}",
"name": "return",
"type": "Hash"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]"
}
]
}
],
"desc": "<p>Creates and returns a <code>Hash</code> object that can be used to generate hash digests\nusing the given <code>algorithm</code>. Optional <code>options</code> argument controls stream\nbehavior. For XOF hash functions such as <code>'shake256'</code>, the <code>outputLength</code> option\ncan be used to specify the desired output length in bytes.</p>\n<p>The <code>algorithm</code> is dependent on the available algorithms supported by the\nversion of OpenSSL on the platform. Examples are <code>'sha256'</code>, <code>'sha512'</code>, etc.\nOn recent releases of OpenSSL, <code>openssl list -digest-algorithms</code> will\ndisplay the available digest algorithms.</p>\n<p>Example: generating the sha256 sum of a file</p>\n<pre><code class=\"language-mjs\">import {\n createReadStream\n} from 'node:fs';\nimport { argv } from 'node:process';\nconst {\n createHash\n} = await import('node:crypto');\n\nconst filename = argv[2];\n\nconst hash = createHash('sha256');\n\nconst input = createReadStream(filename);\ninput.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = input.read();\n if (data)\n hash.update(data);\n else {\n console.log(`${hash.digest('hex')} ${filename}`);\n }\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createReadStream,\n} = require('node:fs');\nconst {\n createHash,\n} = require('node:crypto');\nconst { argv } = require('node:process');\n\nconst filename = argv[2];\n\nconst hash = createHash('sha256');\n\nconst input = createReadStream(filename);\ninput.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = input.read();\n if (data)\n hash.update(data);\n else {\n console.log(`${hash.digest('hex')} ${filename}`);\n }\n});\n</code></pre>"
},
{
"textRaw": "`crypto.createHmac(algorithm, key[, options])`",
"type": "method",
"name": "createHmac",
"meta": {
"added": [
"v0.1.94"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The key can also be an ArrayBuffer or CryptoKey. The encoding option was added. The key cannot contain more than 2 ** 32 - 1 bytes."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "The `key` argument can now be a `KeyObject`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Hmac}",
"name": "return",
"type": "Hmac"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`key` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey}",
"name": "key",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]",
"options": [
{
"textRaw": "`encoding` {string} The string encoding to use when `key` is a string.",
"name": "encoding",
"type": "string",
"desc": "The string encoding to use when `key` is a string."
}
]
}
]
}
],
"desc": "<p>Creates and returns an <code>Hmac</code> object that uses the given <code>algorithm</code> and <code>key</code>.\nOptional <code>options</code> argument controls stream behavior.</p>\n<p>The <code>algorithm</code> is dependent on the available algorithms supported by the\nversion of OpenSSL on the platform. Examples are <code>'sha256'</code>, <code>'sha512'</code>, etc.\nOn recent releases of OpenSSL, <code>openssl list -digest-algorithms</code> will\ndisplay the available digest algorithms.</p>\n<p>The <code>key</code> is the HMAC key used to generate the cryptographic HMAC hash. If it is\na <a href=\"#class-keyobject\"><code>KeyObject</code></a>, its type must be <code>secret</code>.</p>\n<p>Example: generating the sha256 HMAC of a file</p>\n<pre><code class=\"language-mjs\">import {\n createReadStream\n} from 'node:fs';\nimport { argv } from 'node:process';\nconst {\n createHmac\n} = await import('node:crypto');\n\nconst filename = argv[2];\n\nconst hmac = createHmac('sha256', 'a secret');\n\nconst input = createReadStream(filename);\ninput.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = input.read();\n if (data)\n hmac.update(data);\n else {\n console.log(`${hmac.digest('hex')} ${filename}`);\n }\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createReadStream,\n} = require('node:fs');\nconst {\n createHmac,\n} = require('node:crypto');\nconst { argv } = require('node:process');\n\nconst filename = argv[2];\n\nconst hmac = createHmac('sha256', 'a secret');\n\nconst input = createReadStream(filename);\ninput.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = input.read();\n if (data)\n hmac.update(data);\n else {\n console.log(`${hmac.digest('hex')} ${filename}`);\n }\n});\n</code></pre>"
},
{
"textRaw": "`crypto.createPrivateKey(key)`",
"type": "method",
"name": "createPrivateKey",
"meta": {
"added": [
"v11.6.0"
],
"changes": [
{
"version": "v15.12.0",
"pr-url": "https://github.com/nodejs/node/pull/37254",
"description": "The key can also be a JWK object."
},
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The key can also be an ArrayBuffer. The encoding option was added. The key cannot contain more than 2 ** 32 - 1 bytes."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a>\n<ul>\n<li><code>key</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> The key\nmaterial, either in PEM, DER, or JWK format.</li>\n<li><code>format</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be <code>'pem'</code>, <code>'der'</code>, or '<code>'jwk'</code>.\n<strong>Default:</strong> <code>'pem'</code>.</li>\n<li><code>type</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be <code>'pkcs1'</code>, <code>'pkcs8'</code> or <code>'sec1'</code>. This option is\nrequired only if the <code>format</code> is <code>'der'</code> and ignored otherwise.</li>\n<li><code>passphrase</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> The passphrase to use for decryption.</li>\n<li><code>encoding</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The string encoding to use when <code>key</code> is a string.</li>\n</ul>\n</li>\n<li>Returns: <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a></li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Creates and returns a new key object containing a private key. If <code>key</code> is a\nstring or <code>Buffer</code>, <code>format</code> is assumed to be <code>'pem'</code>; otherwise, <code>key</code>\nmust be an object with the properties described above.</p>\n<p>If the private key is encrypted, a <code>passphrase</code> must be specified. The length\nof the passphrase is limited to 1024 bytes.</p>"
},
{
"textRaw": "`crypto.createPublicKey(key)`",
"type": "method",
"name": "createPublicKey",
"meta": {
"added": [
"v11.6.0"
],
"changes": [
{
"version": "v15.12.0",
"pr-url": "https://github.com/nodejs/node/pull/37254",
"description": "The key can also be a JWK object."
},
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The key can also be an ArrayBuffer. The encoding option was added. The key cannot contain more than 2 ** 32 - 1 bytes."
},
{
"version": "v11.13.0",
"pr-url": "https://github.com/nodejs/node/pull/26278",
"description": "The `key` argument can now be a `KeyObject` with type `private`."
},
{
"version": "v11.7.0",
"pr-url": "https://github.com/nodejs/node/pull/25217",
"description": "The `key` argument can now be a private key."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a>\n<ul>\n<li><code>key</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> The key\nmaterial, either in PEM, DER, or JWK format.</li>\n<li><code>format</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be <code>'pem'</code>, <code>'der'</code>, or <code>'jwk'</code>.\n<strong>Default:</strong> <code>'pem'</code>.</li>\n<li><code>type</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be <code>'pkcs1'</code> or <code>'spki'</code>. This option is\nrequired only if the <code>format</code> is <code>'der'</code> and ignored otherwise.</li>\n<li><code>encoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The string encoding to use when <code>key</code> is a string.</li>\n</ul>\n</li>\n<li>Returns: <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a></li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Creates and returns a new key object containing a public key. If <code>key</code> is a\nstring or <code>Buffer</code>, <code>format</code> is assumed to be <code>'pem'</code>; if <code>key</code> is a <code>KeyObject</code>\nwith type <code>'private'</code>, the public key is derived from the given private key;\notherwise, <code>key</code> must be an object with the properties described above.</p>\n<p>If the format is <code>'pem'</code>, the <code>'key'</code> may also be an X.509 certificate.</p>\n<p>Because public keys can be derived from private keys, a private key may be\npassed instead of a public key. In that case, this function behaves as if\n<a href=\"#cryptocreateprivatekeykey\"><code>crypto.createPrivateKey()</code></a> had been called, except that the type of the\nreturned <code>KeyObject</code> will be <code>'public'</code> and that the private key cannot be\nextracted from the returned <code>KeyObject</code>. Similarly, if a <code>KeyObject</code> with type\n<code>'private'</code> is given, a new <code>KeyObject</code> with type <code>'public'</code> will be returned\nand it will be impossible to extract the private key from the returned object.</p>"
},
{
"textRaw": "`crypto.createSecretKey(key[, encoding])`",
"type": "method",
"name": "createSecretKey",
"meta": {
"added": [
"v11.6.0"
],
"changes": [
{
"version": "v16.18.0",
"pr-url": "https://github.com/nodejs/node/pull/44201",
"description": "The key can now be zero-length."
},
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The key can also be an ArrayBuffer or string. The encoding argument was added. The key cannot contain more than 2 ** 32 - 1 bytes."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {KeyObject}",
"name": "return",
"type": "KeyObject"
},
"params": [
{
"textRaw": "`key` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "key",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The string encoding when `key` is a string.",
"name": "encoding",
"type": "string",
"desc": "The string encoding when `key` is a string."
}
]
}
],
"desc": "<p>Creates and returns a new key object containing a secret key for symmetric\nencryption or <code>Hmac</code>.</p>"
},
{
"textRaw": "`crypto.createSign(algorithm[, options])`",
"type": "method",
"name": "createSign",
"meta": {
"added": [
"v0.1.92"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Sign}",
"name": "return",
"type": "Sign"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`options` {Object} [`stream.Writable` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.Writable` options][]"
}
]
}
],
"desc": "<p>Creates and returns a <code>Sign</code> object that uses the given <code>algorithm</code>. Use\n<a href=\"#cryptogethashes\"><code>crypto.getHashes()</code></a> to obtain the names of the available digest algorithms.\nOptional <code>options</code> argument controls the <code>stream.Writable</code> behavior.</p>\n<p>In some cases, a <code>Sign</code> instance can be created using the name of a signature\nalgorithm, such as <code>'RSA-SHA256'</code>, instead of a digest algorithm. This will use\nthe corresponding digest algorithm. This does not work for all signature\nalgorithms, such as <code>'ecdsa-with-SHA256'</code>, so it is best to always use digest\nalgorithm names.</p>"
},
{
"textRaw": "`crypto.createVerify(algorithm[, options])`",
"type": "method",
"name": "createVerify",
"meta": {
"added": [
"v0.1.92"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Verify}",
"name": "return",
"type": "Verify"
},
"params": [
{
"textRaw": "`algorithm` {string}",
"name": "algorithm",
"type": "string"
},
{
"textRaw": "`options` {Object} [`stream.Writable` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.Writable` options][]"
}
]
}
],
"desc": "<p>Creates and returns a <code>Verify</code> object that uses the given algorithm.\nUse <a href=\"#cryptogethashes\"><code>crypto.getHashes()</code></a> to obtain an array of names of the available\nsigning algorithms. Optional <code>options</code> argument controls the\n<code>stream.Writable</code> behavior.</p>\n<p>In some cases, a <code>Verify</code> instance can be created using the name of a signature\nalgorithm, such as <code>'RSA-SHA256'</code>, instead of a digest algorithm. This will use\nthe corresponding digest algorithm. This does not work for all signature\nalgorithms, such as <code>'ecdsa-with-SHA256'</code>, so it is best to always use digest\nalgorithm names.</p>"
},
{
"textRaw": "`crypto.diffieHellman(options)`",
"type": "method",
"name": "diffieHellman",
"meta": {
"added": [
"v13.9.0",
"v12.17.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer}",
"name": "return",
"type": "Buffer"
},
"params": [
{
"textRaw": "`options`: {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`privateKey`: {KeyObject}",
"name": "privateKey",
"type": "KeyObject"
},
{
"textRaw": "`publicKey`: {KeyObject}",
"name": "publicKey",
"type": "KeyObject"
}
]
}
]
}
],
"desc": "<p>Computes the Diffie-Hellman secret based on a <code>privateKey</code> and a <code>publicKey</code>.\nBoth keys must have the same <code>asymmetricKeyType</code>, which must be one of <code>'dh'</code>\n(for Diffie-Hellman), <code>'ec'</code> (for ECDH), <code>'x448'</code>, or <code>'x25519'</code> (for ECDH-ES).</p>"
},
{
"textRaw": "`crypto.generateKey(type, options, callback)`",
"type": "method",
"name": "generateKey",
"meta": {
"added": [
"v15.0.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`type`: {string} The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.",
"name": "type",
"type": "string",
"desc": "The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`."
},
{
"textRaw": "`options`: {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`length`: {number} The bit length of the key to generate. This must be a value greater than 0.",
"name": "length",
"type": "number",
"desc": "The bit length of the key to generate. This must be a value greater than 0.",
"options": [
{
"textRaw": "If `type` is `'hmac'`, the minimum is 8, and the maximum length is 2<sup>31</sup>-1. If the value is not a multiple of 8, the generated key will be truncated to `Math.floor(length / 8)`.",
"name": "If",
"desc": "`type` is `'hmac'`, the minimum is 8, and the maximum length is 2<sup>31</sup>-1. If the value is not a multiple of 8, the generated key will be truncated to `Math.floor(length / 8)`."
},
{
"textRaw": "If `type` is `'aes'`, the length must be one of `128`, `192`, or `256`.",
"name": "If",
"desc": "`type` is `'aes'`, the length must be one of `128`, `192`, or `256`."
}
]
}
]
},
{
"textRaw": "`callback`: {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err`: {Error}",
"name": "err",
"type": "Error"
},
{
"textRaw": "`key`: {KeyObject}",
"name": "key",
"type": "KeyObject"
}
]
}
]
}
],
"desc": "<p>Asynchronously generates a new random secret key of the given <code>length</code>. The\n<code>type</code> will determine which validations will be performed on the <code>length</code>.</p>\n<pre><code class=\"language-mjs\">const {\n generateKey\n} = await import('node:crypto');\n\ngenerateKey('hmac', { length: 64 }, (err, key) => {\n if (err) throw err;\n console.log(key.export().toString('hex')); // 46e..........620\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n generateKey,\n} = require('node:crypto');\n\ngenerateKey('hmac', { length: 64 }, (err, key) => {\n if (err) throw err;\n console.log(key.export().toString('hex')); // 46e..........620\n});\n</code></pre>"
},
{
"textRaw": "`crypto.generateKeyPair(type, options, callback)`",
"type": "method",
"name": "generateKeyPair",
"meta": {
"added": [
"v10.12.0"
],
"changes": [
{
"version": "v16.10.0",
"pr-url": "https://github.com/nodejs/node/pull/39927",
"description": "Add ability to define `RSASSA-PSS-params` sequence parameters for RSA-PSS keys pairs."
},
{
"version": [
"v13.9.0",
"v12.17.0"
],
"pr-url": "https://github.com/nodejs/node/pull/31178",
"description": "Add support for Diffie-Hellman."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26960",
"description": "Add support for RSA-PSS key pairs."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26774",
"description": "Add ability to generate X25519 and X448 key pairs."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26554",
"description": "Add ability to generate Ed25519 and Ed448 key pairs."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "The `generateKeyPair` and `generateKeyPairSync` functions now produce key objects if no encoding was specified."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`type`: {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`.",
"name": "type",
"type": "string",
"desc": "Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`."
},
{
"textRaw": "`options`: {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`modulusLength`: {number} Key size in bits (RSA, DSA).",
"name": "modulusLength",
"type": "number",
"desc": "Key size in bits (RSA, DSA)."
},
{
"textRaw": "`publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`.",
"name": "publicExponent",
"type": "number",
"default": "`0x10001`",
"desc": "Public exponent (RSA)."
},
{
"textRaw": "`hashAlgorithm`: {string} Name of the message digest (RSA-PSS).",
"name": "hashAlgorithm",
"type": "string",
"desc": "Name of the message digest (RSA-PSS)."
},
{
"textRaw": "`mgf1HashAlgorithm`: {string} Name of the message digest used by MGF1 (RSA-PSS).",
"name": "mgf1HashAlgorithm",
"type": "string",
"desc": "Name of the message digest used by MGF1 (RSA-PSS)."
},
{
"textRaw": "`saltLength`: {number} Minimal salt length in bytes (RSA-PSS).",
"name": "saltLength",
"type": "number",
"desc": "Minimal salt length in bytes (RSA-PSS)."
},
{
"textRaw": "`divisorLength`: {number} Size of `q` in bits (DSA).",
"name": "divisorLength",
"type": "number",
"desc": "Size of `q` in bits (DSA)."
},
{
"textRaw": "`namedCurve`: {string} Name of the curve to use (EC).",
"name": "namedCurve",
"type": "string",
"desc": "Name of the curve to use (EC)."
},
{
"textRaw": "`prime`: {Buffer} The prime parameter (DH).",
"name": "prime",
"type": "Buffer",
"desc": "The prime parameter (DH)."
},
{
"textRaw": "`primeLength`: {number} Prime length in bits (DH).",
"name": "primeLength",
"type": "number",
"desc": "Prime length in bits (DH)."
},
{
"textRaw": "`generator`: {number} Custom generator (DH). **Default:** `2`.",
"name": "generator",
"type": "number",
"default": "`2`",
"desc": "Custom generator (DH)."
},
{
"textRaw": "`groupName`: {string} Diffie-Hellman group name (DH). See [`crypto.getDiffieHellman()`][].",
"name": "groupName",
"type": "string",
"desc": "Diffie-Hellman group name (DH). See [`crypto.getDiffieHellman()`][]."
},
{
"textRaw": "`publicKeyEncoding`: {Object} See [`keyObject.export()`][].",
"name": "publicKeyEncoding",
"type": "Object",
"desc": "See [`keyObject.export()`][]."
},
{
"textRaw": "`privateKeyEncoding`: {Object} See [`keyObject.export()`][].",
"name": "privateKeyEncoding",
"type": "Object",
"desc": "See [`keyObject.export()`][]."
}
]
},
{
"textRaw": "`callback`: {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err`: {Error}",
"name": "err",
"type": "Error"
},
{
"textRaw": "`publicKey`: {string | Buffer | KeyObject}",
"name": "publicKey",
"type": "string | Buffer | KeyObject"
},
{
"textRaw": "`privateKey`: {string | Buffer | KeyObject}",
"name": "privateKey",
"type": "string | Buffer | KeyObject"
}
]
}
]
}
],
"desc": "<p>Generates a new asymmetric key pair of the given <code>type</code>. RSA, RSA-PSS, DSA, EC,\nEd25519, Ed448, X25519, X448, and DH are currently supported.</p>\n<p>If a <code>publicKeyEncoding</code> or <code>privateKeyEncoding</code> was specified, this function\nbehaves as if <a href=\"#keyobjectexportoptions\"><code>keyObject.export()</code></a> had been called on its result. Otherwise,\nthe respective part of the key is returned as a <a href=\"#class-keyobject\"><code>KeyObject</code></a>.</p>\n<p>It is recommended to encode public keys as <code>'spki'</code> and private keys as\n<code>'pkcs8'</code> with encryption for long-term storage:</p>\n<pre><code class=\"language-mjs\">const {\n generateKeyPair\n} = await import('node:crypto');\n\ngenerateKeyPair('rsa', {\n modulusLength: 4096,\n publicKeyEncoding: {\n type: 'spki',\n format: 'pem'\n },\n privateKeyEncoding: {\n type: 'pkcs8',\n format: 'pem',\n cipher: 'aes-256-cbc',\n passphrase: 'top secret'\n }\n}, (err, publicKey, privateKey) => {\n // Handle errors and use the generated key pair.\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n generateKeyPair,\n} = require('node:crypto');\n\ngenerateKeyPair('rsa', {\n modulusLength: 4096,\n publicKeyEncoding: {\n type: 'spki',\n format: 'pem'\n },\n privateKeyEncoding: {\n type: 'pkcs8',\n format: 'pem',\n cipher: 'aes-256-cbc',\n passphrase: 'top secret'\n }\n}, (err, publicKey, privateKey) => {\n // Handle errors and use the generated key pair.\n});\n</code></pre>\n<p>On completion, <code>callback</code> will be called with <code>err</code> set to <code>undefined</code> and\n<code>publicKey</code> / <code>privateKey</code> representing the generated key pair.</p>\n<p>If this method is invoked as its <a href=\"util.html#utilpromisifyoriginal\"><code>util.promisify()</code></a>ed version, it returns\na <code>Promise</code> for an <code>Object</code> with <code>publicKey</code> and <code>privateKey</code> properties.</p>"
},
{
"textRaw": "`crypto.generateKeyPairSync(type, options)`",
"type": "method",
"name": "generateKeyPairSync",
"meta": {
"added": [
"v10.12.0"
],
"changes": [
{
"version": "v16.10.0",
"pr-url": "https://github.com/nodejs/node/pull/39927",
"description": "Add ability to define `RSASSA-PSS-params` sequence parameters for RSA-PSS keys pairs."
},
{
"version": [
"v13.9.0",
"v12.17.0"
],
"pr-url": "https://github.com/nodejs/node/pull/31178",
"description": "Add support for Diffie-Hellman."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26960",
"description": "Add support for RSA-PSS key pairs."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26774",
"description": "Add ability to generate X25519 and X448 key pairs."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26554",
"description": "Add ability to generate Ed25519 and Ed448 key pairs."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "The `generateKeyPair` and `generateKeyPairSync` functions now produce key objects if no encoding was specified."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Object}",
"name": "return",
"type": "Object",
"options": [
{
"textRaw": "`publicKey`: {string | Buffer | KeyObject}",
"name": "publicKey",
"type": "string | Buffer | KeyObject"
},
{
"textRaw": "`privateKey`: {string | Buffer | KeyObject}",
"name": "privateKey",
"type": "string | Buffer | KeyObject"
}
]
},
"params": [
{
"textRaw": "`type`: {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`.",
"name": "type",
"type": "string",
"desc": "Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`."
},
{
"textRaw": "`options`: {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`modulusLength`: {number} Key size in bits (RSA, DSA).",
"name": "modulusLength",
"type": "number",
"desc": "Key size in bits (RSA, DSA)."
},
{
"textRaw": "`publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`.",
"name": "publicExponent",
"type": "number",
"default": "`0x10001`",
"desc": "Public exponent (RSA)."
},
{
"textRaw": "`hashAlgorithm`: {string} Name of the message digest (RSA-PSS).",
"name": "hashAlgorithm",
"type": "string",
"desc": "Name of the message digest (RSA-PSS)."
},
{
"textRaw": "`mgf1HashAlgorithm`: {string} Name of the message digest used by MGF1 (RSA-PSS).",
"name": "mgf1HashAlgorithm",
"type": "string",
"desc": "Name of the message digest used by MGF1 (RSA-PSS)."
},
{
"textRaw": "`saltLength`: {number} Minimal salt length in bytes (RSA-PSS).",
"name": "saltLength",
"type": "number",
"desc": "Minimal salt length in bytes (RSA-PSS)."
},
{
"textRaw": "`divisorLength`: {number} Size of `q` in bits (DSA).",
"name": "divisorLength",
"type": "number",
"desc": "Size of `q` in bits (DSA)."
},
{
"textRaw": "`namedCurve`: {string} Name of the curve to use (EC).",
"name": "namedCurve",
"type": "string",
"desc": "Name of the curve to use (EC)."
},
{
"textRaw": "`prime`: {Buffer} The prime parameter (DH).",
"name": "prime",
"type": "Buffer",
"desc": "The prime parameter (DH)."
},
{
"textRaw": "`primeLength`: {number} Prime length in bits (DH).",
"name": "primeLength",
"type": "number",
"desc": "Prime length in bits (DH)."
},
{
"textRaw": "`generator`: {number} Custom generator (DH). **Default:** `2`.",
"name": "generator",
"type": "number",
"default": "`2`",
"desc": "Custom generator (DH)."
},
{
"textRaw": "`groupName`: {string} Diffie-Hellman group name (DH). See [`crypto.getDiffieHellman()`][].",
"name": "groupName",
"type": "string",
"desc": "Diffie-Hellman group name (DH). See [`crypto.getDiffieHellman()`][]."
},
{
"textRaw": "`publicKeyEncoding`: {Object} See [`keyObject.export()`][].",
"name": "publicKeyEncoding",
"type": "Object",
"desc": "See [`keyObject.export()`][]."
},
{
"textRaw": "`privateKeyEncoding`: {Object} See [`keyObject.export()`][].",
"name": "privateKeyEncoding",
"type": "Object",
"desc": "See [`keyObject.export()`][]."
}
]
}
]
}
],
"desc": "<p>Generates a new asymmetric key pair of the given <code>type</code>. RSA, RSA-PSS, DSA, EC,\nEd25519, Ed448, X25519, X448, and DH are currently supported.</p>\n<p>If a <code>publicKeyEncoding</code> or <code>privateKeyEncoding</code> was specified, this function\nbehaves as if <a href=\"#keyobjectexportoptions\"><code>keyObject.export()</code></a> had been called on its result. Otherwise,\nthe respective part of the key is returned as a <a href=\"#class-keyobject\"><code>KeyObject</code></a>.</p>\n<p>When encoding public keys, it is recommended to use <code>'spki'</code>. When encoding\nprivate keys, it is recommended to use <code>'pkcs8'</code> with a strong passphrase,\nand to keep the passphrase confidential.</p>\n<pre><code class=\"language-mjs\">const {\n generateKeyPairSync\n} = await import('node:crypto');\n\nconst {\n publicKey,\n privateKey,\n} = generateKeyPairSync('rsa', {\n modulusLength: 4096,\n publicKeyEncoding: {\n type: 'spki',\n format: 'pem'\n },\n privateKeyEncoding: {\n type: 'pkcs8',\n format: 'pem',\n cipher: 'aes-256-cbc',\n passphrase: 'top secret'\n }\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n generateKeyPairSync,\n} = require('node:crypto');\n\nconst {\n publicKey,\n privateKey,\n} = generateKeyPairSync('rsa', {\n modulusLength: 4096,\n publicKeyEncoding: {\n type: 'spki',\n format: 'pem'\n },\n privateKeyEncoding: {\n type: 'pkcs8',\n format: 'pem',\n cipher: 'aes-256-cbc',\n passphrase: 'top secret'\n }\n});\n</code></pre>\n<p>The return value <code>{ publicKey, privateKey }</code> represents the generated key pair.\nWhen PEM encoding was selected, the respective key will be a string, otherwise\nit will be a buffer containing the data encoded as DER.</p>"
},
{
"textRaw": "`crypto.generateKeySync(type, options)`",
"type": "method",
"name": "generateKeySync",
"meta": {
"added": [
"v15.0.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {KeyObject}",
"name": "return",
"type": "KeyObject"
},
"params": [
{
"textRaw": "`type`: {string} The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.",
"name": "type",
"type": "string",
"desc": "The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`."
},
{
"textRaw": "`options`: {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`length`: {number} The bit length of the key to generate.",
"name": "length",
"type": "number",
"desc": "The bit length of the key to generate.",
"options": [
{
"textRaw": "If `type` is `'hmac'`, the minimum is 8, and the maximum length is 2<sup>31</sup>-1. If the value is not a multiple of 8, the generated key will be truncated to `Math.floor(length / 8)`.",
"name": "If",
"desc": "`type` is `'hmac'`, the minimum is 8, and the maximum length is 2<sup>31</sup>-1. If the value is not a multiple of 8, the generated key will be truncated to `Math.floor(length / 8)`."
},
{
"textRaw": "If `type` is `'aes'`, the length must be one of `128`, `192`, or `256`.",
"name": "If",
"desc": "`type` is `'aes'`, the length must be one of `128`, `192`, or `256`."
}
]
}
]
}
]
}
],
"desc": "<p>Synchronously generates a new random secret key of the given <code>length</code>. The\n<code>type</code> will determine which validations will be performed on the <code>length</code>.</p>\n<pre><code class=\"language-mjs\">const {\n generateKeySync\n} = await import('node:crypto');\n\nconst key = generateKeySync('hmac', { length: 64 });\nconsole.log(key.export().toString('hex')); // e89..........41e\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n generateKeySync,\n} = require('node:crypto');\n\nconst key = generateKeySync('hmac', { length: 64 });\nconsole.log(key.export().toString('hex')); // e89..........41e\n</code></pre>"
},
{
"textRaw": "`crypto.generatePrime(size[, options[, callback]])`",
"type": "method",
"name": "generatePrime",
"meta": {
"added": [
"v15.8.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`size` {number} The size (in bits) of the prime to generate.",
"name": "size",
"type": "number",
"desc": "The size (in bits) of the prime to generate."
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`add` {ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint}",
"name": "add",
"type": "ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint"
},
{
"textRaw": "`rem` {ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint}",
"name": "rem",
"type": "ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint"
},
{
"textRaw": "`safe` {boolean} **Default:** `false`.",
"name": "safe",
"type": "boolean",
"default": "`false`"
},
{
"textRaw": "`bigint` {boolean} When `true`, the generated prime is returned as a `bigint`.",
"name": "bigint",
"type": "boolean",
"desc": "When `true`, the generated prime is returned as a `bigint`."
}
]
},
{
"textRaw": "`callback` {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err` {Error}",
"name": "err",
"type": "Error"
},
{
"textRaw": "`prime` {ArrayBuffer|bigint}",
"name": "prime",
"type": "ArrayBuffer|bigint"
}
]
}
]
}
],
"desc": "<p>Generates a pseudorandom prime of <code>size</code> bits.</p>\n<p>If <code>options.safe</code> is <code>true</code>, the prime will be a safe prime -- that is,\n<code>(prime - 1) / 2</code> will also be a prime.</p>\n<p>The <code>options.add</code> and <code>options.rem</code> parameters can be used to enforce additional\nrequirements, e.g., for Diffie-Hellman:</p>\n<ul>\n<li>If <code>options.add</code> and <code>options.rem</code> are both set, the prime will satisfy the\ncondition that <code>prime % add = rem</code>.</li>\n<li>If only <code>options.add</code> is set and <code>options.safe</code> is not <code>true</code>, the prime will\nsatisfy the condition that <code>prime % add = 1</code>.</li>\n<li>If only <code>options.add</code> is set and <code>options.safe</code> is set to <code>true</code>, the prime\nwill instead satisfy the condition that <code>prime % add = 3</code>. This is necessary\nbecause <code>prime % add = 1</code> for <code>options.add > 2</code> would contradict the condition\nenforced by <code>options.safe</code>.</li>\n<li><code>options.rem</code> is ignored if <code>options.add</code> is not given.</li>\n</ul>\n<p>Both <code>options.add</code> and <code>options.rem</code> must be encoded as big-endian sequences\nif given as an <code>ArrayBuffer</code>, <code>SharedArrayBuffer</code>, <code>TypedArray</code>, <code>Buffer</code>, or\n<code>DataView</code>.</p>\n<p>By default, the prime is encoded as a big-endian sequence of octets\nin an <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a>. If the <code>bigint</code> option is <code>true</code>, then a <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt\" class=\"type\"><bigint></a>\nis provided.</p>"
},
{
"textRaw": "`crypto.generatePrimeSync(size[, options])`",
"type": "method",
"name": "generatePrimeSync",
"meta": {
"added": [
"v15.8.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {ArrayBuffer|bigint}",
"name": "return",
"type": "ArrayBuffer|bigint"
},
"params": [
{
"textRaw": "`size` {number} The size (in bits) of the prime to generate.",
"name": "size",
"type": "number",
"desc": "The size (in bits) of the prime to generate."
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`add` {ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint}",
"name": "add",
"type": "ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint"
},
{
"textRaw": "`rem` {ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint}",
"name": "rem",
"type": "ArrayBuffer|SharedArrayBuffer|TypedArray|Buffer|DataView|bigint"
},
{
"textRaw": "`safe` {boolean} **Default:** `false`.",
"name": "safe",
"type": "boolean",
"default": "`false`"
},
{
"textRaw": "`bigint` {boolean} When `true`, the generated prime is returned as a `bigint`.",
"name": "bigint",
"type": "boolean",
"desc": "When `true`, the generated prime is returned as a `bigint`."
}
]
}
]
}
],
"desc": "<p>Generates a pseudorandom prime of <code>size</code> bits.</p>\n<p>If <code>options.safe</code> is <code>true</code>, the prime will be a safe prime -- that is,\n<code>(prime - 1) / 2</code> will also be a prime.</p>\n<p>The <code>options.add</code> and <code>options.rem</code> parameters can be used to enforce additional\nrequirements, e.g., for Diffie-Hellman:</p>\n<ul>\n<li>If <code>options.add</code> and <code>options.rem</code> are both set, the prime will satisfy the\ncondition that <code>prime % add = rem</code>.</li>\n<li>If only <code>options.add</code> is set and <code>options.safe</code> is not <code>true</code>, the prime will\nsatisfy the condition that <code>prime % add = 1</code>.</li>\n<li>If only <code>options.add</code> is set and <code>options.safe</code> is set to <code>true</code>, the prime\nwill instead satisfy the condition that <code>prime % add = 3</code>. This is necessary\nbecause <code>prime % add = 1</code> for <code>options.add > 2</code> would contradict the condition\nenforced by <code>options.safe</code>.</li>\n<li><code>options.rem</code> is ignored if <code>options.add</code> is not given.</li>\n</ul>\n<p>Both <code>options.add</code> and <code>options.rem</code> must be encoded as big-endian sequences\nif given as an <code>ArrayBuffer</code>, <code>SharedArrayBuffer</code>, <code>TypedArray</code>, <code>Buffer</code>, or\n<code>DataView</code>.</p>\n<p>By default, the prime is encoded as a big-endian sequence of octets\nin an <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a>. If the <code>bigint</code> option is <code>true</code>, then a <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt\" class=\"type\"><bigint></a>\nis provided.</p>"
},
{
"textRaw": "`crypto.getCipherInfo(nameOrNid[, options])`",
"type": "method",
"name": "getCipherInfo",
"meta": {
"added": [
"v15.0.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Object}",
"name": "return",
"type": "Object",
"options": [
{
"textRaw": "`name` {string} The name of the cipher",
"name": "name",
"type": "string",
"desc": "The name of the cipher"
},
{
"textRaw": "`nid` {number} The nid of the cipher",
"name": "nid",
"type": "number",
"desc": "The nid of the cipher"
},
{
"textRaw": "`blockSize` {number} The block size of the cipher in bytes. This property is omitted when `mode` is `'stream'`.",
"name": "blockSize",
"type": "number",
"desc": "The block size of the cipher in bytes. This property is omitted when `mode` is `'stream'`."
},
{
"textRaw": "`ivLength` {number} The expected or default initialization vector length in bytes. This property is omitted if the cipher does not use an initialization vector.",
"name": "ivLength",
"type": "number",
"desc": "The expected or default initialization vector length in bytes. This property is omitted if the cipher does not use an initialization vector."
},
{
"textRaw": "`keyLength` {number} The expected or default key length in bytes.",
"name": "keyLength",
"type": "number",
"desc": "The expected or default key length in bytes."
},
{
"textRaw": "`mode` {string} The cipher mode. One of `'cbc'`, `'ccm'`, `'cfb'`, `'ctr'`, `'ecb'`, `'gcm'`, `'ocb'`, `'ofb'`, `'stream'`, `'wrap'`, `'xts'`.",
"name": "mode",
"type": "string",
"desc": "The cipher mode. One of `'cbc'`, `'ccm'`, `'cfb'`, `'ctr'`, `'ecb'`, `'gcm'`, `'ocb'`, `'ofb'`, `'stream'`, `'wrap'`, `'xts'`."
}
]
},
"params": [
{
"textRaw": "`nameOrNid`: {string|number} The name or nid of the cipher to query.",
"name": "nameOrNid",
"type": "string|number",
"desc": "The name or nid of the cipher to query."
},
{
"textRaw": "`options`: {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`keyLength`: {number} A test key length.",
"name": "keyLength",
"type": "number",
"desc": "A test key length."
},
{
"textRaw": "`ivLength`: {number} A test IV length.",
"name": "ivLength",
"type": "number",
"desc": "A test IV length."
}
]
}
]
}
],
"desc": "<p>Returns information about a given cipher.</p>\n<p>Some ciphers accept variable length keys and initialization vectors. By default,\nthe <code>crypto.getCipherInfo()</code> method will return the default values for these\nciphers. To test if a given key length or iv length is acceptable for given\ncipher, use the <code>keyLength</code> and <code>ivLength</code> options. If the given values are\nunacceptable, <code>undefined</code> will be returned.</p>"
},
{
"textRaw": "`crypto.getCiphers()`",
"type": "method",
"name": "getCiphers",
"meta": {
"added": [
"v0.9.3"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string\\[]} An array with the names of the supported cipher algorithms.",
"name": "return",
"type": "string\\[]",
"desc": "An array with the names of the supported cipher algorithms."
},
"params": []
}
],
"desc": "<pre><code class=\"language-mjs\">const {\n getCiphers\n} = await import('node:crypto');\n\nconsole.log(getCiphers()); // ['aes-128-cbc', 'aes-128-ccm', ...]\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n getCiphers,\n} = require('node:crypto');\n\nconsole.log(getCiphers()); // ['aes-128-cbc', 'aes-128-ccm', ...]\n</code></pre>"
},
{
"textRaw": "`crypto.getCurves()`",
"type": "method",
"name": "getCurves",
"meta": {
"added": [
"v2.3.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string\\[]} An array with the names of the supported elliptic curves.",
"name": "return",
"type": "string\\[]",
"desc": "An array with the names of the supported elliptic curves."
},
"params": []
}
],
"desc": "<pre><code class=\"language-mjs\">const {\n getCurves\n} = await import('node:crypto');\n\nconsole.log(getCurves()); // ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...]\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n getCurves,\n} = require('node:crypto');\n\nconsole.log(getCurves()); // ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...]\n</code></pre>"
},
{
"textRaw": "`crypto.getDiffieHellman(groupName)`",
"type": "method",
"name": "getDiffieHellman",
"meta": {
"added": [
"v0.7.5"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {DiffieHellmanGroup}",
"name": "return",
"type": "DiffieHellmanGroup"
},
"params": [
{
"textRaw": "`groupName` {string}",
"name": "groupName",
"type": "string"
}
]
}
],
"desc": "<p>Creates a predefined <code>DiffieHellmanGroup</code> key exchange object. The\nsupported groups are listed in the documentation for <a href=\"#class-diffiehellmangroup\"><code>DiffieHellmanGroup</code></a>.</p>\n<p>The returned object mimics the interface of objects created by\n<a href=\"#cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding\"><code>crypto.createDiffieHellman()</code></a>, but will not allow changing\nthe keys (with <a href=\"#diffiehellmansetpublickeypublickey-encoding\"><code>diffieHellman.setPublicKey()</code></a>, for example). The\nadvantage of using this method is that the parties do not have to\ngenerate nor exchange a group modulus beforehand, saving both processor\nand communication time.</p>\n<p>Example (obtaining a shared secret):</p>\n<pre><code class=\"language-mjs\">const {\n getDiffieHellman\n} = await import('node:crypto');\nconst alice = getDiffieHellman('modp14');\nconst bob = getDiffieHellman('modp14');\n\nalice.generateKeys();\nbob.generateKeys();\n\nconst aliceSecret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n/* aliceSecret and bobSecret should be the same */\nconsole.log(aliceSecret === bobSecret);\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n getDiffieHellman,\n} = require('node:crypto');\n\nconst alice = getDiffieHellman('modp14');\nconst bob = getDiffieHellman('modp14');\n\nalice.generateKeys();\nbob.generateKeys();\n\nconst aliceSecret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n/* aliceSecret and bobSecret should be the same */\nconsole.log(aliceSecret === bobSecret);\n</code></pre>"
},
{
"textRaw": "`crypto.getFips()`",
"type": "method",
"name": "getFips",
"meta": {
"added": [
"v10.0.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {number} `1` if and only if a FIPS compliant crypto provider is currently in use, `0` otherwise. A future semver-major release may change the return type of this API to a {boolean}.",
"name": "return",
"type": "number",
"desc": "`1` if and only if a FIPS compliant crypto provider is currently in use, `0` otherwise. A future semver-major release may change the return type of this API to a {boolean}."
},
"params": []
}
]
},
{
"textRaw": "`crypto.getHashes()`",
"type": "method",
"name": "getHashes",
"meta": {
"added": [
"v0.9.3"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string\\[]} An array of the names of the supported hash algorithms, such as `'RSA-SHA256'`. Hash algorithms are also called \"digest\" algorithms.",
"name": "return",
"type": "string\\[]",
"desc": "An array of the names of the supported hash algorithms, such as `'RSA-SHA256'`. Hash algorithms are also called \"digest\" algorithms."
},
"params": []
}
],
"desc": "<pre><code class=\"language-mjs\">const {\n getHashes\n} = await import('node:crypto');\n\nconsole.log(getHashes()); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n getHashes,\n} = require('node:crypto');\n\nconsole.log(getHashes()); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]\n</code></pre>"
},
{
"textRaw": "`crypto.hkdf(digest, ikm, salt, info, keylen, callback)`",
"type": "method",
"name": "hkdf",
"meta": {
"added": [
"v15.0.0"
],
"changes": [
{
"version": "v16.18.0",
"pr-url": "https://github.com/nodejs/node/pull/44201",
"description": "The input keying material can now be zero-length."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`digest` {string} The digest algorithm to use.",
"name": "digest",
"type": "string",
"desc": "The digest algorithm to use."
},
{
"textRaw": "`ikm` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject} The input keying material. Must be provided but can be zero-length.",
"name": "ikm",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject",
"desc": "The input keying material. Must be provided but can be zero-length."
},
{
"textRaw": "`salt` {string|ArrayBuffer|Buffer|TypedArray|DataView} The salt value. Must be provided but can be zero-length.",
"name": "salt",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView",
"desc": "The salt value. Must be provided but can be zero-length."
},
{
"textRaw": "`info` {string|ArrayBuffer|Buffer|TypedArray|DataView} Additional info value. Must be provided but can be zero-length, and cannot be more than 1024 bytes.",
"name": "info",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView",
"desc": "Additional info value. Must be provided but can be zero-length, and cannot be more than 1024 bytes."
},
{
"textRaw": "`keylen` {number} The length of the key to generate. Must be greater than 0. The maximum allowable value is `255` times the number of bytes produced by the selected digest function (e.g. `sha512` generates 64-byte hashes, making the maximum HKDF output 16320 bytes).",
"name": "keylen",
"type": "number",
"desc": "The length of the key to generate. Must be greater than 0. The maximum allowable value is `255` times the number of bytes produced by the selected digest function (e.g. `sha512` generates 64-byte hashes, making the maximum HKDF output 16320 bytes)."
},
{
"textRaw": "`callback` {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err` {Error}",
"name": "err",
"type": "Error"
},
{
"textRaw": "`derivedKey` {ArrayBuffer}",
"name": "derivedKey",
"type": "ArrayBuffer"
}
]
}
]
}
],
"desc": "<p>HKDF is a simple key derivation function defined in RFC 5869. The given <code>ikm</code>,\n<code>salt</code> and <code>info</code> are used with the <code>digest</code> to derive a key of <code>keylen</code> bytes.</p>\n<p>The supplied <code>callback</code> function is called with two arguments: <code>err</code> and\n<code>derivedKey</code>. If an errors occurs while deriving the key, <code>err</code> will be set;\notherwise <code>err</code> will be <code>null</code>. The successfully generated <code>derivedKey</code> will\nbe passed to the callback as an <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a>. An error will be thrown if any\nof the input arguments specify invalid values or types.</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst {\n hkdf\n} = await import('node:crypto');\n\nhkdf('sha512', 'key', 'salt', 'info', 64, (err, derivedKey) => {\n if (err) throw err;\n console.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653'\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n hkdf,\n} = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nhkdf('sha512', 'key', 'salt', 'info', 64, (err, derivedKey) => {\n if (err) throw err;\n console.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653'\n});\n</code></pre>"
},
{
"textRaw": "`crypto.hkdfSync(digest, ikm, salt, info, keylen)`",
"type": "method",
"name": "hkdfSync",
"meta": {
"added": [
"v15.0.0"
],
"changes": [
{
"version": "v16.18.0",
"pr-url": "https://github.com/nodejs/node/pull/44201",
"description": "The input keying material can now be zero-length."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {ArrayBuffer}",
"name": "return",
"type": "ArrayBuffer"
},
"params": [
{
"textRaw": "`digest` {string} The digest algorithm to use.",
"name": "digest",
"type": "string",
"desc": "The digest algorithm to use."
},
{
"textRaw": "`ikm` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject} The input keying material. Must be provided but can be zero-length.",
"name": "ikm",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject",
"desc": "The input keying material. Must be provided but can be zero-length."
},
{
"textRaw": "`salt` {string|ArrayBuffer|Buffer|TypedArray|DataView} The salt value. Must be provided but can be zero-length.",
"name": "salt",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView",
"desc": "The salt value. Must be provided but can be zero-length."
},
{
"textRaw": "`info` {string|ArrayBuffer|Buffer|TypedArray|DataView} Additional info value. Must be provided but can be zero-length, and cannot be more than 1024 bytes.",
"name": "info",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView",
"desc": "Additional info value. Must be provided but can be zero-length, and cannot be more than 1024 bytes."
},
{
"textRaw": "`keylen` {number} The length of the key to generate. Must be greater than 0. The maximum allowable value is `255` times the number of bytes produced by the selected digest function (e.g. `sha512` generates 64-byte hashes, making the maximum HKDF output 16320 bytes).",
"name": "keylen",
"type": "number",
"desc": "The length of the key to generate. Must be greater than 0. The maximum allowable value is `255` times the number of bytes produced by the selected digest function (e.g. `sha512` generates 64-byte hashes, making the maximum HKDF output 16320 bytes)."
}
]
}
],
"desc": "<p>Provides a synchronous HKDF key derivation function as defined in RFC 5869. The\ngiven <code>ikm</code>, <code>salt</code> and <code>info</code> are used with the <code>digest</code> to derive a key of\n<code>keylen</code> bytes.</p>\n<p>The successfully generated <code>derivedKey</code> will be returned as an <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a>.</p>\n<p>An error will be thrown if any of the input arguments specify invalid values or\ntypes, or if the derived key cannot be generated.</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst {\n hkdfSync\n} = await import('node:crypto');\n\nconst derivedKey = hkdfSync('sha512', 'key', 'salt', 'info', 64);\nconsole.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653'\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n hkdfSync,\n} = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst derivedKey = hkdfSync('sha512', 'key', 'salt', 'info', 64);\nconsole.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653'\n</code></pre>"
},
{
"textRaw": "`crypto.pbkdf2(password, salt, iterations, keylen, digest, callback)`",
"type": "method",
"name": "pbkdf2",
"meta": {
"added": [
"v0.5.5"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The password and salt arguments can also be ArrayBuffer instances."
},
{
"version": "v14.0.0",
"pr-url": "https://github.com/nodejs/node/pull/30578",
"description": "The `iterations` parameter is now restricted to positive values. Earlier releases treated other values as one."
},
{
"version": "v8.0.0",
"pr-url": "https://github.com/nodejs/node/pull/11305",
"description": "The `digest` parameter is always required now."
},
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/4047",
"description": "Calling this function without passing the `digest` parameter is deprecated now and will emit a warning."
},
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default encoding for `password` if it is a string changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`password` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "password",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`salt` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "salt",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`iterations` {number}",
"name": "iterations",
"type": "number"
},
{
"textRaw": "`keylen` {number}",
"name": "keylen",
"type": "number"
},
{
"textRaw": "`digest` {string}",
"name": "digest",
"type": "string"
},
{
"textRaw": "`callback` {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err` {Error}",
"name": "err",
"type": "Error"
},
{
"textRaw": "`derivedKey` {Buffer}",
"name": "derivedKey",
"type": "Buffer"
}
]
}
]
}
],
"desc": "<p>Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)\nimplementation. A selected HMAC digest algorithm specified by <code>digest</code> is\napplied to derive a key of the requested byte length (<code>keylen</code>) from the\n<code>password</code>, <code>salt</code> and <code>iterations</code>.</p>\n<p>The supplied <code>callback</code> function is called with two arguments: <code>err</code> and\n<code>derivedKey</code>. If an error occurs while deriving the key, <code>err</code> will be set;\notherwise <code>err</code> will be <code>null</code>. By default, the successfully generated\n<code>derivedKey</code> will be passed to the callback as a <a href=\"buffer.html\"><code>Buffer</code></a>. An error will be\nthrown if any of the input arguments specify invalid values or types.</p>\n<p>The <code>iterations</code> argument must be a number set as high as possible. The\nhigher the number of iterations, the more secure the derived key will be,\nbut will take a longer amount of time to complete.</p>\n<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is\nrandom and at least 16 bytes long. See <a href=\"https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf\">NIST SP 800-132</a> for details.</p>\n<p>When passing strings for <code>password</code> or <code>salt</code>, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>\n<pre><code class=\"language-mjs\">const {\n pbkdf2\n} = await import('node:crypto');\n\npbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey.toString('hex')); // '3745e48...08d59ae'\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n pbkdf2,\n} = require('node:crypto');\n\npbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey.toString('hex')); // '3745e48...08d59ae'\n});\n</code></pre>\n<p>The <code>crypto.DEFAULT_ENCODING</code> property can be used to change the way the\n<code>derivedKey</code> is passed to the callback. This property, however, has been\ndeprecated and use should be avoided.</p>\n<pre><code class=\"language-mjs\">import crypto from 'node:crypto';\ncrypto.DEFAULT_ENCODING = 'hex';\ncrypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey); // '3745e48...aa39b34'\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const crypto = require('node:crypto');\ncrypto.DEFAULT_ENCODING = 'hex';\ncrypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey); // '3745e48...aa39b34'\n});\n</code></pre>\n<p>An array of supported digest functions can be retrieved using\n<a href=\"#cryptogethashes\"><code>crypto.getHashes()</code></a>.</p>\n<p>This API uses libuv's threadpool, which can have surprising and\nnegative performance implications for some applications; see the\n<a href=\"cli.html#uv_threadpool_sizesize\"><code>UV_THREADPOOL_SIZE</code></a> documentation for more information.</p>"
},
{
"textRaw": "`crypto.pbkdf2Sync(password, salt, iterations, keylen, digest)`",
"type": "method",
"name": "pbkdf2Sync",
"meta": {
"added": [
"v0.9.3"
],
"changes": [
{
"version": "v14.0.0",
"pr-url": "https://github.com/nodejs/node/pull/30578",
"description": "The `iterations` parameter is now restricted to positive values. Earlier releases treated other values as one."
},
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/4047",
"description": "Calling this function without passing the `digest` parameter is deprecated now and will emit a warning."
},
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default encoding for `password` if it is a string changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer}",
"name": "return",
"type": "Buffer"
},
"params": [
{
"textRaw": "`password` {string|Buffer|TypedArray|DataView}",
"name": "password",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`salt` {string|Buffer|TypedArray|DataView}",
"name": "salt",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`iterations` {number}",
"name": "iterations",
"type": "number"
},
{
"textRaw": "`keylen` {number}",
"name": "keylen",
"type": "number"
},
{
"textRaw": "`digest` {string}",
"name": "digest",
"type": "string"
}
]
}
],
"desc": "<p>Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)\nimplementation. A selected HMAC digest algorithm specified by <code>digest</code> is\napplied to derive a key of the requested byte length (<code>keylen</code>) from the\n<code>password</code>, <code>salt</code> and <code>iterations</code>.</p>\n<p>If an error occurs an <code>Error</code> will be thrown, otherwise the derived key will be\nreturned as a <a href=\"buffer.html\"><code>Buffer</code></a>.</p>\n<p>The <code>iterations</code> argument must be a number set as high as possible. The\nhigher the number of iterations, the more secure the derived key will be,\nbut will take a longer amount of time to complete.</p>\n<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is\nrandom and at least 16 bytes long. See <a href=\"https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf\">NIST SP 800-132</a> for details.</p>\n<p>When passing strings for <code>password</code> or <code>salt</code>, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>\n<pre><code class=\"language-mjs\">const {\n pbkdf2Sync\n} = await import('node:crypto');\n\nconst key = pbkdf2Sync('secret', 'salt', 100000, 64, 'sha512');\nconsole.log(key.toString('hex')); // '3745e48...08d59ae'\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n pbkdf2Sync,\n} = require('node:crypto');\n\nconst key = pbkdf2Sync('secret', 'salt', 100000, 64, 'sha512');\nconsole.log(key.toString('hex')); // '3745e48...08d59ae'\n</code></pre>\n<p>The <code>crypto.DEFAULT_ENCODING</code> property may be used to change the way the\n<code>derivedKey</code> is returned. This property, however, is deprecated and use\nshould be avoided.</p>\n<pre><code class=\"language-mjs\">import crypto from 'node:crypto';\ncrypto.DEFAULT_ENCODING = 'hex';\nconst key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');\nconsole.log(key); // '3745e48...aa39b34'\n</code></pre>\n<pre><code class=\"language-cjs\">const crypto = require('node:crypto');\ncrypto.DEFAULT_ENCODING = 'hex';\nconst key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');\nconsole.log(key); // '3745e48...aa39b34'\n</code></pre>\n<p>An array of supported digest functions can be retrieved using\n<a href=\"#cryptogethashes\"><code>crypto.getHashes()</code></a>.</p>"
},
{
"textRaw": "`crypto.privateDecrypt(privateKey, buffer)`",
"type": "method",
"name": "privateDecrypt",
"meta": {
"added": [
"v0.11.14"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "Added string, ArrayBuffer, and CryptoKey as allowable key types. The oaepLabel can be an ArrayBuffer. The buffer can be a string or ArrayBuffer. All types that accept buffers are limited to a maximum of 2 ** 31 - 1 bytes."
},
{
"version": "v12.11.0",
"pr-url": "https://github.com/nodejs/node/pull/29489",
"description": "The `oaepLabel` option was added."
},
{
"version": "v12.9.0",
"pr-url": "https://github.com/nodejs/node/pull/28335",
"description": "The `oaepHash` option was added."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "This function now supports key objects."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>privateKey</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\n<ul>\n<li><code>oaepHash</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The hash function to use for OAEP padding and MGF1.\n<strong>Default:</strong> <code>'sha1'</code></li>\n<li><code>oaepLabel</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> The label to\nuse for OAEP padding. If not specified, no label is used.</li>\n<li><code>padding</code> <a href=\"crypto.html#cryptoconstants\" class=\"type\"><crypto.constants></a> An optional padding value defined in\n<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code>,\n<code>crypto.constants.RSA_PKCS1_PADDING</code>, or\n<code>crypto.constants.RSA_PKCS1_OAEP_PADDING</code>.</li>\n</ul>\n</li>\n<li><code>buffer</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li>Returns: <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> A new <code>Buffer</code> with the decrypted content.</li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Decrypts <code>buffer</code> with <code>privateKey</code>. <code>buffer</code> was previously encrypted using\nthe corresponding public key, for example using <a href=\"#cryptopublicencryptkey-buffer\"><code>crypto.publicEncrypt()</code></a>.</p>\n<p>If <code>privateKey</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if\n<code>privateKey</code> had been passed to <a href=\"#cryptocreateprivatekeykey\"><code>crypto.createPrivateKey()</code></a>. If it is an\nobject, the <code>padding</code> property can be passed. Otherwise, this function uses\n<code>RSA_PKCS1_OAEP_PADDING</code>.</p>"
},
{
"textRaw": "`crypto.privateEncrypt(privateKey, buffer)`",
"type": "method",
"name": "privateEncrypt",
"meta": {
"added": [
"v1.1.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "Added string, ArrayBuffer, and CryptoKey as allowable key types. The passphrase can be an ArrayBuffer. The buffer can be a string or ArrayBuffer. All types that accept buffers are limited to a maximum of 2 ** 31 - 1 bytes."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "This function now supports key objects."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>privateKey</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\n<ul>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\nA PEM encoded private key.</li>\n<li><code>passphrase</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> An optional\npassphrase for the private key.</li>\n<li><code>padding</code> <a href=\"crypto.html#cryptoconstants\" class=\"type\"><crypto.constants></a> An optional padding value defined in\n<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code> or\n<code>crypto.constants.RSA_PKCS1_PADDING</code>.</li>\n<li><code>encoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The string encoding to use when <code>buffer</code>, <code>key</code>,\nor <code>passphrase</code> are strings.</li>\n</ul>\n</li>\n<li><code>buffer</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li>Returns: <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> A new <code>Buffer</code> with the encrypted content.</li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Encrypts <code>buffer</code> with <code>privateKey</code>. The returned data can be decrypted using\nthe corresponding public key, for example using <a href=\"#cryptopublicdecryptkey-buffer\"><code>crypto.publicDecrypt()</code></a>.</p>\n<p>If <code>privateKey</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if\n<code>privateKey</code> had been passed to <a href=\"#cryptocreateprivatekeykey\"><code>crypto.createPrivateKey()</code></a>. If it is an\nobject, the <code>padding</code> property can be passed. Otherwise, this function uses\n<code>RSA_PKCS1_PADDING</code>.</p>"
},
{
"textRaw": "`crypto.publicDecrypt(key, buffer)`",
"type": "method",
"name": "publicDecrypt",
"meta": {
"added": [
"v1.1.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "Added string, ArrayBuffer, and CryptoKey as allowable key types. The passphrase can be an ArrayBuffer. The buffer can be a string or ArrayBuffer. All types that accept buffers are limited to a maximum of 2 ** 31 - 1 bytes."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "This function now supports key objects."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\n<ul>\n<li><code>passphrase</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> An optional\npassphrase for the private key.</li>\n<li><code>padding</code> <a href=\"crypto.html#cryptoconstants\" class=\"type\"><crypto.constants></a> An optional padding value defined in\n<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code> or\n<code>crypto.constants.RSA_PKCS1_PADDING</code>.</li>\n<li><code>encoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The string encoding to use when <code>buffer</code>, <code>key</code>,\nor <code>passphrase</code> are strings.</li>\n</ul>\n</li>\n<li><code>buffer</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li>Returns: <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> A new <code>Buffer</code> with the decrypted content.</li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Decrypts <code>buffer</code> with <code>key</code>.<code>buffer</code> was previously encrypted using\nthe corresponding private key, for example using <a href=\"#cryptoprivateencryptprivatekey-buffer\"><code>crypto.privateEncrypt()</code></a>.</p>\n<p>If <code>key</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if\n<code>key</code> had been passed to <a href=\"#cryptocreatepublickeykey\"><code>crypto.createPublicKey()</code></a>. If it is an\nobject, the <code>padding</code> property can be passed. Otherwise, this function uses\n<code>RSA_PKCS1_PADDING</code>.</p>\n<p>Because RSA public keys can be derived from private keys, a private key may\nbe passed instead of a public key.</p>"
},
{
"textRaw": "`crypto.publicEncrypt(key, buffer)`",
"type": "method",
"name": "publicEncrypt",
"meta": {
"added": [
"v0.11.14"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "Added string, ArrayBuffer, and CryptoKey as allowable key types. The oaepLabel and passphrase can be ArrayBuffers. The buffer can be a string or ArrayBuffer. All types that accept buffers are limited to a maximum of 2 ** 31 - 1 bytes."
},
{
"version": "v12.11.0",
"pr-url": "https://github.com/nodejs/node/pull/29489",
"description": "The `oaepLabel` option was added."
},
{
"version": "v12.9.0",
"pr-url": "https://github.com/nodejs/node/pull/28335",
"description": "The `oaepHash` option was added."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "This function now supports key objects."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\n<ul>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\nA PEM encoded public or private key, <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a>, or <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>.</li>\n<li><code>oaepHash</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The hash function to use for OAEP padding and MGF1.\n<strong>Default:</strong> <code>'sha1'</code></li>\n<li><code>oaepLabel</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> The label to\nuse for OAEP padding. If not specified, no label is used.</li>\n<li><code>passphrase</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> An optional\npassphrase for the private key.</li>\n<li><code>padding</code> <a href=\"crypto.html#cryptoconstants\" class=\"type\"><crypto.constants></a> An optional padding value defined in\n<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code>,\n<code>crypto.constants.RSA_PKCS1_PADDING</code>, or\n<code>crypto.constants.RSA_PKCS1_OAEP_PADDING</code>.</li>\n<li><code>encoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The string encoding to use when <code>buffer</code>, <code>key</code>,\n<code>oaepLabel</code>, or <code>passphrase</code> are strings.</li>\n</ul>\n</li>\n<li><code>buffer</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li>Returns: <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> A new <code>Buffer</code> with the encrypted content.</li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Encrypts the content of <code>buffer</code> with <code>key</code> and returns a new\n<a href=\"buffer.html\"><code>Buffer</code></a> with encrypted content. The returned data can be decrypted using\nthe corresponding private key, for example using <a href=\"#cryptoprivatedecryptprivatekey-buffer\"><code>crypto.privateDecrypt()</code></a>.</p>\n<p>If <code>key</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if\n<code>key</code> had been passed to <a href=\"#cryptocreatepublickeykey\"><code>crypto.createPublicKey()</code></a>. If it is an\nobject, the <code>padding</code> property can be passed. Otherwise, this function uses\n<code>RSA_PKCS1_OAEP_PADDING</code>.</p>\n<p>Because RSA public keys can be derived from private keys, a private key may\nbe passed instead of a public key.</p>"
},
{
"textRaw": "`crypto.randomBytes(size[, callback])`",
"type": "method",
"name": "randomBytes",
"meta": {
"added": [
"v0.5.8"
],
"changes": [
{
"version": "v9.0.0",
"pr-url": "https://github.com/nodejs/node/pull/16454",
"description": "Passing `null` as the `callback` argument now throws `ERR_INVALID_CALLBACK`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer} if the `callback` function is not provided.",
"name": "return",
"type": "Buffer",
"desc": "if the `callback` function is not provided."
},
"params": [
{
"textRaw": "`size` {number} The number of bytes to generate. The `size` must not be larger than `2**31 - 1`.",
"name": "size",
"type": "number",
"desc": "The number of bytes to generate. The `size` must not be larger than `2**31 - 1`."
},
{
"textRaw": "`callback` {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err` {Error}",
"name": "err",
"type": "Error"
},
{
"textRaw": "`buf` {Buffer}",
"name": "buf",
"type": "Buffer"
}
]
}
]
}
],
"desc": "<p>Generates cryptographically strong pseudorandom data. The <code>size</code> argument\nis a number indicating the number of bytes to generate.</p>\n<p>If a <code>callback</code> function is provided, the bytes are generated asynchronously\nand the <code>callback</code> function is invoked with two arguments: <code>err</code> and <code>buf</code>.\nIf an error occurs, <code>err</code> will be an <code>Error</code> object; otherwise it is <code>null</code>. The\n<code>buf</code> argument is a <a href=\"buffer.html\"><code>Buffer</code></a> containing the generated bytes.</p>\n<pre><code class=\"language-mjs\">// Asynchronous\nconst {\n randomBytes\n} = await import('node:crypto');\n\nrandomBytes(256, (err, buf) => {\n if (err) throw err;\n console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);\n});\n</code></pre>\n<pre><code class=\"language-cjs\">// Asynchronous\nconst {\n randomBytes,\n} = require('node:crypto');\n\nrandomBytes(256, (err, buf) => {\n if (err) throw err;\n console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);\n});\n</code></pre>\n<p>If the <code>callback</code> function is not provided, the random bytes are generated\nsynchronously and returned as a <a href=\"buffer.html\"><code>Buffer</code></a>. An error will be thrown if\nthere is a problem generating the bytes.</p>\n<pre><code class=\"language-mjs\">// Synchronous\nconst {\n randomBytes\n} = await import('node:crypto');\n\nconst buf = randomBytes(256);\nconsole.log(\n `${buf.length} bytes of random data: ${buf.toString('hex')}`);\n</code></pre>\n<pre><code class=\"language-cjs\">// Synchronous\nconst {\n randomBytes,\n} = require('node:crypto');\n\nconst buf = randomBytes(256);\nconsole.log(\n `${buf.length} bytes of random data: ${buf.toString('hex')}`);\n</code></pre>\n<p>The <code>crypto.randomBytes()</code> method will not complete until there is\nsufficient entropy available.\nThis should normally never take longer than a few milliseconds. The only time\nwhen generating the random bytes may conceivably block for a longer period of\ntime is right after boot, when the whole system is still low on entropy.</p>\n<p>This API uses libuv's threadpool, which can have surprising and\nnegative performance implications for some applications; see the\n<a href=\"cli.html#uv_threadpool_sizesize\"><code>UV_THREADPOOL_SIZE</code></a> documentation for more information.</p>\n<p>The asynchronous version of <code>crypto.randomBytes()</code> is carried out in a single\nthreadpool request. To minimize threadpool task length variation, partition\nlarge <code>randomBytes</code> requests when doing so as part of fulfilling a client\nrequest.</p>"
},
{
"textRaw": "`crypto.randomFillSync(buffer[, offset][, size])`",
"type": "method",
"name": "randomFillSync",
"meta": {
"added": [
"v7.10.0",
"v6.13.0"
],
"changes": [
{
"version": "v9.0.0",
"pr-url": "https://github.com/nodejs/node/pull/15231",
"description": "The `buffer` argument may be any `TypedArray` or `DataView`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {ArrayBuffer|Buffer|TypedArray|DataView} The object passed as `buffer` argument.",
"name": "return",
"type": "ArrayBuffer|Buffer|TypedArray|DataView",
"desc": "The object passed as `buffer` argument."
},
"params": [
{
"textRaw": "`buffer` {ArrayBuffer|Buffer|TypedArray|DataView} Must be supplied. The size of the provided `buffer` must not be larger than `2**31 - 1`.",
"name": "buffer",
"type": "ArrayBuffer|Buffer|TypedArray|DataView",
"desc": "Must be supplied. The size of the provided `buffer` must not be larger than `2**31 - 1`."
},
{
"textRaw": "`offset` {number} **Default:** `0`",
"name": "offset",
"type": "number",
"default": "`0`"
},
{
"textRaw": "`size` {number} **Default:** `buffer.length - offset`. The `size` must not be larger than `2**31 - 1`.",
"name": "size",
"type": "number",
"default": "`buffer.length - offset`. The `size` must not be larger than `2**31 - 1`"
}
]
}
],
"desc": "<p>Synchronous version of <a href=\"#cryptorandomfillbuffer-offset-size-callback\"><code>crypto.randomFill()</code></a>.</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst { randomFillSync } = await import('node:crypto');\n\nconst buf = Buffer.alloc(10);\nconsole.log(randomFillSync(buf).toString('hex'));\n\nrandomFillSync(buf, 5);\nconsole.log(buf.toString('hex'));\n\n// The above is equivalent to the following:\nrandomFillSync(buf, 5, 5);\nconsole.log(buf.toString('hex'));\n</code></pre>\n<pre><code class=\"language-cjs\">const { randomFillSync } = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst buf = Buffer.alloc(10);\nconsole.log(randomFillSync(buf).toString('hex'));\n\nrandomFillSync(buf, 5);\nconsole.log(buf.toString('hex'));\n\n// The above is equivalent to the following:\nrandomFillSync(buf, 5, 5);\nconsole.log(buf.toString('hex'));\n</code></pre>\n<p>Any <code>ArrayBuffer</code>, <code>TypedArray</code> or <code>DataView</code> instance may be passed as\n<code>buffer</code>.</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst { randomFillSync } = await import('node:crypto');\n\nconst a = new Uint32Array(10);\nconsole.log(Buffer.from(randomFillSync(a).buffer,\n a.byteOffset, a.byteLength).toString('hex'));\n\nconst b = new DataView(new ArrayBuffer(10));\nconsole.log(Buffer.from(randomFillSync(b).buffer,\n b.byteOffset, b.byteLength).toString('hex'));\n\nconst c = new ArrayBuffer(10);\nconsole.log(Buffer.from(randomFillSync(c)).toString('hex'));\n</code></pre>\n<pre><code class=\"language-cjs\">const { randomFillSync } = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst a = new Uint32Array(10);\nconsole.log(Buffer.from(randomFillSync(a).buffer,\n a.byteOffset, a.byteLength).toString('hex'));\n\nconst b = new DataView(new ArrayBuffer(10));\nconsole.log(Buffer.from(randomFillSync(b).buffer,\n b.byteOffset, b.byteLength).toString('hex'));\n\nconst c = new ArrayBuffer(10);\nconsole.log(Buffer.from(randomFillSync(c)).toString('hex'));\n</code></pre>"
},
{
"textRaw": "`crypto.randomFill(buffer[, offset][, size], callback)`",
"type": "method",
"name": "randomFill",
"meta": {
"added": [
"v7.10.0",
"v6.13.0"
],
"changes": [
{
"version": "v9.0.0",
"pr-url": "https://github.com/nodejs/node/pull/15231",
"description": "The `buffer` argument may be any `TypedArray` or `DataView`."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`buffer` {ArrayBuffer|Buffer|TypedArray|DataView} Must be supplied. The size of the provided `buffer` must not be larger than `2**31 - 1`.",
"name": "buffer",
"type": "ArrayBuffer|Buffer|TypedArray|DataView",
"desc": "Must be supplied. The size of the provided `buffer` must not be larger than `2**31 - 1`."
},
{
"textRaw": "`offset` {number} **Default:** `0`",
"name": "offset",
"type": "number",
"default": "`0`"
},
{
"textRaw": "`size` {number} **Default:** `buffer.length - offset`. The `size` must not be larger than `2**31 - 1`.",
"name": "size",
"type": "number",
"default": "`buffer.length - offset`. The `size` must not be larger than `2**31 - 1`"
},
{
"textRaw": "`callback` {Function} `function(err, buf) {}`.",
"name": "callback",
"type": "Function",
"desc": "`function(err, buf) {}`."
}
]
}
],
"desc": "<p>This function is similar to <a href=\"#cryptorandombytessize-callback\"><code>crypto.randomBytes()</code></a> but requires the first\nargument to be a <a href=\"buffer.html\"><code>Buffer</code></a> that will be filled. It also\nrequires that a callback is passed in.</p>\n<p>If the <code>callback</code> function is not provided, an error will be thrown.</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst { randomFill } = await import('node:crypto');\n\nconst buf = Buffer.alloc(10);\nrandomFill(buf, (err, buf) => {\n if (err) throw err;\n console.log(buf.toString('hex'));\n});\n\nrandomFill(buf, 5, (err, buf) => {\n if (err) throw err;\n console.log(buf.toString('hex'));\n});\n\n// The above is equivalent to the following:\nrandomFill(buf, 5, 5, (err, buf) => {\n if (err) throw err;\n console.log(buf.toString('hex'));\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const { randomFill } = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst buf = Buffer.alloc(10);\nrandomFill(buf, (err, buf) => {\n if (err) throw err;\n console.log(buf.toString('hex'));\n});\n\nrandomFill(buf, 5, (err, buf) => {\n if (err) throw err;\n console.log(buf.toString('hex'));\n});\n\n// The above is equivalent to the following:\nrandomFill(buf, 5, 5, (err, buf) => {\n if (err) throw err;\n console.log(buf.toString('hex'));\n});\n</code></pre>\n<p>Any <code>ArrayBuffer</code>, <code>TypedArray</code>, or <code>DataView</code> instance may be passed as\n<code>buffer</code>.</p>\n<p>While this includes instances of <code>Float32Array</code> and <code>Float64Array</code>, this\nfunction should not be used to generate random floating-point numbers. The\nresult may contain <code>+Infinity</code>, <code>-Infinity</code>, and <code>NaN</code>, and even if the array\ncontains finite numbers only, they are not drawn from a uniform random\ndistribution and have no meaningful lower or upper bounds.</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst { randomFill } = await import('node:crypto');\n\nconst a = new Uint32Array(10);\nrandomFill(a, (err, buf) => {\n if (err) throw err;\n console.log(Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength)\n .toString('hex'));\n});\n\nconst b = new DataView(new ArrayBuffer(10));\nrandomFill(b, (err, buf) => {\n if (err) throw err;\n console.log(Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength)\n .toString('hex'));\n});\n\nconst c = new ArrayBuffer(10);\nrandomFill(c, (err, buf) => {\n if (err) throw err;\n console.log(Buffer.from(buf).toString('hex'));\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const { randomFill } = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst a = new Uint32Array(10);\nrandomFill(a, (err, buf) => {\n if (err) throw err;\n console.log(Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength)\n .toString('hex'));\n});\n\nconst b = new DataView(new ArrayBuffer(10));\nrandomFill(b, (err, buf) => {\n if (err) throw err;\n console.log(Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength)\n .toString('hex'));\n});\n\nconst c = new ArrayBuffer(10);\nrandomFill(c, (err, buf) => {\n if (err) throw err;\n console.log(Buffer.from(buf).toString('hex'));\n});\n</code></pre>\n<p>This API uses libuv's threadpool, which can have surprising and\nnegative performance implications for some applications; see the\n<a href=\"cli.html#uv_threadpool_sizesize\"><code>UV_THREADPOOL_SIZE</code></a> documentation for more information.</p>\n<p>The asynchronous version of <code>crypto.randomFill()</code> is carried out in a single\nthreadpool request. To minimize threadpool task length variation, partition\nlarge <code>randomFill</code> requests when doing so as part of fulfilling a client\nrequest.</p>"
},
{
"textRaw": "`crypto.randomInt([min, ]max[, callback])`",
"type": "method",
"name": "randomInt",
"meta": {
"added": [
"v14.10.0",
"v12.19.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`min` {integer} Start of random range (inclusive). **Default:** `0`.",
"name": "min",
"type": "integer",
"default": "`0`",
"desc": "Start of random range (inclusive)."
},
{
"textRaw": "`max` {integer} End of random range (exclusive).",
"name": "max",
"type": "integer",
"desc": "End of random range (exclusive)."
},
{
"textRaw": "`callback` {Function} `function(err, n) {}`.",
"name": "callback",
"type": "Function",
"desc": "`function(err, n) {}`."
}
]
}
],
"desc": "<p>Return a random integer <code>n</code> such that <code>min <= n < max</code>. This\nimplementation avoids <a href=\"https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#Modulo_bias\">modulo bias</a>.</p>\n<p>The range (<code>max - min</code>) must be less than 2<sup>48</sup>. <code>min</code> and <code>max</code> must\nbe <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger\">safe integers</a>.</p>\n<p>If the <code>callback</code> function is not provided, the random integer is\ngenerated synchronously.</p>\n<pre><code class=\"language-mjs\">// Asynchronous\nconst {\n randomInt\n} = await import('node:crypto');\n\nrandomInt(3, (err, n) => {\n if (err) throw err;\n console.log(`Random number chosen from (0, 1, 2): ${n}`);\n});\n</code></pre>\n<pre><code class=\"language-cjs\">// Asynchronous\nconst {\n randomInt,\n} = require('node:crypto');\n\nrandomInt(3, (err, n) => {\n if (err) throw err;\n console.log(`Random number chosen from (0, 1, 2): ${n}`);\n});\n</code></pre>\n<pre><code class=\"language-mjs\">// Synchronous\nconst {\n randomInt\n} = await import('node:crypto');\n\nconst n = randomInt(3);\nconsole.log(`Random number chosen from (0, 1, 2): ${n}`);\n</code></pre>\n<pre><code class=\"language-cjs\">// Synchronous\nconst {\n randomInt,\n} = require('node:crypto');\n\nconst n = randomInt(3);\nconsole.log(`Random number chosen from (0, 1, 2): ${n}`);\n</code></pre>\n<pre><code class=\"language-mjs\">// With `min` argument\nconst {\n randomInt\n} = await import('node:crypto');\n\nconst n = randomInt(1, 7);\nconsole.log(`The dice rolled: ${n}`);\n</code></pre>\n<pre><code class=\"language-cjs\">// With `min` argument\nconst {\n randomInt,\n} = require('node:crypto');\n\nconst n = randomInt(1, 7);\nconsole.log(`The dice rolled: ${n}`);\n</code></pre>"
},
{
"textRaw": "`crypto.randomUUID([options])`",
"type": "method",
"name": "randomUUID",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string}",
"name": "return",
"type": "string"
},
"params": [
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`disableEntropyCache` {boolean} By default, to improve performance, Node.js generates and caches enough random data to generate up to 128 random UUIDs. To generate a UUID without using the cache, set `disableEntropyCache` to `true`. **Default:** `false`.",
"name": "disableEntropyCache",
"type": "boolean",
"default": "`false`",
"desc": "By default, to improve performance, Node.js generates and caches enough random data to generate up to 128 random UUIDs. To generate a UUID without using the cache, set `disableEntropyCache` to `true`."
}
]
}
]
}
],
"desc": "<p>Generates a random <a href=\"https://www.rfc-editor.org/rfc/rfc4122.txt\">RFC 4122</a> version 4 UUID. The UUID is generated using a\ncryptographic pseudorandom number generator.</p>"
},
{
"textRaw": "`crypto.scrypt(password, salt, keylen[, options], callback)`",
"type": "method",
"name": "scrypt",
"meta": {
"added": [
"v10.5.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The password and salt arguments can also be ArrayBuffer instances."
},
{
"version": [
"v12.8.0",
"v10.17.0"
],
"pr-url": "https://github.com/nodejs/node/pull/28799",
"description": "The `maxmem` value can now be any safe integer."
},
{
"version": "v10.9.0",
"pr-url": "https://github.com/nodejs/node/pull/21525",
"description": "The `cost`, `blockSize` and `parallelization` option names have been added."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`password` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "password",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`salt` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "salt",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`keylen` {number}",
"name": "keylen",
"type": "number"
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`cost` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`.",
"name": "cost",
"type": "number",
"default": "`16384`",
"desc": "CPU/memory cost parameter. Must be a power of two greater than one."
},
{
"textRaw": "`blockSize` {number} Block size parameter. **Default:** `8`.",
"name": "blockSize",
"type": "number",
"default": "`8`",
"desc": "Block size parameter."
},
{
"textRaw": "`parallelization` {number} Parallelization parameter. **Default:** `1`.",
"name": "parallelization",
"type": "number",
"default": "`1`",
"desc": "Parallelization parameter."
},
{
"textRaw": "`N` {number} Alias for `cost`. Only one of both may be specified.",
"name": "N",
"type": "number",
"desc": "Alias for `cost`. Only one of both may be specified."
},
{
"textRaw": "`r` {number} Alias for `blockSize`. Only one of both may be specified.",
"name": "r",
"type": "number",
"desc": "Alias for `blockSize`. Only one of both may be specified."
},
{
"textRaw": "`p` {number} Alias for `parallelization`. Only one of both may be specified.",
"name": "p",
"type": "number",
"desc": "Alias for `parallelization`. Only one of both may be specified."
},
{
"textRaw": "`maxmem` {number} Memory upper bound. It is an error when (approximately) `128 * N * r > maxmem`. **Default:** `32 * 1024 * 1024`.",
"name": "maxmem",
"type": "number",
"default": "`32 * 1024 * 1024`",
"desc": "Memory upper bound. It is an error when (approximately) `128 * N * r > maxmem`."
}
]
},
{
"textRaw": "`callback` {Function}",
"name": "callback",
"type": "Function",
"options": [
{
"textRaw": "`err` {Error}",
"name": "err",
"type": "Error"
},
{
"textRaw": "`derivedKey` {Buffer}",
"name": "derivedKey",
"type": "Buffer"
}
]
}
]
}
],
"desc": "<p>Provides an asynchronous <a href=\"https://en.wikipedia.org/wiki/Scrypt\">scrypt</a> implementation. Scrypt is a password-based\nkey derivation function that is designed to be expensive computationally and\nmemory-wise in order to make brute-force attacks unrewarding.</p>\n<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is\nrandom and at least 16 bytes long. See <a href=\"https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf\">NIST SP 800-132</a> for details.</p>\n<p>When passing strings for <code>password</code> or <code>salt</code>, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>\n<p>The <code>callback</code> function is called with two arguments: <code>err</code> and <code>derivedKey</code>.\n<code>err</code> is an exception object when key derivation fails, otherwise <code>err</code> is\n<code>null</code>. <code>derivedKey</code> is passed to the callback as a <a href=\"buffer.html\"><code>Buffer</code></a>.</p>\n<p>An exception is thrown when any of the input arguments specify invalid values\nor types.</p>\n<pre><code class=\"language-mjs\">const {\n scrypt\n} = await import('node:crypto');\n\n// Using the factory defaults.\nscrypt('password', 'salt', 64, (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey.toString('hex')); // '3745e48...08d59ae'\n});\n// Using a custom N parameter. Must be a power of two.\nscrypt('password', 'salt', 64, { N: 1024 }, (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey.toString('hex')); // '3745e48...aa39b34'\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n scrypt,\n} = require('node:crypto');\n\n// Using the factory defaults.\nscrypt('password', 'salt', 64, (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey.toString('hex')); // '3745e48...08d59ae'\n});\n// Using a custom N parameter. Must be a power of two.\nscrypt('password', 'salt', 64, { N: 1024 }, (err, derivedKey) => {\n if (err) throw err;\n console.log(derivedKey.toString('hex')); // '3745e48...aa39b34'\n});\n</code></pre>"
},
{
"textRaw": "`crypto.scryptSync(password, salt, keylen[, options])`",
"type": "method",
"name": "scryptSync",
"meta": {
"added": [
"v10.5.0"
],
"changes": [
{
"version": [
"v12.8.0",
"v10.17.0"
],
"pr-url": "https://github.com/nodejs/node/pull/28799",
"description": "The `maxmem` value can now be any safe integer."
},
{
"version": "v10.9.0",
"pr-url": "https://github.com/nodejs/node/pull/21525",
"description": "The `cost`, `blockSize` and `parallelization` option names have been added."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer}",
"name": "return",
"type": "Buffer"
},
"params": [
{
"textRaw": "`password` {string|Buffer|TypedArray|DataView}",
"name": "password",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`salt` {string|Buffer|TypedArray|DataView}",
"name": "salt",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`keylen` {number}",
"name": "keylen",
"type": "number"
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`cost` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`.",
"name": "cost",
"type": "number",
"default": "`16384`",
"desc": "CPU/memory cost parameter. Must be a power of two greater than one."
},
{
"textRaw": "`blockSize` {number} Block size parameter. **Default:** `8`.",
"name": "blockSize",
"type": "number",
"default": "`8`",
"desc": "Block size parameter."
},
{
"textRaw": "`parallelization` {number} Parallelization parameter. **Default:** `1`.",
"name": "parallelization",
"type": "number",
"default": "`1`",
"desc": "Parallelization parameter."
},
{
"textRaw": "`N` {number} Alias for `cost`. Only one of both may be specified.",
"name": "N",
"type": "number",
"desc": "Alias for `cost`. Only one of both may be specified."
},
{
"textRaw": "`r` {number} Alias for `blockSize`. Only one of both may be specified.",
"name": "r",
"type": "number",
"desc": "Alias for `blockSize`. Only one of both may be specified."
},
{
"textRaw": "`p` {number} Alias for `parallelization`. Only one of both may be specified.",
"name": "p",
"type": "number",
"desc": "Alias for `parallelization`. Only one of both may be specified."
},
{
"textRaw": "`maxmem` {number} Memory upper bound. It is an error when (approximately) `128 * N * r > maxmem`. **Default:** `32 * 1024 * 1024`.",
"name": "maxmem",
"type": "number",
"default": "`32 * 1024 * 1024`",
"desc": "Memory upper bound. It is an error when (approximately) `128 * N * r > maxmem`."
}
]
}
]
}
],
"desc": "<p>Provides a synchronous <a href=\"https://en.wikipedia.org/wiki/Scrypt\">scrypt</a> implementation. Scrypt is a password-based\nkey derivation function that is designed to be expensive computationally and\nmemory-wise in order to make brute-force attacks unrewarding.</p>\n<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is\nrandom and at least 16 bytes long. See <a href=\"https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf\">NIST SP 800-132</a> for details.</p>\n<p>When passing strings for <code>password</code> or <code>salt</code>, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>\n<p>An exception is thrown when key derivation fails, otherwise the derived key is\nreturned as a <a href=\"buffer.html\"><code>Buffer</code></a>.</p>\n<p>An exception is thrown when any of the input arguments specify invalid values\nor types.</p>\n<pre><code class=\"language-mjs\">const {\n scryptSync\n} = await import('node:crypto');\n// Using the factory defaults.\n\nconst key1 = scryptSync('password', 'salt', 64);\nconsole.log(key1.toString('hex')); // '3745e48...08d59ae'\n// Using a custom N parameter. Must be a power of two.\nconst key2 = scryptSync('password', 'salt', 64, { N: 1024 });\nconsole.log(key2.toString('hex')); // '3745e48...aa39b34'\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n scryptSync,\n} = require('node:crypto');\n// Using the factory defaults.\n\nconst key1 = scryptSync('password', 'salt', 64);\nconsole.log(key1.toString('hex')); // '3745e48...08d59ae'\n// Using a custom N parameter. Must be a power of two.\nconst key2 = scryptSync('password', 'salt', 64, { N: 1024 });\nconsole.log(key2.toString('hex')); // '3745e48...aa39b34'\n</code></pre>"
},
{
"textRaw": "`crypto.secureHeapUsed()`",
"type": "method",
"name": "secureHeapUsed",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Object}",
"name": "return",
"type": "Object",
"options": [
{
"textRaw": "`total` {number} The total allocated secure heap size as specified using the `--secure-heap=n` command-line flag.",
"name": "total",
"type": "number",
"desc": "The total allocated secure heap size as specified using the `--secure-heap=n` command-line flag."
},
{
"textRaw": "`min` {number} The minimum allocation from the secure heap as specified using the `--secure-heap-min` command-line flag.",
"name": "min",
"type": "number",
"desc": "The minimum allocation from the secure heap as specified using the `--secure-heap-min` command-line flag."
},
{
"textRaw": "`used` {number} The total number of bytes currently allocated from the secure heap.",
"name": "used",
"type": "number",
"desc": "The total number of bytes currently allocated from the secure heap."
},
{
"textRaw": "`utilization` {number} The calculated ratio of `used` to `total` allocated bytes.",
"name": "utilization",
"type": "number",
"desc": "The calculated ratio of `used` to `total` allocated bytes."
}
]
},
"params": []
}
]
},
{
"textRaw": "`crypto.setEngine(engine[, flags])`",
"type": "method",
"name": "setEngine",
"meta": {
"added": [
"v0.11.11"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`engine` {string}",
"name": "engine",
"type": "string"
},
{
"textRaw": "`flags` {crypto.constants} **Default:** `crypto.constants.ENGINE_METHOD_ALL`",
"name": "flags",
"type": "crypto.constants",
"default": "`crypto.constants.ENGINE_METHOD_ALL`"
}
]
}
],
"desc": "<p>Load and set the <code>engine</code> for some or all OpenSSL functions (selected by flags).</p>\n<p><code>engine</code> could be either an id or a path to the engine's shared library.</p>\n<p>The optional <code>flags</code> argument uses <code>ENGINE_METHOD_ALL</code> by default. The <code>flags</code>\nis a bit field taking one of or a mix of the following flags (defined in\n<code>crypto.constants</code>):</p>\n<ul>\n<li><code>crypto.constants.ENGINE_METHOD_RSA</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_DSA</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_DH</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_RAND</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_EC</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_CIPHERS</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_DIGESTS</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_PKEY_METHS</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_PKEY_ASN1_METHS</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_ALL</code></li>\n<li><code>crypto.constants.ENGINE_METHOD_NONE</code></li>\n</ul>"
},
{
"textRaw": "`crypto.setFips(bool)`",
"type": "method",
"name": "setFips",
"meta": {
"added": [
"v10.0.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`bool` {boolean} `true` to enable FIPS mode.",
"name": "bool",
"type": "boolean",
"desc": "`true` to enable FIPS mode."
}
]
}
],
"desc": "<p>Enables the FIPS compliant crypto provider in a FIPS-enabled Node.js build.\nThrows an error if FIPS mode is not available.</p>"
},
{
"textRaw": "`crypto.sign(algorithm, data, key[, callback])`",
"type": "method",
"name": "sign",
"meta": {
"added": [
"v12.0.0"
],
"changes": [
{
"version": "v15.12.0",
"pr-url": "https://github.com/nodejs/node/pull/37500",
"description": "Optional callback argument added."
},
{
"version": [
"v13.2.0",
"v12.16.0"
],
"pr-url": "https://github.com/nodejs/node/pull/29292",
"description": "This function now supports IEEE-P1363 DSA and ECDSA signatures."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>algorithm</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Null_type\" class=\"type\"><null></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type\" class=\"type\"><undefined></a></li>\n<li><code>data</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a></li>\n<li><code>callback</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" class=\"type\"><Function></a>\n<ul>\n<li><code>err</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error\" class=\"type\"><Error></a></li>\n<li><code>signature</code> <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a></li>\n</ul>\n</li>\n<li>Returns: <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> if the <code>callback</code> function is not provided.</li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Calculates and returns the signature for <code>data</code> using the given private key and\nalgorithm. If <code>algorithm</code> is <code>null</code> or <code>undefined</code>, then the algorithm is\ndependent upon the key type (especially Ed25519 and Ed448).</p>\n<p>If <code>key</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if <code>key</code> had been\npassed to <a href=\"#cryptocreateprivatekeykey\"><code>crypto.createPrivateKey()</code></a>. If it is an object, the following\nadditional properties can be passed:</p>\n<ul>\n<li>\n<p><code>dsaEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> For DSA and ECDSA, this option specifies the\nformat of the generated signature. It can be one of the following:</p>\n<ul>\n<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li>\n<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li>\n</ul>\n</li>\n<li>\n<p><code>padding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Optional padding value for RSA, one of the following:</p>\n<ul>\n<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li>\n<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li>\n</ul>\n<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function\nused to sign the message as specified in section 3.1 of <a href=\"https://www.rfc-editor.org/rfc/rfc4055.txt\">RFC 4055</a>.</p>\n</li>\n<li>\n<p><code>saltLength</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Salt length for when padding is\n<code>RSA_PKCS1_PSS_PADDING</code>. The special value\n<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest\nsize, <code>crypto.constants.RSA_PSS_SALTLEN_MAX_SIGN</code> (default) sets it to the\nmaximum permissible value.</p>\n</li>\n</ul>\n<p>If the <code>callback</code> function is provided this function uses libuv's threadpool.</p>"
},
{
"textRaw": "`crypto.timingSafeEqual(a, b)`",
"type": "method",
"name": "timingSafeEqual",
"meta": {
"added": [
"v6.6.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The a and b arguments can also be ArrayBuffer."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean}",
"name": "return",
"type": "boolean"
},
"params": [
{
"textRaw": "`a` {ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "a",
"type": "ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`b` {ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "b",
"type": "ArrayBuffer|Buffer|TypedArray|DataView"
}
]
}
],
"desc": "<p>This function compares the underlying bytes that represent the given\n<code>ArrayBuffer</code>, <code>TypedArray</code>, or <code>DataView</code> instances using a constant-time\nalgorithm.</p>\n<p>This function does not leak timing information that\nwould allow an attacker to guess one of the values. This is suitable for\ncomparing HMAC digests or secret values like authentication cookies or\n<a href=\"https://www.w3.org/TR/capability-urls/\">capability urls</a>.</p>\n<p><code>a</code> and <code>b</code> must both be <code>Buffer</code>s, <code>TypedArray</code>s, or <code>DataView</code>s, and they\nmust have the same byte length. An error is thrown if <code>a</code> and <code>b</code> have\ndifferent byte lengths.</p>\n<p>If at least one of <code>a</code> and <code>b</code> is a <code>TypedArray</code> with more than one byte per\nentry, such as <code>Uint16Array</code>, the result will be computed using the platform\nbyte order.</p>\n<p><strong class=\"critical\">When both of the inputs are <code>Float32Array</code>s or\n<code>Float64Array</code>s, this function might return unexpected results due to IEEE 754\nencoding of floating-point numbers. In particular, neither <code>x === y</code> nor\n<code>Object.is(x, y)</code> implies that the byte representations of two floating-point\nnumbers <code>x</code> and <code>y</code> are equal.</strong></p>\n<p>Use of <code>crypto.timingSafeEqual</code> does not guarantee that the <em>surrounding</em> code\nis timing-safe. Care should be taken to ensure that the surrounding code does\nnot introduce timing vulnerabilities.</p>"
},
{
"textRaw": "`crypto.verify(algorithm, data, key, signature[, callback])`",
"type": "method",
"name": "verify",
"meta": {
"added": [
"v12.0.0"
],
"changes": [
{
"version": "v15.12.0",
"pr-url": "https://github.com/nodejs/node/pull/37500",
"description": "Optional callback argument added."
},
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The data, key, and signature arguments can also be ArrayBuffer."
},
{
"version": [
"v13.2.0",
"v12.16.0"
],
"pr-url": "https://github.com/nodejs/node/pull/29292",
"description": "This function now supports IEEE-P1363 DSA and ECDSA signatures."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>algorithm</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Null_type\" class=\"type\"><null></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type\" class=\"type\"><undefined></a></li>\n<li><code>data</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li><code>key</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a></li>\n<li><code>signature</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li><code>callback</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" class=\"type\"><Function></a>\n<ul>\n<li><code>err</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error\" class=\"type\"><Error></a></li>\n<li><code>result</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" class=\"type\"><boolean></a></li>\n</ul>\n</li>\n<li>Returns: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" class=\"type\"><boolean></a> <code>true</code> or <code>false</code> depending on the validity of the\nsignature for the data and public key if the <code>callback</code> function is not\nprovided.</li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Verifies the given signature for <code>data</code> using the given key and algorithm. If\n<code>algorithm</code> is <code>null</code> or <code>undefined</code>, then the algorithm is dependent upon the\nkey type (especially Ed25519 and Ed448).</p>\n<p>If <code>key</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if <code>key</code> had been\npassed to <a href=\"#cryptocreatepublickeykey\"><code>crypto.createPublicKey()</code></a>. If it is an object, the following\nadditional properties can be passed:</p>\n<ul>\n<li>\n<p><code>dsaEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> For DSA and ECDSA, this option specifies the\nformat of the signature. It can be one of the following:</p>\n<ul>\n<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li>\n<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li>\n</ul>\n</li>\n<li>\n<p><code>padding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Optional padding value for RSA, one of the following:</p>\n<ul>\n<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li>\n<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li>\n</ul>\n<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function\nused to sign the message as specified in section 3.1 of <a href=\"https://www.rfc-editor.org/rfc/rfc4055.txt\">RFC 4055</a>.</p>\n</li>\n<li>\n<p><code>saltLength</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Salt length for when padding is\n<code>RSA_PKCS1_PSS_PADDING</code>. The special value\n<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest\nsize, <code>crypto.constants.RSA_PSS_SALTLEN_MAX_SIGN</code> (default) sets it to the\nmaximum permissible value.</p>\n</li>\n</ul>\n<p>The <code>signature</code> argument is the previously calculated signature for the <code>data</code>.</p>\n<p>Because public keys can be derived from private keys, a private key or a public\nkey may be passed for <code>key</code>.</p>\n<p>If the <code>callback</code> function is provided this function uses libuv's threadpool.</p>"
}
],
"type": "module",
"displayName": "`node:crypto` module methods and properties"
},
{
"textRaw": "Notes",
"name": "notes",
"modules": [
{
"textRaw": "Using strings as inputs to cryptographic APIs",
"name": "using_strings_as_inputs_to_cryptographic_apis",
"desc": "<p>For historical reasons, many cryptographic APIs provided by Node.js accept\nstrings as inputs where the underlying cryptographic algorithm works on byte\nsequences. These instances include plaintexts, ciphertexts, symmetric keys,\ninitialization vectors, passphrases, salts, authentication tags,\nand additional authenticated data.</p>\n<p>When passing strings to cryptographic APIs, consider the following factors.</p>\n<ul>\n<li>\n<p>Not all byte sequences are valid UTF-8 strings. Therefore, when a byte\nsequence of length <code>n</code> is derived from a string, its entropy is generally\nlower than the entropy of a random or pseudorandom <code>n</code> byte sequence.\nFor example, no UTF-8 string will result in the byte sequence <code>c0 af</code>. Secret\nkeys should almost exclusively be random or pseudorandom byte sequences.</p>\n</li>\n<li>\n<p>Similarly, when converting random or pseudorandom byte sequences to UTF-8\nstrings, subsequences that do not represent valid code points may be replaced\nby the Unicode replacement character (<code>U+FFFD</code>). The byte representation of\nthe resulting Unicode string may, therefore, not be equal to the byte sequence\nthat the string was created from.</p>\n<pre><code class=\"language-js\">const original = [0xc0, 0xaf];\nconst bytesAsString = Buffer.from(original).toString('utf8');\nconst stringAsBytes = Buffer.from(bytesAsString, 'utf8');\nconsole.log(stringAsBytes);\n// Prints '<Buffer ef bf bd ef bf bd>'.\n</code></pre>\n<p>The outputs of ciphers, hash functions, signature algorithms, and key\nderivation functions are pseudorandom byte sequences and should not be\nused as Unicode strings.</p>\n</li>\n<li>\n<p>When strings are obtained from user input, some Unicode characters can be\nrepresented in multiple equivalent ways that result in different byte\nsequences. For example, when passing a user passphrase to a key derivation\nfunction, such as PBKDF2 or scrypt, the result of the key derivation function\ndepends on whether the string uses composed or decomposed characters. Node.js\ndoes not normalize character representations. Developers should consider using\n<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize\"><code>String.prototype.normalize()</code></a> on user inputs before passing them to\ncryptographic APIs.</p>\n</li>\n</ul>",
"type": "module",
"displayName": "Using strings as inputs to cryptographic APIs"
},
{
"textRaw": "Legacy streams API (prior to Node.js 0.10)",
"name": "legacy_streams_api_(prior_to_node.js_0.10)",
"desc": "<p>The Crypto module was added to Node.js before there was the concept of a\nunified Stream API, and before there were <a href=\"buffer.html\"><code>Buffer</code></a> objects for handling\nbinary data. As such, the many of the <code>crypto</code> defined classes have methods not\ntypically found on other Node.js classes that implement the <a href=\"stream.html\">streams</a>\nAPI (e.g. <code>update()</code>, <code>final()</code>, or <code>digest()</code>). Also, many methods accepted\nand returned <code>'latin1'</code> encoded strings by default rather than <code>Buffer</code>s. This\ndefault was changed after Node.js v0.8 to use <a href=\"buffer.html\"><code>Buffer</code></a> objects by default\ninstead.</p>",
"type": "module",
"displayName": "Legacy streams API (prior to Node.js 0.10)"
},
{
"textRaw": "Support for weak or compromised algorithms",
"name": "support_for_weak_or_compromised_algorithms",
"desc": "<p>The <code>node:crypto</code> module still supports some algorithms which are already\ncompromised and are not currently recommended for use. The API also allows\nthe use of ciphers and hashes with a small key size that are too weak for safe\nuse.</p>\n<p>Users should take full responsibility for selecting the crypto\nalgorithm and key size according to their security requirements.</p>\n<p>Based on the recommendations of <a href=\"https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar1.pdf\">NIST SP 800-131A</a>:</p>\n<ul>\n<li>MD5 and SHA-1 are no longer acceptable where collision resistance is\nrequired such as digital signatures.</li>\n<li>The key used with RSA, DSA, and DH algorithms is recommended to have\nat least 2048 bits and that of the curve of ECDSA and ECDH at least\n224 bits, to be safe to use for several years.</li>\n<li>The DH groups of <code>modp1</code>, <code>modp2</code> and <code>modp5</code> have a key size\nsmaller than 2048 bits and are not recommended.</li>\n</ul>\n<p>See the reference for other recommendations and details.</p>",
"type": "module",
"displayName": "Support for weak or compromised algorithms"
},
{
"textRaw": "CCM mode",
"name": "ccm_mode",
"desc": "<p>CCM is one of the supported <a href=\"https://en.wikipedia.org/wiki/Authenticated_encryption\">AEAD algorithms</a>. Applications which use this\nmode must adhere to certain restrictions when using the cipher API:</p>\n<ul>\n<li>The authentication tag length must be specified during cipher creation by\nsetting the <code>authTagLength</code> option and must be one of 4, 6, 8, 10, 12, 14 or\n16 bytes.</li>\n<li>The length of the initialization vector (nonce) <code>N</code> must be between 7 and 13\nbytes (<code>7 ≤ N ≤ 13</code>).</li>\n<li>The length of the plaintext is limited to <code>2 ** (8 * (15 - N))</code> bytes.</li>\n<li>When decrypting, the authentication tag must be set via <code>setAuthTag()</code> before\ncalling <code>update()</code>.\nOtherwise, decryption will fail and <code>final()</code> will throw an error in\ncompliance with section 2.6 of <a href=\"https://www.rfc-editor.org/rfc/rfc3610.txt\">RFC 3610</a>.</li>\n<li>Using stream methods such as <code>write(data)</code>, <code>end(data)</code> or <code>pipe()</code> in CCM\nmode might fail as CCM cannot handle more than one chunk of data per instance.</li>\n<li>When passing additional authenticated data (AAD), the length of the actual\nmessage in bytes must be passed to <code>setAAD()</code> via the <code>plaintextLength</code>\noption.\nMany crypto libraries include the authentication tag in the ciphertext,\nwhich means that they produce ciphertexts of the length\n<code>plaintextLength + authTagLength</code>. Node.js does not include the authentication\ntag, so the ciphertext length is always <code>plaintextLength</code>.\nThis is not necessary if no AAD is used.</li>\n<li>As CCM processes the whole message at once, <code>update()</code> must be called exactly\nonce.</li>\n<li>Even though calling <code>update()</code> is sufficient to encrypt/decrypt the message,\napplications <em>must</em> call <code>final()</code> to compute or verify the\nauthentication tag.</li>\n</ul>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst {\n createCipheriv,\n createDecipheriv,\n randomBytes\n} = await import('node:crypto');\n\nconst key = 'keykeykeykeykeykeykeykey';\nconst nonce = randomBytes(12);\n\nconst aad = Buffer.from('0123456789', 'hex');\n\nconst cipher = createCipheriv('aes-192-ccm', key, nonce, {\n authTagLength: 16\n});\nconst plaintext = 'Hello world';\ncipher.setAAD(aad, {\n plaintextLength: Buffer.byteLength(plaintext)\n});\nconst ciphertext = cipher.update(plaintext, 'utf8');\ncipher.final();\nconst tag = cipher.getAuthTag();\n\n// Now transmit { ciphertext, nonce, tag }.\n\nconst decipher = createDecipheriv('aes-192-ccm', key, nonce, {\n authTagLength: 16\n});\ndecipher.setAuthTag(tag);\ndecipher.setAAD(aad, {\n plaintextLength: ciphertext.length\n});\nconst receivedPlaintext = decipher.update(ciphertext, null, 'utf8');\n\ntry {\n decipher.final();\n} catch (err) {\n throw new Error('Authentication failed!', { cause: err });\n}\n\nconsole.log(receivedPlaintext);\n</code></pre>\n<pre><code class=\"language-cjs\">const { Buffer } = require('node:buffer');\nconst {\n createCipheriv,\n createDecipheriv,\n randomBytes,\n} = require('node:crypto');\n\nconst key = 'keykeykeykeykeykeykeykey';\nconst nonce = randomBytes(12);\n\nconst aad = Buffer.from('0123456789', 'hex');\n\nconst cipher = createCipheriv('aes-192-ccm', key, nonce, {\n authTagLength: 16\n});\nconst plaintext = 'Hello world';\ncipher.setAAD(aad, {\n plaintextLength: Buffer.byteLength(plaintext)\n});\nconst ciphertext = cipher.update(plaintext, 'utf8');\ncipher.final();\nconst tag = cipher.getAuthTag();\n\n// Now transmit { ciphertext, nonce, tag }.\n\nconst decipher = createDecipheriv('aes-192-ccm', key, nonce, {\n authTagLength: 16\n});\ndecipher.setAuthTag(tag);\ndecipher.setAAD(aad, {\n plaintextLength: ciphertext.length\n});\nconst receivedPlaintext = decipher.update(ciphertext, null, 'utf8');\n\ntry {\n decipher.final();\n} catch (err) {\n throw new Error('Authentication failed!', { cause: err });\n}\n\nconsole.log(receivedPlaintext);\n</code></pre>",
"type": "module",
"displayName": "CCM mode"
}
],
"type": "module",
"displayName": "Notes"
},
{
"textRaw": "Crypto constants",
"name": "crypto_constants",
"desc": "<p>The following constants exported by <code>crypto.constants</code> apply to various uses of\nthe <code>node:crypto</code>, <code>node:tls</code>, and <code>node:https</code> modules and are generally\nspecific to OpenSSL.</p>",
"modules": [
{
"textRaw": "OpenSSL options",
"name": "openssl_options",
"desc": "<p>See the <a href=\"https://wiki.openssl.org/index.php/List_of_SSL_OP_Flags#Table_of_Options\">list of SSL OP Flags</a> for details.</p>\n<table>\n <tr>\n <th>Constant</th>\n <th>Description</th>\n </tr>\n <tr>\n <td><code>SSL_OP_ALL</code></td>\n <td>Applies multiple bug workarounds within OpenSSL. See\n <a href=\"https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html\">https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html</a>\n for detail.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_ALLOW_NO_DHE_KEX</code></td>\n <td>Instructs OpenSSL to allow a non-[EC]DHE-based key exchange mode\n for TLS v1.3</td>\n </tr>\n <tr>\n <td><code>SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION</code></td>\n <td>Allows legacy insecure renegotiation between OpenSSL and unpatched\n clients or servers. See\n <a href=\"https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html\">https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html</a>.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_CIPHER_SERVER_PREFERENCE</code></td>\n <td>Attempts to use the server's preferences instead of the client's when\n selecting a cipher. Behavior depends on protocol version. See\n <a href=\"https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html\">https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html</a>.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_CISCO_ANYCONNECT</code></td>\n <td>Instructs OpenSSL to use Cisco's \"speshul\" version of DTLS_BAD_VER.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_COOKIE_EXCHANGE</code></td>\n <td>Instructs OpenSSL to turn on cookie exchange.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_CRYPTOPRO_TLSEXT_BUG</code></td>\n <td>Instructs OpenSSL to add server-hello extension from an early version\n of the cryptopro draft.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS</code></td>\n <td>Instructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability\n workaround added in OpenSSL 0.9.6d.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_EPHEMERAL_RSA</code></td>\n <td>Instructs OpenSSL to always use the tmp_rsa key when performing RSA\n operations.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_LEGACY_SERVER_CONNECT</code></td>\n <td>Allows initial connection to servers that do not support RI.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_MICROSOFT_SESS_ID_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_MSIE_SSLV2_RSA_PADDING</code></td>\n <td>Instructs OpenSSL to disable the workaround for a man-in-the-middle\n protocol-version vulnerability in the SSL 2.0 server implementation.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NETSCAPE_CA_DN_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_NETSCAPE_CHALLENGE_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_COMPRESSION</code></td>\n <td>Instructs OpenSSL to disable support for SSL/TLS compression.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_ENCRYPT_THEN_MAC</code></td>\n <td>Instructs OpenSSL to disable encrypt-then-MAC.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_QUERY_MTU</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_RENEGOTIATION</code></td>\n <td>Instructs OpenSSL to disable renegotiation.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION</code></td>\n <td>Instructs OpenSSL to always start a new session when performing\n renegotiation.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_SSLv2</code></td>\n <td>Instructs OpenSSL to turn off SSL v2</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_SSLv3</code></td>\n <td>Instructs OpenSSL to turn off SSL v3</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_TICKET</code></td>\n <td>Instructs OpenSSL to disable use of RFC4507bis tickets.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_TLSv1</code></td>\n <td>Instructs OpenSSL to turn off TLS v1</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_TLSv1_1</code></td>\n <td>Instructs OpenSSL to turn off TLS v1.1</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_TLSv1_2</code></td>\n <td>Instructs OpenSSL to turn off TLS v1.2</td>\n </tr>\n <tr>\n <td><code>SSL_OP_NO_TLSv1_3</code></td>\n <td>Instructs OpenSSL to turn off TLS v1.3</td>\n </tr>\n <tr>\n <td><code>SSL_OP_PKCS1_CHECK_1</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_PKCS1_CHECK_2</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_PRIORITIZE_CHACHA</code></td>\n <td>Instructs OpenSSL server to prioritize ChaCha20-Poly1305\n when the client does.\n This option has no effect if\n <code>SSL_OP_CIPHER_SERVER_PREFERENCE</code>\n is not enabled.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_SINGLE_DH_USE</code></td>\n <td>Instructs OpenSSL to always create a new key when using\n temporary/ephemeral DH parameters.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_SINGLE_ECDH_USE</code></td>\n <td>Instructs OpenSSL to always create a new key when using\n temporary/ephemeral ECDH parameters.</td>\n </tr>\n <tr>\n <td><code>SSL_OP_SSLEAY_080_CLIENT_DH_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_TLS_BLOCK_PADDING_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_TLS_D5_BUG</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>SSL_OP_TLS_ROLLBACK_BUG</code></td>\n <td>Instructs OpenSSL to disable version rollback attack detection.</td>\n </tr>\n</table>",
"type": "module",
"displayName": "OpenSSL options"
},
{
"textRaw": "OpenSSL engine constants",
"name": "openssl_engine_constants",
"desc": "<table>\n <tr>\n <th>Constant</th>\n <th>Description</th>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_RSA</code></td>\n <td>Limit engine usage to RSA</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_DSA</code></td>\n <td>Limit engine usage to DSA</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_DH</code></td>\n <td>Limit engine usage to DH</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_RAND</code></td>\n <td>Limit engine usage to RAND</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_EC</code></td>\n <td>Limit engine usage to EC</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_CIPHERS</code></td>\n <td>Limit engine usage to CIPHERS</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_DIGESTS</code></td>\n <td>Limit engine usage to DIGESTS</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_PKEY_METHS</code></td>\n <td>Limit engine usage to PKEY_METHDS</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_PKEY_ASN1_METHS</code></td>\n <td>Limit engine usage to PKEY_ASN1_METHS</td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_ALL</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>ENGINE_METHOD_NONE</code></td>\n <td></td>\n </tr>\n</table>",
"type": "module",
"displayName": "OpenSSL engine constants"
},
{
"textRaw": "Other OpenSSL constants",
"name": "other_openssl_constants",
"desc": "<table>\n <tr>\n <th>Constant</th>\n <th>Description</th>\n </tr>\n <tr>\n <td><code>DH_CHECK_P_NOT_SAFE_PRIME</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>DH_CHECK_P_NOT_PRIME</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>DH_UNABLE_TO_CHECK_GENERATOR</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>DH_NOT_SUITABLE_GENERATOR</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>ALPN_ENABLED</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>RSA_PKCS1_PADDING</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>RSA_SSLV23_PADDING</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>RSA_NO_PADDING</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>RSA_PKCS1_OAEP_PADDING</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>RSA_X931_PADDING</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>RSA_PKCS1_PSS_PADDING</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>RSA_PSS_SALTLEN_DIGEST</code></td>\n <td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the\n digest size when signing or verifying.</td>\n </tr>\n <tr>\n <td><code>RSA_PSS_SALTLEN_MAX_SIGN</code></td>\n <td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the\n maximum permissible value when signing data.</td>\n </tr>\n <tr>\n <td><code>RSA_PSS_SALTLEN_AUTO</code></td>\n <td>Causes the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to be\n determined automatically when verifying a signature.</td>\n </tr>\n <tr>\n <td><code>POINT_CONVERSION_COMPRESSED</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>POINT_CONVERSION_UNCOMPRESSED</code></td>\n <td></td>\n </tr>\n <tr>\n <td><code>POINT_CONVERSION_HYBRID</code></td>\n <td></td>\n </tr>\n</table>",
"type": "module",
"displayName": "Other OpenSSL constants"
},
{
"textRaw": "Node.js crypto constants",
"name": "node.js_crypto_constants",
"desc": "<table>\n <tr>\n <th>Constant</th>\n <th>Description</th>\n </tr>\n <tr>\n <td><code>defaultCoreCipherList</code></td>\n <td>Specifies the built-in default cipher list used by Node.js.</td>\n </tr>\n <tr>\n <td><code>defaultCipherList</code></td>\n <td>Specifies the active default cipher list used by the current Node.js\n process.</td>\n </tr>\n</table>",
"type": "module",
"displayName": "Node.js crypto constants"
}
],
"type": "module",
"displayName": "Crypto constants"
}
],
"classes": [
{
"textRaw": "Class: `Certificate`",
"type": "class",
"name": "Certificate",
"meta": {
"added": [
"v0.11.8"
],
"changes": []
},
"desc": "<p>SPKAC is a Certificate Signing Request mechanism originally implemented by\nNetscape and was specified formally as part of <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/keygen\">HTML5's <code>keygen</code> element</a>.</p>\n<p><code><keygen></code> is deprecated since <a href=\"https://www.w3.org/TR/html52/changes.html#features-removed\">HTML 5.2</a> and new projects\nshould not use this element anymore.</p>\n<p>The <code>node:crypto</code> module provides the <code>Certificate</code> class for working with SPKAC\ndata. The most common usage is handling output generated by the HTML5\n<code><keygen></code> element. Node.js uses <a href=\"https://www.openssl.org/docs/man1.1.0/apps/openssl-spkac.html\">OpenSSL's SPKAC implementation</a> internally.</p>",
"classMethods": [
{
"textRaw": "Static method: `Certificate.exportChallenge(spkac[, encoding])`",
"type": "classMethod",
"name": "exportChallenge",
"meta": {
"added": [
"v9.0.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The spkac argument can be an ArrayBuffer. Limited the size of the spkac argument to a maximum of 2**31 - 1 bytes."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer} The challenge component of the `spkac` data structure, which includes a public key and a challenge.",
"name": "return",
"type": "Buffer",
"desc": "The challenge component of the `spkac` data structure, which includes a public key and a challenge."
},
"params": [
{
"textRaw": "`spkac` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "spkac",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `spkac` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `spkac` string."
}
]
}
],
"desc": "<pre><code class=\"language-mjs\">const { Certificate } = await import('node:crypto');\nconst spkac = getSpkacSomehow();\nconst challenge = Certificate.exportChallenge(spkac);\nconsole.log(challenge.toString('utf8'));\n// Prints: the challenge as a UTF8 string\n</code></pre>\n<pre><code class=\"language-cjs\">const { Certificate } = require('node:crypto');\nconst spkac = getSpkacSomehow();\nconst challenge = Certificate.exportChallenge(spkac);\nconsole.log(challenge.toString('utf8'));\n// Prints: the challenge as a UTF8 string\n</code></pre>"
},
{
"textRaw": "Static method: `Certificate.exportPublicKey(spkac[, encoding])`",
"type": "classMethod",
"name": "exportPublicKey",
"meta": {
"added": [
"v9.0.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The spkac argument can be an ArrayBuffer. Limited the size of the spkac argument to a maximum of 2**31 - 1 bytes."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer} The public key component of the `spkac` data structure, which includes a public key and a challenge.",
"name": "return",
"type": "Buffer",
"desc": "The public key component of the `spkac` data structure, which includes a public key and a challenge."
},
"params": [
{
"textRaw": "`spkac` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "spkac",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `spkac` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `spkac` string."
}
]
}
],
"desc": "<pre><code class=\"language-mjs\">const { Certificate } = await import('node:crypto');\nconst spkac = getSpkacSomehow();\nconst publicKey = Certificate.exportPublicKey(spkac);\nconsole.log(publicKey);\n// Prints: the public key as <Buffer ...>\n</code></pre>\n<pre><code class=\"language-cjs\">const { Certificate } = require('node:crypto');\nconst spkac = getSpkacSomehow();\nconst publicKey = Certificate.exportPublicKey(spkac);\nconsole.log(publicKey);\n// Prints: the public key as <Buffer ...>\n</code></pre>"
},
{
"textRaw": "Static method: `Certificate.verifySpkac(spkac[, encoding])`",
"type": "classMethod",
"name": "verifySpkac",
"meta": {
"added": [
"v9.0.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The spkac argument can be an ArrayBuffer. Added encoding. Limited the size of the spkac argument to a maximum of 2**31 - 1 bytes."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean} `true` if the given `spkac` data structure is valid, `false` otherwise.",
"name": "return",
"type": "boolean",
"desc": "`true` if the given `spkac` data structure is valid, `false` otherwise."
},
"params": [
{
"textRaw": "`spkac` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "spkac",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `spkac` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `spkac` string."
}
]
}
],
"desc": "<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst { Certificate } = await import('node:crypto');\n\nconst spkac = getSpkacSomehow();\nconsole.log(Certificate.verifySpkac(Buffer.from(spkac)));\n// Prints: true or false\n</code></pre>\n<pre><code class=\"language-cjs\">const { Certificate } = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst spkac = getSpkacSomehow();\nconsole.log(Certificate.verifySpkac(Buffer.from(spkac)));\n// Prints: true or false\n</code></pre>"
}
],
"modules": [
{
"textRaw": "Legacy API",
"name": "legacy_api",
"stability": 0,
"stabilityText": "Deprecated",
"desc": "<p>As a legacy interface, it is possible to create new instances of\nthe <code>crypto.Certificate</code> class as illustrated in the examples below.</p>",
"ctors": [
{
"textRaw": "`new crypto.Certificate()`",
"type": "ctor",
"name": "crypto.Certificate",
"signatures": [
{
"params": []
}
],
"desc": "<p>Instances of the <code>Certificate</code> class can be created using the <code>new</code> keyword\nor by calling <code>crypto.Certificate()</code> as a function:</p>\n<pre><code class=\"language-mjs\">const { Certificate } = await import('node:crypto');\n\nconst cert1 = new Certificate();\nconst cert2 = Certificate();\n</code></pre>\n<pre><code class=\"language-cjs\">const { Certificate } = require('node:crypto');\n\nconst cert1 = new Certificate();\nconst cert2 = Certificate();\n</code></pre>"
}
],
"methods": [
{
"textRaw": "`certificate.exportChallenge(spkac[, encoding])`",
"type": "method",
"name": "exportChallenge",
"meta": {
"added": [
"v0.11.8"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer} The challenge component of the `spkac` data structure, which includes a public key and a challenge.",
"name": "return",
"type": "Buffer",
"desc": "The challenge component of the `spkac` data structure, which includes a public key and a challenge."
},
"params": [
{
"textRaw": "`spkac` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "spkac",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `spkac` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `spkac` string."
}
]
}
],
"desc": "<pre><code class=\"language-mjs\">const { Certificate } = await import('node:crypto');\nconst cert = Certificate();\nconst spkac = getSpkacSomehow();\nconst challenge = cert.exportChallenge(spkac);\nconsole.log(challenge.toString('utf8'));\n// Prints: the challenge as a UTF8 string\n</code></pre>\n<pre><code class=\"language-cjs\">const { Certificate } = require('node:crypto');\nconst cert = Certificate();\nconst spkac = getSpkacSomehow();\nconst challenge = cert.exportChallenge(spkac);\nconsole.log(challenge.toString('utf8'));\n// Prints: the challenge as a UTF8 string\n</code></pre>"
},
{
"textRaw": "`certificate.exportPublicKey(spkac[, encoding])`",
"type": "method",
"name": "exportPublicKey",
"meta": {
"added": [
"v0.11.8"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer} The public key component of the `spkac` data structure, which includes a public key and a challenge.",
"name": "return",
"type": "Buffer",
"desc": "The public key component of the `spkac` data structure, which includes a public key and a challenge."
},
"params": [
{
"textRaw": "`spkac` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "spkac",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `spkac` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `spkac` string."
}
]
}
],
"desc": "<pre><code class=\"language-mjs\">const { Certificate } = await import('node:crypto');\nconst cert = Certificate();\nconst spkac = getSpkacSomehow();\nconst publicKey = cert.exportPublicKey(spkac);\nconsole.log(publicKey);\n// Prints: the public key as <Buffer ...>\n</code></pre>\n<pre><code class=\"language-cjs\">const { Certificate } = require('node:crypto');\nconst cert = Certificate();\nconst spkac = getSpkacSomehow();\nconst publicKey = cert.exportPublicKey(spkac);\nconsole.log(publicKey);\n// Prints: the public key as <Buffer ...>\n</code></pre>"
},
{
"textRaw": "`certificate.verifySpkac(spkac[, encoding])`",
"type": "method",
"name": "verifySpkac",
"meta": {
"added": [
"v0.11.8"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean} `true` if the given `spkac` data structure is valid, `false` otherwise.",
"name": "return",
"type": "boolean",
"desc": "`true` if the given `spkac` data structure is valid, `false` otherwise."
},
"params": [
{
"textRaw": "`spkac` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "spkac",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `spkac` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `spkac` string."
}
]
}
],
"desc": "<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst { Certificate } = await import('node:crypto');\n\nconst cert = Certificate();\nconst spkac = getSpkacSomehow();\nconsole.log(cert.verifySpkac(Buffer.from(spkac)));\n// Prints: true or false\n</code></pre>\n<pre><code class=\"language-cjs\">const { Certificate } = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst cert = Certificate();\nconst spkac = getSpkacSomehow();\nconsole.log(cert.verifySpkac(Buffer.from(spkac)));\n// Prints: true or false\n</code></pre>"
}
],
"type": "module",
"displayName": "Legacy API"
}
]
},
{
"textRaw": "Class: `Cipher`",
"type": "class",
"name": "Cipher",
"meta": {
"added": [
"v0.1.94"
],
"changes": []
},
"desc": "<ul>\n<li>Extends: <a href=\"stream.html#class-streamtransform\" class=\"type\"><stream.Transform></a></li>\n</ul>\n<p>Instances of the <code>Cipher</code> class are used to encrypt data. The class can be\nused in one of two ways:</p>\n<ul>\n<li>As a <a href=\"stream.html\">stream</a> that is both readable and writable, where plain unencrypted\ndata is written to produce encrypted data on the readable side, or</li>\n<li>Using the <a href=\"#cipherupdatedata-inputencoding-outputencoding\"><code>cipher.update()</code></a> and <a href=\"#cipherfinaloutputencoding\"><code>cipher.final()</code></a> methods to produce\nthe encrypted data.</li>\n</ul>\n<p>The <a href=\"#cryptocreatecipheralgorithm-password-options\"><code>crypto.createCipher()</code></a> or <a href=\"#cryptocreatecipherivalgorithm-key-iv-options\"><code>crypto.createCipheriv()</code></a> methods are\nused to create <code>Cipher</code> instances. <code>Cipher</code> objects are not to be created\ndirectly using the <code>new</code> keyword.</p>\n<p>Example: Using <code>Cipher</code> objects as streams:</p>\n<pre><code class=\"language-mjs\">const {\n scrypt,\n randomFill,\n createCipheriv\n} = await import('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n\n// First, we'll generate the key. The key length is dependent on the algorithm.\n// In this case for aes192, it is 24 bytes (192 bits).\nscrypt(password, 'salt', 24, (err, key) => {\n if (err) throw err;\n // Then, we'll generate a random initialization vector\n randomFill(new Uint8Array(16), (err, iv) => {\n if (err) throw err;\n\n // Once we have the key and iv, we can create and use the cipher...\n const cipher = createCipheriv(algorithm, key, iv);\n\n let encrypted = '';\n cipher.setEncoding('hex');\n\n cipher.on('data', (chunk) => encrypted += chunk);\n cipher.on('end', () => console.log(encrypted));\n\n cipher.write('some clear text data');\n cipher.end();\n });\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n scrypt,\n randomFill,\n createCipheriv\n} = require('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n\n// First, we'll generate the key. The key length is dependent on the algorithm.\n// In this case for aes192, it is 24 bytes (192 bits).\nscrypt(password, 'salt', 24, (err, key) => {\n if (err) throw err;\n // Then, we'll generate a random initialization vector\n randomFill(new Uint8Array(16), (err, iv) => {\n if (err) throw err;\n\n // Once we have the key and iv, we can create and use the cipher...\n const cipher = createCipheriv(algorithm, key, iv);\n\n let encrypted = '';\n cipher.setEncoding('hex');\n\n cipher.on('data', (chunk) => encrypted += chunk);\n cipher.on('end', () => console.log(encrypted));\n\n cipher.write('some clear text data');\n cipher.end();\n });\n});\n</code></pre>\n<p>Example: Using <code>Cipher</code> and piped streams:</p>\n<pre><code class=\"language-mjs\">import {\n createReadStream,\n createWriteStream,\n} from 'node:fs';\n\nimport {\n pipeline\n} from 'node:stream';\n\nconst {\n scrypt,\n randomFill,\n createCipheriv\n} = await import('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n\n// First, we'll generate the key. The key length is dependent on the algorithm.\n// In this case for aes192, it is 24 bytes (192 bits).\nscrypt(password, 'salt', 24, (err, key) => {\n if (err) throw err;\n // Then, we'll generate a random initialization vector\n randomFill(new Uint8Array(16), (err, iv) => {\n if (err) throw err;\n\n const cipher = createCipheriv(algorithm, key, iv);\n\n const input = createReadStream('test.js');\n const output = createWriteStream('test.enc');\n\n pipeline(input, cipher, output, (err) => {\n if (err) throw err;\n });\n });\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createReadStream,\n createWriteStream,\n} = require('node:fs');\n\nconst {\n pipeline\n} = require('node:stream');\n\nconst {\n scrypt,\n randomFill,\n createCipheriv,\n} = require('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n\n// First, we'll generate the key. The key length is dependent on the algorithm.\n// In this case for aes192, it is 24 bytes (192 bits).\nscrypt(password, 'salt', 24, (err, key) => {\n if (err) throw err;\n // Then, we'll generate a random initialization vector\n randomFill(new Uint8Array(16), (err, iv) => {\n if (err) throw err;\n\n const cipher = createCipheriv(algorithm, key, iv);\n\n const input = createReadStream('test.js');\n const output = createWriteStream('test.enc');\n\n pipeline(input, cipher, output, (err) => {\n if (err) throw err;\n });\n });\n});\n</code></pre>\n<p>Example: Using the <a href=\"#cipherupdatedata-inputencoding-outputencoding\"><code>cipher.update()</code></a> and <a href=\"#cipherfinaloutputencoding\"><code>cipher.final()</code></a> methods:</p>\n<pre><code class=\"language-mjs\">const {\n scrypt,\n randomFill,\n createCipheriv\n} = await import('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n\n// First, we'll generate the key. The key length is dependent on the algorithm.\n// In this case for aes192, it is 24 bytes (192 bits).\nscrypt(password, 'salt', 24, (err, key) => {\n if (err) throw err;\n // Then, we'll generate a random initialization vector\n randomFill(new Uint8Array(16), (err, iv) => {\n if (err) throw err;\n\n const cipher = createCipheriv(algorithm, key, iv);\n\n let encrypted = cipher.update('some clear text data', 'utf8', 'hex');\n encrypted += cipher.final('hex');\n console.log(encrypted);\n });\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n scrypt,\n randomFill,\n createCipheriv,\n} = require('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n\n// First, we'll generate the key. The key length is dependent on the algorithm.\n// In this case for aes192, it is 24 bytes (192 bits).\nscrypt(password, 'salt', 24, (err, key) => {\n if (err) throw err;\n // Then, we'll generate a random initialization vector\n randomFill(new Uint8Array(16), (err, iv) => {\n if (err) throw err;\n\n const cipher = createCipheriv(algorithm, key, iv);\n\n let encrypted = cipher.update('some clear text data', 'utf8', 'hex');\n encrypted += cipher.final('hex');\n console.log(encrypted);\n });\n});\n</code></pre>",
"methods": [
{
"textRaw": "`cipher.final([outputEncoding])`",
"type": "method",
"name": "final",
"meta": {
"added": [
"v0.1.94"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string} Any remaining enciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a [`Buffer`][] is returned.",
"name": "return",
"type": "Buffer | string",
"desc": "Any remaining enciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a [`Buffer`][] is returned."
},
"params": [
{
"textRaw": "`outputEncoding` {string} The [encoding][] of the return value.",
"name": "outputEncoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Once the <code>cipher.final()</code> method has been called, the <code>Cipher</code> object can no\nlonger be used to encrypt data. Attempts to call <code>cipher.final()</code> more than\nonce will result in an error being thrown.</p>"
},
{
"textRaw": "`cipher.getAuthTag()`",
"type": "method",
"name": "getAuthTag",
"meta": {
"added": [
"v1.0.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer} When using an authenticated encryption mode (`GCM`, `CCM`, `OCB`, and `chacha20-poly1305` are currently supported), the `cipher.getAuthTag()` method returns a [`Buffer`][] containing the _authentication tag_ that has been computed from the given data.",
"name": "return",
"type": "Buffer",
"desc": "When using an authenticated encryption mode (`GCM`, `CCM`, `OCB`, and `chacha20-poly1305` are currently supported), the `cipher.getAuthTag()` method returns a [`Buffer`][] containing the _authentication tag_ that has been computed from the given data."
},
"params": []
}
],
"desc": "<p>The <code>cipher.getAuthTag()</code> method should only be called after encryption has\nbeen completed using the <a href=\"#cipherfinaloutputencoding\"><code>cipher.final()</code></a> method.</p>\n<p>If the <code>authTagLength</code> option was set during the <code>cipher</code> instance's creation,\nthis function will return exactly <code>authTagLength</code> bytes.</p>"
},
{
"textRaw": "`cipher.setAAD(buffer[, options])`",
"type": "method",
"name": "setAAD",
"meta": {
"added": [
"v1.0.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Cipher} for method chaining.",
"name": "return",
"type": "Cipher",
"desc": "for method chaining."
},
"params": [
{
"textRaw": "`buffer` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "buffer",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]",
"options": [
{
"textRaw": "`plaintextLength` {number}",
"name": "plaintextLength",
"type": "number"
},
{
"textRaw": "`encoding` {string} The string encoding to use when `buffer` is a string.",
"name": "encoding",
"type": "string",
"desc": "The string encoding to use when `buffer` is a string."
}
]
}
]
}
],
"desc": "<p>When using an authenticated encryption mode (<code>GCM</code>, <code>CCM</code>, <code>OCB</code>, and\n<code>chacha20-poly1305</code> are\ncurrently supported), the <code>cipher.setAAD()</code> method sets the value used for the\n<em>additional authenticated data</em> (AAD) input parameter.</p>\n<p>The <code>plaintextLength</code> option is optional for <code>GCM</code> and <code>OCB</code>. When using <code>CCM</code>,\nthe <code>plaintextLength</code> option must be specified and its value must match the\nlength of the plaintext in bytes. See <a href=\"#ccm-mode\">CCM mode</a>.</p>\n<p>The <code>cipher.setAAD()</code> method must be called before <a href=\"#cipherupdatedata-inputencoding-outputencoding\"><code>cipher.update()</code></a>.</p>"
},
{
"textRaw": "`cipher.setAutoPadding([autoPadding])`",
"type": "method",
"name": "setAutoPadding",
"meta": {
"added": [
"v0.7.1"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Cipher} for method chaining.",
"name": "return",
"type": "Cipher",
"desc": "for method chaining."
},
"params": [
{
"textRaw": "`autoPadding` {boolean} **Default:** `true`",
"name": "autoPadding",
"type": "boolean",
"default": "`true`"
}
]
}
],
"desc": "<p>When using block encryption algorithms, the <code>Cipher</code> class will automatically\nadd padding to the input data to the appropriate block size. To disable the\ndefault padding call <code>cipher.setAutoPadding(false)</code>.</p>\n<p>When <code>autoPadding</code> is <code>false</code>, the length of the entire input data must be a\nmultiple of the cipher's block size or <a href=\"#cipherfinaloutputencoding\"><code>cipher.final()</code></a> will throw an error.\nDisabling automatic padding is useful for non-standard padding, for instance\nusing <code>0x0</code> instead of PKCS padding.</p>\n<p>The <code>cipher.setAutoPadding()</code> method must be called before\n<a href=\"#cipherfinaloutputencoding\"><code>cipher.final()</code></a>.</p>"
},
{
"textRaw": "`cipher.update(data[, inputEncoding][, outputEncoding])`",
"type": "method",
"name": "update",
"meta": {
"added": [
"v0.1.94"
],
"changes": [
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default `inputEncoding` changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`data` {string|Buffer|TypedArray|DataView}",
"name": "data",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the data.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the data."
},
{
"textRaw": "`outputEncoding` {string} The [encoding][] of the return value.",
"name": "outputEncoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Updates the cipher with <code>data</code>. If the <code>inputEncoding</code> argument is given,\nthe <code>data</code>\nargument is a string using the specified encoding. If the <code>inputEncoding</code>\nargument is not given, <code>data</code> must be a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or\n<code>DataView</code>. If <code>data</code> is a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code>, then\n<code>inputEncoding</code> is ignored.</p>\n<p>The <code>outputEncoding</code> specifies the output format of the enciphered\ndata. If the <code>outputEncoding</code>\nis specified, a string using the specified encoding is returned. If no\n<code>outputEncoding</code> is provided, a <a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>\n<p>The <code>cipher.update()</code> method can be called multiple times with new data until\n<a href=\"#cipherfinaloutputencoding\"><code>cipher.final()</code></a> is called. Calling <code>cipher.update()</code> after\n<a href=\"#cipherfinaloutputencoding\"><code>cipher.final()</code></a> will result in an error being thrown.</p>"
}
]
},
{
"textRaw": "Class: `Decipher`",
"type": "class",
"name": "Decipher",
"meta": {
"added": [
"v0.1.94"
],
"changes": []
},
"desc": "<ul>\n<li>Extends: <a href=\"stream.html#class-streamtransform\" class=\"type\"><stream.Transform></a></li>\n</ul>\n<p>Instances of the <code>Decipher</code> class are used to decrypt data. The class can be\nused in one of two ways:</p>\n<ul>\n<li>As a <a href=\"stream.html\">stream</a> that is both readable and writable, where plain encrypted\ndata is written to produce unencrypted data on the readable side, or</li>\n<li>Using the <a href=\"#decipherupdatedata-inputencoding-outputencoding\"><code>decipher.update()</code></a> and <a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a> methods to\nproduce the unencrypted data.</li>\n</ul>\n<p>The <a href=\"#cryptocreatedecipheralgorithm-password-options\"><code>crypto.createDecipher()</code></a> or <a href=\"#cryptocreatedecipherivalgorithm-key-iv-options\"><code>crypto.createDecipheriv()</code></a> methods are\nused to create <code>Decipher</code> instances. <code>Decipher</code> objects are not to be created\ndirectly using the <code>new</code> keyword.</p>\n<p>Example: Using <code>Decipher</code> objects as streams:</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst {\n scryptSync,\n createDecipheriv\n} = await import('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n// Key length is dependent on the algorithm. In this case for aes192, it is\n// 24 bytes (192 bits).\n// Use the async `crypto.scrypt()` instead.\nconst key = scryptSync(password, 'salt', 24);\n// The IV is usually passed along with the ciphertext.\nconst iv = Buffer.alloc(16, 0); // Initialization vector.\n\nconst decipher = createDecipheriv(algorithm, key, iv);\n\nlet decrypted = '';\ndecipher.on('readable', () => {\n let chunk;\n while (null !== (chunk = decipher.read())) {\n decrypted += chunk.toString('utf8');\n }\n});\ndecipher.on('end', () => {\n console.log(decrypted);\n // Prints: some clear text data\n});\n\n// Encrypted with same algorithm, key and iv.\nconst encrypted =\n 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';\ndecipher.write(encrypted, 'hex');\ndecipher.end();\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n scryptSync,\n createDecipheriv,\n} = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n// Key length is dependent on the algorithm. In this case for aes192, it is\n// 24 bytes (192 bits).\n// Use the async `crypto.scrypt()` instead.\nconst key = scryptSync(password, 'salt', 24);\n// The IV is usually passed along with the ciphertext.\nconst iv = Buffer.alloc(16, 0); // Initialization vector.\n\nconst decipher = createDecipheriv(algorithm, key, iv);\n\nlet decrypted = '';\ndecipher.on('readable', () => {\n let chunk;\n while (null !== (chunk = decipher.read())) {\n decrypted += chunk.toString('utf8');\n }\n});\ndecipher.on('end', () => {\n console.log(decrypted);\n // Prints: some clear text data\n});\n\n// Encrypted with same algorithm, key and iv.\nconst encrypted =\n 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';\ndecipher.write(encrypted, 'hex');\ndecipher.end();\n</code></pre>\n<p>Example: Using <code>Decipher</code> and piped streams:</p>\n<pre><code class=\"language-mjs\">import {\n createReadStream,\n createWriteStream,\n} from 'node:fs';\nimport { Buffer } from 'node:buffer';\nconst {\n scryptSync,\n createDecipheriv\n} = await import('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n// Use the async `crypto.scrypt()` instead.\nconst key = scryptSync(password, 'salt', 24);\n// The IV is usually passed along with the ciphertext.\nconst iv = Buffer.alloc(16, 0); // Initialization vector.\n\nconst decipher = createDecipheriv(algorithm, key, iv);\n\nconst input = createReadStream('test.enc');\nconst output = createWriteStream('test.js');\n\ninput.pipe(decipher).pipe(output);\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createReadStream,\n createWriteStream,\n} = require('node:fs');\nconst {\n scryptSync,\n createDecipheriv,\n} = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n// Use the async `crypto.scrypt()` instead.\nconst key = scryptSync(password, 'salt', 24);\n// The IV is usually passed along with the ciphertext.\nconst iv = Buffer.alloc(16, 0); // Initialization vector.\n\nconst decipher = createDecipheriv(algorithm, key, iv);\n\nconst input = createReadStream('test.enc');\nconst output = createWriteStream('test.js');\n\ninput.pipe(decipher).pipe(output);\n</code></pre>\n<p>Example: Using the <a href=\"#decipherupdatedata-inputencoding-outputencoding\"><code>decipher.update()</code></a> and <a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a> methods:</p>\n<pre><code class=\"language-mjs\">import { Buffer } from 'node:buffer';\nconst {\n scryptSync,\n createDecipheriv\n} = await import('node:crypto');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n// Use the async `crypto.scrypt()` instead.\nconst key = scryptSync(password, 'salt', 24);\n// The IV is usually passed along with the ciphertext.\nconst iv = Buffer.alloc(16, 0); // Initialization vector.\n\nconst decipher = createDecipheriv(algorithm, key, iv);\n\n// Encrypted using same algorithm, key and iv.\nconst encrypted =\n 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';\nlet decrypted = decipher.update(encrypted, 'hex', 'utf8');\ndecrypted += decipher.final('utf8');\nconsole.log(decrypted);\n// Prints: some clear text data\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n scryptSync,\n createDecipheriv,\n} = require('node:crypto');\nconst { Buffer } = require('node:buffer');\n\nconst algorithm = 'aes-192-cbc';\nconst password = 'Password used to generate key';\n// Use the async `crypto.scrypt()` instead.\nconst key = scryptSync(password, 'salt', 24);\n// The IV is usually passed along with the ciphertext.\nconst iv = Buffer.alloc(16, 0); // Initialization vector.\n\nconst decipher = createDecipheriv(algorithm, key, iv);\n\n// Encrypted using same algorithm, key and iv.\nconst encrypted =\n 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';\nlet decrypted = decipher.update(encrypted, 'hex', 'utf8');\ndecrypted += decipher.final('utf8');\nconsole.log(decrypted);\n// Prints: some clear text data\n</code></pre>",
"methods": [
{
"textRaw": "`decipher.final([outputEncoding])`",
"type": "method",
"name": "final",
"meta": {
"added": [
"v0.1.94"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string} Any remaining deciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a [`Buffer`][] is returned.",
"name": "return",
"type": "Buffer | string",
"desc": "Any remaining deciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a [`Buffer`][] is returned."
},
"params": [
{
"textRaw": "`outputEncoding` {string} The [encoding][] of the return value.",
"name": "outputEncoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Once the <code>decipher.final()</code> method has been called, the <code>Decipher</code> object can\nno longer be used to decrypt data. Attempts to call <code>decipher.final()</code> more\nthan once will result in an error being thrown.</p>"
},
{
"textRaw": "`decipher.setAAD(buffer[, options])`",
"type": "method",
"name": "setAAD",
"meta": {
"added": [
"v1.0.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The buffer argument can be a string or ArrayBuffer and is limited to no more than 2 ** 31 - 1 bytes."
},
{
"version": "v7.2.0",
"pr-url": "https://github.com/nodejs/node/pull/9398",
"description": "This method now returns a reference to `decipher`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Decipher} for method chaining.",
"name": "return",
"type": "Decipher",
"desc": "for method chaining."
},
"params": [
{
"textRaw": "`buffer` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "buffer",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]",
"options": [
{
"textRaw": "`plaintextLength` {number}",
"name": "plaintextLength",
"type": "number"
},
{
"textRaw": "`encoding` {string} String encoding to use when `buffer` is a string.",
"name": "encoding",
"type": "string",
"desc": "String encoding to use when `buffer` is a string."
}
]
}
]
}
],
"desc": "<p>When using an authenticated encryption mode (<code>GCM</code>, <code>CCM</code>, <code>OCB</code>, and\n<code>chacha20-poly1305</code> are\ncurrently supported), the <code>decipher.setAAD()</code> method sets the value used for the\n<em>additional authenticated data</em> (AAD) input parameter.</p>\n<p>The <code>options</code> argument is optional for <code>GCM</code>. When using <code>CCM</code>, the\n<code>plaintextLength</code> option must be specified and its value must match the length\nof the ciphertext in bytes. See <a href=\"#ccm-mode\">CCM mode</a>.</p>\n<p>The <code>decipher.setAAD()</code> method must be called before <a href=\"#decipherupdatedata-inputencoding-outputencoding\"><code>decipher.update()</code></a>.</p>\n<p>When passing a string as the <code>buffer</code>, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>"
},
{
"textRaw": "`decipher.setAuthTag(buffer[, encoding])`",
"type": "method",
"name": "setAuthTag",
"meta": {
"added": [
"v1.0.0"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The buffer argument can be a string or ArrayBuffer and is limited to no more than 2 ** 31 - 1 bytes."
},
{
"version": "v11.0.0",
"pr-url": "https://github.com/nodejs/node/pull/17825",
"description": "This method now throws if the GCM tag length is invalid."
},
{
"version": "v7.2.0",
"pr-url": "https://github.com/nodejs/node/pull/9398",
"description": "This method now returns a reference to `decipher`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Decipher} for method chaining.",
"name": "return",
"type": "Decipher",
"desc": "for method chaining."
},
"params": [
{
"textRaw": "`buffer` {string|Buffer|ArrayBuffer|TypedArray|DataView}",
"name": "buffer",
"type": "string|Buffer|ArrayBuffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} String encoding to use when `buffer` is a string.",
"name": "encoding",
"type": "string",
"desc": "String encoding to use when `buffer` is a string."
}
]
}
],
"desc": "<p>When using an authenticated encryption mode (<code>GCM</code>, <code>CCM</code>, <code>OCB</code>, and\n<code>chacha20-poly1305</code> are\ncurrently supported), the <code>decipher.setAuthTag()</code> method is used to pass in the\nreceived <em>authentication tag</em>. If no tag is provided, or if the cipher text\nhas been tampered with, <a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a> will throw, indicating that the\ncipher text should be discarded due to failed authentication. If the tag length\nis invalid according to <a href=\"https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf\">NIST SP 800-38D</a> or does not match the value of the\n<code>authTagLength</code> option, <code>decipher.setAuthTag()</code> will throw an error.</p>\n<p>The <code>decipher.setAuthTag()</code> method must be called before <a href=\"#decipherupdatedata-inputencoding-outputencoding\"><code>decipher.update()</code></a>\nfor <code>CCM</code> mode or before <a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a> for <code>GCM</code> and <code>OCB</code> modes and\n<code>chacha20-poly1305</code>.\n<code>decipher.setAuthTag()</code> can only be called once.</p>\n<p>When passing a string as the authentication tag, please consider\n<a href=\"#using-strings-as-inputs-to-cryptographic-apis\">caveats when using strings as inputs to cryptographic APIs</a>.</p>"
},
{
"textRaw": "`decipher.setAutoPadding([autoPadding])`",
"type": "method",
"name": "setAutoPadding",
"meta": {
"added": [
"v0.7.1"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Decipher} for method chaining.",
"name": "return",
"type": "Decipher",
"desc": "for method chaining."
},
"params": [
{
"textRaw": "`autoPadding` {boolean} **Default:** `true`",
"name": "autoPadding",
"type": "boolean",
"default": "`true`"
}
]
}
],
"desc": "<p>When data has been encrypted without standard block padding, calling\n<code>decipher.setAutoPadding(false)</code> will disable automatic padding to prevent\n<a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a> from checking for and removing padding.</p>\n<p>Turning auto padding off will only work if the input data's length is a\nmultiple of the ciphers block size.</p>\n<p>The <code>decipher.setAutoPadding()</code> method must be called before\n<a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a>.</p>"
},
{
"textRaw": "`decipher.update(data[, inputEncoding][, outputEncoding])`",
"type": "method",
"name": "update",
"meta": {
"added": [
"v0.1.94"
],
"changes": [
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default `inputEncoding` changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`data` {string|Buffer|TypedArray|DataView}",
"name": "data",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the `data` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the `data` string."
},
{
"textRaw": "`outputEncoding` {string} The [encoding][] of the return value.",
"name": "outputEncoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Updates the decipher with <code>data</code>. If the <code>inputEncoding</code> argument is given,\nthe <code>data</code>\nargument is a string using the specified encoding. If the <code>inputEncoding</code>\nargument is not given, <code>data</code> must be a <a href=\"buffer.html\"><code>Buffer</code></a>. If <code>data</code> is a\n<a href=\"buffer.html\"><code>Buffer</code></a> then <code>inputEncoding</code> is ignored.</p>\n<p>The <code>outputEncoding</code> specifies the output format of the enciphered\ndata. If the <code>outputEncoding</code>\nis specified, a string using the specified encoding is returned. If no\n<code>outputEncoding</code> is provided, a <a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>\n<p>The <code>decipher.update()</code> method can be called multiple times with new data until\n<a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a> is called. Calling <code>decipher.update()</code> after\n<a href=\"#decipherfinaloutputencoding\"><code>decipher.final()</code></a> will result in an error being thrown.</p>"
}
]
},
{
"textRaw": "Class: `DiffieHellman`",
"type": "class",
"name": "DiffieHellman",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"desc": "<p>The <code>DiffieHellman</code> class is a utility for creating Diffie-Hellman key\nexchanges.</p>\n<p>Instances of the <code>DiffieHellman</code> class can be created using the\n<a href=\"#cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding\"><code>crypto.createDiffieHellman()</code></a> function.</p>\n<pre><code class=\"language-mjs\">import assert from 'node:assert';\n\nconst {\n createDiffieHellman\n} = await import('node:crypto');\n\n// Generate Alice's keys...\nconst alice = createDiffieHellman(2048);\nconst aliceKey = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = createDiffieHellman(alice.getPrime(), alice.getGenerator());\nconst bobKey = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst aliceSecret = alice.computeSecret(bobKey);\nconst bobSecret = bob.computeSecret(aliceKey);\n\n// OK\nassert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));\n</code></pre>\n<pre><code class=\"language-cjs\">const assert = require('node:assert');\n\nconst {\n createDiffieHellman,\n} = require('node:crypto');\n\n// Generate Alice's keys...\nconst alice = createDiffieHellman(2048);\nconst aliceKey = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = createDiffieHellman(alice.getPrime(), alice.getGenerator());\nconst bobKey = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst aliceSecret = alice.computeSecret(bobKey);\nconst bobSecret = bob.computeSecret(aliceKey);\n\n// OK\nassert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));\n</code></pre>",
"methods": [
{
"textRaw": "`diffieHellman.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])`",
"type": "method",
"name": "computeSecret",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`otherPublicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "otherPublicKey",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of an `otherPublicKey` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of an `otherPublicKey` string."
},
{
"textRaw": "`outputEncoding` {string} The [encoding][] of the return value.",
"name": "outputEncoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Computes the shared secret using <code>otherPublicKey</code> as the other\nparty's public key and returns the computed shared secret. The supplied\nkey is interpreted using the specified <code>inputEncoding</code>, and secret is\nencoded using specified <code>outputEncoding</code>.\nIf the <code>inputEncoding</code> is not\nprovided, <code>otherPublicKey</code> is expected to be a <a href=\"buffer.html\"><code>Buffer</code></a>,\n<code>TypedArray</code>, or <code>DataView</code>.</p>\n<p>If <code>outputEncoding</code> is given a string is returned; otherwise, a\n<a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>"
},
{
"textRaw": "`diffieHellman.generateKeys([encoding])`",
"type": "method",
"name": "generateKeys",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Generates private and public Diffie-Hellman key values, and returns\nthe public key in the specified <code>encoding</code>. This key should be\ntransferred to the other party.\nIf <code>encoding</code> is provided a string is returned; otherwise a\n<a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>"
},
{
"textRaw": "`diffieHellman.getGenerator([encoding])`",
"type": "method",
"name": "getGenerator",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Returns the Diffie-Hellman generator in the specified <code>encoding</code>.\nIf <code>encoding</code> is provided a string is\nreturned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>"
},
{
"textRaw": "`diffieHellman.getPrime([encoding])`",
"type": "method",
"name": "getPrime",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Returns the Diffie-Hellman prime in the specified <code>encoding</code>.\nIf <code>encoding</code> is provided a string is\nreturned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>"
},
{
"textRaw": "`diffieHellman.getPrivateKey([encoding])`",
"type": "method",
"name": "getPrivateKey",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Returns the Diffie-Hellman private key in the specified <code>encoding</code>.\nIf <code>encoding</code> is provided a\nstring is returned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>"
},
{
"textRaw": "`diffieHellman.getPublicKey([encoding])`",
"type": "method",
"name": "getPublicKey",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Returns the Diffie-Hellman public key in the specified <code>encoding</code>.\nIf <code>encoding</code> is provided a\nstring is returned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>"
},
{
"textRaw": "`diffieHellman.setPrivateKey(privateKey[, encoding])`",
"type": "method",
"name": "setPrivateKey",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`privateKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "privateKey",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `privateKey` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `privateKey` string."
}
]
}
],
"desc": "<p>Sets the Diffie-Hellman private key. If the <code>encoding</code> argument is provided,\n<code>privateKey</code> is expected\nto be a string. If no <code>encoding</code> is provided, <code>privateKey</code> is expected\nto be a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code>.</p>"
},
{
"textRaw": "`diffieHellman.setPublicKey(publicKey[, encoding])`",
"type": "method",
"name": "setPublicKey",
"meta": {
"added": [
"v0.5.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`publicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "publicKey",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `publicKey` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `publicKey` string."
}
]
}
],
"desc": "<p>Sets the Diffie-Hellman public key. If the <code>encoding</code> argument is provided,\n<code>publicKey</code> is expected\nto be a string. If no <code>encoding</code> is provided, <code>publicKey</code> is expected\nto be a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code>.</p>"
}
],
"properties": [
{
"textRaw": "`diffieHellman.verifyError`",
"name": "verifyError",
"meta": {
"added": [
"v0.11.12"
],
"changes": []
},
"desc": "<p>A bit field containing any warnings and/or errors resulting from a check\nperformed during initialization of the <code>DiffieHellman</code> object.</p>\n<p>The following values are valid for this property (as defined in <code>node:constants</code> module):</p>\n<ul>\n<li><code>DH_CHECK_P_NOT_SAFE_PRIME</code></li>\n<li><code>DH_CHECK_P_NOT_PRIME</code></li>\n<li><code>DH_UNABLE_TO_CHECK_GENERATOR</code></li>\n<li><code>DH_NOT_SUITABLE_GENERATOR</code></li>\n</ul>"
}
]
},
{
"textRaw": "Class: `DiffieHellmanGroup`",
"type": "class",
"name": "DiffieHellmanGroup",
"meta": {
"added": [
"v0.7.5"
],
"changes": []
},
"desc": "<p>The <code>DiffieHellmanGroup</code> class takes a well-known modp group as its argument.\nIt works the same as <code>DiffieHellman</code>, except that it does not allow changing\nits keys after creation. In other words, it does not implement <code>setPublicKey()</code>\nor <code>setPrivateKey()</code> methods.</p>\n<pre><code class=\"language-mjs\">const { createDiffieHellmanGroup } = await import('node:crypto');\nconst dh = createDiffieHellmanGroup('modp16');\n</code></pre>\n<pre><code class=\"language-cjs\">const { createDiffieHellmanGroup } = require('node:crypto');\nconst dh = createDiffieHellmanGroup('modp16');\n</code></pre>\n<p>The following groups are supported:</p>\n<ul>\n<li><code>'modp14'</code> (2048 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc3526.txt\">RFC 3526</a> Section 3)</li>\n<li><code>'modp15'</code> (3072 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc3526.txt\">RFC 3526</a> Section 4)</li>\n<li><code>'modp16'</code> (4096 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc3526.txt\">RFC 3526</a> Section 5)</li>\n<li><code>'modp17'</code> (6144 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc3526.txt\">RFC 3526</a> Section 6)</li>\n<li><code>'modp18'</code> (8192 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc3526.txt\">RFC 3526</a> Section 7)</li>\n</ul>\n<p>The following groups are still supported but deprecated (see <a href=\"#support-for-weak-or-compromised-algorithms\">Caveats</a>):</p>\n<ul>\n<li><code>'modp1'</code> (768 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc2409.txt\">RFC 2409</a> Section 6.1) <span class=\"deprecated-inline\"></span></li>\n<li><code>'modp2'</code> (1024 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc2409.txt\">RFC 2409</a> Section 6.2) <span class=\"deprecated-inline\"></span></li>\n<li><code>'modp5'</code> (1536 bits, <a href=\"https://www.rfc-editor.org/rfc/rfc3526.txt\">RFC 3526</a> Section 2) <span class=\"deprecated-inline\"></span></li>\n</ul>\n<p>These deprecated groups might be removed in future versions of Node.js.</p>"
},
{
"textRaw": "Class: `ECDH`",
"type": "class",
"name": "ECDH",
"meta": {
"added": [
"v0.11.14"
],
"changes": []
},
"desc": "<p>The <code>ECDH</code> class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH)\nkey exchanges.</p>\n<p>Instances of the <code>ECDH</code> class can be created using the\n<a href=\"#cryptocreateecdhcurvename\"><code>crypto.createECDH()</code></a> function.</p>\n<pre><code class=\"language-mjs\">import assert from 'node:assert';\n\nconst {\n createECDH\n} = await import('node:crypto');\n\n// Generate Alice's keys...\nconst alice = createECDH('secp521r1');\nconst aliceKey = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = createECDH('secp521r1');\nconst bobKey = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst aliceSecret = alice.computeSecret(bobKey);\nconst bobSecret = bob.computeSecret(aliceKey);\n\nassert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));\n// OK\n</code></pre>\n<pre><code class=\"language-cjs\">const assert = require('node:assert');\n\nconst {\n createECDH,\n} = require('node:crypto');\n\n// Generate Alice's keys...\nconst alice = createECDH('secp521r1');\nconst aliceKey = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = createECDH('secp521r1');\nconst bobKey = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst aliceSecret = alice.computeSecret(bobKey);\nconst bobSecret = bob.computeSecret(aliceKey);\n\nassert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));\n// OK\n</code></pre>",
"classMethods": [
{
"textRaw": "Static method: `ECDH.convertKey(key, curve[, inputEncoding[, outputEncoding[, format]]])`",
"type": "classMethod",
"name": "convertKey",
"meta": {
"added": [
"v10.0.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`key` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "key",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`curve` {string}",
"name": "curve",
"type": "string"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the `key` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the `key` string."
},
{
"textRaw": "`outputEncoding` {string} The [encoding][] of the return value.",
"name": "outputEncoding",
"type": "string",
"desc": "The [encoding][] of the return value."
},
{
"textRaw": "`format` {string} **Default:** `'uncompressed'`",
"name": "format",
"type": "string",
"default": "`'uncompressed'`"
}
]
}
],
"desc": "<p>Converts the EC Diffie-Hellman public key specified by <code>key</code> and <code>curve</code> to the\nformat specified by <code>format</code>. The <code>format</code> argument specifies point encoding\nand can be <code>'compressed'</code>, <code>'uncompressed'</code> or <code>'hybrid'</code>. The supplied key is\ninterpreted using the specified <code>inputEncoding</code>, and the returned key is encoded\nusing the specified <code>outputEncoding</code>.</p>\n<p>Use <a href=\"#cryptogetcurves\"><code>crypto.getCurves()</code></a> to obtain a list of available curve names.\nOn recent OpenSSL releases, <code>openssl ecparam -list_curves</code> will also display\nthe name and description of each available elliptic curve.</p>\n<p>If <code>format</code> is not specified the point will be returned in <code>'uncompressed'</code>\nformat.</p>\n<p>If the <code>inputEncoding</code> is not provided, <code>key</code> is expected to be a <a href=\"buffer.html\"><code>Buffer</code></a>,\n<code>TypedArray</code>, or <code>DataView</code>.</p>\n<p>Example (uncompressing a key):</p>\n<pre><code class=\"language-mjs\">const {\n createECDH,\n ECDH\n} = await import('node:crypto');\n\nconst ecdh = createECDH('secp256k1');\necdh.generateKeys();\n\nconst compressedKey = ecdh.getPublicKey('hex', 'compressed');\n\nconst uncompressedKey = ECDH.convertKey(compressedKey,\n 'secp256k1',\n 'hex',\n 'hex',\n 'uncompressed');\n\n// The converted key and the uncompressed public key should be the same\nconsole.log(uncompressedKey === ecdh.getPublicKey('hex'));\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createECDH,\n ECDH,\n} = require('node:crypto');\n\nconst ecdh = createECDH('secp256k1');\necdh.generateKeys();\n\nconst compressedKey = ecdh.getPublicKey('hex', 'compressed');\n\nconst uncompressedKey = ECDH.convertKey(compressedKey,\n 'secp256k1',\n 'hex',\n 'hex',\n 'uncompressed');\n\n// The converted key and the uncompressed public key should be the same\nconsole.log(uncompressedKey === ecdh.getPublicKey('hex'));\n</code></pre>"
}
],
"methods": [
{
"textRaw": "`ecdh.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])`",
"type": "method",
"name": "computeSecret",
"meta": {
"added": [
"v0.11.14"
],
"changes": [
{
"version": "v10.0.0",
"pr-url": "https://github.com/nodejs/node/pull/16849",
"description": "Changed error format to better support invalid public key error."
},
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default `inputEncoding` changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`otherPublicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "otherPublicKey",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the `otherPublicKey` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the `otherPublicKey` string."
},
{
"textRaw": "`outputEncoding` {string} The [encoding][] of the return value.",
"name": "outputEncoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Computes the shared secret using <code>otherPublicKey</code> as the other\nparty's public key and returns the computed shared secret. The supplied\nkey is interpreted using specified <code>inputEncoding</code>, and the returned secret\nis encoded using the specified <code>outputEncoding</code>.\nIf the <code>inputEncoding</code> is not\nprovided, <code>otherPublicKey</code> is expected to be a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or\n<code>DataView</code>.</p>\n<p>If <code>outputEncoding</code> is given a string will be returned; otherwise a\n<a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>\n<p><code>ecdh.computeSecret</code> will throw an\n<code>ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY</code> error when <code>otherPublicKey</code>\nlies outside of the elliptic curve. Since <code>otherPublicKey</code> is\nusually supplied from a remote user over an insecure network,\nbe sure to handle this exception accordingly.</p>"
},
{
"textRaw": "`ecdh.generateKeys([encoding[, format]])`",
"type": "method",
"name": "generateKeys",
"meta": {
"added": [
"v0.11.14"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
},
{
"textRaw": "`format` {string} **Default:** `'uncompressed'`",
"name": "format",
"type": "string",
"default": "`'uncompressed'`"
}
]
}
],
"desc": "<p>Generates private and public EC Diffie-Hellman key values, and returns\nthe public key in the specified <code>format</code> and <code>encoding</code>. This key should be\ntransferred to the other party.</p>\n<p>The <code>format</code> argument specifies point encoding and can be <code>'compressed'</code> or\n<code>'uncompressed'</code>. If <code>format</code> is not specified, the point will be returned in\n<code>'uncompressed'</code> format.</p>\n<p>If <code>encoding</code> is provided a string is returned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a>\nis returned.</p>"
},
{
"textRaw": "`ecdh.getPrivateKey([encoding])`",
"type": "method",
"name": "getPrivateKey",
"meta": {
"added": [
"v0.11.14"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string} The EC Diffie-Hellman in the specified `encoding`.",
"name": "return",
"type": "Buffer | string",
"desc": "The EC Diffie-Hellman in the specified `encoding`."
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>If <code>encoding</code> is specified, a string is returned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a> is\nreturned.</p>"
},
{
"textRaw": "`ecdh.getPublicKey([encoding][, format])`",
"type": "method",
"name": "getPublicKey",
"meta": {
"added": [
"v0.11.14"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string} The EC Diffie-Hellman public key in the specified `encoding` and `format`.",
"name": "return",
"type": "Buffer | string",
"desc": "The EC Diffie-Hellman public key in the specified `encoding` and `format`."
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
},
{
"textRaw": "`format` {string} **Default:** `'uncompressed'`",
"name": "format",
"type": "string",
"default": "`'uncompressed'`"
}
]
}
],
"desc": "<p>The <code>format</code> argument specifies point encoding and can be <code>'compressed'</code> or\n<code>'uncompressed'</code>. If <code>format</code> is not specified the point will be returned in\n<code>'uncompressed'</code> format.</p>\n<p>If <code>encoding</code> is specified, a string is returned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a> is\nreturned.</p>"
},
{
"textRaw": "`ecdh.setPrivateKey(privateKey[, encoding])`",
"type": "method",
"name": "setPrivateKey",
"meta": {
"added": [
"v0.11.14"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`privateKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "privateKey",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `privateKey` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `privateKey` string."
}
]
}
],
"desc": "<p>Sets the EC Diffie-Hellman private key.\nIf <code>encoding</code> is provided, <code>privateKey</code> is expected\nto be a string; otherwise <code>privateKey</code> is expected to be a <a href=\"buffer.html\"><code>Buffer</code></a>,\n<code>TypedArray</code>, or <code>DataView</code>.</p>\n<p>If <code>privateKey</code> is not valid for the curve specified when the <code>ECDH</code> object was\ncreated, an error is thrown. Upon setting the private key, the associated\npublic point (key) is also generated and set in the <code>ECDH</code> object.</p>"
},
{
"textRaw": "`ecdh.setPublicKey(publicKey[, encoding])`",
"type": "method",
"name": "setPublicKey",
"meta": {
"added": [
"v0.11.14"
],
"deprecated": [
"v5.2.0"
],
"changes": []
},
"stability": 0,
"stabilityText": "Deprecated",
"signatures": [
{
"params": [
{
"textRaw": "`publicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}",
"name": "publicKey",
"type": "string|ArrayBuffer|Buffer|TypedArray|DataView"
},
{
"textRaw": "`encoding` {string} The [encoding][] of the `publicKey` string.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the `publicKey` string."
}
]
}
],
"desc": "<p>Sets the EC Diffie-Hellman public key.\nIf <code>encoding</code> is provided <code>publicKey</code> is expected to\nbe a string; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code> is expected.</p>\n<p>There is not normally a reason to call this method because <code>ECDH</code>\nonly requires a private key and the other party's public key to compute the\nshared secret. Typically either <a href=\"#ecdhgeneratekeysencoding-format\"><code>ecdh.generateKeys()</code></a> or\n<a href=\"#ecdhsetprivatekeyprivatekey-encoding\"><code>ecdh.setPrivateKey()</code></a> will be called. The <a href=\"#ecdhsetprivatekeyprivatekey-encoding\"><code>ecdh.setPrivateKey()</code></a> method\nattempts to generate the public point/key associated with the private key being\nset.</p>\n<p>Example (obtaining a shared secret):</p>\n<pre><code class=\"language-mjs\">const {\n createECDH,\n createHash\n} = await import('node:crypto');\n\nconst alice = createECDH('secp256k1');\nconst bob = createECDH('secp256k1');\n\n// This is a shortcut way of specifying one of Alice's previous private\n// keys. It would be unwise to use such a predictable private key in a real\n// application.\nalice.setPrivateKey(\n createHash('sha256').update('alice', 'utf8').digest()\n);\n\n// Bob uses a newly generated cryptographically strong\n// pseudorandom key pair\nbob.generateKeys();\n\nconst aliceSecret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n// aliceSecret and bobSecret should be the same shared secret value\nconsole.log(aliceSecret === bobSecret);\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createECDH,\n createHash,\n} = require('node:crypto');\n\nconst alice = createECDH('secp256k1');\nconst bob = createECDH('secp256k1');\n\n// This is a shortcut way of specifying one of Alice's previous private\n// keys. It would be unwise to use such a predictable private key in a real\n// application.\nalice.setPrivateKey(\n createHash('sha256').update('alice', 'utf8').digest()\n);\n\n// Bob uses a newly generated cryptographically strong\n// pseudorandom key pair\nbob.generateKeys();\n\nconst aliceSecret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n// aliceSecret and bobSecret should be the same shared secret value\nconsole.log(aliceSecret === bobSecret);\n</code></pre>"
}
]
},
{
"textRaw": "Class: `Hash`",
"type": "class",
"name": "Hash",
"meta": {
"added": [
"v0.1.92"
],
"changes": []
},
"desc": "<ul>\n<li>Extends: <a href=\"stream.html#class-streamtransform\" class=\"type\"><stream.Transform></a></li>\n</ul>\n<p>The <code>Hash</code> class is a utility for creating hash digests of data. It can be\nused in one of two ways:</p>\n<ul>\n<li>As a <a href=\"stream.html\">stream</a> that is both readable and writable, where data is written\nto produce a computed hash digest on the readable side, or</li>\n<li>Using the <a href=\"#hashupdatedata-inputencoding\"><code>hash.update()</code></a> and <a href=\"#hashdigestencoding\"><code>hash.digest()</code></a> methods to produce the\ncomputed hash.</li>\n</ul>\n<p>The <a href=\"#cryptocreatehashalgorithm-options\"><code>crypto.createHash()</code></a> method is used to create <code>Hash</code> instances. <code>Hash</code>\nobjects are not to be created directly using the <code>new</code> keyword.</p>\n<p>Example: Using <code>Hash</code> objects as streams:</p>\n<pre><code class=\"language-mjs\">const {\n createHash\n} = await import('node:crypto');\n\nconst hash = createHash('sha256');\n\nhash.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = hash.read();\n if (data) {\n console.log(data.toString('hex'));\n // Prints:\n // 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n }\n});\n\nhash.write('some data to hash');\nhash.end();\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createHash,\n} = require('node:crypto');\n\nconst hash = createHash('sha256');\n\nhash.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = hash.read();\n if (data) {\n console.log(data.toString('hex'));\n // Prints:\n // 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n }\n});\n\nhash.write('some data to hash');\nhash.end();\n</code></pre>\n<p>Example: Using <code>Hash</code> and piped streams:</p>\n<pre><code class=\"language-mjs\">import { createReadStream } from 'node:fs';\nimport { stdout } from 'node:process';\nconst { createHash } = await import('node:crypto');\n\nconst hash = createHash('sha256');\n\nconst input = createReadStream('test.js');\ninput.pipe(hash).setEncoding('hex').pipe(stdout);\n</code></pre>\n<pre><code class=\"language-cjs\">const { createReadStream } = require('node:fs');\nconst { createHash } = require('node:crypto');\nconst { stdout } = require('node:process');\n\nconst hash = createHash('sha256');\n\nconst input = createReadStream('test.js');\ninput.pipe(hash).setEncoding('hex').pipe(stdout);\n</code></pre>\n<p>Example: Using the <a href=\"#hashupdatedata-inputencoding\"><code>hash.update()</code></a> and <a href=\"#hashdigestencoding\"><code>hash.digest()</code></a> methods:</p>\n<pre><code class=\"language-mjs\">const {\n createHash\n} = await import('node:crypto');\n\nconst hash = createHash('sha256');\n\nhash.update('some data to hash');\nconsole.log(hash.digest('hex'));\n// Prints:\n// 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createHash,\n} = require('node:crypto');\n\nconst hash = createHash('sha256');\n\nhash.update('some data to hash');\nconsole.log(hash.digest('hex'));\n// Prints:\n// 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n</code></pre>",
"methods": [
{
"textRaw": "`hash.copy([options])`",
"type": "method",
"name": "copy",
"meta": {
"added": [
"v13.1.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Hash}",
"name": "return",
"type": "Hash"
},
"params": [
{
"textRaw": "`options` {Object} [`stream.transform` options][]",
"name": "options",
"type": "Object",
"desc": "[`stream.transform` options][]"
}
]
}
],
"desc": "<p>Creates a new <code>Hash</code> object that contains a deep copy of the internal state\nof the current <code>Hash</code> object.</p>\n<p>The optional <code>options</code> argument controls stream behavior. For XOF hash\nfunctions such as <code>'shake256'</code>, the <code>outputLength</code> option can be used to\nspecify the desired output length in bytes.</p>\n<p>An error is thrown when an attempt is made to copy the <code>Hash</code> object after\nits <a href=\"#hashdigestencoding\"><code>hash.digest()</code></a> method has been called.</p>\n<pre><code class=\"language-mjs\">// Calculate a rolling hash.\nconst {\n createHash\n} = await import('node:crypto');\n\nconst hash = createHash('sha256');\n\nhash.update('one');\nconsole.log(hash.copy().digest('hex'));\n\nhash.update('two');\nconsole.log(hash.copy().digest('hex'));\n\nhash.update('three');\nconsole.log(hash.copy().digest('hex'));\n\n// Etc.\n</code></pre>\n<pre><code class=\"language-cjs\">// Calculate a rolling hash.\nconst {\n createHash,\n} = require('node:crypto');\n\nconst hash = createHash('sha256');\n\nhash.update('one');\nconsole.log(hash.copy().digest('hex'));\n\nhash.update('two');\nconsole.log(hash.copy().digest('hex'));\n\nhash.update('three');\nconsole.log(hash.copy().digest('hex'));\n\n// Etc.\n</code></pre>"
},
{
"textRaw": "`hash.digest([encoding])`",
"type": "method",
"name": "digest",
"meta": {
"added": [
"v0.1.92"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Calculates the digest of all of the data passed to be hashed (using the\n<a href=\"#hashupdatedata-inputencoding\"><code>hash.update()</code></a> method).\nIf <code>encoding</code> is provided a string will be returned; otherwise\na <a href=\"buffer.html\"><code>Buffer</code></a> is returned.</p>\n<p>The <code>Hash</code> object can not be used again after <code>hash.digest()</code> method has been\ncalled. Multiple calls will cause an error to be thrown.</p>"
},
{
"textRaw": "`hash.update(data[, inputEncoding])`",
"type": "method",
"name": "update",
"meta": {
"added": [
"v0.1.92"
],
"changes": [
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default `inputEncoding` changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`data` {string|Buffer|TypedArray|DataView}",
"name": "data",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the `data` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the `data` string."
}
]
}
],
"desc": "<p>Updates the hash content with the given <code>data</code>, the encoding of which\nis given in <code>inputEncoding</code>.\nIf <code>encoding</code> is not provided, and the <code>data</code> is a string, an\nencoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or\n<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p>\n<p>This can be called many times with new data as it is streamed.</p>"
}
]
},
{
"textRaw": "Class: `Hmac`",
"type": "class",
"name": "Hmac",
"meta": {
"added": [
"v0.1.94"
],
"changes": []
},
"desc": "<ul>\n<li>Extends: <a href=\"stream.html#class-streamtransform\" class=\"type\"><stream.Transform></a></li>\n</ul>\n<p>The <code>Hmac</code> class is a utility for creating cryptographic HMAC digests. It can\nbe used in one of two ways:</p>\n<ul>\n<li>As a <a href=\"stream.html\">stream</a> that is both readable and writable, where data is written\nto produce a computed HMAC digest on the readable side, or</li>\n<li>Using the <a href=\"#hmacupdatedata-inputencoding\"><code>hmac.update()</code></a> and <a href=\"#hmacdigestencoding\"><code>hmac.digest()</code></a> methods to produce the\ncomputed HMAC digest.</li>\n</ul>\n<p>The <a href=\"#cryptocreatehmacalgorithm-key-options\"><code>crypto.createHmac()</code></a> method is used to create <code>Hmac</code> instances. <code>Hmac</code>\nobjects are not to be created directly using the <code>new</code> keyword.</p>\n<p>Example: Using <code>Hmac</code> objects as streams:</p>\n<pre><code class=\"language-mjs\">const {\n createHmac\n} = await import('node:crypto');\n\nconst hmac = createHmac('sha256', 'a secret');\n\nhmac.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = hmac.read();\n if (data) {\n console.log(data.toString('hex'));\n // Prints:\n // 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n }\n});\n\nhmac.write('some data to hash');\nhmac.end();\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createHmac,\n} = require('node:crypto');\n\nconst hmac = createHmac('sha256', 'a secret');\n\nhmac.on('readable', () => {\n // Only one element is going to be produced by the\n // hash stream.\n const data = hmac.read();\n if (data) {\n console.log(data.toString('hex'));\n // Prints:\n // 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n }\n});\n\nhmac.write('some data to hash');\nhmac.end();\n</code></pre>\n<p>Example: Using <code>Hmac</code> and piped streams:</p>\n<pre><code class=\"language-mjs\">import { createReadStream } from 'node:fs';\nimport { stdout } from 'node:process';\nconst {\n createHmac\n} = await import('node:crypto');\n\nconst hmac = createHmac('sha256', 'a secret');\n\nconst input = createReadStream('test.js');\ninput.pipe(hmac).pipe(stdout);\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createReadStream,\n} = require('node:fs');\nconst {\n createHmac,\n} = require('node:crypto');\nconst { stdout } = require('node:process');\n\nconst hmac = createHmac('sha256', 'a secret');\n\nconst input = createReadStream('test.js');\ninput.pipe(hmac).pipe(stdout);\n</code></pre>\n<p>Example: Using the <a href=\"#hmacupdatedata-inputencoding\"><code>hmac.update()</code></a> and <a href=\"#hmacdigestencoding\"><code>hmac.digest()</code></a> methods:</p>\n<pre><code class=\"language-mjs\">const {\n createHmac\n} = await import('node:crypto');\n\nconst hmac = createHmac('sha256', 'a secret');\n\nhmac.update('some data to hash');\nconsole.log(hmac.digest('hex'));\n// Prints:\n// 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n createHmac,\n} = require('node:crypto');\n\nconst hmac = createHmac('sha256', 'a secret');\n\nhmac.update('some data to hash');\nconsole.log(hmac.digest('hex'));\n// Prints:\n// 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n</code></pre>",
"methods": [
{
"textRaw": "`hmac.digest([encoding])`",
"type": "method",
"name": "digest",
"meta": {
"added": [
"v0.1.94"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {Buffer | string}",
"name": "return",
"type": "Buffer | string"
},
"params": [
{
"textRaw": "`encoding` {string} The [encoding][] of the return value.",
"name": "encoding",
"type": "string",
"desc": "The [encoding][] of the return value."
}
]
}
],
"desc": "<p>Calculates the HMAC digest of all of the data passed using <a href=\"#hmacupdatedata-inputencoding\"><code>hmac.update()</code></a>.\nIf <code>encoding</code> is\nprovided a string is returned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a> is returned;</p>\n<p>The <code>Hmac</code> object can not be used again after <code>hmac.digest()</code> has been\ncalled. Multiple calls to <code>hmac.digest()</code> will result in an error being thrown.</p>"
},
{
"textRaw": "`hmac.update(data[, inputEncoding])`",
"type": "method",
"name": "update",
"meta": {
"added": [
"v0.1.94"
],
"changes": [
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default `inputEncoding` changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`data` {string|Buffer|TypedArray|DataView}",
"name": "data",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the `data` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the `data` string."
}
]
}
],
"desc": "<p>Updates the <code>Hmac</code> content with the given <code>data</code>, the encoding of which\nis given in <code>inputEncoding</code>.\nIf <code>encoding</code> is not provided, and the <code>data</code> is a string, an\nencoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or\n<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p>\n<p>This can be called many times with new data as it is streamed.</p>"
}
]
},
{
"textRaw": "Class: `KeyObject`",
"type": "class",
"name": "KeyObject",
"meta": {
"added": [
"v11.6.0"
],
"changes": [
{
"version": [
"v14.5.0",
"v12.19.0"
],
"pr-url": "https://github.com/nodejs/node/pull/33360",
"description": "Instances of this class can now be passed to worker threads using `postMessage`."
},
{
"version": "v11.13.0",
"pr-url": "https://github.com/nodejs/node/pull/26438",
"description": "This class is now exported."
}
]
},
"desc": "<p>Node.js uses a <code>KeyObject</code> class to represent a symmetric or asymmetric key,\nand each kind of key exposes different functions. The\n<a href=\"#cryptocreatesecretkeykey-encoding\"><code>crypto.createSecretKey()</code></a>, <a href=\"#cryptocreatepublickeykey\"><code>crypto.createPublicKey()</code></a> and\n<a href=\"#cryptocreateprivatekeykey\"><code>crypto.createPrivateKey()</code></a> methods are used to create <code>KeyObject</code>\ninstances. <code>KeyObject</code> objects are not to be created directly using the <code>new</code>\nkeyword.</p>\n<p>Most applications should consider using the new <code>KeyObject</code> API instead of\npassing keys as strings or <code>Buffer</code>s due to improved security features.</p>\n<p><code>KeyObject</code> instances can be passed to other threads via <a href=\"worker_threads.html#portpostmessagevalue-transferlist\"><code>postMessage()</code></a>.\nThe receiver obtains a cloned <code>KeyObject</code>, and the <code>KeyObject</code> does not need to\nbe listed in the <code>transferList</code> argument.</p>",
"classMethods": [
{
"textRaw": "Static method: `KeyObject.from(key)`",
"type": "classMethod",
"name": "from",
"meta": {
"added": [
"v15.0.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {KeyObject}",
"name": "return",
"type": "KeyObject"
},
"params": [
{
"textRaw": "`key` {CryptoKey}",
"name": "key",
"type": "CryptoKey"
}
]
}
],
"desc": "<p>Example: Converting a <code>CryptoKey</code> instance to a <code>KeyObject</code>:</p>\n<pre><code class=\"language-mjs\">const { webcrypto, KeyObject } = await import('node:crypto');\nconst { subtle } = webcrypto;\n\nconst key = await subtle.generateKey({\n name: 'HMAC',\n hash: 'SHA-256',\n length: 256\n}, true, ['sign', 'verify']);\n\nconst keyObject = KeyObject.from(key);\nconsole.log(keyObject.symmetricKeySize);\n// Prints: 32 (symmetric key size in bytes)\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n webcrypto: {\n subtle,\n },\n KeyObject,\n} = require('node:crypto');\n\n(async function() {\n const key = await subtle.generateKey({\n name: 'HMAC',\n hash: 'SHA-256',\n length: 256\n }, true, ['sign', 'verify']);\n\n const keyObject = KeyObject.from(key);\n console.log(keyObject.symmetricKeySize);\n // Prints: 32 (symmetric key size in bytes)\n})();\n</code></pre>"
}
],
"properties": [
{
"textRaw": "`asymmetricKeyDetails` {Object}",
"type": "Object",
"name": "asymmetricKeyDetails",
"meta": {
"added": [
"v15.7.0"
],
"changes": [
{
"version": "v16.9.0",
"pr-url": "https://github.com/nodejs/node/pull/39851",
"description": "Expose `RSASSA-PSS-params` sequence parameters for RSA-PSS keys."
}
]
},
"options": [
{
"textRaw": "`modulusLength`: {number} Key size in bits (RSA, DSA).",
"name": "modulusLength",
"type": "number",
"desc": "Key size in bits (RSA, DSA)."
},
{
"textRaw": "`publicExponent`: {bigint} Public exponent (RSA).",
"name": "publicExponent",
"type": "bigint",
"desc": "Public exponent (RSA)."
},
{
"textRaw": "`hashAlgorithm`: {string} Name of the message digest (RSA-PSS).",
"name": "hashAlgorithm",
"type": "string",
"desc": "Name of the message digest (RSA-PSS)."
},
{
"textRaw": "`mgf1HashAlgorithm`: {string} Name of the message digest used by MGF1 (RSA-PSS).",
"name": "mgf1HashAlgorithm",
"type": "string",
"desc": "Name of the message digest used by MGF1 (RSA-PSS)."
},
{
"textRaw": "`saltLength`: {number} Minimal salt length in bytes (RSA-PSS).",
"name": "saltLength",
"type": "number",
"desc": "Minimal salt length in bytes (RSA-PSS)."
},
{
"textRaw": "`divisorLength`: {number} Size of `q` in bits (DSA).",
"name": "divisorLength",
"type": "number",
"desc": "Size of `q` in bits (DSA)."
},
{
"textRaw": "`namedCurve`: {string} Name of the curve (EC).",
"name": "namedCurve",
"type": "string",
"desc": "Name of the curve (EC)."
}
],
"desc": "<p>This property exists only on asymmetric keys. Depending on the type of the key,\nthis object contains information about the key. None of the information obtained\nthrough this property can be used to uniquely identify a key or to compromise\nthe security of the key.</p>\n<p>For RSA-PSS keys, if the key material contains a <code>RSASSA-PSS-params</code> sequence,\nthe <code>hashAlgorithm</code>, <code>mgf1HashAlgorithm</code>, and <code>saltLength</code> properties will be\nset.</p>\n<p>Other key details might be exposed via this API using additional attributes.</p>"
},
{
"textRaw": "`asymmetricKeyType` {string}",
"type": "string",
"name": "asymmetricKeyType",
"meta": {
"added": [
"v11.6.0"
],
"changes": [
{
"version": [
"v13.9.0",
"v12.17.0"
],
"pr-url": "https://github.com/nodejs/node/pull/31178",
"description": "Added support for `'dh'`."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26960",
"description": "Added support for `'rsa-pss'`."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26786",
"description": "This property now returns `undefined` for KeyObject instances of unrecognized type instead of aborting."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26774",
"description": "Added support for `'x25519'` and `'x448'`."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26319",
"description": "Added support for `'ed25519'` and `'ed448'`."
}
]
},
"desc": "<p>For asymmetric keys, this property represents the type of the key. Supported key\ntypes are:</p>\n<ul>\n<li><code>'rsa'</code> (OID 1.2.840.113549.1.1.1)</li>\n<li><code>'rsa-pss'</code> (OID 1.2.840.113549.1.1.10)</li>\n<li><code>'dsa'</code> (OID 1.2.840.10040.4.1)</li>\n<li><code>'ec'</code> (OID 1.2.840.10045.2.1)</li>\n<li><code>'x25519'</code> (OID 1.3.101.110)</li>\n<li><code>'x448'</code> (OID 1.3.101.111)</li>\n<li><code>'ed25519'</code> (OID 1.3.101.112)</li>\n<li><code>'ed448'</code> (OID 1.3.101.113)</li>\n<li><code>'dh'</code> (OID 1.2.840.113549.1.3.1)</li>\n</ul>\n<p>This property is <code>undefined</code> for unrecognized <code>KeyObject</code> types and symmetric\nkeys.</p>"
},
{
"textRaw": "`symmetricKeySize` {number}",
"type": "number",
"name": "symmetricKeySize",
"meta": {
"added": [
"v11.6.0"
],
"changes": []
},
"desc": "<p>For secret keys, this property represents the size of the key in bytes. This\nproperty is <code>undefined</code> for asymmetric keys.</p>"
},
{
"textRaw": "`type` {string}",
"type": "string",
"name": "type",
"meta": {
"added": [
"v11.6.0"
],
"changes": []
},
"desc": "<p>Depending on the type of this <code>KeyObject</code>, this property is either\n<code>'secret'</code> for secret (symmetric) keys, <code>'public'</code> for public (asymmetric) keys\nor <code>'private'</code> for private (asymmetric) keys.</p>"
}
],
"methods": [
{
"textRaw": "`keyObject.export([options])`",
"type": "method",
"name": "export",
"meta": {
"added": [
"v11.6.0"
],
"changes": [
{
"version": "v15.9.0",
"pr-url": "https://github.com/nodejs/node/pull/37081",
"description": "Added support for `'jwk'` format."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string | Buffer | Object}",
"name": "return",
"type": "string | Buffer | Object"
},
"params": [
{
"textRaw": "`options`: {Object}",
"name": "options",
"type": "Object"
}
]
}
],
"desc": "<p>For symmetric keys, the following encoding options can be used:</p>\n<ul>\n<li><code>format</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be <code>'buffer'</code> (default) or <code>'jwk'</code>.</li>\n</ul>\n<p>For public keys, the following encoding options can be used:</p>\n<ul>\n<li><code>type</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be one of <code>'pkcs1'</code> (RSA only) or <code>'spki'</code>.</li>\n<li><code>format</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be <code>'pem'</code>, <code>'der'</code>, or <code>'jwk'</code>.</li>\n</ul>\n<p>For private keys, the following encoding options can be used:</p>\n<ul>\n<li><code>type</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be one of <code>'pkcs1'</code> (RSA only), <code>'pkcs8'</code> or\n<code>'sec1'</code> (EC only).</li>\n<li><code>format</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> Must be <code>'pem'</code>, <code>'der'</code>, or <code>'jwk'</code>.</li>\n<li><code>cipher</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> If specified, the private key will be encrypted with\nthe given <code>cipher</code> and <code>passphrase</code> using PKCS#5 v2.0 password based\nencryption.</li>\n<li><code>passphrase</code>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> The passphrase to use for encryption, see\n<code>cipher</code>.</li>\n</ul>\n<p>The result type depends on the selected encoding format, when PEM the\nresult is a string, when DER it will be a buffer containing the data\nencoded as DER, when <a href=\"https://tools.ietf.org/html/rfc7517\">JWK</a> it will be an object.</p>\n<p>When <a href=\"https://tools.ietf.org/html/rfc7517\">JWK</a> encoding format was selected, all other encoding options are\nignored.</p>\n<p>PKCS#1, SEC1, and PKCS#8 type keys can be encrypted by using a combination of\nthe <code>cipher</code> and <code>format</code> options. The PKCS#8 <code>type</code> can be used with any\n<code>format</code> to encrypt any key algorithm (RSA, EC, or DH) by specifying a\n<code>cipher</code>. PKCS#1 and SEC1 can only be encrypted by specifying a <code>cipher</code>\nwhen the PEM <code>format</code> is used. For maximum compatibility, use PKCS#8 for\nencrypted private keys. Since PKCS#8 defines its own\nencryption mechanism, PEM-level encryption is not supported when encrypting\na PKCS#8 key. See <a href=\"https://www.rfc-editor.org/rfc/rfc5208.txt\">RFC 5208</a> for PKCS#8 encryption and <a href=\"https://www.rfc-editor.org/rfc/rfc1421.txt\">RFC 1421</a> for\nPKCS#1 and SEC1 encryption.</p>"
},
{
"textRaw": "`keyObject.equals(otherKeyObject)`",
"type": "method",
"name": "equals",
"meta": {
"added": [
"v16.15.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean}",
"name": "return",
"type": "boolean"
},
"params": [
{
"textRaw": "`otherKeyObject`: {KeyObject} A `KeyObject` with which to compare `keyObject`.",
"name": "otherKeyObject",
"type": "KeyObject",
"desc": "A `KeyObject` with which to compare `keyObject`."
}
]
}
],
"desc": "<p>Returns <code>true</code> or <code>false</code> depending on whether the keys have exactly the same\ntype, value, and parameters. This method is not\n<a href=\"https://en.wikipedia.org/wiki/Timing_attack\">constant time</a>.</p>"
}
]
},
{
"textRaw": "Class: `Sign`",
"type": "class",
"name": "Sign",
"meta": {
"added": [
"v0.1.92"
],
"changes": []
},
"desc": "<ul>\n<li>Extends: <a href=\"stream.html#class-streamwritable\" class=\"type\"><stream.Writable></a></li>\n</ul>\n<p>The <code>Sign</code> class is a utility for generating signatures. It can be used in one\nof two ways:</p>\n<ul>\n<li>As a writable <a href=\"stream.html\">stream</a>, where data to be signed is written and the\n<a href=\"#signsignprivatekey-outputencoding\"><code>sign.sign()</code></a> method is used to generate and return the signature, or</li>\n<li>Using the <a href=\"#signupdatedata-inputencoding\"><code>sign.update()</code></a> and <a href=\"#signsignprivatekey-outputencoding\"><code>sign.sign()</code></a> methods to produce the\nsignature.</li>\n</ul>\n<p>The <a href=\"#cryptocreatesignalgorithm-options\"><code>crypto.createSign()</code></a> method is used to create <code>Sign</code> instances. The\nargument is the string name of the hash function to use. <code>Sign</code> objects are not\nto be created directly using the <code>new</code> keyword.</p>\n<p>Example: Using <code>Sign</code> and <a href=\"#class-verify\"><code>Verify</code></a> objects as streams:</p>\n<pre><code class=\"language-mjs\">const {\n generateKeyPairSync,\n createSign,\n createVerify\n} = await import('node:crypto');\n\nconst { privateKey, publicKey } = generateKeyPairSync('ec', {\n namedCurve: 'sect239k1'\n});\n\nconst sign = createSign('SHA256');\nsign.write('some data to sign');\nsign.end();\nconst signature = sign.sign(privateKey, 'hex');\n\nconst verify = createVerify('SHA256');\nverify.write('some data to sign');\nverify.end();\nconsole.log(verify.verify(publicKey, signature, 'hex'));\n// Prints: true\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n generateKeyPairSync,\n createSign,\n createVerify,\n} = require('node:crypto');\n\nconst { privateKey, publicKey } = generateKeyPairSync('ec', {\n namedCurve: 'sect239k1'\n});\n\nconst sign = createSign('SHA256');\nsign.write('some data to sign');\nsign.end();\nconst signature = sign.sign(privateKey, 'hex');\n\nconst verify = createVerify('SHA256');\nverify.write('some data to sign');\nverify.end();\nconsole.log(verify.verify(publicKey, signature, 'hex'));\n// Prints: true\n</code></pre>\n<p>Example: Using the <a href=\"#signupdatedata-inputencoding\"><code>sign.update()</code></a> and <a href=\"#verifyupdatedata-inputencoding\"><code>verify.update()</code></a> methods:</p>\n<pre><code class=\"language-mjs\">const {\n generateKeyPairSync,\n createSign,\n createVerify\n} = await import('node:crypto');\n\nconst { privateKey, publicKey } = generateKeyPairSync('rsa', {\n modulusLength: 2048,\n});\n\nconst sign = createSign('SHA256');\nsign.update('some data to sign');\nsign.end();\nconst signature = sign.sign(privateKey);\n\nconst verify = createVerify('SHA256');\nverify.update('some data to sign');\nverify.end();\nconsole.log(verify.verify(publicKey, signature));\n// Prints: true\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n generateKeyPairSync,\n createSign,\n createVerify,\n} = require('node:crypto');\n\nconst { privateKey, publicKey } = generateKeyPairSync('rsa', {\n modulusLength: 2048,\n});\n\nconst sign = createSign('SHA256');\nsign.update('some data to sign');\nsign.end();\nconst signature = sign.sign(privateKey);\n\nconst verify = createVerify('SHA256');\nverify.update('some data to sign');\nverify.end();\nconsole.log(verify.verify(publicKey, signature));\n// Prints: true\n</code></pre>",
"methods": [
{
"textRaw": "`sign.sign(privateKey[, outputEncoding])`",
"type": "method",
"name": "sign",
"meta": {
"added": [
"v0.1.92"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The privateKey can also be an ArrayBuffer and CryptoKey."
},
{
"version": [
"v13.2.0",
"v12.16.0"
],
"pr-url": "https://github.com/nodejs/node/pull/29292",
"description": "This function now supports IEEE-P1363 DSA and ECDSA signatures."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26960",
"description": "This function now supports RSA-PSS keys."
},
{
"version": "v11.6.0",
"pr-url": "https://github.com/nodejs/node/pull/24234",
"description": "This function now supports key objects."
},
{
"version": "v8.0.0",
"pr-url": "https://github.com/nodejs/node/pull/11705",
"description": "Support for RSASSA-PSS and additional options was added."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>privateKey</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\n<ul>\n<li><code>dsaEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a></li>\n<li><code>padding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a></li>\n<li><code>saltLength</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a></li>\n</ul>\n</li>\n<li><code>outputEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The <a href=\"buffer.html#buffers-and-character-encodings\">encoding</a> of the return value.</li>\n<li>Returns: <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a></li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Calculates the signature on all the data passed through using either\n<a href=\"#signupdatedata-inputencoding\"><code>sign.update()</code></a> or <a href=\"stream.html#writablewritechunk-encoding-callback\"><code>sign.write()</code></a>.</p>\n<p>If <code>privateKey</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if\n<code>privateKey</code> had been passed to <a href=\"#cryptocreateprivatekeykey\"><code>crypto.createPrivateKey()</code></a>. If it is an\nobject, the following additional properties can be passed:</p>\n<ul>\n<li>\n<p><code>dsaEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> For DSA and ECDSA, this option specifies the\nformat of the generated signature. It can be one of the following:</p>\n<ul>\n<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li>\n<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li>\n</ul>\n</li>\n<li>\n<p><code>padding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Optional padding value for RSA, one of the following:</p>\n<ul>\n<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li>\n<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li>\n</ul>\n<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function\nused to sign the message as specified in section 3.1 of <a href=\"https://www.rfc-editor.org/rfc/rfc4055.txt\">RFC 4055</a>, unless\nan MGF1 hash function has been specified as part of the key in compliance with\nsection 3.3 of <a href=\"https://www.rfc-editor.org/rfc/rfc4055.txt\">RFC 4055</a>.</p>\n</li>\n<li>\n<p><code>saltLength</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Salt length for when padding is\n<code>RSA_PKCS1_PSS_PADDING</code>. The special value\n<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest\nsize, <code>crypto.constants.RSA_PSS_SALTLEN_MAX_SIGN</code> (default) sets it to the\nmaximum permissible value.</p>\n</li>\n</ul>\n<p>If <code>outputEncoding</code> is provided a string is returned; otherwise a <a href=\"buffer.html\"><code>Buffer</code></a>\nis returned.</p>\n<p>The <code>Sign</code> object can not be again used after <code>sign.sign()</code> method has been\ncalled. Multiple calls to <code>sign.sign()</code> will result in an error being thrown.</p>"
},
{
"textRaw": "`sign.update(data[, inputEncoding])`",
"type": "method",
"name": "update",
"meta": {
"added": [
"v0.1.92"
],
"changes": [
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default `inputEncoding` changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`data` {string|Buffer|TypedArray|DataView}",
"name": "data",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the `data` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the `data` string."
}
]
}
],
"desc": "<p>Updates the <code>Sign</code> content with the given <code>data</code>, the encoding of which\nis given in <code>inputEncoding</code>.\nIf <code>encoding</code> is not provided, and the <code>data</code> is a string, an\nencoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or\n<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p>\n<p>This can be called many times with new data as it is streamed.</p>"
}
]
},
{
"textRaw": "Class: `Verify`",
"type": "class",
"name": "Verify",
"meta": {
"added": [
"v0.1.92"
],
"changes": []
},
"desc": "<ul>\n<li>Extends: <a href=\"stream.html#class-streamwritable\" class=\"type\"><stream.Writable></a></li>\n</ul>\n<p>The <code>Verify</code> class is a utility for verifying signatures. It can be used in one\nof two ways:</p>\n<ul>\n<li>As a writable <a href=\"stream.html\">stream</a> where written data is used to validate against the\nsupplied signature, or</li>\n<li>Using the <a href=\"#verifyupdatedata-inputencoding\"><code>verify.update()</code></a> and <a href=\"#verifyverifyobject-signature-signatureencoding\"><code>verify.verify()</code></a> methods to verify\nthe signature.</li>\n</ul>\n<p>The <a href=\"#cryptocreateverifyalgorithm-options\"><code>crypto.createVerify()</code></a> method is used to create <code>Verify</code> instances.\n<code>Verify</code> objects are not to be created directly using the <code>new</code> keyword.</p>\n<p>See <a href=\"#class-sign\"><code>Sign</code></a> for examples.</p>",
"methods": [
{
"textRaw": "`verify.update(data[, inputEncoding])`",
"type": "method",
"name": "update",
"meta": {
"added": [
"v0.1.92"
],
"changes": [
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/5522",
"description": "The default `inputEncoding` changed from `binary` to `utf8`."
}
]
},
"signatures": [
{
"params": [
{
"textRaw": "`data` {string|Buffer|TypedArray|DataView}",
"name": "data",
"type": "string|Buffer|TypedArray|DataView"
},
{
"textRaw": "`inputEncoding` {string} The [encoding][] of the `data` string.",
"name": "inputEncoding",
"type": "string",
"desc": "The [encoding][] of the `data` string."
}
]
}
],
"desc": "<p>Updates the <code>Verify</code> content with the given <code>data</code>, the encoding of which\nis given in <code>inputEncoding</code>.\nIf <code>inputEncoding</code> is not provided, and the <code>data</code> is a string, an\nencoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href=\"buffer.html\"><code>Buffer</code></a>, <code>TypedArray</code>, or\n<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p>\n<p>This can be called many times with new data as it is streamed.</p>"
},
{
"textRaw": "`verify.verify(object, signature[, signatureEncoding])`",
"type": "method",
"name": "verify",
"meta": {
"added": [
"v0.1.92"
],
"changes": [
{
"version": "v15.0.0",
"pr-url": "https://github.com/nodejs/node/pull/35093",
"description": "The object can also be an ArrayBuffer and CryptoKey."
},
{
"version": [
"v13.2.0",
"v12.16.0"
],
"pr-url": "https://github.com/nodejs/node/pull/29292",
"description": "This function now supports IEEE-P1363 DSA and ECDSA signatures."
},
{
"version": "v12.0.0",
"pr-url": "https://github.com/nodejs/node/pull/26960",
"description": "This function now supports RSA-PSS keys."
},
{
"version": "v11.7.0",
"pr-url": "https://github.com/nodejs/node/pull/25217",
"description": "The key can now be a private key."
},
{
"version": "v8.0.0",
"pr-url": "https://github.com/nodejs/node/pull/11705",
"description": "Support for RSASSA-PSS and additional options was added."
}
]
},
"signatures": [
{
"params": []
}
],
"desc": "<!--lint disable maximum-line-length remark-lint-->\n<ul>\n<li><code>object</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" class=\"type\"><Object></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a> | <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> | <a href=\"webcrypto.html#class-cryptokey\" class=\"type\"><CryptoKey></a>\n<ul>\n<li><code>dsaEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a></li>\n<li><code>padding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a></li>\n<li><code>saltLength</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a></li>\n</ul>\n</li>\n<li><code>signature</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\" class=\"type\"><ArrayBuffer></a> | <a href=\"buffer.html#class-buffer\" class=\"type\"><Buffer></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\" class=\"type\"><TypedArray></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView\" class=\"type\"><DataView></a></li>\n<li><code>signatureEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> The <a href=\"buffer.html#buffers-and-character-encodings\">encoding</a> of the <code>signature</code> string.</li>\n<li>Returns: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" class=\"type\"><boolean></a> <code>true</code> or <code>false</code> depending on the validity of the\nsignature for the data and public key.</li>\n</ul>\n<!--lint enable maximum-line-length remark-lint-->\n<p>Verifies the provided data using the given <code>object</code> and <code>signature</code>.</p>\n<p>If <code>object</code> is not a <a href=\"#class-keyobject\"><code>KeyObject</code></a>, this function behaves as if\n<code>object</code> had been passed to <a href=\"#cryptocreatepublickeykey\"><code>crypto.createPublicKey()</code></a>. If it is an\nobject, the following additional properties can be passed:</p>\n<ul>\n<li>\n<p><code>dsaEncoding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> For DSA and ECDSA, this option specifies the\nformat of the signature. It can be one of the following:</p>\n<ul>\n<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li>\n<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li>\n</ul>\n</li>\n<li>\n<p><code>padding</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Optional padding value for RSA, one of the following:</p>\n<ul>\n<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li>\n<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li>\n</ul>\n<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function\nused to verify the message as specified in section 3.1 of <a href=\"https://www.rfc-editor.org/rfc/rfc4055.txt\">RFC 4055</a>, unless\nan MGF1 hash function has been specified as part of the key in compliance with\nsection 3.3 of <a href=\"https://www.rfc-editor.org/rfc/rfc4055.txt\">RFC 4055</a>.</p>\n</li>\n<li>\n<p><code>saltLength</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><integer></a> Salt length for when padding is\n<code>RSA_PKCS1_PSS_PADDING</code>. The special value\n<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest\nsize, <code>crypto.constants.RSA_PSS_SALTLEN_AUTO</code> (default) causes it to be\ndetermined automatically.</p>\n</li>\n</ul>\n<p>The <code>signature</code> argument is the previously calculated signature for the data, in\nthe <code>signatureEncoding</code>.\nIf a <code>signatureEncoding</code> is specified, the <code>signature</code> is expected to be a\nstring; otherwise <code>signature</code> is expected to be a <a href=\"buffer.html\"><code>Buffer</code></a>,\n<code>TypedArray</code>, or <code>DataView</code>.</p>\n<p>The <code>verify</code> object can not be used again after <code>verify.verify()</code> has been\ncalled. Multiple calls to <code>verify.verify()</code> will result in an error being\nthrown.</p>\n<p>Because public keys can be derived from private keys, a private key may\nbe passed instead of a public key.</p>"
}
]
},
{
"textRaw": "Class: `X509Certificate`",
"type": "class",
"name": "X509Certificate",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>Encapsulates an X509 certificate and provides read-only access to\nits information.</p>\n<pre><code class=\"language-mjs\">const { X509Certificate } = await import('node:crypto');\n\nconst x509 = new X509Certificate('{... pem encoded cert ...}');\n\nconsole.log(x509.subject);\n</code></pre>\n<pre><code class=\"language-cjs\">const { X509Certificate } = require('node:crypto');\n\nconst x509 = new X509Certificate('{... pem encoded cert ...}');\n\nconsole.log(x509.subject);\n</code></pre>",
"properties": [
{
"textRaw": "`ca` Type: {boolean} Will be `true` if this is a Certificate Authority (CA) certificate.",
"type": "boolean",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "Will be `true` if this is a Certificate Authority (CA) certificate."
},
{
"textRaw": "`fingerprint` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The SHA-1 fingerprint of this certificate.</p>\n<p>Because SHA-1 is cryptographically broken and because the security of SHA-1 is\nsignificantly worse than that of algorithms that are commonly used to sign\ncertificates, consider using <a href=\"#x509fingerprint256\"><code>x509.fingerprint256</code></a> instead.</p>"
},
{
"textRaw": "`fingerprint256` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The SHA-256 fingerprint of this certificate.</p>"
},
{
"textRaw": "`fingerprint512` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v16.14.0"
],
"changes": []
},
"desc": "<p>The SHA-512 fingerprint of this certificate.</p>\n<p>Because computing the SHA-256 fingerprint is usually faster and because it is\nonly half the size of the SHA-512 fingerprint, <a href=\"#x509fingerprint256\"><code>x509.fingerprint256</code></a> may be\na better choice. While SHA-512 presumably provides a higher level of security in\ngeneral, the security of SHA-256 matches that of most algorithms that are\ncommonly used to sign certificates.</p>"
},
{
"textRaw": "`infoAccess` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": [
{
"version": "v16.13.2",
"pr-url": "https://github.com/nodejs-private/node-private/pull/300",
"description": "Parts of this string may be encoded as JSON string literals in response to CVE-2021-44532."
}
]
},
"desc": "<p>A textual representation of the certificate's authority information access\nextension.</p>\n<p>This is a line feed separated list of access descriptions. Each line begins with\nthe access method and the kind of the access location, followed by a colon and\nthe value associated with the access location.</p>\n<p>After the prefix denoting the access method and the kind of the access location,\nthe remainder of each line might be enclosed in quotes to indicate that the\nvalue is a JSON string literal. For backward compatibility, Node.js only uses\nJSON string literals within this property when necessary to avoid ambiguity.\nThird-party code should be prepared to handle both possible entry formats.</p>"
},
{
"textRaw": "`issuer` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The issuer identification included in this certificate.</p>"
},
{
"textRaw": "`issuerCertificate` Type: {X509Certificate}",
"type": "X509Certificate",
"name": "Type",
"meta": {
"added": [
"v15.9.0"
],
"changes": []
},
"desc": "<p>The issuer certificate or <code>undefined</code> if the issuer certificate is not\navailable.</p>"
},
{
"textRaw": "`keyUsage` Type: {string\\[]}",
"type": "string\\[]",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>An array detailing the key usages for this certificate.</p>"
},
{
"textRaw": "`publicKey` Type: {KeyObject}",
"type": "KeyObject",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The public key <a href=\"crypto.html#class-keyobject\" class=\"type\"><KeyObject></a> for this certificate.</p>"
},
{
"textRaw": "`raw` Type: {Buffer}",
"type": "Buffer",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>A <code>Buffer</code> containing the DER encoding of this certificate.</p>"
},
{
"textRaw": "`serialNumber` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The serial number of this certificate.</p>\n<p>Serial numbers are assigned by certificate authorities and do not uniquely\nidentify certificates. Consider using <a href=\"#x509fingerprint256\"><code>x509.fingerprint256</code></a> as a unique\nidentifier instead.</p>"
},
{
"textRaw": "`subject` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The complete subject of this certificate.</p>"
},
{
"textRaw": "`subjectAltName` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": [
{
"version": "v16.13.2",
"pr-url": "https://github.com/nodejs-private/node-private/pull/300",
"description": "Parts of this string may be encoded as JSON string literals in response to CVE-2021-44532."
}
]
},
"desc": "<p>The subject alternative name specified for this certificate.</p>\n<p>This is a comma-separated list of subject alternative names. Each entry begins\nwith a string identifying the kind of the subject alternative name followed by\na colon and the value associated with the entry.</p>\n<p>Earlier versions of Node.js incorrectly assumed that it is safe to split this\nproperty at the two-character sequence <code>', '</code> (see <a href=\"https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44532\">CVE-2021-44532</a>). However,\nboth malicious and legitimate certificates can contain subject alternative names\nthat include this sequence when represented as a string.</p>\n<p>After the prefix denoting the type of the entry, the remainder of each entry\nmight be enclosed in quotes to indicate that the value is a JSON string literal.\nFor backward compatibility, Node.js only uses JSON string literals within this\nproperty when necessary to avoid ambiguity. Third-party code should be prepared\nto handle both possible entry formats.</p>"
},
{
"textRaw": "`validFrom` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The date/time from which this certificate is considered valid.</p>"
},
{
"textRaw": "`validTo` Type: {string}",
"type": "string",
"name": "Type",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"desc": "<p>The date/time until which this certificate is considered valid.</p>"
}
],
"methods": [
{
"textRaw": "`x509.checkEmail(email[, options])`",
"type": "method",
"name": "checkEmail",
"meta": {
"added": [
"v15.6.0"
],
"changes": [
{
"version": "v16.15.0",
"pr-url": "https://github.com/nodejs/node/pull/41569",
"description": "The subject option can now be set to `'default'`."
},
{
"version": "v16.14.1",
"pr-url": "https://github.com/nodejs/node/pull/41599",
"description": "The `wildcards`, `partialWildcards`, `multiLabelWildcards`, and `singleLabelSubdomains` options have been removed since they had no effect."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string|undefined} Returns `email` if the certificate matches, `undefined` if it does not.",
"name": "return",
"type": "string|undefined",
"desc": "Returns `email` if the certificate matches, `undefined` if it does not."
},
"params": [
{
"textRaw": "`email` {string}",
"name": "email",
"type": "string"
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`subject` {string} `'default'`, `'always'`, or `'never'`. **Default:** `'always'`.",
"name": "subject",
"type": "string",
"default": "`'always'`",
"desc": "`'default'`, `'always'`, or `'never'`."
},
{
"textRaw": "`wildcards` {boolean} **Default:** `true`.",
"name": "wildcards",
"type": "boolean",
"default": "`true`"
},
{
"textRaw": "`partialWildcards` {boolean} **Default:** `true`.",
"name": "partialWildcards",
"type": "boolean",
"default": "`true`"
},
{
"textRaw": "`multiLabelWildcards` {boolean} **Default:** `false`.",
"name": "multiLabelWildcards",
"type": "boolean",
"default": "`false`"
},
{
"textRaw": "`singleLabelSubdomains` {boolean} **Default:** `false`.",
"name": "singleLabelSubdomains",
"type": "boolean",
"default": "`false`"
}
]
}
]
}
],
"desc": "<p>Checks whether the certificate matches the given email address.</p>\n<p>If the <code>'subject'</code> option is set to <code>'always'</code> and if the subject alternative\nname extension either does not exist or does not contain a matching email\naddress, the certificate subject is considered.</p>\n<p>If the <code>'subject'</code> option is set to <code>'default'</code>, the certificate subject is only\nconsidered if the subject alternative name extension either does not exist or\ndoes not contain any email addresses.</p>\n<p>If the <code>'subject'</code> option is set to <code>'never'</code>, the certificate subject is never\nconsidered, even if the certificate contains no subject alternative names.</p>"
},
{
"textRaw": "`x509.checkHost(name[, options])`",
"type": "method",
"name": "checkHost",
"meta": {
"added": [
"v15.6.0"
],
"changes": [
{
"version": "v16.15.0",
"pr-url": "https://github.com/nodejs/node/pull/41569",
"description": "The subject option can now be set to `'default'`."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string|undefined} Returns a subject name that matches `name`, or `undefined` if no subject name matches `name`.",
"name": "return",
"type": "string|undefined",
"desc": "Returns a subject name that matches `name`, or `undefined` if no subject name matches `name`."
},
"params": [
{
"textRaw": "`name` {string}",
"name": "name",
"type": "string"
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`subject` {string} `'default'`, `'always'`, or `'never'`. **Default:** `'always'`.",
"name": "subject",
"type": "string",
"default": "`'always'`",
"desc": "`'default'`, `'always'`, or `'never'`."
},
{
"textRaw": "`wildcards` {boolean} **Default:** `true`.",
"name": "wildcards",
"type": "boolean",
"default": "`true`"
},
{
"textRaw": "`partialWildcards` {boolean} **Default:** `true`.",
"name": "partialWildcards",
"type": "boolean",
"default": "`true`"
},
{
"textRaw": "`multiLabelWildcards` {boolean} **Default:** `false`.",
"name": "multiLabelWildcards",
"type": "boolean",
"default": "`false`"
},
{
"textRaw": "`singleLabelSubdomains` {boolean} **Default:** `false`.",
"name": "singleLabelSubdomains",
"type": "boolean",
"default": "`false`"
}
]
}
]
}
],
"desc": "<p>Checks whether the certificate matches the given host name.</p>\n<p>If the certificate matches the given host name, the matching subject name is\nreturned. The returned name might be an exact match (e.g., <code>foo.example.com</code>)\nor it might contain wildcards (e.g., <code>*.example.com</code>). Because host name\ncomparisons are case-insensitive, the returned subject name might also differ\nfrom the given <code>name</code> in capitalization.</p>\n<p>If the <code>'subject'</code> option is set to <code>'always'</code> and if the subject alternative\nname extension either does not exist or does not contain a matching DNS name,\nthe certificate subject is considered.</p>\n<p>If the <code>'subject'</code> option is set to <code>'default'</code>, the certificate subject is only\nconsidered if the subject alternative name extension either does not exist or\ndoes not contain any DNS names. This behavior is consistent with <a href=\"https://www.rfc-editor.org/rfc/rfc2818.txt\">RFC 2818</a>\n(\"HTTP Over TLS\").</p>\n<p>If the <code>'subject'</code> option is set to <code>'never'</code>, the certificate subject is never\nconsidered, even if the certificate contains no subject alternative names.</p>"
},
{
"textRaw": "`x509.checkIP(ip)`",
"type": "method",
"name": "checkIP",
"meta": {
"added": [
"v15.6.0"
],
"changes": [
{
"version": "v16.14.1",
"pr-url": "https://github.com/nodejs/node/pull/41571",
"description": "The `options` argument has been removed since it had no effect."
}
]
},
"signatures": [
{
"return": {
"textRaw": "Returns: {string|undefined} Returns `ip` if the certificate matches, `undefined` if it does not.",
"name": "return",
"type": "string|undefined",
"desc": "Returns `ip` if the certificate matches, `undefined` if it does not."
},
"params": [
{
"textRaw": "`ip` {string}",
"name": "ip",
"type": "string"
}
]
}
],
"desc": "<p>Checks whether the certificate matches the given IP address (IPv4 or IPv6).</p>\n<p>Only <a href=\"https://www.rfc-editor.org/rfc/rfc5280.txt\">RFC 5280</a> <code>iPAddress</code> subject alternative names are considered, and they\nmust match the given <code>ip</code> address exactly. Other subject alternative names as\nwell as the subject field of the certificate are ignored.</p>"
},
{
"textRaw": "`x509.checkIssued(otherCert)`",
"type": "method",
"name": "checkIssued",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean}",
"name": "return",
"type": "boolean"
},
"params": [
{
"textRaw": "`otherCert` {X509Certificate}",
"name": "otherCert",
"type": "X509Certificate"
}
]
}
],
"desc": "<p>Checks whether this certificate was issued by the given <code>otherCert</code>.</p>"
},
{
"textRaw": "`x509.checkPrivateKey(privateKey)`",
"type": "method",
"name": "checkPrivateKey",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean}",
"name": "return",
"type": "boolean"
},
"params": [
{
"textRaw": "`privateKey` {KeyObject} A private key.",
"name": "privateKey",
"type": "KeyObject",
"desc": "A private key."
}
]
}
],
"desc": "<p>Checks whether the public key for this certificate is consistent with\nthe given private key.</p>"
},
{
"textRaw": "`x509.toJSON()`",
"type": "method",
"name": "toJSON",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "Type: {string}",
"name": "Type",
"type": "string"
}
]
}
],
"desc": "<p>There is no standard JSON encoding for X509 certificates. The\n<code>toJSON()</code> method returns a string containing the PEM encoded\ncertificate.</p>"
},
{
"textRaw": "`x509.toLegacyObject()`",
"type": "method",
"name": "toLegacyObject",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "Type: {Object}",
"name": "Type",
"type": "Object"
}
]
}
],
"desc": "<p>Returns information about this certificate using the legacy\n<a href=\"tls.html#certificate-object\">certificate object</a> encoding.</p>"
},
{
"textRaw": "`x509.toString()`",
"type": "method",
"name": "toString",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "Type: {string}",
"name": "Type",
"type": "string"
}
]
}
],
"desc": "<p>Returns the PEM-encoded certificate.</p>"
},
{
"textRaw": "`x509.verify(publicKey)`",
"type": "method",
"name": "verify",
"meta": {
"added": [
"v15.6.0"
],
"changes": []
},
"signatures": [
{
"return": {
"textRaw": "Returns: {boolean}",
"name": "return",
"type": "boolean"
},
"params": [
{
"textRaw": "`publicKey` {KeyObject} A public key.",
"name": "publicKey",
"type": "KeyObject",
"desc": "A public key."
}
]
}
],
"desc": "<p>Verifies that this certificate was signed by the given public key.\nDoes not perform any other validation checks on the certificate.</p>"
}
],
"signatures": [
{
"params": [
{
"textRaw": "`buffer` {string|TypedArray|Buffer|DataView} A PEM or DER encoded X509 Certificate.",
"name": "buffer",
"type": "string|TypedArray|Buffer|DataView",
"desc": "A PEM or DER encoded X509 Certificate."
}
]
}
]
}
],
"type": "module",
"displayName": "Crypto"
}
]
}
Kontol Shell Bypass