1<!DOCTYPE html> 2<html lang="en"> 3<head> 4 <meta charset="utf-8"> 5 <meta name="viewport" content="width=device-width"> 6 <meta name="nodejs.org:node-version" content="v18.18.2"> 7 <title>Crypto | Node.js v18.18.2 Documentation</title> 8 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 9 <link rel="stylesheet" href="assets/style.css"> 10 <link rel="stylesheet" href="assets/hljs.css"> 11 <link rel="canonical" href="https://nodejs.org/api/crypto.html"> 12 <script async defer src="assets/api.js" type="text/javascript"></script> 13 <style>@media(max-width:630px){.with-51-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:638px){.with-52-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:294px){.with-9-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:374px){.with-19-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:518px){.with-37-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:526px){.with-38-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:742px){.with-65-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:326px){.with-13-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:606px){.with-48-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:446px){.with-28-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:566px){.with-43-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:710px){.with-61-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:398px){.with-22-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:670px){.with-56-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:334px){.with-14-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:366px){.with-18-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:318px){.with-12-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:342px){.with-15-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:662px){.with-55-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:558px){.with-42-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}</style> 14</head> 15<body class="alt apidoc" id="api-section-crypto"> 16 <div id="content" class="clearfix"> 17 <div id="column2" class="interior"> 18 <div id="intro" class="interior"> 19 <a href="/" title="Go back to the home page"> 20 Node.js 21 </a> 22 </div> 23 <ul> 24<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 25<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 26</ul> 27<hr class="line"> 28<ul> 29<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 30<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 31<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 32<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 33<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 34<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 35<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 36<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 37<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 38<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 39<li><a href="console.html" class="nav-console">Console</a></li> 40<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 41<li><a href="crypto.html" class="nav-crypto active">Crypto</a></li> 42<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 43<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 44<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 45<li><a href="dns.html" class="nav-dns">DNS</a></li> 46<li><a href="domain.html" class="nav-domain">Domain</a></li> 47<li><a href="errors.html" class="nav-errors">Errors</a></li> 48<li><a href="events.html" class="nav-events">Events</a></li> 49<li><a href="fs.html" class="nav-fs">File system</a></li> 50<li><a href="globals.html" class="nav-globals">Globals</a></li> 51<li><a href="http.html" class="nav-http">HTTP</a></li> 52<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 53<li><a href="https.html" class="nav-https">HTTPS</a></li> 54<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 55<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 56<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 57<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 58<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 59<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 60<li><a href="net.html" class="nav-net">Net</a></li> 61<li><a href="os.html" class="nav-os">OS</a></li> 62<li><a href="path.html" class="nav-path">Path</a></li> 63<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 64<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 65<li><a href="process.html" class="nav-process">Process</a></li> 66<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 67<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 68<li><a href="readline.html" class="nav-readline">Readline</a></li> 69<li><a href="repl.html" class="nav-repl">REPL</a></li> 70<li><a href="report.html" class="nav-report">Report</a></li> 71<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 72<li><a href="stream.html" class="nav-stream">Stream</a></li> 73<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 74<li><a href="test.html" class="nav-test">Test runner</a></li> 75<li><a href="timers.html" class="nav-timers">Timers</a></li> 76<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 77<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 78<li><a href="tty.html" class="nav-tty">TTY</a></li> 79<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 80<li><a href="url.html" class="nav-url">URL</a></li> 81<li><a href="util.html" class="nav-util">Utilities</a></li> 82<li><a href="v8.html" class="nav-v8">V8</a></li> 83<li><a href="vm.html" class="nav-vm">VM</a></li> 84<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 85<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 86<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 87<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 88<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 89</ul> 90<hr class="line"> 91<ul> 92<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 93</ul> 94 </div> 95 96 <div id="column1" data-id="crypto" class="interior"> 97 <header class="header"> 98 <div class="header-container"> 99 <h1>Node.js v18.18.2 documentation</h1> 100 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 101 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 102 <path fill="none" d="M0 0h24v24H0z" /> 103 <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 104 <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 105 </svg> 106 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 107 <path d="M0 0h24v24H0z" fill="none" /> 108 <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 109 </svg> 110 </button> 111 </div> 112 <div id="gtoc"> 113 <ul> 114 <li class="pinned-header">Node.js v18.18.2</li> 115 116 <li class="picker-header"> 117 <a href="#"> 118 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 119 Table of contents 120 </a> 121 122 <div class="picker"><div class="toc"><ul> 123<li><span class="stability_2"><a href="#crypto">Crypto</a></span> 124<ul> 125<li><a href="#determining-if-crypto-support-is-unavailable">Determining if crypto support is unavailable</a></li> 126<li><a href="#class-certificate">Class: <code>Certificate</code></a> 127<ul> 128<li><a href="#static-method-certificateexportchallengespkac-encoding">Static method: <code>Certificate.exportChallenge(spkac[, encoding])</code></a></li> 129<li><a href="#static-method-certificateexportpublickeyspkac-encoding">Static method: <code>Certificate.exportPublicKey(spkac[, encoding])</code></a></li> 130<li><a href="#static-method-certificateverifyspkacspkac-encoding">Static method: <code>Certificate.verifySpkac(spkac[, encoding])</code></a></li> 131<li><span class="stability_0"><a href="#legacy-api">Legacy API</a></span> 132<ul> 133<li><a href="#new-cryptocertificate"><code>new crypto.Certificate()</code></a></li> 134<li><a href="#certificateexportchallengespkac-encoding"><code>certificate.exportChallenge(spkac[, encoding])</code></a></li> 135<li><a href="#certificateexportpublickeyspkac-encoding"><code>certificate.exportPublicKey(spkac[, encoding])</code></a></li> 136<li><a href="#certificateverifyspkacspkac-encoding"><code>certificate.verifySpkac(spkac[, encoding])</code></a></li> 137</ul> 138</li> 139</ul> 140</li> 141<li><a href="#class-cipher">Class: <code>Cipher</code></a> 142<ul> 143<li><a href="#cipherfinaloutputencoding"><code>cipher.final([outputEncoding])</code></a></li> 144<li><a href="#ciphergetauthtag"><code>cipher.getAuthTag()</code></a></li> 145<li><a href="#ciphersetaadbuffer-options"><code>cipher.setAAD(buffer[, options])</code></a></li> 146<li><a href="#ciphersetautopaddingautopadding"><code>cipher.setAutoPadding([autoPadding])</code></a></li> 147<li><a href="#cipherupdatedata-inputencoding-outputencoding"><code>cipher.update(data[, inputEncoding][, outputEncoding])</code></a></li> 148</ul> 149</li> 150<li><a href="#class-decipher">Class: <code>Decipher</code></a> 151<ul> 152<li><a href="#decipherfinaloutputencoding"><code>decipher.final([outputEncoding])</code></a></li> 153<li><a href="#deciphersetaadbuffer-options"><code>decipher.setAAD(buffer[, options])</code></a></li> 154<li><a href="#deciphersetauthtagbuffer-encoding"><code>decipher.setAuthTag(buffer[, encoding])</code></a></li> 155<li><a href="#deciphersetautopaddingautopadding"><code>decipher.setAutoPadding([autoPadding])</code></a></li> 156<li><a href="#decipherupdatedata-inputencoding-outputencoding"><code>decipher.update(data[, inputEncoding][, outputEncoding])</code></a></li> 157</ul> 158</li> 159<li><a href="#class-diffiehellman">Class: <code>DiffieHellman</code></a> 160<ul> 161<li><a href="#diffiehellmancomputesecretotherpublickey-inputencoding-outputencoding"><code>diffieHellman.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])</code></a></li> 162<li><a href="#diffiehellmangeneratekeysencoding"><code>diffieHellman.generateKeys([encoding])</code></a></li> 163<li><a href="#diffiehellmangetgeneratorencoding"><code>diffieHellman.getGenerator([encoding])</code></a></li> 164<li><a href="#diffiehellmangetprimeencoding"><code>diffieHellman.getPrime([encoding])</code></a></li> 165<li><a href="#diffiehellmangetprivatekeyencoding"><code>diffieHellman.getPrivateKey([encoding])</code></a></li> 166<li><a href="#diffiehellmangetpublickeyencoding"><code>diffieHellman.getPublicKey([encoding])</code></a></li> 167<li><a href="#diffiehellmansetprivatekeyprivatekey-encoding"><code>diffieHellman.setPrivateKey(privateKey[, encoding])</code></a></li> 168<li><a href="#diffiehellmansetpublickeypublickey-encoding"><code>diffieHellman.setPublicKey(publicKey[, encoding])</code></a></li> 169<li><a href="#diffiehellmanverifyerror"><code>diffieHellman.verifyError</code></a></li> 170</ul> 171</li> 172<li><a href="#class-diffiehellmangroup">Class: <code>DiffieHellmanGroup</code></a></li> 173<li><a href="#class-ecdh">Class: <code>ECDH</code></a> 174<ul> 175<li><a href="#static-method-ecdhconvertkeykey-curve-inputencoding-outputencoding-format">Static method: <code>ECDH.convertKey(key, curve[, inputEncoding[, outputEncoding[, format]]])</code></a></li> 176<li><a href="#ecdhcomputesecretotherpublickey-inputencoding-outputencoding"><code>ecdh.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])</code></a></li> 177<li><a href="#ecdhgeneratekeysencoding-format"><code>ecdh.generateKeys([encoding[, format]])</code></a></li> 178<li><a href="#ecdhgetprivatekeyencoding"><code>ecdh.getPrivateKey([encoding])</code></a></li> 179<li><a href="#ecdhgetpublickeyencoding-format"><code>ecdh.getPublicKey([encoding][, format])</code></a></li> 180<li><a href="#ecdhsetprivatekeyprivatekey-encoding"><code>ecdh.setPrivateKey(privateKey[, encoding])</code></a></li> 181<li><span class="stability_0"><a href="#ecdhsetpublickeypublickey-encoding"><code>ecdh.setPublicKey(publicKey[, encoding])</code></a></span></li> 182</ul> 183</li> 184<li><a href="#class-hash">Class: <code>Hash</code></a> 185<ul> 186<li><a href="#hashcopyoptions"><code>hash.copy([options])</code></a></li> 187<li><a href="#hashdigestencoding"><code>hash.digest([encoding])</code></a></li> 188<li><a href="#hashupdatedata-inputencoding"><code>hash.update(data[, inputEncoding])</code></a></li> 189</ul> 190</li> 191<li><a href="#class-hmac">Class: <code>Hmac</code></a> 192<ul> 193<li><a href="#hmacdigestencoding"><code>hmac.digest([encoding])</code></a></li> 194<li><a href="#hmacupdatedata-inputencoding"><code>hmac.update(data[, inputEncoding])</code></a></li> 195</ul> 196</li> 197<li><a href="#class-keyobject">Class: <code>KeyObject</code></a> 198<ul> 199<li><a href="#static-method-keyobjectfromkey">Static method: <code>KeyObject.from(key)</code></a></li> 200<li><a href="#keyobjectasymmetrickeydetails"><code>keyObject.asymmetricKeyDetails</code></a></li> 201<li><a href="#keyobjectasymmetrickeytype"><code>keyObject.asymmetricKeyType</code></a></li> 202<li><a href="#keyobjectexportoptions"><code>keyObject.export([options])</code></a></li> 203<li><a href="#keyobjectequalsotherkeyobject"><code>keyObject.equals(otherKeyObject)</code></a></li> 204<li><a href="#keyobjectsymmetrickeysize"><code>keyObject.symmetricKeySize</code></a></li> 205<li><a href="#keyobjecttype"><code>keyObject.type</code></a></li> 206</ul> 207</li> 208<li><a href="#class-sign">Class: <code>Sign</code></a> 209<ul> 210<li><a href="#signsignprivatekey-outputencoding"><code>sign.sign(privateKey[, outputEncoding])</code></a></li> 211<li><a href="#signupdatedata-inputencoding"><code>sign.update(data[, inputEncoding])</code></a></li> 212</ul> 213</li> 214<li><a href="#class-verify">Class: <code>Verify</code></a> 215<ul> 216<li><a href="#verifyupdatedata-inputencoding"><code>verify.update(data[, inputEncoding])</code></a></li> 217<li><a href="#verifyverifyobject-signature-signatureencoding"><code>verify.verify(object, signature[, signatureEncoding])</code></a></li> 218</ul> 219</li> 220<li><a href="#class-x509certificate">Class: <code>X509Certificate</code></a> 221<ul> 222<li><a href="#new-x509certificatebuffer"><code>new X509Certificate(buffer)</code></a></li> 223<li><a href="#x509ca"><code>x509.ca</code></a></li> 224<li><a href="#x509checkemailemail-options"><code>x509.checkEmail(email[, options])</code></a></li> 225<li><a href="#x509checkhostname-options"><code>x509.checkHost(name[, options])</code></a></li> 226<li><a href="#x509checkipip"><code>x509.checkIP(ip)</code></a></li> 227<li><a href="#x509checkissuedothercert"><code>x509.checkIssued(otherCert)</code></a></li> 228<li><a href="#x509checkprivatekeyprivatekey"><code>x509.checkPrivateKey(privateKey)</code></a></li> 229<li><a href="#x509fingerprint"><code>x509.fingerprint</code></a></li> 230<li><a href="#x509fingerprint256"><code>x509.fingerprint256</code></a></li> 231<li><a href="#x509fingerprint512"><code>x509.fingerprint512</code></a></li> 232<li><a href="#x509infoaccess"><code>x509.infoAccess</code></a></li> 233<li><a href="#x509issuer"><code>x509.issuer</code></a></li> 234<li><a href="#x509issuercertificate"><code>x509.issuerCertificate</code></a></li> 235<li><a href="#x509keyusage"><code>x509.keyUsage</code></a></li> 236<li><a href="#x509publickey"><code>x509.publicKey</code></a></li> 237<li><a href="#x509raw"><code>x509.raw</code></a></li> 238<li><a href="#x509serialnumber"><code>x509.serialNumber</code></a></li> 239<li><a href="#x509subject"><code>x509.subject</code></a></li> 240<li><a href="#x509subjectaltname"><code>x509.subjectAltName</code></a></li> 241<li><a href="#x509tojson"><code>x509.toJSON()</code></a></li> 242<li><a href="#x509tolegacyobject"><code>x509.toLegacyObject()</code></a></li> 243<li><a href="#x509tostring"><code>x509.toString()</code></a></li> 244<li><a href="#x509validfrom"><code>x509.validFrom</code></a></li> 245<li><a href="#x509validto"><code>x509.validTo</code></a></li> 246<li><a href="#x509verifypublickey"><code>x509.verify(publicKey)</code></a></li> 247</ul> 248</li> 249<li><a href="#nodecrypto-module-methods-and-properties"><code>node:crypto</code> module methods and properties</a> 250<ul> 251<li><a href="#cryptoconstants"><code>crypto.constants</code></a></li> 252<li><span class="stability_0"><a href="#cryptodefault_encoding"><code>crypto.DEFAULT_ENCODING</code></a></span></li> 253<li><span class="stability_0"><a href="#cryptofips"><code>crypto.fips</code></a></span></li> 254<li><a href="#cryptocheckprimecandidate-options-callback"><code>crypto.checkPrime(candidate[, options], callback)</code></a></li> 255<li><a href="#cryptocheckprimesynccandidate-options"><code>crypto.checkPrimeSync(candidate[, options])</code></a></li> 256<li><span class="stability_0"><a href="#cryptocreatecipheralgorithm-password-options"><code>crypto.createCipher(algorithm, password[, options])</code></a></span></li> 257<li><a href="#cryptocreatecipherivalgorithm-key-iv-options"><code>crypto.createCipheriv(algorithm, key, iv[, options])</code></a></li> 258<li><span class="stability_0"><a href="#cryptocreatedecipheralgorithm-password-options"><code>crypto.createDecipher(algorithm, password[, options])</code></a></span></li> 259<li><a href="#cryptocreatedecipherivalgorithm-key-iv-options"><code>crypto.createDecipheriv(algorithm, key, iv[, options])</code></a></li> 260<li><a href="#cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding"><code>crypto.createDiffieHellman(prime[, primeEncoding][, generator][, generatorEncoding])</code></a></li> 261<li><a href="#cryptocreatediffiehellmanprimelength-generator"><code>crypto.createDiffieHellman(primeLength[, generator])</code></a></li> 262<li><a href="#cryptocreatediffiehellmangroupname"><code>crypto.createDiffieHellmanGroup(name)</code></a></li> 263<li><a href="#cryptocreateecdhcurvename"><code>crypto.createECDH(curveName)</code></a></li> 264<li><a href="#cryptocreatehashalgorithm-options"><code>crypto.createHash(algorithm[, options])</code></a></li> 265<li><a href="#cryptocreatehmacalgorithm-key-options"><code>crypto.createHmac(algorithm, key[, options])</code></a></li> 266<li><a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey(key)</code></a></li> 267<li><a href="#cryptocreatepublickeykey"><code>crypto.createPublicKey(key)</code></a></li> 268<li><a href="#cryptocreatesecretkeykey-encoding"><code>crypto.createSecretKey(key[, encoding])</code></a></li> 269<li><a href="#cryptocreatesignalgorithm-options"><code>crypto.createSign(algorithm[, options])</code></a></li> 270<li><a href="#cryptocreateverifyalgorithm-options"><code>crypto.createVerify(algorithm[, options])</code></a></li> 271<li><a href="#cryptodiffiehellmanoptions"><code>crypto.diffieHellman(options)</code></a></li> 272<li><a href="#cryptogeneratekeytype-options-callback"><code>crypto.generateKey(type, options, callback)</code></a></li> 273<li><a href="#cryptogeneratekeypairtype-options-callback"><code>crypto.generateKeyPair(type, options, callback)</code></a></li> 274<li><a href="#cryptogeneratekeypairsynctype-options"><code>crypto.generateKeyPairSync(type, options)</code></a></li> 275<li><a href="#cryptogeneratekeysynctype-options"><code>crypto.generateKeySync(type, options)</code></a></li> 276<li><a href="#cryptogenerateprimesize-options-callback"><code>crypto.generatePrime(size[, options[, callback]])</code></a></li> 277<li><a href="#cryptogenerateprimesyncsize-options"><code>crypto.generatePrimeSync(size[, options])</code></a></li> 278<li><a href="#cryptogetcipherinfonameornid-options"><code>crypto.getCipherInfo(nameOrNid[, options])</code></a></li> 279<li><a href="#cryptogetciphers"><code>crypto.getCiphers()</code></a></li> 280<li><a href="#cryptogetcurves"><code>crypto.getCurves()</code></a></li> 281<li><a href="#cryptogetdiffiehellmangroupname"><code>crypto.getDiffieHellman(groupName)</code></a></li> 282<li><a href="#cryptogetfips"><code>crypto.getFips()</code></a></li> 283<li><a href="#cryptogethashes"><code>crypto.getHashes()</code></a></li> 284<li><a href="#cryptogetrandomvaluestypedarray"><code>crypto.getRandomValues(typedArray)</code></a></li> 285<li><a href="#cryptohkdfdigest-ikm-salt-info-keylen-callback"><code>crypto.hkdf(digest, ikm, salt, info, keylen, callback)</code></a></li> 286<li><a href="#cryptohkdfsyncdigest-ikm-salt-info-keylen"><code>crypto.hkdfSync(digest, ikm, salt, info, keylen)</code></a></li> 287<li><a href="#cryptopbkdf2password-salt-iterations-keylen-digest-callback"><code>crypto.pbkdf2(password, salt, iterations, keylen, digest, callback)</code></a></li> 288<li><a href="#cryptopbkdf2syncpassword-salt-iterations-keylen-digest"><code>crypto.pbkdf2Sync(password, salt, iterations, keylen, digest)</code></a></li> 289<li><a href="#cryptoprivatedecryptprivatekey-buffer"><code>crypto.privateDecrypt(privateKey, buffer)</code></a></li> 290<li><a href="#cryptoprivateencryptprivatekey-buffer"><code>crypto.privateEncrypt(privateKey, buffer)</code></a></li> 291<li><a href="#cryptopublicdecryptkey-buffer"><code>crypto.publicDecrypt(key, buffer)</code></a></li> 292<li><a href="#cryptopublicencryptkey-buffer"><code>crypto.publicEncrypt(key, buffer)</code></a></li> 293<li><a href="#cryptorandombytessize-callback"><code>crypto.randomBytes(size[, callback])</code></a></li> 294<li><a href="#cryptorandomfillsyncbuffer-offset-size"><code>crypto.randomFillSync(buffer[, offset][, size])</code></a></li> 295<li><a href="#cryptorandomfillbuffer-offset-size-callback"><code>crypto.randomFill(buffer[, offset][, size], callback)</code></a></li> 296<li><a href="#cryptorandomintmin-max-callback"><code>crypto.randomInt([min, ]max[, callback])</code></a></li> 297<li><a href="#cryptorandomuuidoptions"><code>crypto.randomUUID([options])</code></a></li> 298<li><a href="#cryptoscryptpassword-salt-keylen-options-callback"><code>crypto.scrypt(password, salt, keylen[, options], callback)</code></a></li> 299<li><a href="#cryptoscryptsyncpassword-salt-keylen-options"><code>crypto.scryptSync(password, salt, keylen[, options])</code></a></li> 300<li><a href="#cryptosecureheapused"><code>crypto.secureHeapUsed()</code></a></li> 301<li><a href="#cryptosetengineengine-flags"><code>crypto.setEngine(engine[, flags])</code></a></li> 302<li><a href="#cryptosetfipsbool"><code>crypto.setFips(bool)</code></a></li> 303<li><a href="#cryptosignalgorithm-data-key-callback"><code>crypto.sign(algorithm, data, key[, callback])</code></a></li> 304<li><a href="#cryptosubtle"><code>crypto.subtle</code></a></li> 305<li><a href="#cryptotimingsafeequala-b"><code>crypto.timingSafeEqual(a, b)</code></a></li> 306<li><a href="#cryptoverifyalgorithm-data-key-signature-callback"><code>crypto.verify(algorithm, data, key, signature[, callback])</code></a></li> 307<li><a href="#cryptowebcrypto"><code>crypto.webcrypto</code></a></li> 308</ul> 309</li> 310<li><a href="#notes">Notes</a> 311<ul> 312<li><a href="#using-strings-as-inputs-to-cryptographic-apis">Using strings as inputs to cryptographic APIs</a></li> 313<li><a href="#legacy-streams-api-prior-to-nodejs-010">Legacy streams API (prior to Node.js 0.10)</a></li> 314<li><a href="#support-for-weak-or-compromised-algorithms">Support for weak or compromised algorithms</a></li> 315<li><a href="#ccm-mode">CCM mode</a></li> 316<li><a href="#fips-mode">FIPS mode</a></li> 317</ul> 318</li> 319<li><a href="#crypto-constants">Crypto constants</a> 320<ul> 321<li><a href="#openssl-options">OpenSSL options</a></li> 322<li><a href="#openssl-engine-constants">OpenSSL engine constants</a></li> 323<li><a href="#other-openssl-constants">Other OpenSSL constants</a></li> 324<li><a href="#nodejs-crypto-constants">Node.js crypto constants</a></li> 325</ul> 326</li> 327</ul> 328</li> 329</ul></div></div> 330 </li> 331 332 333 <li class="picker-header"> 334 <a href="#"> 335 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 336 Index 337 </a> 338 339 <div class="picker"><ul> 340<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 341<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 342 343 <li> 344 <a href="index.html">Index</a> 345 </li> 346 </ul> 347 348<hr class="line"> 349<ul> 350<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 351<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 352<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 353<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 354<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 355<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 356<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 357<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 358<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 359<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 360<li><a href="console.html" class="nav-console">Console</a></li> 361<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 362<li><a href="crypto.html" class="nav-crypto active">Crypto</a></li> 363<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 364<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 365<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 366<li><a href="dns.html" class="nav-dns">DNS</a></li> 367<li><a href="domain.html" class="nav-domain">Domain</a></li> 368<li><a href="errors.html" class="nav-errors">Errors</a></li> 369<li><a href="events.html" class="nav-events">Events</a></li> 370<li><a href="fs.html" class="nav-fs">File system</a></li> 371<li><a href="globals.html" class="nav-globals">Globals</a></li> 372<li><a href="http.html" class="nav-http">HTTP</a></li> 373<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 374<li><a href="https.html" class="nav-https">HTTPS</a></li> 375<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 376<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 377<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 378<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 379<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 380<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 381<li><a href="net.html" class="nav-net">Net</a></li> 382<li><a href="os.html" class="nav-os">OS</a></li> 383<li><a href="path.html" class="nav-path">Path</a></li> 384<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 385<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 386<li><a href="process.html" class="nav-process">Process</a></li> 387<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 388<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 389<li><a href="readline.html" class="nav-readline">Readline</a></li> 390<li><a href="repl.html" class="nav-repl">REPL</a></li> 391<li><a href="report.html" class="nav-report">Report</a></li> 392<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 393<li><a href="stream.html" class="nav-stream">Stream</a></li> 394<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 395<li><a href="test.html" class="nav-test">Test runner</a></li> 396<li><a href="timers.html" class="nav-timers">Timers</a></li> 397<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 398<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 399<li><a href="tty.html" class="nav-tty">TTY</a></li> 400<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 401<li><a href="url.html" class="nav-url">URL</a></li> 402<li><a href="util.html" class="nav-util">Utilities</a></li> 403<li><a href="v8.html" class="nav-v8">V8</a></li> 404<li><a href="vm.html" class="nav-vm">VM</a></li> 405<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 406<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 407<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 408<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 409<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 410</ul> 411<hr class="line"> 412<ul> 413<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 414</ul></div> 415 </li> 416 417 418 <li class="picker-header"> 419 <a href="#"> 420 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 421 Other versions 422 </a> 423 <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v20.x/api/crypto.html">20.x</a></li> 424<li><a href="https://nodejs.org/docs/latest-v19.x/api/crypto.html">19.x</a></li> 425<li><a href="https://nodejs.org/docs/latest-v18.x/api/crypto.html">18.x <b>LTS</b></a></li> 426<li><a href="https://nodejs.org/docs/latest-v17.x/api/crypto.html">17.x</a></li> 427<li><a href="https://nodejs.org/docs/latest-v16.x/api/crypto.html">16.x</a></li> 428<li><a href="https://nodejs.org/docs/latest-v15.x/api/crypto.html">15.x</a></li> 429<li><a href="https://nodejs.org/docs/latest-v14.x/api/crypto.html">14.x</a></li> 430<li><a href="https://nodejs.org/docs/latest-v13.x/api/crypto.html">13.x</a></li> 431<li><a href="https://nodejs.org/docs/latest-v12.x/api/crypto.html">12.x</a></li> 432<li><a href="https://nodejs.org/docs/latest-v11.x/api/crypto.html">11.x</a></li> 433<li><a href="https://nodejs.org/docs/latest-v10.x/api/crypto.html">10.x</a></li> 434<li><a href="https://nodejs.org/docs/latest-v9.x/api/crypto.html">9.x</a></li> 435<li><a href="https://nodejs.org/docs/latest-v8.x/api/crypto.html">8.x</a></li> 436<li><a href="https://nodejs.org/docs/latest-v7.x/api/crypto.html">7.x</a></li> 437<li><a href="https://nodejs.org/docs/latest-v6.x/api/crypto.html">6.x</a></li> 438<li><a href="https://nodejs.org/docs/latest-v5.x/api/crypto.html">5.x</a></li> 439<li><a href="https://nodejs.org/docs/latest-v4.x/api/crypto.html">4.x</a></li> 440<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/crypto.html">0.12.x</a></li> 441<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/crypto.html">0.10.x</a></li></ol></div> 442 </li> 443 444 <li class="picker-header"> 445 <a href="#"> 446 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 447 Options 448 </a> 449 450 <div class="picker"> 451 <ul> 452 <li> 453 <a href="all.html">View on single page</a> 454 </li> 455 <li> 456 <a href="crypto.json">View as JSON</a> 457 </li> 458 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/crypto.md">Edit on GitHub</a></li> 459 </ul> 460 </div> 461 </li> 462 </ul> 463 </div> 464 <hr> 465 </header> 466 467 <details id="toc" open><summary>Table of contents</summary><ul> 468<li><span class="stability_2"><a href="#crypto">Crypto</a></span> 469<ul> 470<li><a href="#determining-if-crypto-support-is-unavailable">Determining if crypto support is unavailable</a></li> 471<li><a href="#class-certificate">Class: <code>Certificate</code></a> 472<ul> 473<li><a href="#static-method-certificateexportchallengespkac-encoding">Static method: <code>Certificate.exportChallenge(spkac[, encoding])</code></a></li> 474<li><a href="#static-method-certificateexportpublickeyspkac-encoding">Static method: <code>Certificate.exportPublicKey(spkac[, encoding])</code></a></li> 475<li><a href="#static-method-certificateverifyspkacspkac-encoding">Static method: <code>Certificate.verifySpkac(spkac[, encoding])</code></a></li> 476<li><span class="stability_0"><a href="#legacy-api">Legacy API</a></span> 477<ul> 478<li><a href="#new-cryptocertificate"><code>new crypto.Certificate()</code></a></li> 479<li><a href="#certificateexportchallengespkac-encoding"><code>certificate.exportChallenge(spkac[, encoding])</code></a></li> 480<li><a href="#certificateexportpublickeyspkac-encoding"><code>certificate.exportPublicKey(spkac[, encoding])</code></a></li> 481<li><a href="#certificateverifyspkacspkac-encoding"><code>certificate.verifySpkac(spkac[, encoding])</code></a></li> 482</ul> 483</li> 484</ul> 485</li> 486<li><a href="#class-cipher">Class: <code>Cipher</code></a> 487<ul> 488<li><a href="#cipherfinaloutputencoding"><code>cipher.final([outputEncoding])</code></a></li> 489<li><a href="#ciphergetauthtag"><code>cipher.getAuthTag()</code></a></li> 490<li><a href="#ciphersetaadbuffer-options"><code>cipher.setAAD(buffer[, options])</code></a></li> 491<li><a href="#ciphersetautopaddingautopadding"><code>cipher.setAutoPadding([autoPadding])</code></a></li> 492<li><a href="#cipherupdatedata-inputencoding-outputencoding"><code>cipher.update(data[, inputEncoding][, outputEncoding])</code></a></li> 493</ul> 494</li> 495<li><a href="#class-decipher">Class: <code>Decipher</code></a> 496<ul> 497<li><a href="#decipherfinaloutputencoding"><code>decipher.final([outputEncoding])</code></a></li> 498<li><a href="#deciphersetaadbuffer-options"><code>decipher.setAAD(buffer[, options])</code></a></li> 499<li><a href="#deciphersetauthtagbuffer-encoding"><code>decipher.setAuthTag(buffer[, encoding])</code></a></li> 500<li><a href="#deciphersetautopaddingautopadding"><code>decipher.setAutoPadding([autoPadding])</code></a></li> 501<li><a href="#decipherupdatedata-inputencoding-outputencoding"><code>decipher.update(data[, inputEncoding][, outputEncoding])</code></a></li> 502</ul> 503</li> 504<li><a href="#class-diffiehellman">Class: <code>DiffieHellman</code></a> 505<ul> 506<li><a href="#diffiehellmancomputesecretotherpublickey-inputencoding-outputencoding"><code>diffieHellman.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])</code></a></li> 507<li><a href="#diffiehellmangeneratekeysencoding"><code>diffieHellman.generateKeys([encoding])</code></a></li> 508<li><a href="#diffiehellmangetgeneratorencoding"><code>diffieHellman.getGenerator([encoding])</code></a></li> 509<li><a href="#diffiehellmangetprimeencoding"><code>diffieHellman.getPrime([encoding])</code></a></li> 510<li><a href="#diffiehellmangetprivatekeyencoding"><code>diffieHellman.getPrivateKey([encoding])</code></a></li> 511<li><a href="#diffiehellmangetpublickeyencoding"><code>diffieHellman.getPublicKey([encoding])</code></a></li> 512<li><a href="#diffiehellmansetprivatekeyprivatekey-encoding"><code>diffieHellman.setPrivateKey(privateKey[, encoding])</code></a></li> 513<li><a href="#diffiehellmansetpublickeypublickey-encoding"><code>diffieHellman.setPublicKey(publicKey[, encoding])</code></a></li> 514<li><a href="#diffiehellmanverifyerror"><code>diffieHellman.verifyError</code></a></li> 515</ul> 516</li> 517<li><a href="#class-diffiehellmangroup">Class: <code>DiffieHellmanGroup</code></a></li> 518<li><a href="#class-ecdh">Class: <code>ECDH</code></a> 519<ul> 520<li><a href="#static-method-ecdhconvertkeykey-curve-inputencoding-outputencoding-format">Static method: <code>ECDH.convertKey(key, curve[, inputEncoding[, outputEncoding[, format]]])</code></a></li> 521<li><a href="#ecdhcomputesecretotherpublickey-inputencoding-outputencoding"><code>ecdh.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])</code></a></li> 522<li><a href="#ecdhgeneratekeysencoding-format"><code>ecdh.generateKeys([encoding[, format]])</code></a></li> 523<li><a href="#ecdhgetprivatekeyencoding"><code>ecdh.getPrivateKey([encoding])</code></a></li> 524<li><a href="#ecdhgetpublickeyencoding-format"><code>ecdh.getPublicKey([encoding][, format])</code></a></li> 525<li><a href="#ecdhsetprivatekeyprivatekey-encoding"><code>ecdh.setPrivateKey(privateKey[, encoding])</code></a></li> 526<li><span class="stability_0"><a href="#ecdhsetpublickeypublickey-encoding"><code>ecdh.setPublicKey(publicKey[, encoding])</code></a></span></li> 527</ul> 528</li> 529<li><a href="#class-hash">Class: <code>Hash</code></a> 530<ul> 531<li><a href="#hashcopyoptions"><code>hash.copy([options])</code></a></li> 532<li><a href="#hashdigestencoding"><code>hash.digest([encoding])</code></a></li> 533<li><a href="#hashupdatedata-inputencoding"><code>hash.update(data[, inputEncoding])</code></a></li> 534</ul> 535</li> 536<li><a href="#class-hmac">Class: <code>Hmac</code></a> 537<ul> 538<li><a href="#hmacdigestencoding"><code>hmac.digest([encoding])</code></a></li> 539<li><a href="#hmacupdatedata-inputencoding"><code>hmac.update(data[, inputEncoding])</code></a></li> 540</ul> 541</li> 542<li><a href="#class-keyobject">Class: <code>KeyObject</code></a> 543<ul> 544<li><a href="#static-method-keyobjectfromkey">Static method: <code>KeyObject.from(key)</code></a></li> 545<li><a href="#keyobjectasymmetrickeydetails"><code>keyObject.asymmetricKeyDetails</code></a></li> 546<li><a href="#keyobjectasymmetrickeytype"><code>keyObject.asymmetricKeyType</code></a></li> 547<li><a href="#keyobjectexportoptions"><code>keyObject.export([options])</code></a></li> 548<li><a href="#keyobjectequalsotherkeyobject"><code>keyObject.equals(otherKeyObject)</code></a></li> 549<li><a href="#keyobjectsymmetrickeysize"><code>keyObject.symmetricKeySize</code></a></li> 550<li><a href="#keyobjecttype"><code>keyObject.type</code></a></li> 551</ul> 552</li> 553<li><a href="#class-sign">Class: <code>Sign</code></a> 554<ul> 555<li><a href="#signsignprivatekey-outputencoding"><code>sign.sign(privateKey[, outputEncoding])</code></a></li> 556<li><a href="#signupdatedata-inputencoding"><code>sign.update(data[, inputEncoding])</code></a></li> 557</ul> 558</li> 559<li><a href="#class-verify">Class: <code>Verify</code></a> 560<ul> 561<li><a href="#verifyupdatedata-inputencoding"><code>verify.update(data[, inputEncoding])</code></a></li> 562<li><a href="#verifyverifyobject-signature-signatureencoding"><code>verify.verify(object, signature[, signatureEncoding])</code></a></li> 563</ul> 564</li> 565<li><a href="#class-x509certificate">Class: <code>X509Certificate</code></a> 566<ul> 567<li><a href="#new-x509certificatebuffer"><code>new X509Certificate(buffer)</code></a></li> 568<li><a href="#x509ca"><code>x509.ca</code></a></li> 569<li><a href="#x509checkemailemail-options"><code>x509.checkEmail(email[, options])</code></a></li> 570<li><a href="#x509checkhostname-options"><code>x509.checkHost(name[, options])</code></a></li> 571<li><a href="#x509checkipip"><code>x509.checkIP(ip)</code></a></li> 572<li><a href="#x509checkissuedothercert"><code>x509.checkIssued(otherCert)</code></a></li> 573<li><a href="#x509checkprivatekeyprivatekey"><code>x509.checkPrivateKey(privateKey)</code></a></li> 574<li><a href="#x509fingerprint"><code>x509.fingerprint</code></a></li> 575<li><a href="#x509fingerprint256"><code>x509.fingerprint256</code></a></li> 576<li><a href="#x509fingerprint512"><code>x509.fingerprint512</code></a></li> 577<li><a href="#x509infoaccess"><code>x509.infoAccess</code></a></li> 578<li><a href="#x509issuer"><code>x509.issuer</code></a></li> 579<li><a href="#x509issuercertificate"><code>x509.issuerCertificate</code></a></li> 580<li><a href="#x509keyusage"><code>x509.keyUsage</code></a></li> 581<li><a href="#x509publickey"><code>x509.publicKey</code></a></li> 582<li><a href="#x509raw"><code>x509.raw</code></a></li> 583<li><a href="#x509serialnumber"><code>x509.serialNumber</code></a></li> 584<li><a href="#x509subject"><code>x509.subject</code></a></li> 585<li><a href="#x509subjectaltname"><code>x509.subjectAltName</code></a></li> 586<li><a href="#x509tojson"><code>x509.toJSON()</code></a></li> 587<li><a href="#x509tolegacyobject"><code>x509.toLegacyObject()</code></a></li> 588<li><a href="#x509tostring"><code>x509.toString()</code></a></li> 589<li><a href="#x509validfrom"><code>x509.validFrom</code></a></li> 590<li><a href="#x509validto"><code>x509.validTo</code></a></li> 591<li><a href="#x509verifypublickey"><code>x509.verify(publicKey)</code></a></li> 592</ul> 593</li> 594<li><a href="#nodecrypto-module-methods-and-properties"><code>node:crypto</code> module methods and properties</a> 595<ul> 596<li><a href="#cryptoconstants"><code>crypto.constants</code></a></li> 597<li><span class="stability_0"><a href="#cryptodefault_encoding"><code>crypto.DEFAULT_ENCODING</code></a></span></li> 598<li><span class="stability_0"><a href="#cryptofips"><code>crypto.fips</code></a></span></li> 599<li><a href="#cryptocheckprimecandidate-options-callback"><code>crypto.checkPrime(candidate[, options], callback)</code></a></li> 600<li><a href="#cryptocheckprimesynccandidate-options"><code>crypto.checkPrimeSync(candidate[, options])</code></a></li> 601<li><span class="stability_0"><a href="#cryptocreatecipheralgorithm-password-options"><code>crypto.createCipher(algorithm, password[, options])</code></a></span></li> 602<li><a href="#cryptocreatecipherivalgorithm-key-iv-options"><code>crypto.createCipheriv(algorithm, key, iv[, options])</code></a></li> 603<li><span class="stability_0"><a href="#cryptocreatedecipheralgorithm-password-options"><code>crypto.createDecipher(algorithm, password[, options])</code></a></span></li> 604<li><a href="#cryptocreatedecipherivalgorithm-key-iv-options"><code>crypto.createDecipheriv(algorithm, key, iv[, options])</code></a></li> 605<li><a href="#cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding"><code>crypto.createDiffieHellman(prime[, primeEncoding][, generator][, generatorEncoding])</code></a></li> 606<li><a href="#cryptocreatediffiehellmanprimelength-generator"><code>crypto.createDiffieHellman(primeLength[, generator])</code></a></li> 607<li><a href="#cryptocreatediffiehellmangroupname"><code>crypto.createDiffieHellmanGroup(name)</code></a></li> 608<li><a href="#cryptocreateecdhcurvename"><code>crypto.createECDH(curveName)</code></a></li> 609<li><a href="#cryptocreatehashalgorithm-options"><code>crypto.createHash(algorithm[, options])</code></a></li> 610<li><a href="#cryptocreatehmacalgorithm-key-options"><code>crypto.createHmac(algorithm, key[, options])</code></a></li> 611<li><a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey(key)</code></a></li> 612<li><a href="#cryptocreatepublickeykey"><code>crypto.createPublicKey(key)</code></a></li> 613<li><a href="#cryptocreatesecretkeykey-encoding"><code>crypto.createSecretKey(key[, encoding])</code></a></li> 614<li><a href="#cryptocreatesignalgorithm-options"><code>crypto.createSign(algorithm[, options])</code></a></li> 615<li><a href="#cryptocreateverifyalgorithm-options"><code>crypto.createVerify(algorithm[, options])</code></a></li> 616<li><a href="#cryptodiffiehellmanoptions"><code>crypto.diffieHellman(options)</code></a></li> 617<li><a href="#cryptogeneratekeytype-options-callback"><code>crypto.generateKey(type, options, callback)</code></a></li> 618<li><a href="#cryptogeneratekeypairtype-options-callback"><code>crypto.generateKeyPair(type, options, callback)</code></a></li> 619<li><a href="#cryptogeneratekeypairsynctype-options"><code>crypto.generateKeyPairSync(type, options)</code></a></li> 620<li><a href="#cryptogeneratekeysynctype-options"><code>crypto.generateKeySync(type, options)</code></a></li> 621<li><a href="#cryptogenerateprimesize-options-callback"><code>crypto.generatePrime(size[, options[, callback]])</code></a></li> 622<li><a href="#cryptogenerateprimesyncsize-options"><code>crypto.generatePrimeSync(size[, options])</code></a></li> 623<li><a href="#cryptogetcipherinfonameornid-options"><code>crypto.getCipherInfo(nameOrNid[, options])</code></a></li> 624<li><a href="#cryptogetciphers"><code>crypto.getCiphers()</code></a></li> 625<li><a href="#cryptogetcurves"><code>crypto.getCurves()</code></a></li> 626<li><a href="#cryptogetdiffiehellmangroupname"><code>crypto.getDiffieHellman(groupName)</code></a></li> 627<li><a href="#cryptogetfips"><code>crypto.getFips()</code></a></li> 628<li><a href="#cryptogethashes"><code>crypto.getHashes()</code></a></li> 629<li><a href="#cryptogetrandomvaluestypedarray"><code>crypto.getRandomValues(typedArray)</code></a></li> 630<li><a href="#cryptohkdfdigest-ikm-salt-info-keylen-callback"><code>crypto.hkdf(digest, ikm, salt, info, keylen, callback)</code></a></li> 631<li><a href="#cryptohkdfsyncdigest-ikm-salt-info-keylen"><code>crypto.hkdfSync(digest, ikm, salt, info, keylen)</code></a></li> 632<li><a href="#cryptopbkdf2password-salt-iterations-keylen-digest-callback"><code>crypto.pbkdf2(password, salt, iterations, keylen, digest, callback)</code></a></li> 633<li><a href="#cryptopbkdf2syncpassword-salt-iterations-keylen-digest"><code>crypto.pbkdf2Sync(password, salt, iterations, keylen, digest)</code></a></li> 634<li><a href="#cryptoprivatedecryptprivatekey-buffer"><code>crypto.privateDecrypt(privateKey, buffer)</code></a></li> 635<li><a href="#cryptoprivateencryptprivatekey-buffer"><code>crypto.privateEncrypt(privateKey, buffer)</code></a></li> 636<li><a href="#cryptopublicdecryptkey-buffer"><code>crypto.publicDecrypt(key, buffer)</code></a></li> 637<li><a href="#cryptopublicencryptkey-buffer"><code>crypto.publicEncrypt(key, buffer)</code></a></li> 638<li><a href="#cryptorandombytessize-callback"><code>crypto.randomBytes(size[, callback])</code></a></li> 639<li><a href="#cryptorandomfillsyncbuffer-offset-size"><code>crypto.randomFillSync(buffer[, offset][, size])</code></a></li> 640<li><a href="#cryptorandomfillbuffer-offset-size-callback"><code>crypto.randomFill(buffer[, offset][, size], callback)</code></a></li> 641<li><a href="#cryptorandomintmin-max-callback"><code>crypto.randomInt([min, ]max[, callback])</code></a></li> 642<li><a href="#cryptorandomuuidoptions"><code>crypto.randomUUID([options])</code></a></li> 643<li><a href="#cryptoscryptpassword-salt-keylen-options-callback"><code>crypto.scrypt(password, salt, keylen[, options], callback)</code></a></li> 644<li><a href="#cryptoscryptsyncpassword-salt-keylen-options"><code>crypto.scryptSync(password, salt, keylen[, options])</code></a></li> 645<li><a href="#cryptosecureheapused"><code>crypto.secureHeapUsed()</code></a></li> 646<li><a href="#cryptosetengineengine-flags"><code>crypto.setEngine(engine[, flags])</code></a></li> 647<li><a href="#cryptosetfipsbool"><code>crypto.setFips(bool)</code></a></li> 648<li><a href="#cryptosignalgorithm-data-key-callback"><code>crypto.sign(algorithm, data, key[, callback])</code></a></li> 649<li><a href="#cryptosubtle"><code>crypto.subtle</code></a></li> 650<li><a href="#cryptotimingsafeequala-b"><code>crypto.timingSafeEqual(a, b)</code></a></li> 651<li><a href="#cryptoverifyalgorithm-data-key-signature-callback"><code>crypto.verify(algorithm, data, key, signature[, callback])</code></a></li> 652<li><a href="#cryptowebcrypto"><code>crypto.webcrypto</code></a></li> 653</ul> 654</li> 655<li><a href="#notes">Notes</a> 656<ul> 657<li><a href="#using-strings-as-inputs-to-cryptographic-apis">Using strings as inputs to cryptographic APIs</a></li> 658<li><a href="#legacy-streams-api-prior-to-nodejs-010">Legacy streams API (prior to Node.js 0.10)</a></li> 659<li><a href="#support-for-weak-or-compromised-algorithms">Support for weak or compromised algorithms</a></li> 660<li><a href="#ccm-mode">CCM mode</a></li> 661<li><a href="#fips-mode">FIPS mode</a></li> 662</ul> 663</li> 664<li><a href="#crypto-constants">Crypto constants</a> 665<ul> 666<li><a href="#openssl-options">OpenSSL options</a></li> 667<li><a href="#openssl-engine-constants">OpenSSL engine constants</a></li> 668<li><a href="#other-openssl-constants">Other OpenSSL constants</a></li> 669<li><a href="#nodejs-crypto-constants">Node.js crypto constants</a></li> 670</ul> 671</li> 672</ul> 673</li> 674</ul></details> 675 676 <div id="apicontent"> 677 <h2>Crypto<span><a class="mark" href="#crypto" id="crypto">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto"></a></h2> 678 679<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 680<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.18.2/lib/crypto.js">lib/crypto.js</a></p> 681<p>The <code>node:crypto</code> module provides cryptographic functionality that includes a 682set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify 683functions.</p> 684 685<pre class="with-51-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { createHmac } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 686 687<span class="hljs-keyword">const</span> secret = <span class="hljs-string">'abcdefg'</span>; 688<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, secret) 689 .<span class="hljs-title function_">update</span>(<span class="hljs-string">'I love cupcakes'</span>) 690 .<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>); 691<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash); 692<span class="hljs-comment">// Prints:</span> 693<span class="hljs-comment">// c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { createHmac } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 694 695<span class="hljs-keyword">const</span> secret = <span class="hljs-string">'abcdefg'</span>; 696<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, secret) 697 .<span class="hljs-title function_">update</span>(<span class="hljs-string">'I love cupcakes'</span>) 698 .<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>); 699<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash); 700<span class="hljs-comment">// Prints:</span> 701<span class="hljs-comment">// c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e</span></code><button class="copy-button">copy</button></pre> 702<section><h3>Determining if crypto support is unavailable<span><a class="mark" href="#determining-if-crypto-support-is-unavailable" id="determining-if-crypto-support-is-unavailable">#</a></span><a aria-hidden="true" class="legacy" id="crypto_determining_if_crypto_support_is_unavailable"></a></h3> 703<p>It is possible for Node.js to be built without including support for the 704<code>node:crypto</code> module. In such cases, attempting to <code>import</code> from <code>crypto</code> or 705calling <code>require('node:crypto')</code> will result in an error being thrown.</p> 706<p>When using CommonJS, the error thrown can be caught using try/catch:</p> 707<!-- eslint-skip --> 708<pre><code class="language-js cjs"><span class="hljs-keyword">let</span> crypto; 709<span class="hljs-keyword">try</span> { 710 crypto = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 711} <span class="hljs-keyword">catch</span> (err) { 712 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'crypto support is disabled!'</span>); 713}</code> <button class="copy-button">copy</button></pre> 714<p>When using the lexical ESM <code>import</code> keyword, the error can only be 715caught if a handler for <code>process.on('uncaughtException')</code> is registered 716<em>before</em> any attempt to load the module is made (using, for instance, 717a preload module).</p> 718<p>When using ESM, if there is a chance that the code may be run on a build 719of Node.js where crypto support is not enabled, consider using the 720<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> 721<pre><code class="language-js mjs"><span class="hljs-keyword">let</span> crypto; 722<span class="hljs-keyword">try</span> { 723 crypto = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 724} <span class="hljs-keyword">catch</span> (err) { 725 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'crypto support is disabled!'</span>); 726}</code> <button class="copy-button">copy</button></pre> 727</section><section><h3>Class: <code>Certificate</code><span><a class="mark" href="#class-certificate" id="class-certificate">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_certificate"></a></h3> 728<div class="api_metadata"> 729<span>Added in: v0.11.8</span> 730</div> 731<p>SPKAC is a Certificate Signing Request mechanism originally implemented by 732Netscape and was specified formally as part of HTML5's <code>keygen</code> element.</p> 733<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 734should not use this element anymore.</p> 735<p>The <code>node:crypto</code> module provides the <code>Certificate</code> class for working with SPKAC 736data. The most common usage is handling output generated by the HTML5 737<code><keygen></code> element. Node.js uses <a href="https://www.openssl.org/docs/man3.0/man1/openssl-spkac.html">OpenSSL's SPKAC implementation</a> internally.</p> 738<h4>Static method: <code>Certificate.exportChallenge(spkac[, encoding])</code><span><a class="mark" href="#static-method-certificateexportchallengespkac-encoding" id="static-method-certificateexportchallengespkac-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_static_method_certificate_exportchallenge_spkac_encoding"></a></h4> 739<div class="api_metadata"> 740<details class="changelog"><summary>History</summary> 741<table> 742<tbody><tr><th>Version</th><th>Changes</th></tr> 743<tr><td>v15.0.0</td> 744<td><p>The spkac argument can be an ArrayBuffer. Limited the size of the spkac argument to a maximum of 2**31 - 1 bytes.</p></td></tr> 745<tr><td>v9.0.0</td> 746<td><p><span>Added in: v9.0.0</span></p></td></tr> 747</tbody></table> 748</details> 749</div> 750<ul> 751<li><code>spkac</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> 752<li><code>encoding</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>spkac</code> string.</li> 753<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> The challenge component of the <code>spkac</code> data structure, which 754includes a public key and a challenge.</li> 755</ul> 756 757<pre class="with-52-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 758<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 759<span class="hljs-keyword">const</span> challenge = <span class="hljs-title class_">Certificate</span>.<span class="hljs-title function_">exportChallenge</span>(spkac); 760<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(challenge.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'utf8'</span>)); 761<span class="hljs-comment">// Prints: the challenge as a UTF8 string</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 762<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 763<span class="hljs-keyword">const</span> challenge = <span class="hljs-title class_">Certificate</span>.<span class="hljs-title function_">exportChallenge</span>(spkac); 764<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(challenge.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'utf8'</span>)); 765<span class="hljs-comment">// Prints: the challenge as a UTF8 string</span></code><button class="copy-button">copy</button></pre> 766<h4>Static method: <code>Certificate.exportPublicKey(spkac[, encoding])</code><span><a class="mark" href="#static-method-certificateexportpublickeyspkac-encoding" id="static-method-certificateexportpublickeyspkac-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_static_method_certificate_exportpublickey_spkac_encoding"></a></h4> 767<div class="api_metadata"> 768<details class="changelog"><summary>History</summary> 769<table> 770<tbody><tr><th>Version</th><th>Changes</th></tr> 771<tr><td>v15.0.0</td> 772<td><p>The spkac argument can be an ArrayBuffer. Limited the size of the spkac argument to a maximum of 2**31 - 1 bytes.</p></td></tr> 773<tr><td>v9.0.0</td> 774<td><p><span>Added in: v9.0.0</span></p></td></tr> 775</tbody></table> 776</details> 777</div> 778<ul> 779<li><code>spkac</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> 780<li><code>encoding</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>spkac</code> string.</li> 781<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> The public key component of the <code>spkac</code> data structure, 782which includes a public key and a challenge.</li> 783</ul> 784 785<pre class="with-52-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 786<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 787<span class="hljs-keyword">const</span> publicKey = <span class="hljs-title class_">Certificate</span>.<span class="hljs-title function_">exportPublicKey</span>(spkac); 788<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(publicKey); 789<span class="hljs-comment">// Prints: the public key as <Buffer ...></span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 790<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 791<span class="hljs-keyword">const</span> publicKey = <span class="hljs-title class_">Certificate</span>.<span class="hljs-title function_">exportPublicKey</span>(spkac); 792<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(publicKey); 793<span class="hljs-comment">// Prints: the public key as <Buffer ...></span></code><button class="copy-button">copy</button></pre> 794<h4>Static method: <code>Certificate.verifySpkac(spkac[, encoding])</code><span><a class="mark" href="#static-method-certificateverifyspkacspkac-encoding" id="static-method-certificateverifyspkacspkac-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_static_method_certificate_verifyspkac_spkac_encoding"></a></h4> 795<div class="api_metadata"> 796<details class="changelog"><summary>History</summary> 797<table> 798<tbody><tr><th>Version</th><th>Changes</th></tr> 799<tr><td>v15.0.0</td> 800<td><p>The spkac argument can be an ArrayBuffer. Added encoding. Limited the size of the spkac argument to a maximum of 2**31 - 1 bytes.</p></td></tr> 801<tr><td>v9.0.0</td> 802<td><p><span>Added in: v9.0.0</span></p></td></tr> 803</tbody></table> 804</details> 805</div> 806<ul> 807<li><code>spkac</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> 808<li><code>encoding</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>spkac</code> string.</li> 809<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> if the given <code>spkac</code> data structure is valid, 810<code>false</code> otherwise.</li> 811</ul> 812 813<pre class="with-52-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 814<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 815 816<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 817<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Certificate</span>.<span class="hljs-title function_">verifySpkac</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(spkac))); 818<span class="hljs-comment">// Prints: true or false</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 819<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 820 821<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 822<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Certificate</span>.<span class="hljs-title function_">verifySpkac</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(spkac))); 823<span class="hljs-comment">// Prints: true or false</span></code><button class="copy-button">copy</button></pre> 824<h4>Legacy API<span><a class="mark" href="#legacy-api" id="legacy-api">#</a></span><a aria-hidden="true" class="legacy" id="crypto_legacy_api"></a></h4> 825<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated</div><p></p> 826<p>As a legacy interface, it is possible to create new instances of 827the <code>crypto.Certificate</code> class as illustrated in the examples below.</p> 828<h5><code>new crypto.Certificate()</code><span><a class="mark" href="#new-cryptocertificate" id="new-cryptocertificate">#</a></span><a aria-hidden="true" class="legacy" id="crypto_new_crypto_certificate"></a></h5> 829<p>Instances of the <code>Certificate</code> class can be created using the <code>new</code> keyword 830or by calling <code>crypto.Certificate()</code> as a function:</p> 831 832<pre class="with-52-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 833 834<span class="hljs-keyword">const</span> cert1 = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Certificate</span>(); 835<span class="hljs-keyword">const</span> cert2 = <span class="hljs-title class_">Certificate</span>();</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 836 837<span class="hljs-keyword">const</span> cert1 = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Certificate</span>(); 838<span class="hljs-keyword">const</span> cert2 = <span class="hljs-title class_">Certificate</span>();</code><button class="copy-button">copy</button></pre> 839<h5><code>certificate.exportChallenge(spkac[, encoding])</code><span><a class="mark" href="#certificateexportchallengespkac-encoding" id="certificateexportchallengespkac-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_certificate_exportchallenge_spkac_encoding"></a></h5> 840<div class="api_metadata"> 841<span>Added in: v0.11.8</span> 842</div> 843<ul> 844<li><code>spkac</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> 845<li><code>encoding</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>spkac</code> string.</li> 846<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> The challenge component of the <code>spkac</code> data structure, which 847includes a public key and a challenge.</li> 848</ul> 849 850<pre class="with-52-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 851<span class="hljs-keyword">const</span> cert = <span class="hljs-title class_">Certificate</span>(); 852<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 853<span class="hljs-keyword">const</span> challenge = cert.<span class="hljs-title function_">exportChallenge</span>(spkac); 854<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(challenge.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'utf8'</span>)); 855<span class="hljs-comment">// Prints: the challenge as a UTF8 string</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 856<span class="hljs-keyword">const</span> cert = <span class="hljs-title class_">Certificate</span>(); 857<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 858<span class="hljs-keyword">const</span> challenge = cert.<span class="hljs-title function_">exportChallenge</span>(spkac); 859<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(challenge.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'utf8'</span>)); 860<span class="hljs-comment">// Prints: the challenge as a UTF8 string</span></code><button class="copy-button">copy</button></pre> 861<h5><code>certificate.exportPublicKey(spkac[, encoding])</code><span><a class="mark" href="#certificateexportpublickeyspkac-encoding" id="certificateexportpublickeyspkac-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_certificate_exportpublickey_spkac_encoding"></a></h5> 862<div class="api_metadata"> 863<span>Added in: v0.11.8</span> 864</div> 865<ul> 866<li><code>spkac</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> 867<li><code>encoding</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>spkac</code> string.</li> 868<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> The public key component of the <code>spkac</code> data structure, 869which includes a public key and a challenge.</li> 870</ul> 871 872<pre class="with-52-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 873<span class="hljs-keyword">const</span> cert = <span class="hljs-title class_">Certificate</span>(); 874<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 875<span class="hljs-keyword">const</span> publicKey = cert.<span class="hljs-title function_">exportPublicKey</span>(spkac); 876<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(publicKey); 877<span class="hljs-comment">// Prints: the public key as <Buffer ...></span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 878<span class="hljs-keyword">const</span> cert = <span class="hljs-title class_">Certificate</span>(); 879<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 880<span class="hljs-keyword">const</span> publicKey = cert.<span class="hljs-title function_">exportPublicKey</span>(spkac); 881<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(publicKey); 882<span class="hljs-comment">// Prints: the public key as <Buffer ...></span></code><button class="copy-button">copy</button></pre> 883<h5><code>certificate.verifySpkac(spkac[, encoding])</code><span><a class="mark" href="#certificateverifyspkacspkac-encoding" id="certificateverifyspkacspkac-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_certificate_verifyspkac_spkac_encoding"></a></h5> 884<div class="api_metadata"> 885<span>Added in: v0.11.8</span> 886</div> 887<ul> 888<li><code>spkac</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> 889<li><code>encoding</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>spkac</code> string.</li> 890<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> if the given <code>spkac</code> data structure is valid, 891<code>false</code> otherwise.</li> 892</ul> 893 894<pre class="with-52-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 895<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 896 897<span class="hljs-keyword">const</span> cert = <span class="hljs-title class_">Certificate</span>(); 898<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 899<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(cert.<span class="hljs-title function_">verifySpkac</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(spkac))); 900<span class="hljs-comment">// Prints: true or false</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 901<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Certificate</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 902 903<span class="hljs-keyword">const</span> cert = <span class="hljs-title class_">Certificate</span>(); 904<span class="hljs-keyword">const</span> spkac = <span class="hljs-title function_">getSpkacSomehow</span>(); 905<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(cert.<span class="hljs-title function_">verifySpkac</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(spkac))); 906<span class="hljs-comment">// Prints: true or false</span></code><button class="copy-button">copy</button></pre> 907</section><section><h3>Class: <code>Cipher</code><span><a class="mark" href="#class-cipher" id="class-cipher">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_cipher"></a></h3> 908<div class="api_metadata"> 909<span>Added in: v0.1.94</span> 910</div> 911<ul> 912<li>Extends: <a href="stream.html#class-streamtransform" class="type"><stream.Transform></a></li> 913</ul> 914<p>Instances of the <code>Cipher</code> class are used to encrypt data. The class can be 915used in one of two ways:</p> 916<ul> 917<li>As a <a href="stream.html">stream</a> that is both readable and writable, where plain unencrypted 918data is written to produce encrypted data on the readable side, or</li> 919<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 920the encrypted data.</li> 921</ul> 922<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 923used to create <code>Cipher</code> instances. <code>Cipher</code> objects are not to be created 924directly using the <code>new</code> keyword.</p> 925<p>Example: Using <code>Cipher</code> objects as streams:</p> 926 927<pre class="with-9-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 928 scrypt, 929 randomFill, 930 createCipheriv, 931} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 932 933<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 934<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 935 936<span class="hljs-comment">// First, we'll generate the key. The key length is dependent on the algorithm.</span> 937<span class="hljs-comment">// In this case for aes192, it is 24 bytes (192 bits).</span> 938<span class="hljs-title function_">scrypt</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 939 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 940 <span class="hljs-comment">// Then, we'll generate a random initialization vector</span> 941 <span class="hljs-title function_">randomFill</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint8Array</span>(<span class="hljs-number">16</span>), <span class="hljs-function">(<span class="hljs-params">err, iv</span>) =></span> { 942 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 943 944 <span class="hljs-comment">// Once we have the key and iv, we can create and use the cipher...</span> 945 <span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(algorithm, key, iv); 946 947 <span class="hljs-keyword">let</span> encrypted = <span class="hljs-string">''</span>; 948 cipher.<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'hex'</span>); 949 950 cipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> encrypted += chunk); 951 cipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(encrypted)); 952 953 cipher.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some clear text data'</span>); 954 cipher.<span class="hljs-title function_">end</span>(); 955 }); 956});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 957 scrypt, 958 randomFill, 959 createCipheriv, 960} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 961 962<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 963<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 964 965<span class="hljs-comment">// First, we'll generate the key. The key length is dependent on the algorithm.</span> 966<span class="hljs-comment">// In this case for aes192, it is 24 bytes (192 bits).</span> 967<span class="hljs-title function_">scrypt</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 968 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 969 <span class="hljs-comment">// Then, we'll generate a random initialization vector</span> 970 <span class="hljs-title function_">randomFill</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint8Array</span>(<span class="hljs-number">16</span>), <span class="hljs-function">(<span class="hljs-params">err, iv</span>) =></span> { 971 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 972 973 <span class="hljs-comment">// Once we have the key and iv, we can create and use the cipher...</span> 974 <span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(algorithm, key, iv); 975 976 <span class="hljs-keyword">let</span> encrypted = <span class="hljs-string">''</span>; 977 cipher.<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'hex'</span>); 978 979 cipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> encrypted += chunk); 980 cipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(encrypted)); 981 982 cipher.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some clear text data'</span>); 983 cipher.<span class="hljs-title function_">end</span>(); 984 }); 985});</code><button class="copy-button">copy</button></pre> 986<p>Example: Using <code>Cipher</code> and piped streams:</p> 987 988<pre class="with-19-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 989 createReadStream, 990 createWriteStream, 991} <span class="hljs-keyword">from</span> <span class="hljs-string">'node:fs'</span>; 992 993<span class="hljs-keyword">import</span> { 994 pipeline, 995} <span class="hljs-keyword">from</span> <span class="hljs-string">'node:stream'</span>; 996 997<span class="hljs-keyword">const</span> { 998 scrypt, 999 randomFill, 1000 createCipheriv, 1001} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1002 1003<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1004<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1005 1006<span class="hljs-comment">// First, we'll generate the key. The key length is dependent on the algorithm.</span> 1007<span class="hljs-comment">// In this case for aes192, it is 24 bytes (192 bits).</span> 1008<span class="hljs-title function_">scrypt</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 1009 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1010 <span class="hljs-comment">// Then, we'll generate a random initialization vector</span> 1011 <span class="hljs-title function_">randomFill</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint8Array</span>(<span class="hljs-number">16</span>), <span class="hljs-function">(<span class="hljs-params">err, iv</span>) =></span> { 1012 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1013 1014 <span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(algorithm, key, iv); 1015 1016 <span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.js'</span>); 1017 <span class="hljs-keyword">const</span> output = <span class="hljs-title function_">createWriteStream</span>(<span class="hljs-string">'test.enc'</span>); 1018 1019 <span class="hljs-title function_">pipeline</span>(input, cipher, output, <span class="hljs-function">(<span class="hljs-params">err</span>) =></span> { 1020 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1021 }); 1022 }); 1023});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 1024 createReadStream, 1025 createWriteStream, 1026} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 1027 1028<span class="hljs-keyword">const</span> { 1029 pipeline, 1030} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:stream'</span>); 1031 1032<span class="hljs-keyword">const</span> { 1033 scrypt, 1034 randomFill, 1035 createCipheriv, 1036} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1037 1038<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1039<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1040 1041<span class="hljs-comment">// First, we'll generate the key. The key length is dependent on the algorithm.</span> 1042<span class="hljs-comment">// In this case for aes192, it is 24 bytes (192 bits).</span> 1043<span class="hljs-title function_">scrypt</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 1044 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1045 <span class="hljs-comment">// Then, we'll generate a random initialization vector</span> 1046 <span class="hljs-title function_">randomFill</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint8Array</span>(<span class="hljs-number">16</span>), <span class="hljs-function">(<span class="hljs-params">err, iv</span>) =></span> { 1047 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1048 1049 <span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(algorithm, key, iv); 1050 1051 <span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.js'</span>); 1052 <span class="hljs-keyword">const</span> output = <span class="hljs-title function_">createWriteStream</span>(<span class="hljs-string">'test.enc'</span>); 1053 1054 <span class="hljs-title function_">pipeline</span>(input, cipher, output, <span class="hljs-function">(<span class="hljs-params">err</span>) =></span> { 1055 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1056 }); 1057 }); 1058});</code><button class="copy-button">copy</button></pre> 1059<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> 1060 1061<pre class="with-9-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 1062 scrypt, 1063 randomFill, 1064 createCipheriv, 1065} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1066 1067<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1068<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1069 1070<span class="hljs-comment">// First, we'll generate the key. The key length is dependent on the algorithm.</span> 1071<span class="hljs-comment">// In this case for aes192, it is 24 bytes (192 bits).</span> 1072<span class="hljs-title function_">scrypt</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 1073 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1074 <span class="hljs-comment">// Then, we'll generate a random initialization vector</span> 1075 <span class="hljs-title function_">randomFill</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint8Array</span>(<span class="hljs-number">16</span>), <span class="hljs-function">(<span class="hljs-params">err, iv</span>) =></span> { 1076 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1077 1078 <span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(algorithm, key, iv); 1079 1080 <span class="hljs-keyword">let</span> encrypted = cipher.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some clear text data'</span>, <span class="hljs-string">'utf8'</span>, <span class="hljs-string">'hex'</span>); 1081 encrypted += cipher.<span class="hljs-title function_">final</span>(<span class="hljs-string">'hex'</span>); 1082 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(encrypted); 1083 }); 1084});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 1085 scrypt, 1086 randomFill, 1087 createCipheriv, 1088} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1089 1090<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1091<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1092 1093<span class="hljs-comment">// First, we'll generate the key. The key length is dependent on the algorithm.</span> 1094<span class="hljs-comment">// In this case for aes192, it is 24 bytes (192 bits).</span> 1095<span class="hljs-title function_">scrypt</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 1096 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1097 <span class="hljs-comment">// Then, we'll generate a random initialization vector</span> 1098 <span class="hljs-title function_">randomFill</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint8Array</span>(<span class="hljs-number">16</span>), <span class="hljs-function">(<span class="hljs-params">err, iv</span>) =></span> { 1099 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 1100 1101 <span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(algorithm, key, iv); 1102 1103 <span class="hljs-keyword">let</span> encrypted = cipher.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some clear text data'</span>, <span class="hljs-string">'utf8'</span>, <span class="hljs-string">'hex'</span>); 1104 encrypted += cipher.<span class="hljs-title function_">final</span>(<span class="hljs-string">'hex'</span>); 1105 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(encrypted); 1106 }); 1107});</code><button class="copy-button">copy</button></pre> 1108<h4><code>cipher.final([outputEncoding])</code><span><a class="mark" href="#cipherfinaloutputencoding" id="cipherfinaloutputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_cipher_final_outputencoding"></a></h4> 1109<div class="api_metadata"> 1110<span>Added in: v0.1.94</span> 1111</div> 1112<ul> 1113<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> 1114<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> Any remaining enciphered contents. 1115If <code>outputEncoding</code> is specified, a string is 1116returned. If an <code>outputEncoding</code> is not provided, a <a href="buffer.html"><code>Buffer</code></a> is returned.</li> 1117</ul> 1118<p>Once the <code>cipher.final()</code> method has been called, the <code>Cipher</code> object can no 1119longer be used to encrypt data. Attempts to call <code>cipher.final()</code> more than 1120once will result in an error being thrown.</p> 1121<h4><code>cipher.getAuthTag()</code><span><a class="mark" href="#ciphergetauthtag" id="ciphergetauthtag">#</a></span><a aria-hidden="true" class="legacy" id="crypto_cipher_getauthtag"></a></h4> 1122<div class="api_metadata"> 1123<span>Added in: v1.0.0</span> 1124</div> 1125<ul> 1126<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> When using an authenticated encryption mode (<code>GCM</code>, <code>CCM</code>, 1127<code>OCB</code>, and <code>chacha20-poly1305</code> are currently supported), the 1128<code>cipher.getAuthTag()</code> method returns a 1129<a href="buffer.html"><code>Buffer</code></a> containing the <em>authentication tag</em> that has been computed from 1130the given data.</li> 1131</ul> 1132<p>The <code>cipher.getAuthTag()</code> method should only be called after encryption has 1133been completed using the <a href="#cipherfinaloutputencoding"><code>cipher.final()</code></a> method.</p> 1134<p>If the <code>authTagLength</code> option was set during the <code>cipher</code> instance's creation, 1135this function will return exactly <code>authTagLength</code> bytes.</p> 1136<h4><code>cipher.setAAD(buffer[, options])</code><span><a class="mark" href="#ciphersetaadbuffer-options" id="ciphersetaadbuffer-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_cipher_setaad_buffer_options"></a></h4> 1137<div class="api_metadata"> 1138<span>Added in: v1.0.0</span> 1139</div> 1140<ul> 1141<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> 1142<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a> 1143<ul> 1144<li><code>plaintextLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1145<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> is a string.</li> 1146</ul> 1147</li> 1148<li>Returns: <a href="crypto.html#class-cipher" class="type"><Cipher></a> for method chaining.</li> 1149</ul> 1150<p>When using an authenticated encryption mode (<code>GCM</code>, <code>CCM</code>, <code>OCB</code>, and 1151<code>chacha20-poly1305</code> are 1152currently supported), the <code>cipher.setAAD()</code> method sets the value used for the 1153<em>additional authenticated data</em> (AAD) input parameter.</p> 1154<p>The <code>plaintextLength</code> option is optional for <code>GCM</code> and <code>OCB</code>. When using <code>CCM</code>, 1155the <code>plaintextLength</code> option must be specified and its value must match the 1156length of the plaintext in bytes. See <a href="#ccm-mode">CCM mode</a>.</p> 1157<p>The <code>cipher.setAAD()</code> method must be called before <a href="#cipherupdatedata-inputencoding-outputencoding"><code>cipher.update()</code></a>.</p> 1158<h4><code>cipher.setAutoPadding([autoPadding])</code><span><a class="mark" href="#ciphersetautopaddingautopadding" id="ciphersetautopaddingautopadding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_cipher_setautopadding_autopadding"></a></h4> 1159<div class="api_metadata"> 1160<span>Added in: v0.7.1</span> 1161</div> 1162<ul> 1163<li><code>autoPadding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>true</code></li> 1164<li>Returns: <a href="crypto.html#class-cipher" class="type"><Cipher></a> for method chaining.</li> 1165</ul> 1166<p>When using block encryption algorithms, the <code>Cipher</code> class will automatically 1167add padding to the input data to the appropriate block size. To disable the 1168default padding call <code>cipher.setAutoPadding(false)</code>.</p> 1169<p>When <code>autoPadding</code> is <code>false</code>, the length of the entire input data must be a 1170multiple of the cipher's block size or <a href="#cipherfinaloutputencoding"><code>cipher.final()</code></a> will throw an error. 1171Disabling automatic padding is useful for non-standard padding, for instance 1172using <code>0x0</code> instead of PKCS padding.</p> 1173<p>The <code>cipher.setAutoPadding()</code> method must be called before 1174<a href="#cipherfinaloutputencoding"><code>cipher.final()</code></a>.</p> 1175<h4><code>cipher.update(data[, inputEncoding][, outputEncoding])</code><span><a class="mark" href="#cipherupdatedata-inputencoding-outputencoding" id="cipherupdatedata-inputencoding-outputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_cipher_update_data_inputencoding_outputencoding"></a></h4> 1176<div class="api_metadata"> 1177<details class="changelog"><summary>History</summary> 1178<table> 1179<tbody><tr><th>Version</th><th>Changes</th></tr> 1180<tr><td>v6.0.0</td> 1181<td><p>The default <code>inputEncoding</code> changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 1182<tr><td>v0.1.94</td> 1183<td><p><span>Added in: v0.1.94</span></p></td></tr> 1184</tbody></table> 1185</details> 1186</div> 1187<ul> 1188<li><code>data</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> | <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> 1189<li><code>inputEncoding</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 data.</li> 1190<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> 1191<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> 1192</ul> 1193<p>Updates the cipher with <code>data</code>. If the <code>inputEncoding</code> argument is given, 1194the <code>data</code> 1195argument is a string using the specified encoding. If the <code>inputEncoding</code> 1196argument is not given, <code>data</code> must be a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or 1197<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 1198<code>inputEncoding</code> is ignored.</p> 1199<p>The <code>outputEncoding</code> specifies the output format of the enciphered 1200data. If the <code>outputEncoding</code> 1201is specified, a string using the specified encoding is returned. If no 1202<code>outputEncoding</code> is provided, a <a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1203<p>The <code>cipher.update()</code> method can be called multiple times with new data until 1204<a href="#cipherfinaloutputencoding"><code>cipher.final()</code></a> is called. Calling <code>cipher.update()</code> after 1205<a href="#cipherfinaloutputencoding"><code>cipher.final()</code></a> will result in an error being thrown.</p> 1206</section><section><h3>Class: <code>Decipher</code><span><a class="mark" href="#class-decipher" id="class-decipher">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_decipher"></a></h3> 1207<div class="api_metadata"> 1208<span>Added in: v0.1.94</span> 1209</div> 1210<ul> 1211<li>Extends: <a href="stream.html#class-streamtransform" class="type"><stream.Transform></a></li> 1212</ul> 1213<p>Instances of the <code>Decipher</code> class are used to decrypt data. The class can be 1214used in one of two ways:</p> 1215<ul> 1216<li>As a <a href="stream.html">stream</a> that is both readable and writable, where plain encrypted 1217data is written to produce unencrypted data on the readable side, or</li> 1218<li>Using the <a href="#decipherupdatedata-inputencoding-outputencoding"><code>decipher.update()</code></a> and <a href="#decipherfinaloutputencoding"><code>decipher.final()</code></a> methods to 1219produce the unencrypted data.</li> 1220</ul> 1221<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 1222used to create <code>Decipher</code> instances. <code>Decipher</code> objects are not to be created 1223directly using the <code>new</code> keyword.</p> 1224<p>Example: Using <code>Decipher</code> objects as streams:</p> 1225 1226<pre class="with-37-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 1227<span class="hljs-keyword">const</span> { 1228 scryptSync, 1229 createDecipheriv, 1230} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1231 1232<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1233<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1234<span class="hljs-comment">// Key length is dependent on the algorithm. In this case for aes192, it is</span> 1235<span class="hljs-comment">// 24 bytes (192 bits).</span> 1236<span class="hljs-comment">// Use the async `crypto.scrypt()` instead.</span> 1237<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">scryptSync</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>); 1238<span class="hljs-comment">// The IV is usually passed along with the ciphertext.</span> 1239<span class="hljs-keyword">const</span> iv = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">16</span>, <span class="hljs-number">0</span>); <span class="hljs-comment">// Initialization vector.</span> 1240 1241<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(algorithm, key, iv); 1242 1243<span class="hljs-keyword">let</span> decrypted = <span class="hljs-string">''</span>; 1244decipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 1245 <span class="hljs-keyword">let</span> chunk; 1246 <span class="hljs-keyword">while</span> (<span class="hljs-literal">null</span> !== (chunk = decipher.<span class="hljs-title function_">read</span>())) { 1247 decrypted += chunk.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'utf8'</span>); 1248 } 1249}); 1250decipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 1251 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(decrypted); 1252 <span class="hljs-comment">// Prints: some clear text data</span> 1253}); 1254 1255<span class="hljs-comment">// Encrypted with same algorithm, key and iv.</span> 1256<span class="hljs-keyword">const</span> encrypted = 1257 <span class="hljs-string">'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa'</span>; 1258decipher.<span class="hljs-title function_">write</span>(encrypted, <span class="hljs-string">'hex'</span>); 1259decipher.<span class="hljs-title function_">end</span>();</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 1260 scryptSync, 1261 createDecipheriv, 1262} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1263<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 1264 1265<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1266<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1267<span class="hljs-comment">// Key length is dependent on the algorithm. In this case for aes192, it is</span> 1268<span class="hljs-comment">// 24 bytes (192 bits).</span> 1269<span class="hljs-comment">// Use the async `crypto.scrypt()` instead.</span> 1270<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">scryptSync</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>); 1271<span class="hljs-comment">// The IV is usually passed along with the ciphertext.</span> 1272<span class="hljs-keyword">const</span> iv = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">16</span>, <span class="hljs-number">0</span>); <span class="hljs-comment">// Initialization vector.</span> 1273 1274<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(algorithm, key, iv); 1275 1276<span class="hljs-keyword">let</span> decrypted = <span class="hljs-string">''</span>; 1277decipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 1278 <span class="hljs-keyword">let</span> chunk; 1279 <span class="hljs-keyword">while</span> (<span class="hljs-literal">null</span> !== (chunk = decipher.<span class="hljs-title function_">read</span>())) { 1280 decrypted += chunk.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'utf8'</span>); 1281 } 1282}); 1283decipher.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 1284 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(decrypted); 1285 <span class="hljs-comment">// Prints: some clear text data</span> 1286}); 1287 1288<span class="hljs-comment">// Encrypted with same algorithm, key and iv.</span> 1289<span class="hljs-keyword">const</span> encrypted = 1290 <span class="hljs-string">'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa'</span>; 1291decipher.<span class="hljs-title function_">write</span>(encrypted, <span class="hljs-string">'hex'</span>); 1292decipher.<span class="hljs-title function_">end</span>();</code><button class="copy-button">copy</button></pre> 1293<p>Example: Using <code>Decipher</code> and piped streams:</p> 1294 1295<pre class="with-19-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 1296 createReadStream, 1297 createWriteStream, 1298} <span class="hljs-keyword">from</span> <span class="hljs-string">'node:fs'</span>; 1299<span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 1300<span class="hljs-keyword">const</span> { 1301 scryptSync, 1302 createDecipheriv, 1303} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1304 1305<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1306<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1307<span class="hljs-comment">// Use the async `crypto.scrypt()` instead.</span> 1308<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">scryptSync</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>); 1309<span class="hljs-comment">// The IV is usually passed along with the ciphertext.</span> 1310<span class="hljs-keyword">const</span> iv = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">16</span>, <span class="hljs-number">0</span>); <span class="hljs-comment">// Initialization vector.</span> 1311 1312<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(algorithm, key, iv); 1313 1314<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.enc'</span>); 1315<span class="hljs-keyword">const</span> output = <span class="hljs-title function_">createWriteStream</span>(<span class="hljs-string">'test.js'</span>); 1316 1317input.<span class="hljs-title function_">pipe</span>(decipher).<span class="hljs-title function_">pipe</span>(output);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 1318 createReadStream, 1319 createWriteStream, 1320} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 1321<span class="hljs-keyword">const</span> { 1322 scryptSync, 1323 createDecipheriv, 1324} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1325<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 1326 1327<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1328<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1329<span class="hljs-comment">// Use the async `crypto.scrypt()` instead.</span> 1330<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">scryptSync</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>); 1331<span class="hljs-comment">// The IV is usually passed along with the ciphertext.</span> 1332<span class="hljs-keyword">const</span> iv = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">16</span>, <span class="hljs-number">0</span>); <span class="hljs-comment">// Initialization vector.</span> 1333 1334<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(algorithm, key, iv); 1335 1336<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.enc'</span>); 1337<span class="hljs-keyword">const</span> output = <span class="hljs-title function_">createWriteStream</span>(<span class="hljs-string">'test.js'</span>); 1338 1339input.<span class="hljs-title function_">pipe</span>(decipher).<span class="hljs-title function_">pipe</span>(output);</code><button class="copy-button">copy</button></pre> 1340<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> 1341 1342<pre class="with-37-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 1343<span class="hljs-keyword">const</span> { 1344 scryptSync, 1345 createDecipheriv, 1346} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1347 1348<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1349<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1350<span class="hljs-comment">// Use the async `crypto.scrypt()` instead.</span> 1351<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">scryptSync</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>); 1352<span class="hljs-comment">// The IV is usually passed along with the ciphertext.</span> 1353<span class="hljs-keyword">const</span> iv = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">16</span>, <span class="hljs-number">0</span>); <span class="hljs-comment">// Initialization vector.</span> 1354 1355<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(algorithm, key, iv); 1356 1357<span class="hljs-comment">// Encrypted using same algorithm, key and iv.</span> 1358<span class="hljs-keyword">const</span> encrypted = 1359 <span class="hljs-string">'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa'</span>; 1360<span class="hljs-keyword">let</span> decrypted = decipher.<span class="hljs-title function_">update</span>(encrypted, <span class="hljs-string">'hex'</span>, <span class="hljs-string">'utf8'</span>); 1361decrypted += decipher.<span class="hljs-title function_">final</span>(<span class="hljs-string">'utf8'</span>); 1362<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(decrypted); 1363<span class="hljs-comment">// Prints: some clear text data</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 1364 scryptSync, 1365 createDecipheriv, 1366} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1367<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 1368 1369<span class="hljs-keyword">const</span> algorithm = <span class="hljs-string">'aes-192-cbc'</span>; 1370<span class="hljs-keyword">const</span> password = <span class="hljs-string">'Password used to generate key'</span>; 1371<span class="hljs-comment">// Use the async `crypto.scrypt()` instead.</span> 1372<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">scryptSync</span>(password, <span class="hljs-string">'salt'</span>, <span class="hljs-number">24</span>); 1373<span class="hljs-comment">// The IV is usually passed along with the ciphertext.</span> 1374<span class="hljs-keyword">const</span> iv = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">16</span>, <span class="hljs-number">0</span>); <span class="hljs-comment">// Initialization vector.</span> 1375 1376<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(algorithm, key, iv); 1377 1378<span class="hljs-comment">// Encrypted using same algorithm, key and iv.</span> 1379<span class="hljs-keyword">const</span> encrypted = 1380 <span class="hljs-string">'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa'</span>; 1381<span class="hljs-keyword">let</span> decrypted = decipher.<span class="hljs-title function_">update</span>(encrypted, <span class="hljs-string">'hex'</span>, <span class="hljs-string">'utf8'</span>); 1382decrypted += decipher.<span class="hljs-title function_">final</span>(<span class="hljs-string">'utf8'</span>); 1383<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(decrypted); 1384<span class="hljs-comment">// Prints: some clear text data</span></code><button class="copy-button">copy</button></pre> 1385<h4><code>decipher.final([outputEncoding])</code><span><a class="mark" href="#decipherfinaloutputencoding" id="decipherfinaloutputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_decipher_final_outputencoding"></a></h4> 1386<div class="api_metadata"> 1387<span>Added in: v0.1.94</span> 1388</div> 1389<ul> 1390<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> 1391<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> Any remaining deciphered contents. 1392If <code>outputEncoding</code> is specified, a string is 1393returned. If an <code>outputEncoding</code> is not provided, a <a href="buffer.html"><code>Buffer</code></a> is returned.</li> 1394</ul> 1395<p>Once the <code>decipher.final()</code> method has been called, the <code>Decipher</code> object can 1396no longer be used to decrypt data. Attempts to call <code>decipher.final()</code> more 1397than once will result in an error being thrown.</p> 1398<h4><code>decipher.setAAD(buffer[, options])</code><span><a class="mark" href="#deciphersetaadbuffer-options" id="deciphersetaadbuffer-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_decipher_setaad_buffer_options"></a></h4> 1399<div class="api_metadata"> 1400<details class="changelog"><summary>History</summary> 1401<table> 1402<tbody><tr><th>Version</th><th>Changes</th></tr> 1403<tr><td>v15.0.0</td> 1404<td><p>The buffer argument can be a string or ArrayBuffer and is limited to no more than 2 ** 31 - 1 bytes.</p></td></tr> 1405<tr><td>v7.2.0</td> 1406<td><p>This method now returns a reference to <code>decipher</code>.</p></td></tr> 1407<tr><td>v1.0.0</td> 1408<td><p><span>Added in: v1.0.0</span></p></td></tr> 1409</tbody></table> 1410</details> 1411</div> 1412<ul> 1413<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> 1414<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a> 1415<ul> 1416<li><code>plaintextLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1417<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> String encoding to use when <code>buffer</code> is a string.</li> 1418</ul> 1419</li> 1420<li>Returns: <a href="crypto.html#class-decipher" class="type"><Decipher></a> for method chaining.</li> 1421</ul> 1422<p>When using an authenticated encryption mode (<code>GCM</code>, <code>CCM</code>, <code>OCB</code>, and 1423<code>chacha20-poly1305</code> are 1424currently supported), the <code>decipher.setAAD()</code> method sets the value used for the 1425<em>additional authenticated data</em> (AAD) input parameter.</p> 1426<p>The <code>options</code> argument is optional for <code>GCM</code>. When using <code>CCM</code>, the 1427<code>plaintextLength</code> option must be specified and its value must match the length 1428of the ciphertext in bytes. See <a href="#ccm-mode">CCM mode</a>.</p> 1429<p>The <code>decipher.setAAD()</code> method must be called before <a href="#decipherupdatedata-inputencoding-outputencoding"><code>decipher.update()</code></a>.</p> 1430<p>When passing a string as the <code>buffer</code>, please consider 1431<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 1432<h4><code>decipher.setAuthTag(buffer[, encoding])</code><span><a class="mark" href="#deciphersetauthtagbuffer-encoding" id="deciphersetauthtagbuffer-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_decipher_setauthtag_buffer_encoding"></a></h4> 1433<div class="api_metadata"> 1434<details class="changelog"><summary>History</summary> 1435<table> 1436<tbody><tr><th>Version</th><th>Changes</th></tr> 1437<tr><td>v15.0.0</td> 1438<td><p>The buffer argument can be a string or ArrayBuffer and is limited to no more than 2 ** 31 - 1 bytes.</p></td></tr> 1439<tr><td>v11.0.0</td> 1440<td><p>This method now throws if the GCM tag length is invalid.</p></td></tr> 1441<tr><td>v7.2.0</td> 1442<td><p>This method now returns a reference to <code>decipher</code>.</p></td></tr> 1443<tr><td>v1.0.0</td> 1444<td><p><span>Added in: v1.0.0</span></p></td></tr> 1445</tbody></table> 1446</details> 1447</div> 1448<ul> 1449<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="buffer.html#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></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> 1450<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> String encoding to use when <code>buffer</code> is a string.</li> 1451<li>Returns: <a href="crypto.html#class-decipher" class="type"><Decipher></a> for method chaining.</li> 1452</ul> 1453<p>When using an authenticated encryption mode (<code>GCM</code>, <code>CCM</code>, <code>OCB</code>, and 1454<code>chacha20-poly1305</code> are 1455currently supported), the <code>decipher.setAuthTag()</code> method is used to pass in the 1456received <em>authentication tag</em>. If no tag is provided, or if the cipher text 1457has been tampered with, <a href="#decipherfinaloutputencoding"><code>decipher.final()</code></a> will throw, indicating that the 1458cipher text should be discarded due to failed authentication. If the tag length 1459is 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 1460<code>authTagLength</code> option, <code>decipher.setAuthTag()</code> will throw an error.</p> 1461<p>The <code>decipher.setAuthTag()</code> method must be called before <a href="#decipherupdatedata-inputencoding-outputencoding"><code>decipher.update()</code></a> 1462for <code>CCM</code> mode or before <a href="#decipherfinaloutputencoding"><code>decipher.final()</code></a> for <code>GCM</code> and <code>OCB</code> modes and 1463<code>chacha20-poly1305</code>. 1464<code>decipher.setAuthTag()</code> can only be called once.</p> 1465<p>When passing a string as the authentication tag, please consider 1466<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 1467<h4><code>decipher.setAutoPadding([autoPadding])</code><span><a class="mark" href="#deciphersetautopaddingautopadding" id="deciphersetautopaddingautopadding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_decipher_setautopadding_autopadding"></a></h4> 1468<div class="api_metadata"> 1469<span>Added in: v0.7.1</span> 1470</div> 1471<ul> 1472<li><code>autoPadding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>true</code></li> 1473<li>Returns: <a href="crypto.html#class-decipher" class="type"><Decipher></a> for method chaining.</li> 1474</ul> 1475<p>When data has been encrypted without standard block padding, calling 1476<code>decipher.setAutoPadding(false)</code> will disable automatic padding to prevent 1477<a href="#decipherfinaloutputencoding"><code>decipher.final()</code></a> from checking for and removing padding.</p> 1478<p>Turning auto padding off will only work if the input data's length is a 1479multiple of the ciphers block size.</p> 1480<p>The <code>decipher.setAutoPadding()</code> method must be called before 1481<a href="#decipherfinaloutputencoding"><code>decipher.final()</code></a>.</p> 1482<h4><code>decipher.update(data[, inputEncoding][, outputEncoding])</code><span><a class="mark" href="#decipherupdatedata-inputencoding-outputencoding" id="decipherupdatedata-inputencoding-outputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_decipher_update_data_inputencoding_outputencoding"></a></h4> 1483<div class="api_metadata"> 1484<details class="changelog"><summary>History</summary> 1485<table> 1486<tbody><tr><th>Version</th><th>Changes</th></tr> 1487<tr><td>v6.0.0</td> 1488<td><p>The default <code>inputEncoding</code> changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 1489<tr><td>v0.1.94</td> 1490<td><p><span>Added in: v0.1.94</span></p></td></tr> 1491</tbody></table> 1492</details> 1493</div> 1494<ul> 1495<li><code>data</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> | <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> 1496<li><code>inputEncoding</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>data</code> string.</li> 1497<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> 1498<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> 1499</ul> 1500<p>Updates the decipher with <code>data</code>. If the <code>inputEncoding</code> argument is given, 1501the <code>data</code> 1502argument is a string using the specified encoding. If the <code>inputEncoding</code> 1503argument is not given, <code>data</code> must be a <a href="buffer.html"><code>Buffer</code></a>. If <code>data</code> is a 1504<a href="buffer.html"><code>Buffer</code></a> then <code>inputEncoding</code> is ignored.</p> 1505<p>The <code>outputEncoding</code> specifies the output format of the enciphered 1506data. If the <code>outputEncoding</code> 1507is specified, a string using the specified encoding is returned. If no 1508<code>outputEncoding</code> is provided, a <a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1509<p>The <code>decipher.update()</code> method can be called multiple times with new data until 1510<a href="#decipherfinaloutputencoding"><code>decipher.final()</code></a> is called. Calling <code>decipher.update()</code> after 1511<a href="#decipherfinaloutputencoding"><code>decipher.final()</code></a> will result in an error being thrown.</p> 1512</section><section><h3>Class: <code>DiffieHellman</code><span><a class="mark" href="#class-diffiehellman" id="class-diffiehellman">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_diffiehellman"></a></h3> 1513<div class="api_metadata"> 1514<span>Added in: v0.5.0</span> 1515</div> 1516<p>The <code>DiffieHellman</code> class is a utility for creating Diffie-Hellman key 1517exchanges.</p> 1518<p>Instances of the <code>DiffieHellman</code> class can be created using the 1519<a href="#cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding"><code>crypto.createDiffieHellman()</code></a> function.</p> 1520 1521<pre class="with-38-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> assert <span class="hljs-keyword">from</span> <span class="hljs-string">'node:assert'</span>; 1522 1523<span class="hljs-keyword">const</span> { 1524 createDiffieHellman, 1525} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1526 1527<span class="hljs-comment">// Generate Alice's keys...</span> 1528<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">createDiffieHellman</span>(<span class="hljs-number">2048</span>); 1529<span class="hljs-keyword">const</span> aliceKey = alice.<span class="hljs-title function_">generateKeys</span>(); 1530 1531<span class="hljs-comment">// Generate Bob's keys...</span> 1532<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">createDiffieHellman</span>(alice.<span class="hljs-title function_">getPrime</span>(), alice.<span class="hljs-title function_">getGenerator</span>()); 1533<span class="hljs-keyword">const</span> bobKey = bob.<span class="hljs-title function_">generateKeys</span>(); 1534 1535<span class="hljs-comment">// Exchange and generate the secret...</span> 1536<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bobKey); 1537<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(aliceKey); 1538 1539<span class="hljs-comment">// OK</span> 1540assert.<span class="hljs-title function_">strictEqual</span>(aliceSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>), bobSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>));</code><code class="language-js cjs"><span class="hljs-keyword">const</span> assert = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:assert'</span>); 1541 1542<span class="hljs-keyword">const</span> { 1543 createDiffieHellman, 1544} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1545 1546<span class="hljs-comment">// Generate Alice's keys...</span> 1547<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">createDiffieHellman</span>(<span class="hljs-number">2048</span>); 1548<span class="hljs-keyword">const</span> aliceKey = alice.<span class="hljs-title function_">generateKeys</span>(); 1549 1550<span class="hljs-comment">// Generate Bob's keys...</span> 1551<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">createDiffieHellman</span>(alice.<span class="hljs-title function_">getPrime</span>(), alice.<span class="hljs-title function_">getGenerator</span>()); 1552<span class="hljs-keyword">const</span> bobKey = bob.<span class="hljs-title function_">generateKeys</span>(); 1553 1554<span class="hljs-comment">// Exchange and generate the secret...</span> 1555<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bobKey); 1556<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(aliceKey); 1557 1558<span class="hljs-comment">// OK</span> 1559assert.<span class="hljs-title function_">strictEqual</span>(aliceSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>), bobSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>));</code><button class="copy-button">copy</button></pre> 1560<h4><code>diffieHellman.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])</code><span><a class="mark" href="#diffiehellmancomputesecretotherpublickey-inputencoding-outputencoding" id="diffiehellmancomputesecretotherpublickey-inputencoding-outputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_computesecret_otherpublickey_inputencoding_outputencoding"></a></h4> 1561<div class="api_metadata"> 1562<span>Added in: v0.5.0</span> 1563</div> 1564<ul> 1565<li><code>otherPublicKey</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> 1566<li><code>inputEncoding</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 an <code>otherPublicKey</code> string.</li> 1567<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> 1568<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> 1569</ul> 1570<p>Computes the shared secret using <code>otherPublicKey</code> as the other 1571party's public key and returns the computed shared secret. The supplied 1572key is interpreted using the specified <code>inputEncoding</code>, and secret is 1573encoded using specified <code>outputEncoding</code>. 1574If the <code>inputEncoding</code> is not 1575provided, <code>otherPublicKey</code> is expected to be a <a href="buffer.html"><code>Buffer</code></a>, 1576<code>TypedArray</code>, or <code>DataView</code>.</p> 1577<p>If <code>outputEncoding</code> is given a string is returned; otherwise, a 1578<a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1579<h4><code>diffieHellman.generateKeys([encoding])</code><span><a class="mark" href="#diffiehellmangeneratekeysencoding" id="diffiehellmangeneratekeysencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_generatekeys_encoding"></a></h4> 1580<div class="api_metadata"> 1581<span>Added in: v0.5.0</span> 1582</div> 1583<ul> 1584<li><code>encoding</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> 1585<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> 1586</ul> 1587<p>Generates private and public Diffie-Hellman key values unless they have been 1588generated or computed already, and returns 1589the public key in the specified <code>encoding</code>. This key should be 1590transferred to the other party. 1591If <code>encoding</code> is provided a string is returned; otherwise a 1592<a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1593<p>This function is a thin wrapper around <a href="https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html"><code>DH_generate_key()</code></a>. In particular, 1594once a private key has been generated or set, calling this function only updates 1595the public key but does not generate a new private key.</p> 1596<h4><code>diffieHellman.getGenerator([encoding])</code><span><a class="mark" href="#diffiehellmangetgeneratorencoding" id="diffiehellmangetgeneratorencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_getgenerator_encoding"></a></h4> 1597<div class="api_metadata"> 1598<span>Added in: v0.5.0</span> 1599</div> 1600<ul> 1601<li><code>encoding</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> 1602<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> 1603</ul> 1604<p>Returns the Diffie-Hellman generator in the specified <code>encoding</code>. 1605If <code>encoding</code> is provided a string is 1606returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1607<h4><code>diffieHellman.getPrime([encoding])</code><span><a class="mark" href="#diffiehellmangetprimeencoding" id="diffiehellmangetprimeencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_getprime_encoding"></a></h4> 1608<div class="api_metadata"> 1609<span>Added in: v0.5.0</span> 1610</div> 1611<ul> 1612<li><code>encoding</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> 1613<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> 1614</ul> 1615<p>Returns the Diffie-Hellman prime in the specified <code>encoding</code>. 1616If <code>encoding</code> is provided a string is 1617returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1618<h4><code>diffieHellman.getPrivateKey([encoding])</code><span><a class="mark" href="#diffiehellmangetprivatekeyencoding" id="diffiehellmangetprivatekeyencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_getprivatekey_encoding"></a></h4> 1619<div class="api_metadata"> 1620<span>Added in: v0.5.0</span> 1621</div> 1622<ul> 1623<li><code>encoding</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> 1624<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> 1625</ul> 1626<p>Returns the Diffie-Hellman private key in the specified <code>encoding</code>. 1627If <code>encoding</code> is provided a 1628string is returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1629<h4><code>diffieHellman.getPublicKey([encoding])</code><span><a class="mark" href="#diffiehellmangetpublickeyencoding" id="diffiehellmangetpublickeyencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_getpublickey_encoding"></a></h4> 1630<div class="api_metadata"> 1631<span>Added in: v0.5.0</span> 1632</div> 1633<ul> 1634<li><code>encoding</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> 1635<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> 1636</ul> 1637<p>Returns the Diffie-Hellman public key in the specified <code>encoding</code>. 1638If <code>encoding</code> is provided a 1639string is returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1640<h4><code>diffieHellman.setPrivateKey(privateKey[, encoding])</code><span><a class="mark" href="#diffiehellmansetprivatekeyprivatekey-encoding" id="diffiehellmansetprivatekeyprivatekey-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_setprivatekey_privatekey_encoding"></a></h4> 1641<div class="api_metadata"> 1642<span>Added in: v0.5.0</span> 1643</div> 1644<ul> 1645<li><code>privateKey</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> 1646<li><code>encoding</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>privateKey</code> string.</li> 1647</ul> 1648<p>Sets the Diffie-Hellman private key. If the <code>encoding</code> argument is provided, 1649<code>privateKey</code> is expected 1650to be a string. If no <code>encoding</code> is provided, <code>privateKey</code> is expected 1651to be a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code>.</p> 1652<p>This function does not automatically compute the associated public key. Either 1653<a href="#diffiehellmansetpublickeypublickey-encoding"><code>diffieHellman.setPublicKey()</code></a> or <a href="#diffiehellmangeneratekeysencoding"><code>diffieHellman.generateKeys()</code></a> can be 1654used to manually provide the public key or to automatically derive it.</p> 1655<h4><code>diffieHellman.setPublicKey(publicKey[, encoding])</code><span><a class="mark" href="#diffiehellmansetpublickeypublickey-encoding" id="diffiehellmansetpublickeypublickey-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_setpublickey_publickey_encoding"></a></h4> 1656<div class="api_metadata"> 1657<span>Added in: v0.5.0</span> 1658</div> 1659<ul> 1660<li><code>publicKey</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> 1661<li><code>encoding</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>publicKey</code> string.</li> 1662</ul> 1663<p>Sets the Diffie-Hellman public key. If the <code>encoding</code> argument is provided, 1664<code>publicKey</code> is expected 1665to be a string. If no <code>encoding</code> is provided, <code>publicKey</code> is expected 1666to be a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code>.</p> 1667<h4><code>diffieHellman.verifyError</code><span><a class="mark" href="#diffiehellmanverifyerror" id="diffiehellmanverifyerror">#</a></span><a aria-hidden="true" class="legacy" id="crypto_diffiehellman_verifyerror"></a></h4> 1668<div class="api_metadata"> 1669<span>Added in: v0.11.12</span> 1670</div> 1671<p>A bit field containing any warnings and/or errors resulting from a check 1672performed during initialization of the <code>DiffieHellman</code> object.</p> 1673<p>The following values are valid for this property (as defined in <code>node:constants</code> module):</p> 1674<ul> 1675<li><code>DH_CHECK_P_NOT_SAFE_PRIME</code></li> 1676<li><code>DH_CHECK_P_NOT_PRIME</code></li> 1677<li><code>DH_UNABLE_TO_CHECK_GENERATOR</code></li> 1678<li><code>DH_NOT_SUITABLE_GENERATOR</code></li> 1679</ul> 1680</section><section><h3>Class: <code>DiffieHellmanGroup</code><span><a class="mark" href="#class-diffiehellmangroup" id="class-diffiehellmangroup">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_diffiehellmangroup"></a></h3> 1681<div class="api_metadata"> 1682<span>Added in: v0.7.5</span> 1683</div> 1684<p>The <code>DiffieHellmanGroup</code> class takes a well-known modp group as its argument. 1685It works the same as <code>DiffieHellman</code>, except that it does not allow changing 1686its keys after creation. In other words, it does not implement <code>setPublicKey()</code> 1687or <code>setPrivateKey()</code> methods.</p> 1688 1689<pre class="with-65-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { createDiffieHellmanGroup } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1690<span class="hljs-keyword">const</span> dh = <span class="hljs-title function_">createDiffieHellmanGroup</span>(<span class="hljs-string">'modp16'</span>);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { createDiffieHellmanGroup } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1691<span class="hljs-keyword">const</span> dh = <span class="hljs-title function_">createDiffieHellmanGroup</span>(<span class="hljs-string">'modp16'</span>);</code><button class="copy-button">copy</button></pre> 1692<p>The following groups are supported:</p> 1693<ul> 1694<li><code>'modp14'</code> (2048 bits, <a href="https://www.rfc-editor.org/rfc/rfc3526.txt">RFC 3526</a> Section 3)</li> 1695<li><code>'modp15'</code> (3072 bits, <a href="https://www.rfc-editor.org/rfc/rfc3526.txt">RFC 3526</a> Section 4)</li> 1696<li><code>'modp16'</code> (4096 bits, <a href="https://www.rfc-editor.org/rfc/rfc3526.txt">RFC 3526</a> Section 5)</li> 1697<li><code>'modp17'</code> (6144 bits, <a href="https://www.rfc-editor.org/rfc/rfc3526.txt">RFC 3526</a> Section 6)</li> 1698<li><code>'modp18'</code> (8192 bits, <a href="https://www.rfc-editor.org/rfc/rfc3526.txt">RFC 3526</a> Section 7)</li> 1699</ul> 1700<p>The following groups are still supported but deprecated (see <a href="#support-for-weak-or-compromised-algorithms">Caveats</a>):</p> 1701<ul> 1702<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> 1703<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> 1704<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> 1705</ul> 1706<p>These deprecated groups might be removed in future versions of Node.js.</p> 1707</section><section><h3>Class: <code>ECDH</code><span><a class="mark" href="#class-ecdh" id="class-ecdh">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_ecdh"></a></h3> 1708<div class="api_metadata"> 1709<span>Added in: v0.11.14</span> 1710</div> 1711<p>The <code>ECDH</code> class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH) 1712key exchanges.</p> 1713<p>Instances of the <code>ECDH</code> class can be created using the 1714<a href="#cryptocreateecdhcurvename"><code>crypto.createECDH()</code></a> function.</p> 1715 1716<pre class="with-38-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> assert <span class="hljs-keyword">from</span> <span class="hljs-string">'node:assert'</span>; 1717 1718<span class="hljs-keyword">const</span> { 1719 createECDH, 1720} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1721 1722<span class="hljs-comment">// Generate Alice's keys...</span> 1723<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp521r1'</span>); 1724<span class="hljs-keyword">const</span> aliceKey = alice.<span class="hljs-title function_">generateKeys</span>(); 1725 1726<span class="hljs-comment">// Generate Bob's keys...</span> 1727<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp521r1'</span>); 1728<span class="hljs-keyword">const</span> bobKey = bob.<span class="hljs-title function_">generateKeys</span>(); 1729 1730<span class="hljs-comment">// Exchange and generate the secret...</span> 1731<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bobKey); 1732<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(aliceKey); 1733 1734assert.<span class="hljs-title function_">strictEqual</span>(aliceSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>), bobSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 1735<span class="hljs-comment">// OK</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> assert = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:assert'</span>); 1736 1737<span class="hljs-keyword">const</span> { 1738 createECDH, 1739} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1740 1741<span class="hljs-comment">// Generate Alice's keys...</span> 1742<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp521r1'</span>); 1743<span class="hljs-keyword">const</span> aliceKey = alice.<span class="hljs-title function_">generateKeys</span>(); 1744 1745<span class="hljs-comment">// Generate Bob's keys...</span> 1746<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp521r1'</span>); 1747<span class="hljs-keyword">const</span> bobKey = bob.<span class="hljs-title function_">generateKeys</span>(); 1748 1749<span class="hljs-comment">// Exchange and generate the secret...</span> 1750<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bobKey); 1751<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(aliceKey); 1752 1753assert.<span class="hljs-title function_">strictEqual</span>(aliceSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>), bobSecret.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 1754<span class="hljs-comment">// OK</span></code><button class="copy-button">copy</button></pre> 1755<h4>Static method: <code>ECDH.convertKey(key, curve[, inputEncoding[, outputEncoding[, format]]])</code><span><a class="mark" href="#static-method-ecdhconvertkeykey-curve-inputencoding-outputencoding-format" id="static-method-ecdhconvertkeykey-curve-inputencoding-outputencoding-format">#</a></span><a aria-hidden="true" class="legacy" id="crypto_static_method_ecdh_convertkey_key_curve_inputencoding_outputencoding_format"></a></h4> 1756<div class="api_metadata"> 1757<span>Added in: v10.0.0</span> 1758</div> 1759<ul> 1760<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></li> 1761<li><code>curve</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1762<li><code>inputEncoding</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>key</code> string.</li> 1763<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> 1764<li><code>format</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> <strong>Default:</strong> <code>'uncompressed'</code></li> 1765<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> 1766</ul> 1767<p>Converts the EC Diffie-Hellman public key specified by <code>key</code> and <code>curve</code> to the 1768format specified by <code>format</code>. The <code>format</code> argument specifies point encoding 1769and can be <code>'compressed'</code>, <code>'uncompressed'</code> or <code>'hybrid'</code>. The supplied key is 1770interpreted using the specified <code>inputEncoding</code>, and the returned key is encoded 1771using the specified <code>outputEncoding</code>.</p> 1772<p>Use <a href="#cryptogetcurves"><code>crypto.getCurves()</code></a> to obtain a list of available curve names. 1773On recent OpenSSL releases, <code>openssl ecparam -list_curves</code> will also display 1774the name and description of each available elliptic curve.</p> 1775<p>If <code>format</code> is not specified the point will be returned in <code>'uncompressed'</code> 1776format.</p> 1777<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>, 1778<code>TypedArray</code>, or <code>DataView</code>.</p> 1779<p>Example (uncompressing a key):</p> 1780 1781<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 1782 createECDH, 1783 <span class="hljs-variable constant_">ECDH</span>, 1784} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1785 1786<span class="hljs-keyword">const</span> ecdh = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp256k1'</span>); 1787ecdh.<span class="hljs-title function_">generateKeys</span>(); 1788 1789<span class="hljs-keyword">const</span> compressedKey = ecdh.<span class="hljs-title function_">getPublicKey</span>(<span class="hljs-string">'hex'</span>, <span class="hljs-string">'compressed'</span>); 1790 1791<span class="hljs-keyword">const</span> uncompressedKey = <span class="hljs-variable constant_">ECDH</span>.<span class="hljs-title function_">convertKey</span>(compressedKey, 1792 <span class="hljs-string">'secp256k1'</span>, 1793 <span class="hljs-string">'hex'</span>, 1794 <span class="hljs-string">'hex'</span>, 1795 <span class="hljs-string">'uncompressed'</span>); 1796 1797<span class="hljs-comment">// The converted key and the uncompressed public key should be the same</span> 1798<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(uncompressedKey === ecdh.<span class="hljs-title function_">getPublicKey</span>(<span class="hljs-string">'hex'</span>));</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 1799 createECDH, 1800 <span class="hljs-variable constant_">ECDH</span>, 1801} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1802 1803<span class="hljs-keyword">const</span> ecdh = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp256k1'</span>); 1804ecdh.<span class="hljs-title function_">generateKeys</span>(); 1805 1806<span class="hljs-keyword">const</span> compressedKey = ecdh.<span class="hljs-title function_">getPublicKey</span>(<span class="hljs-string">'hex'</span>, <span class="hljs-string">'compressed'</span>); 1807 1808<span class="hljs-keyword">const</span> uncompressedKey = <span class="hljs-variable constant_">ECDH</span>.<span class="hljs-title function_">convertKey</span>(compressedKey, 1809 <span class="hljs-string">'secp256k1'</span>, 1810 <span class="hljs-string">'hex'</span>, 1811 <span class="hljs-string">'hex'</span>, 1812 <span class="hljs-string">'uncompressed'</span>); 1813 1814<span class="hljs-comment">// The converted key and the uncompressed public key should be the same</span> 1815<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(uncompressedKey === ecdh.<span class="hljs-title function_">getPublicKey</span>(<span class="hljs-string">'hex'</span>));</code><button class="copy-button">copy</button></pre> 1816<h4><code>ecdh.computeSecret(otherPublicKey[, inputEncoding][, outputEncoding])</code><span><a class="mark" href="#ecdhcomputesecretotherpublickey-inputencoding-outputencoding" id="ecdhcomputesecretotherpublickey-inputencoding-outputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_ecdh_computesecret_otherpublickey_inputencoding_outputencoding"></a></h4> 1817<div class="api_metadata"> 1818<details class="changelog"><summary>History</summary> 1819<table> 1820<tbody><tr><th>Version</th><th>Changes</th></tr> 1821<tr><td>v10.0.0</td> 1822<td><p>Changed error format to better support invalid public key error.</p></td></tr> 1823<tr><td>v6.0.0</td> 1824<td><p>The default <code>inputEncoding</code> changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 1825<tr><td>v0.11.14</td> 1826<td><p><span>Added in: v0.11.14</span></p></td></tr> 1827</tbody></table> 1828</details> 1829</div> 1830<ul> 1831<li><code>otherPublicKey</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> 1832<li><code>inputEncoding</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>otherPublicKey</code> string.</li> 1833<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> 1834<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> 1835</ul> 1836<p>Computes the shared secret using <code>otherPublicKey</code> as the other 1837party's public key and returns the computed shared secret. The supplied 1838key is interpreted using specified <code>inputEncoding</code>, and the returned secret 1839is encoded using the specified <code>outputEncoding</code>. 1840If the <code>inputEncoding</code> is not 1841provided, <code>otherPublicKey</code> is expected to be a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or 1842<code>DataView</code>.</p> 1843<p>If <code>outputEncoding</code> is given a string will be returned; otherwise a 1844<a href="buffer.html"><code>Buffer</code></a> is returned.</p> 1845<p><code>ecdh.computeSecret</code> will throw an 1846<code>ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY</code> error when <code>otherPublicKey</code> 1847lies outside of the elliptic curve. Since <code>otherPublicKey</code> is 1848usually supplied from a remote user over an insecure network, 1849be sure to handle this exception accordingly.</p> 1850<h4><code>ecdh.generateKeys([encoding[, format]])</code><span><a class="mark" href="#ecdhgeneratekeysencoding-format" id="ecdhgeneratekeysencoding-format">#</a></span><a aria-hidden="true" class="legacy" id="crypto_ecdh_generatekeys_encoding_format"></a></h4> 1851<div class="api_metadata"> 1852<span>Added in: v0.11.14</span> 1853</div> 1854<ul> 1855<li><code>encoding</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> 1856<li><code>format</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> <strong>Default:</strong> <code>'uncompressed'</code></li> 1857<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> 1858</ul> 1859<p>Generates private and public EC Diffie-Hellman key values, and returns 1860the public key in the specified <code>format</code> and <code>encoding</code>. This key should be 1861transferred to the other party.</p> 1862<p>The <code>format</code> argument specifies point encoding and can be <code>'compressed'</code> or 1863<code>'uncompressed'</code>. If <code>format</code> is not specified, the point will be returned in 1864<code>'uncompressed'</code> format.</p> 1865<p>If <code>encoding</code> is provided a string is returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> 1866is returned.</p> 1867<h4><code>ecdh.getPrivateKey([encoding])</code><span><a class="mark" href="#ecdhgetprivatekeyencoding" id="ecdhgetprivatekeyencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_ecdh_getprivatekey_encoding"></a></h4> 1868<div class="api_metadata"> 1869<span>Added in: v0.11.14</span> 1870</div> 1871<ul> 1872<li><code>encoding</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> 1873<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> The EC Diffie-Hellman in the specified <code>encoding</code>.</li> 1874</ul> 1875<p>If <code>encoding</code> is specified, a string is returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> is 1876returned.</p> 1877<h4><code>ecdh.getPublicKey([encoding][, format])</code><span><a class="mark" href="#ecdhgetpublickeyencoding-format" id="ecdhgetpublickeyencoding-format">#</a></span><a aria-hidden="true" class="legacy" id="crypto_ecdh_getpublickey_encoding_format"></a></h4> 1878<div class="api_metadata"> 1879<span>Added in: v0.11.14</span> 1880</div> 1881<ul> 1882<li><code>encoding</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> 1883<li><code>format</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> <strong>Default:</strong> <code>'uncompressed'</code></li> 1884<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> The EC Diffie-Hellman public key in the specified 1885<code>encoding</code> and <code>format</code>.</li> 1886</ul> 1887<p>The <code>format</code> argument specifies point encoding and can be <code>'compressed'</code> or 1888<code>'uncompressed'</code>. If <code>format</code> is not specified the point will be returned in 1889<code>'uncompressed'</code> format.</p> 1890<p>If <code>encoding</code> is specified, a string is returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> is 1891returned.</p> 1892<h4><code>ecdh.setPrivateKey(privateKey[, encoding])</code><span><a class="mark" href="#ecdhsetprivatekeyprivatekey-encoding" id="ecdhsetprivatekeyprivatekey-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_ecdh_setprivatekey_privatekey_encoding"></a></h4> 1893<div class="api_metadata"> 1894<span>Added in: v0.11.14</span> 1895</div> 1896<ul> 1897<li><code>privateKey</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> 1898<li><code>encoding</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>privateKey</code> string.</li> 1899</ul> 1900<p>Sets the EC Diffie-Hellman private key. 1901If <code>encoding</code> is provided, <code>privateKey</code> is expected 1902to be a string; otherwise <code>privateKey</code> is expected to be a <a href="buffer.html"><code>Buffer</code></a>, 1903<code>TypedArray</code>, or <code>DataView</code>.</p> 1904<p>If <code>privateKey</code> is not valid for the curve specified when the <code>ECDH</code> object was 1905created, an error is thrown. Upon setting the private key, the associated 1906public point (key) is also generated and set in the <code>ECDH</code> object.</p> 1907<h4><code>ecdh.setPublicKey(publicKey[, encoding])</code><span><a class="mark" href="#ecdhsetpublickeypublickey-encoding" id="ecdhsetpublickeypublickey-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_ecdh_setpublickey_publickey_encoding"></a></h4> 1908<div class="api_metadata"> 1909<span>Added in: v0.11.14</span><span>Deprecated since: v5.2.0</span> 1910</div> 1911<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated</div><p></p> 1912<ul> 1913<li><code>publicKey</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> 1914<li><code>encoding</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>publicKey</code> string.</li> 1915</ul> 1916<p>Sets the EC Diffie-Hellman public key. 1917If <code>encoding</code> is provided <code>publicKey</code> is expected to 1918be a string; otherwise a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code> is expected.</p> 1919<p>There is not normally a reason to call this method because <code>ECDH</code> 1920only requires a private key and the other party's public key to compute the 1921shared secret. Typically either <a href="#ecdhgeneratekeysencoding-format"><code>ecdh.generateKeys()</code></a> or 1922<a href="#ecdhsetprivatekeyprivatekey-encoding"><code>ecdh.setPrivateKey()</code></a> will be called. The <a href="#ecdhsetprivatekeyprivatekey-encoding"><code>ecdh.setPrivateKey()</code></a> method 1923attempts to generate the public point/key associated with the private key being 1924set.</p> 1925<p>Example (obtaining a shared secret):</p> 1926 1927<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 1928 createECDH, 1929 createHash, 1930} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1931 1932<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp256k1'</span>); 1933<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp256k1'</span>); 1934 1935<span class="hljs-comment">// This is a shortcut way of specifying one of Alice's previous private</span> 1936<span class="hljs-comment">// keys. It would be unwise to use such a predictable private key in a real</span> 1937<span class="hljs-comment">// application.</span> 1938alice.<span class="hljs-title function_">setPrivateKey</span>( 1939 <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>).<span class="hljs-title function_">update</span>(<span class="hljs-string">'alice'</span>, <span class="hljs-string">'utf8'</span>).<span class="hljs-title function_">digest</span>(), 1940); 1941 1942<span class="hljs-comment">// Bob uses a newly generated cryptographically strong</span> 1943<span class="hljs-comment">// pseudorandom key pair</span> 1944bob.<span class="hljs-title function_">generateKeys</span>(); 1945 1946<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bob.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 1947<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(alice.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 1948 1949<span class="hljs-comment">// aliceSecret and bobSecret should be the same shared secret value</span> 1950<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(aliceSecret === bobSecret);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 1951 createECDH, 1952 createHash, 1953} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 1954 1955<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp256k1'</span>); 1956<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">createECDH</span>(<span class="hljs-string">'secp256k1'</span>); 1957 1958<span class="hljs-comment">// This is a shortcut way of specifying one of Alice's previous private</span> 1959<span class="hljs-comment">// keys. It would be unwise to use such a predictable private key in a real</span> 1960<span class="hljs-comment">// application.</span> 1961alice.<span class="hljs-title function_">setPrivateKey</span>( 1962 <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>).<span class="hljs-title function_">update</span>(<span class="hljs-string">'alice'</span>, <span class="hljs-string">'utf8'</span>).<span class="hljs-title function_">digest</span>(), 1963); 1964 1965<span class="hljs-comment">// Bob uses a newly generated cryptographically strong</span> 1966<span class="hljs-comment">// pseudorandom key pair</span> 1967bob.<span class="hljs-title function_">generateKeys</span>(); 1968 1969<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bob.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 1970<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(alice.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 1971 1972<span class="hljs-comment">// aliceSecret and bobSecret should be the same shared secret value</span> 1973<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(aliceSecret === bobSecret);</code><button class="copy-button">copy</button></pre> 1974</section><section><h3>Class: <code>Hash</code><span><a class="mark" href="#class-hash" id="class-hash">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_hash"></a></h3> 1975<div class="api_metadata"> 1976<span>Added in: v0.1.92</span> 1977</div> 1978<ul> 1979<li>Extends: <a href="stream.html#class-streamtransform" class="type"><stream.Transform></a></li> 1980</ul> 1981<p>The <code>Hash</code> class is a utility for creating hash digests of data. It can be 1982used in one of two ways:</p> 1983<ul> 1984<li>As a <a href="stream.html">stream</a> that is both readable and writable, where data is written 1985to produce a computed hash digest on the readable side, or</li> 1986<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 1987computed hash.</li> 1988</ul> 1989<p>The <a href="#cryptocreatehashalgorithm-options"><code>crypto.createHash()</code></a> method is used to create <code>Hash</code> instances. <code>Hash</code> 1990objects are not to be created directly using the <code>new</code> keyword.</p> 1991<p>Example: Using <code>Hash</code> objects as streams:</p> 1992 1993<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 1994 createHash, 1995} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 1996 1997<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 1998 1999hash.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 2000 <span class="hljs-comment">// Only one element is going to be produced by the</span> 2001 <span class="hljs-comment">// hash stream.</span> 2002 <span class="hljs-keyword">const</span> data = hash.<span class="hljs-title function_">read</span>(); 2003 <span class="hljs-keyword">if</span> (data) { 2004 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(data.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 2005 <span class="hljs-comment">// Prints:</span> 2006 <span class="hljs-comment">// 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50</span> 2007 } 2008}); 2009 2010hash.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to hash'</span>); 2011hash.<span class="hljs-title function_">end</span>();</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2012 createHash, 2013} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2014 2015<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 2016 2017hash.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 2018 <span class="hljs-comment">// Only one element is going to be produced by the</span> 2019 <span class="hljs-comment">// hash stream.</span> 2020 <span class="hljs-keyword">const</span> data = hash.<span class="hljs-title function_">read</span>(); 2021 <span class="hljs-keyword">if</span> (data) { 2022 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(data.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 2023 <span class="hljs-comment">// Prints:</span> 2024 <span class="hljs-comment">// 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50</span> 2025 } 2026}); 2027 2028hash.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to hash'</span>); 2029hash.<span class="hljs-title function_">end</span>();</code><button class="copy-button">copy</button></pre> 2030<p>Example: Using <code>Hash</code> and piped streams:</p> 2031 2032<pre class="with-48-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { createReadStream } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:fs'</span>; 2033<span class="hljs-keyword">import</span> { stdout } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:process'</span>; 2034<span class="hljs-keyword">const</span> { createHash } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2035 2036<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 2037 2038<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.js'</span>); 2039input.<span class="hljs-title function_">pipe</span>(hash).<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'hex'</span>).<span class="hljs-title function_">pipe</span>(stdout);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { createReadStream } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 2040<span class="hljs-keyword">const</span> { createHash } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2041<span class="hljs-keyword">const</span> { stdout } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:process'</span>); 2042 2043<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 2044 2045<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.js'</span>); 2046input.<span class="hljs-title function_">pipe</span>(hash).<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'hex'</span>).<span class="hljs-title function_">pipe</span>(stdout);</code><button class="copy-button">copy</button></pre> 2047<p>Example: Using the <a href="#hashupdatedata-inputencoding"><code>hash.update()</code></a> and <a href="#hashdigestencoding"><code>hash.digest()</code></a> methods:</p> 2048 2049<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 2050 createHash, 2051} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2052 2053<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 2054 2055hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to hash'</span>); 2056<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2057<span class="hljs-comment">// Prints:</span> 2058<span class="hljs-comment">// 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2059 createHash, 2060} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2061 2062<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 2063 2064hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to hash'</span>); 2065<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2066<span class="hljs-comment">// Prints:</span> 2067<span class="hljs-comment">// 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50</span></code><button class="copy-button">copy</button></pre> 2068<h4><code>hash.copy([options])</code><span><a class="mark" href="#hashcopyoptions" id="hashcopyoptions">#</a></span><a aria-hidden="true" class="legacy" id="crypto_hash_copy_options"></a></h4> 2069<div class="api_metadata"> 2070<span>Added in: v13.1.0</span> 2071</div> 2072<ul> 2073<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a></li> 2074<li>Returns: <a href="crypto.html#class-hash" class="type"><Hash></a></li> 2075</ul> 2076<p>Creates a new <code>Hash</code> object that contains a deep copy of the internal state 2077of the current <code>Hash</code> object.</p> 2078<p>The optional <code>options</code> argument controls stream behavior. For XOF hash 2079functions such as <code>'shake256'</code>, the <code>outputLength</code> option can be used to 2080specify the desired output length in bytes.</p> 2081<p>An error is thrown when an attempt is made to copy the <code>Hash</code> object after 2082its <a href="#hashdigestencoding"><code>hash.digest()</code></a> method has been called.</p> 2083 2084<pre class="with-28-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// Calculate a rolling hash.</span> 2085<span class="hljs-keyword">const</span> { 2086 createHash, 2087} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2088 2089<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 2090 2091hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'one'</span>); 2092<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">copy</span>().<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2093 2094hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'two'</span>); 2095<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">copy</span>().<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2096 2097hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'three'</span>); 2098<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">copy</span>().<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2099 2100<span class="hljs-comment">// Etc.</span></code><code class="language-js cjs"><span class="hljs-comment">// Calculate a rolling hash.</span> 2101<span class="hljs-keyword">const</span> { 2102 createHash, 2103} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2104 2105<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 2106 2107hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'one'</span>); 2108<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">copy</span>().<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2109 2110hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'two'</span>); 2111<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">copy</span>().<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2112 2113hash.<span class="hljs-title function_">update</span>(<span class="hljs-string">'three'</span>); 2114<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hash.<span class="hljs-title function_">copy</span>().<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2115 2116<span class="hljs-comment">// Etc.</span></code><button class="copy-button">copy</button></pre> 2117<h4><code>hash.digest([encoding])</code><span><a class="mark" href="#hashdigestencoding" id="hashdigestencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_hash_digest_encoding"></a></h4> 2118<div class="api_metadata"> 2119<span>Added in: v0.1.92</span> 2120</div> 2121<ul> 2122<li><code>encoding</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> 2123<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> 2124</ul> 2125<p>Calculates the digest of all of the data passed to be hashed (using the 2126<a href="#hashupdatedata-inputencoding"><code>hash.update()</code></a> method). 2127If <code>encoding</code> is provided a string will be returned; otherwise 2128a <a href="buffer.html"><code>Buffer</code></a> is returned.</p> 2129<p>The <code>Hash</code> object can not be used again after <code>hash.digest()</code> method has been 2130called. Multiple calls will cause an error to be thrown.</p> 2131<h4><code>hash.update(data[, inputEncoding])</code><span><a class="mark" href="#hashupdatedata-inputencoding" id="hashupdatedata-inputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_hash_update_data_inputencoding"></a></h4> 2132<div class="api_metadata"> 2133<details class="changelog"><summary>History</summary> 2134<table> 2135<tbody><tr><th>Version</th><th>Changes</th></tr> 2136<tr><td>v6.0.0</td> 2137<td><p>The default <code>inputEncoding</code> changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 2138<tr><td>v0.1.92</td> 2139<td><p><span>Added in: v0.1.92</span></p></td></tr> 2140</tbody></table> 2141</details> 2142</div> 2143<ul> 2144<li><code>data</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> | <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> 2145<li><code>inputEncoding</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>data</code> string.</li> 2146</ul> 2147<p>Updates the hash content with the given <code>data</code>, the encoding of which 2148is given in <code>inputEncoding</code>. 2149If <code>encoding</code> is not provided, and the <code>data</code> is a string, an 2150encoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or 2151<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p> 2152<p>This can be called many times with new data as it is streamed.</p> 2153</section><section><h3>Class: <code>Hmac</code><span><a class="mark" href="#class-hmac" id="class-hmac">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_hmac"></a></h3> 2154<div class="api_metadata"> 2155<span>Added in: v0.1.94</span> 2156</div> 2157<ul> 2158<li>Extends: <a href="stream.html#class-streamtransform" class="type"><stream.Transform></a></li> 2159</ul> 2160<p>The <code>Hmac</code> class is a utility for creating cryptographic HMAC digests. It can 2161be used in one of two ways:</p> 2162<ul> 2163<li>As a <a href="stream.html">stream</a> that is both readable and writable, where data is written 2164to produce a computed HMAC digest on the readable side, or</li> 2165<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 2166computed HMAC digest.</li> 2167</ul> 2168<p>The <a href="#cryptocreatehmacalgorithm-key-options"><code>crypto.createHmac()</code></a> method is used to create <code>Hmac</code> instances. <code>Hmac</code> 2169objects are not to be created directly using the <code>new</code> keyword.</p> 2170<p>Example: Using <code>Hmac</code> objects as streams:</p> 2171 2172<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 2173 createHmac, 2174} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2175 2176<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 2177 2178hmac.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 2179 <span class="hljs-comment">// Only one element is going to be produced by the</span> 2180 <span class="hljs-comment">// hash stream.</span> 2181 <span class="hljs-keyword">const</span> data = hmac.<span class="hljs-title function_">read</span>(); 2182 <span class="hljs-keyword">if</span> (data) { 2183 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(data.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 2184 <span class="hljs-comment">// Prints:</span> 2185 <span class="hljs-comment">// 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e</span> 2186 } 2187}); 2188 2189hmac.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to hash'</span>); 2190hmac.<span class="hljs-title function_">end</span>();</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2191 createHmac, 2192} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2193 2194<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 2195 2196hmac.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 2197 <span class="hljs-comment">// Only one element is going to be produced by the</span> 2198 <span class="hljs-comment">// hash stream.</span> 2199 <span class="hljs-keyword">const</span> data = hmac.<span class="hljs-title function_">read</span>(); 2200 <span class="hljs-keyword">if</span> (data) { 2201 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(data.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 2202 <span class="hljs-comment">// Prints:</span> 2203 <span class="hljs-comment">// 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e</span> 2204 } 2205}); 2206 2207hmac.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to hash'</span>); 2208hmac.<span class="hljs-title function_">end</span>();</code><button class="copy-button">copy</button></pre> 2209<p>Example: Using <code>Hmac</code> and piped streams:</p> 2210 2211<pre class="with-43-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { createReadStream } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:fs'</span>; 2212<span class="hljs-keyword">import</span> { stdout } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:process'</span>; 2213<span class="hljs-keyword">const</span> { 2214 createHmac, 2215} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2216 2217<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 2218 2219<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.js'</span>); 2220input.<span class="hljs-title function_">pipe</span>(hmac).<span class="hljs-title function_">pipe</span>(stdout);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2221 createReadStream, 2222} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 2223<span class="hljs-keyword">const</span> { 2224 createHmac, 2225} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2226<span class="hljs-keyword">const</span> { stdout } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:process'</span>); 2227 2228<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 2229 2230<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(<span class="hljs-string">'test.js'</span>); 2231input.<span class="hljs-title function_">pipe</span>(hmac).<span class="hljs-title function_">pipe</span>(stdout);</code><button class="copy-button">copy</button></pre> 2232<p>Example: Using the <a href="#hmacupdatedata-inputencoding"><code>hmac.update()</code></a> and <a href="#hmacdigestencoding"><code>hmac.digest()</code></a> methods:</p> 2233 2234<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 2235 createHmac, 2236} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2237 2238<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 2239 2240hmac.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to hash'</span>); 2241<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hmac.<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2242<span class="hljs-comment">// Prints:</span> 2243<span class="hljs-comment">// 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2244 createHmac, 2245} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2246 2247<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 2248 2249hmac.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to hash'</span>); 2250<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(hmac.<span class="hljs-title function_">digest</span>(<span class="hljs-string">'hex'</span>)); 2251<span class="hljs-comment">// Prints:</span> 2252<span class="hljs-comment">// 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e</span></code><button class="copy-button">copy</button></pre> 2253<h4><code>hmac.digest([encoding])</code><span><a class="mark" href="#hmacdigestencoding" id="hmacdigestencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_hmac_digest_encoding"></a></h4> 2254<div class="api_metadata"> 2255<span>Added in: v0.1.94</span> 2256</div> 2257<ul> 2258<li><code>encoding</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> 2259<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> 2260</ul> 2261<p>Calculates the HMAC digest of all of the data passed using <a href="#hmacupdatedata-inputencoding"><code>hmac.update()</code></a>. 2262If <code>encoding</code> is 2263provided a string is returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> is returned;</p> 2264<p>The <code>Hmac</code> object can not be used again after <code>hmac.digest()</code> has been 2265called. Multiple calls to <code>hmac.digest()</code> will result in an error being thrown.</p> 2266<h4><code>hmac.update(data[, inputEncoding])</code><span><a class="mark" href="#hmacupdatedata-inputencoding" id="hmacupdatedata-inputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_hmac_update_data_inputencoding"></a></h4> 2267<div class="api_metadata"> 2268<details class="changelog"><summary>History</summary> 2269<table> 2270<tbody><tr><th>Version</th><th>Changes</th></tr> 2271<tr><td>v6.0.0</td> 2272<td><p>The default <code>inputEncoding</code> changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 2273<tr><td>v0.1.94</td> 2274<td><p><span>Added in: v0.1.94</span></p></td></tr> 2275</tbody></table> 2276</details> 2277</div> 2278<ul> 2279<li><code>data</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> | <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> 2280<li><code>inputEncoding</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>data</code> string.</li> 2281</ul> 2282<p>Updates the <code>Hmac</code> content with the given <code>data</code>, the encoding of which 2283is given in <code>inputEncoding</code>. 2284If <code>encoding</code> is not provided, and the <code>data</code> is a string, an 2285encoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or 2286<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p> 2287<p>This can be called many times with new data as it is streamed.</p> 2288</section><section><h3>Class: <code>KeyObject</code><span><a class="mark" href="#class-keyobject" id="class-keyobject">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_keyobject"></a></h3> 2289<div class="api_metadata"> 2290<details class="changelog"><summary>History</summary> 2291<table> 2292<tbody><tr><th>Version</th><th>Changes</th></tr> 2293<tr><td>v14.5.0, v12.19.0</td> 2294<td><p>Instances of this class can now be passed to worker threads using <code>postMessage</code>.</p></td></tr> 2295<tr><td>v11.13.0</td> 2296<td><p>This class is now exported.</p></td></tr> 2297<tr><td>v11.6.0</td> 2298<td><p><span>Added in: v11.6.0</span></p></td></tr> 2299</tbody></table> 2300</details> 2301</div> 2302<p>Node.js uses a <code>KeyObject</code> class to represent a symmetric or asymmetric key, 2303and each kind of key exposes different functions. The 2304<a href="#cryptocreatesecretkeykey-encoding"><code>crypto.createSecretKey()</code></a>, <a href="#cryptocreatepublickeykey"><code>crypto.createPublicKey()</code></a> and 2305<a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey()</code></a> methods are used to create <code>KeyObject</code> 2306instances. <code>KeyObject</code> objects are not to be created directly using the <code>new</code> 2307keyword.</p> 2308<p>Most applications should consider using the new <code>KeyObject</code> API instead of 2309passing keys as strings or <code>Buffer</code>s due to improved security features.</p> 2310<p><code>KeyObject</code> instances can be passed to other threads via <a href="worker_threads.html#portpostmessagevalue-transferlist"><code>postMessage()</code></a>. 2311The receiver obtains a cloned <code>KeyObject</code>, and the <code>KeyObject</code> does not need to 2312be listed in the <code>transferList</code> argument.</p> 2313<h4>Static method: <code>KeyObject.from(key)</code><span><a class="mark" href="#static-method-keyobjectfromkey" id="static-method-keyobjectfromkey">#</a></span><a aria-hidden="true" class="legacy" id="crypto_static_method_keyobject_from_key"></a></h4> 2314<div class="api_metadata"> 2315<span>Added in: v15.0.0</span> 2316</div> 2317<ul> 2318<li><code>key</code> <a href="webcrypto.html#class-cryptokey" class="type"><CryptoKey></a></li> 2319<li>Returns: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 2320</ul> 2321<p>Example: Converting a <code>CryptoKey</code> instance to a <code>KeyObject</code>:</p> 2322 2323<pre class="with-61-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { webcrypto, <span class="hljs-title class_">KeyObject</span> } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2324<span class="hljs-keyword">const</span> { subtle } = webcrypto; 2325 2326<span class="hljs-keyword">const</span> key = <span class="hljs-keyword">await</span> subtle.<span class="hljs-title function_">generateKey</span>({ 2327 <span class="hljs-attr">name</span>: <span class="hljs-string">'HMAC'</span>, 2328 <span class="hljs-attr">hash</span>: <span class="hljs-string">'SHA-256'</span>, 2329 <span class="hljs-attr">length</span>: <span class="hljs-number">256</span>, 2330}, <span class="hljs-literal">true</span>, [<span class="hljs-string">'sign'</span>, <span class="hljs-string">'verify'</span>]); 2331 2332<span class="hljs-keyword">const</span> keyObject = <span class="hljs-title class_">KeyObject</span>.<span class="hljs-title function_">from</span>(key); 2333<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(keyObject.<span class="hljs-property">symmetricKeySize</span>); 2334<span class="hljs-comment">// Prints: 32 (symmetric key size in bytes)</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2335 <span class="hljs-attr">webcrypto</span>: { 2336 subtle, 2337 }, 2338 <span class="hljs-title class_">KeyObject</span>, 2339} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2340 2341(<span class="hljs-keyword">async</span> <span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) { 2342 <span class="hljs-keyword">const</span> key = <span class="hljs-keyword">await</span> subtle.<span class="hljs-title function_">generateKey</span>({ 2343 <span class="hljs-attr">name</span>: <span class="hljs-string">'HMAC'</span>, 2344 <span class="hljs-attr">hash</span>: <span class="hljs-string">'SHA-256'</span>, 2345 <span class="hljs-attr">length</span>: <span class="hljs-number">256</span>, 2346 }, <span class="hljs-literal">true</span>, [<span class="hljs-string">'sign'</span>, <span class="hljs-string">'verify'</span>]); 2347 2348 <span class="hljs-keyword">const</span> keyObject = <span class="hljs-title class_">KeyObject</span>.<span class="hljs-title function_">from</span>(key); 2349 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(keyObject.<span class="hljs-property">symmetricKeySize</span>); 2350 <span class="hljs-comment">// Prints: 32 (symmetric key size in bytes)</span> 2351})();</code><button class="copy-button">copy</button></pre> 2352<h4><code>keyObject.asymmetricKeyDetails</code><span><a class="mark" href="#keyobjectasymmetrickeydetails" id="keyobjectasymmetrickeydetails">#</a></span><a aria-hidden="true" class="legacy" id="crypto_keyobject_asymmetrickeydetails"></a></h4> 2353<div class="api_metadata"> 2354<details class="changelog"><summary>History</summary> 2355<table> 2356<tbody><tr><th>Version</th><th>Changes</th></tr> 2357<tr><td>v16.9.0</td> 2358<td><p>Expose <code>RSASSA-PSS-params</code> sequence parameters for RSA-PSS keys.</p></td></tr> 2359<tr><td>v15.7.0</td> 2360<td><p><span>Added in: v15.7.0</span></p></td></tr> 2361</tbody></table> 2362</details> 2363</div> 2364<ul> 2365<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2366<ul> 2367<li><code>modulusLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Key size in bits (RSA, DSA).</li> 2368<li><code>publicExponent</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a> Public exponent (RSA).</li> 2369<li><code>hashAlgorithm</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the message digest (RSA-PSS).</li> 2370<li><code>mgf1HashAlgorithm</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the message digest used by 2371MGF1 (RSA-PSS).</li> 2372<li><code>saltLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Minimal salt length in bytes (RSA-PSS).</li> 2373<li><code>divisorLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Size of <code>q</code> in bits (DSA).</li> 2374<li><code>namedCurve</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the curve (EC).</li> 2375</ul> 2376</li> 2377</ul> 2378<p>This property exists only on asymmetric keys. Depending on the type of the key, 2379this object contains information about the key. None of the information obtained 2380through this property can be used to uniquely identify a key or to compromise 2381the security of the key.</p> 2382<p>For RSA-PSS keys, if the key material contains a <code>RSASSA-PSS-params</code> sequence, 2383the <code>hashAlgorithm</code>, <code>mgf1HashAlgorithm</code>, and <code>saltLength</code> properties will be 2384set.</p> 2385<p>Other key details might be exposed via this API using additional attributes.</p> 2386<h4><code>keyObject.asymmetricKeyType</code><span><a class="mark" href="#keyobjectasymmetrickeytype" id="keyobjectasymmetrickeytype">#</a></span><a aria-hidden="true" class="legacy" id="crypto_keyobject_asymmetrickeytype"></a></h4> 2387<div class="api_metadata"> 2388<details class="changelog"><summary>History</summary> 2389<table> 2390<tbody><tr><th>Version</th><th>Changes</th></tr> 2391<tr><td>v13.9.0, v12.17.0</td> 2392<td><p>Added support for <code>'dh'</code>.</p></td></tr> 2393<tr><td>v12.0.0</td> 2394<td><p>Added support for <code>'rsa-pss'</code>.</p></td></tr> 2395<tr><td>v12.0.0</td> 2396<td><p>This property now returns <code>undefined</code> for KeyObject instances of unrecognized type instead of aborting.</p></td></tr> 2397<tr><td>v12.0.0</td> 2398<td><p>Added support for <code>'x25519'</code> and <code>'x448'</code>.</p></td></tr> 2399<tr><td>v12.0.0</td> 2400<td><p>Added support for <code>'ed25519'</code> and <code>'ed448'</code>.</p></td></tr> 2401<tr><td>v11.6.0</td> 2402<td><p><span>Added in: v11.6.0</span></p></td></tr> 2403</tbody></table> 2404</details> 2405</div> 2406<ul> 2407<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2408</ul> 2409<p>For asymmetric keys, this property represents the type of the key. Supported key 2410types are:</p> 2411<ul> 2412<li><code>'rsa'</code> (OID 1.2.840.113549.1.1.1)</li> 2413<li><code>'rsa-pss'</code> (OID 1.2.840.113549.1.1.10)</li> 2414<li><code>'dsa'</code> (OID 1.2.840.10040.4.1)</li> 2415<li><code>'ec'</code> (OID 1.2.840.10045.2.1)</li> 2416<li><code>'x25519'</code> (OID 1.3.101.110)</li> 2417<li><code>'x448'</code> (OID 1.3.101.111)</li> 2418<li><code>'ed25519'</code> (OID 1.3.101.112)</li> 2419<li><code>'ed448'</code> (OID 1.3.101.113)</li> 2420<li><code>'dh'</code> (OID 1.2.840.113549.1.3.1)</li> 2421</ul> 2422<p>This property is <code>undefined</code> for unrecognized <code>KeyObject</code> types and symmetric 2423keys.</p> 2424<h4><code>keyObject.export([options])</code><span><a class="mark" href="#keyobjectexportoptions" id="keyobjectexportoptions">#</a></span><a aria-hidden="true" class="legacy" id="crypto_keyobject_export_options"></a></h4> 2425<div class="api_metadata"> 2426<details class="changelog"><summary>History</summary> 2427<table> 2428<tbody><tr><th>Version</th><th>Changes</th></tr> 2429<tr><td>v15.9.0</td> 2430<td><p>Added support for <code>'jwk'</code> format.</p></td></tr> 2431<tr><td>v11.6.0</td> 2432<td><p><span>Added in: v11.6.0</span></p></td></tr> 2433</tbody></table> 2434</details> 2435</div> 2436<ul> 2437<li><code>options</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2438<li>Returns: <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> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2439</ul> 2440<p>For symmetric keys, the following encoding options can be used:</p> 2441<ul> 2442<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> 2443</ul> 2444<p>For public keys, the following encoding options can be used:</p> 2445<ul> 2446<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> 2447<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> 2448</ul> 2449<p>For private keys, the following encoding options can be used:</p> 2450<ul> 2451<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 2452<code>'sec1'</code> (EC only).</li> 2453<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> 2454<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 2455the given <code>cipher</code> and <code>passphrase</code> using PKCS#5 v2.0 password based 2456encryption.</li> 2457<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 2458<code>cipher</code>.</li> 2459</ul> 2460<p>The result type depends on the selected encoding format, when PEM the 2461result is a string, when DER it will be a buffer containing the data 2462encoded as DER, when <a href="https://tools.ietf.org/html/rfc7517">JWK</a> it will be an object.</p> 2463<p>When <a href="https://tools.ietf.org/html/rfc7517">JWK</a> encoding format was selected, all other encoding options are 2464ignored.</p> 2465<p>PKCS#1, SEC1, and PKCS#8 type keys can be encrypted by using a combination of 2466the <code>cipher</code> and <code>format</code> options. The PKCS#8 <code>type</code> can be used with any 2467<code>format</code> to encrypt any key algorithm (RSA, EC, or DH) by specifying a 2468<code>cipher</code>. PKCS#1 and SEC1 can only be encrypted by specifying a <code>cipher</code> 2469when the PEM <code>format</code> is used. For maximum compatibility, use PKCS#8 for 2470encrypted private keys. Since PKCS#8 defines its own 2471encryption mechanism, PEM-level encryption is not supported when encrypting 2472a 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 2473PKCS#1 and SEC1 encryption.</p> 2474<h4><code>keyObject.equals(otherKeyObject)</code><span><a class="mark" href="#keyobjectequalsotherkeyobject" id="keyobjectequalsotherkeyobject">#</a></span><a aria-hidden="true" class="legacy" id="crypto_keyobject_equals_otherkeyobject"></a></h4> 2475<div class="api_metadata"> 2476<span>Added in: v17.7.0</span> 2477</div> 2478<ul> 2479<li><code>otherKeyObject</code>: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a> A <code>KeyObject</code> with which to 2480compare <code>keyObject</code>.</li> 2481<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2482</ul> 2483<p>Returns <code>true</code> or <code>false</code> depending on whether the keys have exactly the same 2484type, value, and parameters. This method is not 2485<a href="https://en.wikipedia.org/wiki/Timing_attack">constant time</a>.</p> 2486<h4><code>keyObject.symmetricKeySize</code><span><a class="mark" href="#keyobjectsymmetrickeysize" id="keyobjectsymmetrickeysize">#</a></span><a aria-hidden="true" class="legacy" id="crypto_keyobject_symmetrickeysize"></a></h4> 2487<div class="api_metadata"> 2488<span>Added in: v11.6.0</span> 2489</div> 2490<ul> 2491<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2492</ul> 2493<p>For secret keys, this property represents the size of the key in bytes. This 2494property is <code>undefined</code> for asymmetric keys.</p> 2495<h4><code>keyObject.type</code><span><a class="mark" href="#keyobjecttype" id="keyobjecttype">#</a></span><a aria-hidden="true" class="legacy" id="crypto_keyobject_type"></a></h4> 2496<div class="api_metadata"> 2497<span>Added in: v11.6.0</span> 2498</div> 2499<ul> 2500<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2501</ul> 2502<p>Depending on the type of this <code>KeyObject</code>, this property is either 2503<code>'secret'</code> for secret (symmetric) keys, <code>'public'</code> for public (asymmetric) keys 2504or <code>'private'</code> for private (asymmetric) keys.</p> 2505</section><section><h3>Class: <code>Sign</code><span><a class="mark" href="#class-sign" id="class-sign">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_sign"></a></h3> 2506<div class="api_metadata"> 2507<span>Added in: v0.1.92</span> 2508</div> 2509<ul> 2510<li>Extends: <a href="stream.html#class-streamwritable" class="type"><stream.Writable></a></li> 2511</ul> 2512<p>The <code>Sign</code> class is a utility for generating signatures. It can be used in one 2513of two ways:</p> 2514<ul> 2515<li>As a writable <a href="stream.html">stream</a>, where data to be signed is written and the 2516<a href="#signsignprivatekey-outputencoding"><code>sign.sign()</code></a> method is used to generate and return the signature, or</li> 2517<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 2518signature.</li> 2519</ul> 2520<p>The <a href="#cryptocreatesignalgorithm-options"><code>crypto.createSign()</code></a> method is used to create <code>Sign</code> instances. The 2521argument is the string name of the hash function to use. <code>Sign</code> objects are not 2522to be created directly using the <code>new</code> keyword.</p> 2523<p>Example: Using <code>Sign</code> and <a href="#class-verify"><code>Verify</code></a> objects as streams:</p> 2524 2525<pre class="with-22-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 2526 generateKeyPairSync, 2527 createSign, 2528 createVerify, 2529} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2530 2531<span class="hljs-keyword">const</span> { privateKey, publicKey } = <span class="hljs-title function_">generateKeyPairSync</span>(<span class="hljs-string">'ec'</span>, { 2532 <span class="hljs-attr">namedCurve</span>: <span class="hljs-string">'sect239k1'</span>, 2533}); 2534 2535<span class="hljs-keyword">const</span> sign = <span class="hljs-title function_">createSign</span>(<span class="hljs-string">'SHA256'</span>); 2536sign.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to sign'</span>); 2537sign.<span class="hljs-title function_">end</span>(); 2538<span class="hljs-keyword">const</span> signature = sign.<span class="hljs-title function_">sign</span>(privateKey, <span class="hljs-string">'hex'</span>); 2539 2540<span class="hljs-keyword">const</span> verify = <span class="hljs-title function_">createVerify</span>(<span class="hljs-string">'SHA256'</span>); 2541verify.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to sign'</span>); 2542verify.<span class="hljs-title function_">end</span>(); 2543<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(verify.<span class="hljs-title function_">verify</span>(publicKey, signature, <span class="hljs-string">'hex'</span>)); 2544<span class="hljs-comment">// Prints: true</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2545 generateKeyPairSync, 2546 createSign, 2547 createVerify, 2548} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2549 2550<span class="hljs-keyword">const</span> { privateKey, publicKey } = <span class="hljs-title function_">generateKeyPairSync</span>(<span class="hljs-string">'ec'</span>, { 2551 <span class="hljs-attr">namedCurve</span>: <span class="hljs-string">'sect239k1'</span>, 2552}); 2553 2554<span class="hljs-keyword">const</span> sign = <span class="hljs-title function_">createSign</span>(<span class="hljs-string">'SHA256'</span>); 2555sign.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to sign'</span>); 2556sign.<span class="hljs-title function_">end</span>(); 2557<span class="hljs-keyword">const</span> signature = sign.<span class="hljs-title function_">sign</span>(privateKey, <span class="hljs-string">'hex'</span>); 2558 2559<span class="hljs-keyword">const</span> verify = <span class="hljs-title function_">createVerify</span>(<span class="hljs-string">'SHA256'</span>); 2560verify.<span class="hljs-title function_">write</span>(<span class="hljs-string">'some data to sign'</span>); 2561verify.<span class="hljs-title function_">end</span>(); 2562<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(verify.<span class="hljs-title function_">verify</span>(publicKey, signature, <span class="hljs-string">'hex'</span>)); 2563<span class="hljs-comment">// Prints: true</span></code><button class="copy-button">copy</button></pre> 2564<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> 2565 2566<pre class="with-22-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 2567 generateKeyPairSync, 2568 createSign, 2569 createVerify, 2570} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2571 2572<span class="hljs-keyword">const</span> { privateKey, publicKey } = <span class="hljs-title function_">generateKeyPairSync</span>(<span class="hljs-string">'rsa'</span>, { 2573 <span class="hljs-attr">modulusLength</span>: <span class="hljs-number">2048</span>, 2574}); 2575 2576<span class="hljs-keyword">const</span> sign = <span class="hljs-title function_">createSign</span>(<span class="hljs-string">'SHA256'</span>); 2577sign.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to sign'</span>); 2578sign.<span class="hljs-title function_">end</span>(); 2579<span class="hljs-keyword">const</span> signature = sign.<span class="hljs-title function_">sign</span>(privateKey); 2580 2581<span class="hljs-keyword">const</span> verify = <span class="hljs-title function_">createVerify</span>(<span class="hljs-string">'SHA256'</span>); 2582verify.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to sign'</span>); 2583verify.<span class="hljs-title function_">end</span>(); 2584<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(verify.<span class="hljs-title function_">verify</span>(publicKey, signature)); 2585<span class="hljs-comment">// Prints: true</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 2586 generateKeyPairSync, 2587 createSign, 2588 createVerify, 2589} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2590 2591<span class="hljs-keyword">const</span> { privateKey, publicKey } = <span class="hljs-title function_">generateKeyPairSync</span>(<span class="hljs-string">'rsa'</span>, { 2592 <span class="hljs-attr">modulusLength</span>: <span class="hljs-number">2048</span>, 2593}); 2594 2595<span class="hljs-keyword">const</span> sign = <span class="hljs-title function_">createSign</span>(<span class="hljs-string">'SHA256'</span>); 2596sign.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to sign'</span>); 2597sign.<span class="hljs-title function_">end</span>(); 2598<span class="hljs-keyword">const</span> signature = sign.<span class="hljs-title function_">sign</span>(privateKey); 2599 2600<span class="hljs-keyword">const</span> verify = <span class="hljs-title function_">createVerify</span>(<span class="hljs-string">'SHA256'</span>); 2601verify.<span class="hljs-title function_">update</span>(<span class="hljs-string">'some data to sign'</span>); 2602verify.<span class="hljs-title function_">end</span>(); 2603<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(verify.<span class="hljs-title function_">verify</span>(publicKey, signature)); 2604<span class="hljs-comment">// Prints: true</span></code><button class="copy-button">copy</button></pre> 2605<h4><code>sign.sign(privateKey[, outputEncoding])</code><span><a class="mark" href="#signsignprivatekey-outputencoding" id="signsignprivatekey-outputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_sign_sign_privatekey_outputencoding"></a></h4> 2606<div class="api_metadata"> 2607<details class="changelog"><summary>History</summary> 2608<table> 2609<tbody><tr><th>Version</th><th>Changes</th></tr> 2610<tr><td>v15.0.0</td> 2611<td><p>The privateKey can also be an ArrayBuffer and CryptoKey.</p></td></tr> 2612<tr><td>v13.2.0, v12.16.0</td> 2613<td><p>This function now supports IEEE-P1363 DSA and ECDSA signatures.</p></td></tr> 2614<tr><td>v12.0.0</td> 2615<td><p>This function now supports RSA-PSS keys.</p></td></tr> 2616<tr><td>v11.6.0</td> 2617<td><p>This function now supports key objects.</p></td></tr> 2618<tr><td>v8.0.0</td> 2619<td><p>Support for RSASSA-PSS and additional options was added.</p></td></tr> 2620<tr><td>v0.1.92</td> 2621<td><p><span>Added in: v0.1.92</span></p></td></tr> 2622</tbody></table> 2623</details> 2624</div> 2625<!--lint disable maximum-line-length remark-lint--> 2626<ul> 2627<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> 2628<ul> 2629<li><code>dsaEncoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2630<li><code>padding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 2631<li><code>saltLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 2632</ul> 2633</li> 2634<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> 2635<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> 2636</ul> 2637<!--lint enable maximum-line-length remark-lint--> 2638<p>Calculates the signature on all the data passed through using either 2639<a href="#signupdatedata-inputencoding"><code>sign.update()</code></a> or <a href="stream.html#writablewritechunk-encoding-callback"><code>sign.write()</code></a>.</p> 2640<p>If <code>privateKey</code> is not a <a href="#class-keyobject"><code>KeyObject</code></a>, this function behaves as if 2641<code>privateKey</code> had been passed to <a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey()</code></a>. If it is an 2642object, the following additional properties can be passed:</p> 2643<ul> 2644<li> 2645<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 2646format of the generated signature. It can be one of the following:</p> 2647<ul> 2648<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li> 2649<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li> 2650</ul> 2651</li> 2652<li> 2653<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> 2654<ul> 2655<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li> 2656<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li> 2657</ul> 2658<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function 2659used 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 2660an MGF1 hash function has been specified as part of the key in compliance with 2661section 3.3 of <a href="https://www.rfc-editor.org/rfc/rfc4055.txt">RFC 4055</a>.</p> 2662</li> 2663<li> 2664<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 2665<code>RSA_PKCS1_PSS_PADDING</code>. The special value 2666<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest 2667size, <code>crypto.constants.RSA_PSS_SALTLEN_MAX_SIGN</code> (default) sets it to the 2668maximum permissible value.</p> 2669</li> 2670</ul> 2671<p>If <code>outputEncoding</code> is provided a string is returned; otherwise a <a href="buffer.html"><code>Buffer</code></a> 2672is returned.</p> 2673<p>The <code>Sign</code> object can not be again used after <code>sign.sign()</code> method has been 2674called. Multiple calls to <code>sign.sign()</code> will result in an error being thrown.</p> 2675<h4><code>sign.update(data[, inputEncoding])</code><span><a class="mark" href="#signupdatedata-inputencoding" id="signupdatedata-inputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_sign_update_data_inputencoding"></a></h4> 2676<div class="api_metadata"> 2677<details class="changelog"><summary>History</summary> 2678<table> 2679<tbody><tr><th>Version</th><th>Changes</th></tr> 2680<tr><td>v6.0.0</td> 2681<td><p>The default <code>inputEncoding</code> changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 2682<tr><td>v0.1.92</td> 2683<td><p><span>Added in: v0.1.92</span></p></td></tr> 2684</tbody></table> 2685</details> 2686</div> 2687<ul> 2688<li><code>data</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> | <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> 2689<li><code>inputEncoding</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>data</code> string.</li> 2690</ul> 2691<p>Updates the <code>Sign</code> content with the given <code>data</code>, the encoding of which 2692is given in <code>inputEncoding</code>. 2693If <code>encoding</code> is not provided, and the <code>data</code> is a string, an 2694encoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or 2695<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p> 2696<p>This can be called many times with new data as it is streamed.</p> 2697</section><section><h3>Class: <code>Verify</code><span><a class="mark" href="#class-verify" id="class-verify">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_verify"></a></h3> 2698<div class="api_metadata"> 2699<span>Added in: v0.1.92</span> 2700</div> 2701<ul> 2702<li>Extends: <a href="stream.html#class-streamwritable" class="type"><stream.Writable></a></li> 2703</ul> 2704<p>The <code>Verify</code> class is a utility for verifying signatures. It can be used in one 2705of two ways:</p> 2706<ul> 2707<li>As a writable <a href="stream.html">stream</a> where written data is used to validate against the 2708supplied signature, or</li> 2709<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 2710the signature.</li> 2711</ul> 2712<p>The <a href="#cryptocreateverifyalgorithm-options"><code>crypto.createVerify()</code></a> method is used to create <code>Verify</code> instances. 2713<code>Verify</code> objects are not to be created directly using the <code>new</code> keyword.</p> 2714<p>See <a href="#class-sign"><code>Sign</code></a> for examples.</p> 2715<h4><code>verify.update(data[, inputEncoding])</code><span><a class="mark" href="#verifyupdatedata-inputencoding" id="verifyupdatedata-inputencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_verify_update_data_inputencoding"></a></h4> 2716<div class="api_metadata"> 2717<details class="changelog"><summary>History</summary> 2718<table> 2719<tbody><tr><th>Version</th><th>Changes</th></tr> 2720<tr><td>v6.0.0</td> 2721<td><p>The default <code>inputEncoding</code> changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 2722<tr><td>v0.1.92</td> 2723<td><p><span>Added in: v0.1.92</span></p></td></tr> 2724</tbody></table> 2725</details> 2726</div> 2727<ul> 2728<li><code>data</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> | <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> 2729<li><code>inputEncoding</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>data</code> string.</li> 2730</ul> 2731<p>Updates the <code>Verify</code> content with the given <code>data</code>, the encoding of which 2732is given in <code>inputEncoding</code>. 2733If <code>inputEncoding</code> is not provided, and the <code>data</code> is a string, an 2734encoding of <code>'utf8'</code> is enforced. If <code>data</code> is a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or 2735<code>DataView</code>, then <code>inputEncoding</code> is ignored.</p> 2736<p>This can be called many times with new data as it is streamed.</p> 2737<h4><code>verify.verify(object, signature[, signatureEncoding])</code><span><a class="mark" href="#verifyverifyobject-signature-signatureencoding" id="verifyverifyobject-signature-signatureencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_verify_verify_object_signature_signatureencoding"></a></h4> 2738<div class="api_metadata"> 2739<details class="changelog"><summary>History</summary> 2740<table> 2741<tbody><tr><th>Version</th><th>Changes</th></tr> 2742<tr><td>v15.0.0</td> 2743<td><p>The object can also be an ArrayBuffer and CryptoKey.</p></td></tr> 2744<tr><td>v13.2.0, v12.16.0</td> 2745<td><p>This function now supports IEEE-P1363 DSA and ECDSA signatures.</p></td></tr> 2746<tr><td>v12.0.0</td> 2747<td><p>This function now supports RSA-PSS keys.</p></td></tr> 2748<tr><td>v11.7.0</td> 2749<td><p>The key can now be a private key.</p></td></tr> 2750<tr><td>v8.0.0</td> 2751<td><p>Support for RSASSA-PSS and additional options was added.</p></td></tr> 2752<tr><td>v0.1.92</td> 2753<td><p><span>Added in: v0.1.92</span></p></td></tr> 2754</tbody></table> 2755</details> 2756</div> 2757<!--lint disable maximum-line-length remark-lint--> 2758<ul> 2759<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> 2760<ul> 2761<li><code>dsaEncoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2762<li><code>padding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 2763<li><code>saltLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 2764</ul> 2765</li> 2766<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> 2767<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> 2768<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 2769signature for the data and public key.</li> 2770</ul> 2771<!--lint enable maximum-line-length remark-lint--> 2772<p>Verifies the provided data using the given <code>object</code> and <code>signature</code>.</p> 2773<p>If <code>object</code> is not a <a href="#class-keyobject"><code>KeyObject</code></a>, this function behaves as if 2774<code>object</code> had been passed to <a href="#cryptocreatepublickeykey"><code>crypto.createPublicKey()</code></a>. If it is an 2775object, the following additional properties can be passed:</p> 2776<ul> 2777<li> 2778<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 2779format of the signature. It can be one of the following:</p> 2780<ul> 2781<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li> 2782<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li> 2783</ul> 2784</li> 2785<li> 2786<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> 2787<ul> 2788<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li> 2789<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li> 2790</ul> 2791<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function 2792used 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 2793an MGF1 hash function has been specified as part of the key in compliance with 2794section 3.3 of <a href="https://www.rfc-editor.org/rfc/rfc4055.txt">RFC 4055</a>.</p> 2795</li> 2796<li> 2797<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 2798<code>RSA_PKCS1_PSS_PADDING</code>. The special value 2799<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest 2800size, <code>crypto.constants.RSA_PSS_SALTLEN_AUTO</code> (default) causes it to be 2801determined automatically.</p> 2802</li> 2803</ul> 2804<p>The <code>signature</code> argument is the previously calculated signature for the data, in 2805the <code>signatureEncoding</code>. 2806If a <code>signatureEncoding</code> is specified, the <code>signature</code> is expected to be a 2807string; otherwise <code>signature</code> is expected to be a <a href="buffer.html"><code>Buffer</code></a>, 2808<code>TypedArray</code>, or <code>DataView</code>.</p> 2809<p>The <code>verify</code> object can not be used again after <code>verify.verify()</code> has been 2810called. Multiple calls to <code>verify.verify()</code> will result in an error being 2811thrown.</p> 2812<p>Because public keys can be derived from private keys, a private key may 2813be passed instead of a public key.</p> 2814</section><section><h3>Class: <code>X509Certificate</code><span><a class="mark" href="#class-x509certificate" id="class-x509certificate">#</a></span><a aria-hidden="true" class="legacy" id="crypto_class_x509certificate"></a></h3> 2815<div class="api_metadata"> 2816<span>Added in: v15.6.0</span> 2817</div> 2818<p>Encapsulates an X509 certificate and provides read-only access to 2819its information.</p> 2820 2821<pre class="with-56-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { X509Certificate } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 2822 2823<span class="hljs-keyword">const</span> x509 = <span class="hljs-keyword">new</span> <span class="hljs-title function_">X509Certificate</span>(<span class="hljs-string">'{... pem encoded cert ...}'</span>); 2824 2825<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(x509.<span class="hljs-property">subject</span>);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { X509Certificate } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 2826 2827<span class="hljs-keyword">const</span> x509 = <span class="hljs-keyword">new</span> <span class="hljs-title function_">X509Certificate</span>(<span class="hljs-string">'{... pem encoded cert ...}'</span>); 2828 2829<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(x509.<span class="hljs-property">subject</span>);</code><button class="copy-button">copy</button></pre> 2830<h4><code>new X509Certificate(buffer)</code><span><a class="mark" href="#new-x509certificatebuffer" id="new-x509certificatebuffer">#</a></span><a aria-hidden="true" class="legacy" id="crypto_new_x509certificate_buffer"></a></h4> 2831<div class="api_metadata"> 2832<span>Added in: v15.6.0</span> 2833</div> 2834<ul> 2835<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/TypedArray" class="type"><TypedArray></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/DataView" class="type"><DataView></a> A PEM or DER encoded 2836X509 Certificate.</li> 2837</ul> 2838<h4><code>x509.ca</code><span><a class="mark" href="#x509ca" id="x509ca">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_ca"></a></h4> 2839<div class="api_metadata"> 2840<span>Added in: v15.6.0</span> 2841</div> 2842<ul> 2843<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Will be <code>true</code> if this is a Certificate Authority (CA) 2844certificate.</li> 2845</ul> 2846<h4><code>x509.checkEmail(email[, options])</code><span><a class="mark" href="#x509checkemailemail-options" id="x509checkemailemail-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_checkemail_email_options"></a></h4> 2847<div class="api_metadata"> 2848<details class="changelog"><summary>History</summary> 2849<table> 2850<tbody><tr><th>Version</th><th>Changes</th></tr> 2851<tr><td>v18.0.0</td> 2852<td><p>The subject option now defaults to <code>'default'</code>.</p></td></tr> 2853<tr><td>v17.5.0</td> 2854<td><p>The subject option can now be set to <code>'default'</code>.</p></td></tr> 2855<tr><td>v17.5.0, v16.14.1</td> 2856<td><p>The <code>wildcards</code>, <code>partialWildcards</code>, <code>multiLabelWildcards</code>, and <code>singleLabelSubdomains</code> options have been removed since they had no effect.</p></td></tr> 2857<tr><td>v15.6.0</td> 2858<td><p><span>Added in: v15.6.0</span></p></td></tr> 2859</tbody></table> 2860</details> 2861</div> 2862<ul> 2863<li><code>email</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2864<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2865<ul> 2866<li><code>subject</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> <code>'default'</code>, <code>'always'</code>, or <code>'never'</code>. 2867<strong>Default:</strong> <code>'default'</code>.</li> 2868</ul> 2869</li> 2870<li>Returns: <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#Undefined_type" class="type"><undefined></a> Returns <code>email</code> if the certificate matches, 2871<code>undefined</code> if it does not.</li> 2872</ul> 2873<p>Checks whether the certificate matches the given email address.</p> 2874<p>If the <code>'subject'</code> option is undefined or set to <code>'default'</code>, the certificate 2875subject is only considered if the subject alternative name extension either does 2876not exist or does not contain any email addresses.</p> 2877<p>If the <code>'subject'</code> option is set to <code>'always'</code> and if the subject alternative 2878name extension either does not exist or does not contain a matching email 2879address, the certificate subject is considered.</p> 2880<p>If the <code>'subject'</code> option is set to <code>'never'</code>, the certificate subject is never 2881considered, even if the certificate contains no subject alternative names.</p> 2882<h4><code>x509.checkHost(name[, options])</code><span><a class="mark" href="#x509checkhostname-options" id="x509checkhostname-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_checkhost_name_options"></a></h4> 2883<div class="api_metadata"> 2884<details class="changelog"><summary>History</summary> 2885<table> 2886<tbody><tr><th>Version</th><th>Changes</th></tr> 2887<tr><td>v18.0.0</td> 2888<td><p>The subject option now defaults to <code>'default'</code>.</p></td></tr> 2889<tr><td>v17.5.0</td> 2890<td><p>The subject option can now be set to <code>'default'</code>.</p></td></tr> 2891<tr><td>v15.6.0</td> 2892<td><p><span>Added in: v15.6.0</span></p></td></tr> 2893</tbody></table> 2894</details> 2895</div> 2896<ul> 2897<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2898<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2899<ul> 2900<li><code>subject</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> <code>'default'</code>, <code>'always'</code>, or <code>'never'</code>. 2901<strong>Default:</strong> <code>'default'</code>.</li> 2902<li><code>wildcards</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>true</code>.</li> 2903<li><code>partialWildcards</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>true</code>.</li> 2904<li><code>multiLabelWildcards</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>false</code>.</li> 2905<li><code>singleLabelSubdomains</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>false</code>.</li> 2906</ul> 2907</li> 2908<li>Returns: <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#Undefined_type" class="type"><undefined></a> Returns a subject name that matches <code>name</code>, 2909or <code>undefined</code> if no subject name matches <code>name</code>.</li> 2910</ul> 2911<p>Checks whether the certificate matches the given host name.</p> 2912<p>If the certificate matches the given host name, the matching subject name is 2913returned. The returned name might be an exact match (e.g., <code>foo.example.com</code>) 2914or it might contain wildcards (e.g., <code>*.example.com</code>). Because host name 2915comparisons are case-insensitive, the returned subject name might also differ 2916from the given <code>name</code> in capitalization.</p> 2917<p>If the <code>'subject'</code> option is undefined or set to <code>'default'</code>, the certificate 2918subject is only considered if the subject alternative name extension either does 2919not exist or does not contain any DNS names. This behavior is consistent with 2920<a href="https://www.rfc-editor.org/rfc/rfc2818.txt">RFC 2818</a> ("HTTP Over TLS").</p> 2921<p>If the <code>'subject'</code> option is set to <code>'always'</code> and if the subject alternative 2922name extension either does not exist or does not contain a matching DNS name, 2923the certificate subject is considered.</p> 2924<p>If the <code>'subject'</code> option is set to <code>'never'</code>, the certificate subject is never 2925considered, even if the certificate contains no subject alternative names.</p> 2926<h4><code>x509.checkIP(ip)</code><span><a class="mark" href="#x509checkipip" id="x509checkipip">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_checkip_ip"></a></h4> 2927<div class="api_metadata"> 2928<details class="changelog"><summary>History</summary> 2929<table> 2930<tbody><tr><th>Version</th><th>Changes</th></tr> 2931<tr><td>v17.5.0, v16.14.1</td> 2932<td><p>The <code>options</code> argument has been removed since it had no effect.</p></td></tr> 2933<tr><td>v15.6.0</td> 2934<td><p><span>Added in: v15.6.0</span></p></td></tr> 2935</tbody></table> 2936</details> 2937</div> 2938<ul> 2939<li><code>ip</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2940<li>Returns: <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#Undefined_type" class="type"><undefined></a> Returns <code>ip</code> if the certificate matches, 2941<code>undefined</code> if it does not.</li> 2942</ul> 2943<p>Checks whether the certificate matches the given IP address (IPv4 or IPv6).</p> 2944<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 2945must match the given <code>ip</code> address exactly. Other subject alternative names as 2946well as the subject field of the certificate are ignored.</p> 2947<h4><code>x509.checkIssued(otherCert)</code><span><a class="mark" href="#x509checkissuedothercert" id="x509checkissuedothercert">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_checkissued_othercert"></a></h4> 2948<div class="api_metadata"> 2949<span>Added in: v15.6.0</span> 2950</div> 2951<ul> 2952<li><code>otherCert</code> <a href="crypto.html#class-x509certificate" class="type"><X509Certificate></a></li> 2953<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2954</ul> 2955<p>Checks whether this certificate was issued by the given <code>otherCert</code>.</p> 2956<h4><code>x509.checkPrivateKey(privateKey)</code><span><a class="mark" href="#x509checkprivatekeyprivatekey" id="x509checkprivatekeyprivatekey">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_checkprivatekey_privatekey"></a></h4> 2957<div class="api_metadata"> 2958<span>Added in: v15.6.0</span> 2959</div> 2960<ul> 2961<li><code>privateKey</code> <a href="crypto.html#class-keyobject" class="type"><KeyObject></a> A private key.</li> 2962<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2963</ul> 2964<p>Checks whether the public key for this certificate is consistent with 2965the given private key.</p> 2966<h4><code>x509.fingerprint</code><span><a class="mark" href="#x509fingerprint" id="x509fingerprint">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_fingerprint"></a></h4> 2967<div class="api_metadata"> 2968<span>Added in: v15.6.0</span> 2969</div> 2970<ul> 2971<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2972</ul> 2973<p>The SHA-1 fingerprint of this certificate.</p> 2974<p>Because SHA-1 is cryptographically broken and because the security of SHA-1 is 2975significantly worse than that of algorithms that are commonly used to sign 2976certificates, consider using <a href="#x509fingerprint256"><code>x509.fingerprint256</code></a> instead.</p> 2977<h4><code>x509.fingerprint256</code><span><a class="mark" href="#x509fingerprint256" id="x509fingerprint256">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_fingerprint256"></a></h4> 2978<div class="api_metadata"> 2979<span>Added in: v15.6.0</span> 2980</div> 2981<ul> 2982<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2983</ul> 2984<p>The SHA-256 fingerprint of this certificate.</p> 2985<h4><code>x509.fingerprint512</code><span><a class="mark" href="#x509fingerprint512" id="x509fingerprint512">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_fingerprint512"></a></h4> 2986<div class="api_metadata"> 2987<span>Added in: v17.2.0, v16.14.0</span> 2988</div> 2989<ul> 2990<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2991</ul> 2992<p>The SHA-512 fingerprint of this certificate.</p> 2993<p>Because computing the SHA-256 fingerprint is usually faster and because it is 2994only half the size of the SHA-512 fingerprint, <a href="#x509fingerprint256"><code>x509.fingerprint256</code></a> may be 2995a better choice. While SHA-512 presumably provides a higher level of security in 2996general, the security of SHA-256 matches that of most algorithms that are 2997commonly used to sign certificates.</p> 2998<h4><code>x509.infoAccess</code><span><a class="mark" href="#x509infoaccess" id="x509infoaccess">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_infoaccess"></a></h4> 2999<div class="api_metadata"> 3000<details class="changelog"><summary>History</summary> 3001<table> 3002<tbody><tr><th>Version</th><th>Changes</th></tr> 3003<tr><td>v17.3.1, v16.13.2</td> 3004<td><p>Parts of this string may be encoded as JSON string literals in response to CVE-2021-44532.</p></td></tr> 3005<tr><td>v15.6.0</td> 3006<td><p><span>Added in: v15.6.0</span></p></td></tr> 3007</tbody></table> 3008</details> 3009</div> 3010<ul> 3011<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3012</ul> 3013<p>A textual representation of the certificate's authority information access 3014extension.</p> 3015<p>This is a line feed separated list of access descriptions. Each line begins with 3016the access method and the kind of the access location, followed by a colon and 3017the value associated with the access location.</p> 3018<p>After the prefix denoting the access method and the kind of the access location, 3019the remainder of each line might be enclosed in quotes to indicate that the 3020value is a JSON string literal. For backward compatibility, Node.js only uses 3021JSON string literals within this property when necessary to avoid ambiguity. 3022Third-party code should be prepared to handle both possible entry formats.</p> 3023<h4><code>x509.issuer</code><span><a class="mark" href="#x509issuer" id="x509issuer">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_issuer"></a></h4> 3024<div class="api_metadata"> 3025<span>Added in: v15.6.0</span> 3026</div> 3027<ul> 3028<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3029</ul> 3030<p>The issuer identification included in this certificate.</p> 3031<h4><code>x509.issuerCertificate</code><span><a class="mark" href="#x509issuercertificate" id="x509issuercertificate">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_issuercertificate"></a></h4> 3032<div class="api_metadata"> 3033<span>Added in: v15.9.0</span> 3034</div> 3035<ul> 3036<li>Type: <a href="crypto.html#class-x509certificate" class="type"><X509Certificate></a></li> 3037</ul> 3038<p>The issuer certificate or <code>undefined</code> if the issuer certificate is not 3039available.</p> 3040<h4><code>x509.keyUsage</code><span><a class="mark" href="#x509keyusage" id="x509keyusage">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_keyusage"></a></h4> 3041<div class="api_metadata"> 3042<span>Added in: v15.6.0</span> 3043</div> 3044<ul> 3045<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 3046</ul> 3047<p>An array detailing the key usages for this certificate.</p> 3048<h4><code>x509.publicKey</code><span><a class="mark" href="#x509publickey" id="x509publickey">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_publickey"></a></h4> 3049<div class="api_metadata"> 3050<span>Added in: v15.6.0</span> 3051</div> 3052<ul> 3053<li>Type: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3054</ul> 3055<p>The public key <a href="crypto.html#class-keyobject" class="type"><KeyObject></a> for this certificate.</p> 3056<h4><code>x509.raw</code><span><a class="mark" href="#x509raw" id="x509raw">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_raw"></a></h4> 3057<div class="api_metadata"> 3058<span>Added in: v15.6.0</span> 3059</div> 3060<ul> 3061<li>Type: <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 3062</ul> 3063<p>A <code>Buffer</code> containing the DER encoding of this certificate.</p> 3064<h4><code>x509.serialNumber</code><span><a class="mark" href="#x509serialnumber" id="x509serialnumber">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_serialnumber"></a></h4> 3065<div class="api_metadata"> 3066<span>Added in: v15.6.0</span> 3067</div> 3068<ul> 3069<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3070</ul> 3071<p>The serial number of this certificate.</p> 3072<p>Serial numbers are assigned by certificate authorities and do not uniquely 3073identify certificates. Consider using <a href="#x509fingerprint256"><code>x509.fingerprint256</code></a> as a unique 3074identifier instead.</p> 3075<h4><code>x509.subject</code><span><a class="mark" href="#x509subject" id="x509subject">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_subject"></a></h4> 3076<div class="api_metadata"> 3077<span>Added in: v15.6.0</span> 3078</div> 3079<ul> 3080<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3081</ul> 3082<p>The complete subject of this certificate.</p> 3083<h4><code>x509.subjectAltName</code><span><a class="mark" href="#x509subjectaltname" id="x509subjectaltname">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_subjectaltname"></a></h4> 3084<div class="api_metadata"> 3085<details class="changelog"><summary>History</summary> 3086<table> 3087<tbody><tr><th>Version</th><th>Changes</th></tr> 3088<tr><td>v17.3.1, v16.13.2</td> 3089<td><p>Parts of this string may be encoded as JSON string literals in response to CVE-2021-44532.</p></td></tr> 3090<tr><td>v15.6.0</td> 3091<td><p><span>Added in: v15.6.0</span></p></td></tr> 3092</tbody></table> 3093</details> 3094</div> 3095<ul> 3096<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3097</ul> 3098<p>The subject alternative name specified for this certificate.</p> 3099<p>This is a comma-separated list of subject alternative names. Each entry begins 3100with a string identifying the kind of the subject alternative name followed by 3101a colon and the value associated with the entry.</p> 3102<p>Earlier versions of Node.js incorrectly assumed that it is safe to split this 3103property 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, 3104both malicious and legitimate certificates can contain subject alternative names 3105that include this sequence when represented as a string.</p> 3106<p>After the prefix denoting the type of the entry, the remainder of each entry 3107might be enclosed in quotes to indicate that the value is a JSON string literal. 3108For backward compatibility, Node.js only uses JSON string literals within this 3109property when necessary to avoid ambiguity. Third-party code should be prepared 3110to handle both possible entry formats.</p> 3111<h4><code>x509.toJSON()</code><span><a class="mark" href="#x509tojson" id="x509tojson">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_tojson"></a></h4> 3112<div class="api_metadata"> 3113<span>Added in: v15.6.0</span> 3114</div> 3115<ul> 3116<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3117</ul> 3118<p>There is no standard JSON encoding for X509 certificates. The 3119<code>toJSON()</code> method returns a string containing the PEM encoded 3120certificate.</p> 3121<h4><code>x509.toLegacyObject()</code><span><a class="mark" href="#x509tolegacyobject" id="x509tolegacyobject">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_tolegacyobject"></a></h4> 3122<div class="api_metadata"> 3123<span>Added in: v15.6.0</span> 3124</div> 3125<ul> 3126<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 3127</ul> 3128<p>Returns information about this certificate using the legacy 3129<a href="tls.html#certificate-object">certificate object</a> encoding.</p> 3130<h4><code>x509.toString()</code><span><a class="mark" href="#x509tostring" id="x509tostring">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_tostring"></a></h4> 3131<div class="api_metadata"> 3132<span>Added in: v15.6.0</span> 3133</div> 3134<ul> 3135<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3136</ul> 3137<p>Returns the PEM-encoded certificate.</p> 3138<h4><code>x509.validFrom</code><span><a class="mark" href="#x509validfrom" id="x509validfrom">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_validfrom"></a></h4> 3139<div class="api_metadata"> 3140<span>Added in: v15.6.0</span> 3141</div> 3142<ul> 3143<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3144</ul> 3145<p>The date/time from which this certificate is considered valid.</p> 3146<h4><code>x509.validTo</code><span><a class="mark" href="#x509validto" id="x509validto">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_validto"></a></h4> 3147<div class="api_metadata"> 3148<span>Added in: v15.6.0</span> 3149</div> 3150<ul> 3151<li>Type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3152</ul> 3153<p>The date/time until which this certificate is considered valid.</p> 3154<h4><code>x509.verify(publicKey)</code><span><a class="mark" href="#x509verifypublickey" id="x509verifypublickey">#</a></span><a aria-hidden="true" class="legacy" id="crypto_x509_verify_publickey"></a></h4> 3155<div class="api_metadata"> 3156<span>Added in: v15.6.0</span> 3157</div> 3158<ul> 3159<li><code>publicKey</code> <a href="crypto.html#class-keyobject" class="type"><KeyObject></a> A public key.</li> 3160<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3161</ul> 3162<p>Verifies that this certificate was signed by the given public key. 3163Does not perform any other validation checks on the certificate.</p> 3164</section><section><h3><code>node:crypto</code> module methods and properties<span><a class="mark" href="#nodecrypto-module-methods-and-properties" id="nodecrypto-module-methods-and-properties">#</a></span><a aria-hidden="true" class="legacy" id="crypto_node_crypto_module_methods_and_properties"></a></h3> 3165<h4><code>crypto.constants</code><span><a class="mark" href="#cryptoconstants" id="cryptoconstants">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_constants"></a></h4> 3166<div class="api_metadata"> 3167<span>Added in: v6.3.0</span> 3168</div> 3169<ul> 3170<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 3171</ul> 3172<p>An object containing commonly used constants for crypto and security related 3173operations. The specific constants currently defined are described in 3174<a href="#crypto-constants">Crypto constants</a>.</p> 3175<h4><code>crypto.DEFAULT_ENCODING</code><span><a class="mark" href="#cryptodefault_encoding" id="cryptodefault_encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_default_encoding"></a></h4> 3176<div class="api_metadata"> 3177<span>Added in: v0.9.3</span><span>Deprecated since: v10.0.0</span> 3178</div> 3179<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated</div><p></p> 3180<p>The default encoding to use for functions that can take either strings 3181or <a href="buffer.html">buffers</a>. The default value is <code>'buffer'</code>, which makes methods 3182default to <a href="buffer.html"><code>Buffer</code></a> objects.</p> 3183<p>The <code>crypto.DEFAULT_ENCODING</code> mechanism is provided for backward compatibility 3184with legacy programs that expect <code>'latin1'</code> to be the default encoding.</p> 3185<p>New applications should expect the default to be <code>'buffer'</code>.</p> 3186<p>This property is deprecated.</p> 3187<h4><code>crypto.fips</code><span><a class="mark" href="#cryptofips" id="cryptofips">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_fips"></a></h4> 3188<div class="api_metadata"> 3189<span>Added in: v6.0.0</span><span>Deprecated since: v10.0.0</span> 3190</div> 3191<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated</div><p></p> 3192<p>Property for checking and controlling whether a FIPS compliant crypto provider 3193is currently in use. Setting to true requires a FIPS build of Node.js.</p> 3194<p>This property is deprecated. Please use <code>crypto.setFips()</code> and 3195<code>crypto.getFips()</code> instead.</p> 3196<h4><code>crypto.checkPrime(candidate[, options], callback)</code><span><a class="mark" href="#cryptocheckprimecandidate-options-callback" id="cryptocheckprimecandidate-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_checkprime_candidate_options_callback"></a></h4> 3197<div class="api_metadata"> 3198<details class="changelog"><summary>History</summary> 3199<table> 3200<tbody><tr><th>Version</th><th>Changes</th></tr> 3201<tr><td>v18.0.0</td> 3202<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 3203<tr><td>v15.8.0</td> 3204<td><p><span>Added in: v15.8.0</span></p></td></tr> 3205</tbody></table> 3206</details> 3207</div> 3208<ul> 3209<li><code>candidate</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer" class="type"><SharedArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></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/DataView" class="type"><DataView></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a> 3210A possible prime encoded as a sequence of big endian octets of arbitrary 3211length.</li> 3212<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 3213<ul> 3214<li><code>checks</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of Miller-Rabin probabilistic primality 3215iterations to perform. When the value is <code>0</code> (zero), a number of checks 3216is used that yields a false positive rate of at most 2<sup>-64</sup> for 3217random input. Care must be used when selecting a number of checks. Refer 3218to the OpenSSL documentation for the <a href="https://www.openssl.org/docs/man1.1.1/man3/BN_is_prime_ex.html"><code>BN_is_prime_ex</code></a> function <code>nchecks</code> 3219options for more details. <strong>Default:</strong> <code>0</code></li> 3220</ul> 3221</li> 3222<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 3223<ul> 3224<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a> Set to an <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a> object if an error occurred during check.</li> 3225<li><code>result</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> if the candidate is a prime with an error 3226probability less than <code>0.25 ** options.checks</code>.</li> 3227</ul> 3228</li> 3229</ul> 3230<p>Checks the primality of the <code>candidate</code>.</p> 3231<h4><code>crypto.checkPrimeSync(candidate[, options])</code><span><a class="mark" href="#cryptocheckprimesynccandidate-options" id="cryptocheckprimesynccandidate-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_checkprimesync_candidate_options"></a></h4> 3232<div class="api_metadata"> 3233<span>Added in: v15.8.0</span> 3234</div> 3235<ul> 3236<li><code>candidate</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer" class="type"><SharedArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></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/DataView" class="type"><DataView></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a> 3237A possible prime encoded as a sequence of big endian octets of arbitrary 3238length.</li> 3239<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 3240<ul> 3241<li><code>checks</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of Miller-Rabin probabilistic primality 3242iterations to perform. When the value is <code>0</code> (zero), a number of checks 3243is used that yields a false positive rate of at most 2<sup>-64</sup> for 3244random input. Care must be used when selecting a number of checks. Refer 3245to the OpenSSL documentation for the <a href="https://www.openssl.org/docs/man1.1.1/man3/BN_is_prime_ex.html"><code>BN_is_prime_ex</code></a> function <code>nchecks</code> 3246options for more details. <strong>Default:</strong> <code>0</code></li> 3247</ul> 3248</li> 3249<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> if the candidate is a prime with an error 3250probability less than <code>0.25 ** options.checks</code>.</li> 3251</ul> 3252<p>Checks the primality of the <code>candidate</code>.</p> 3253<h4><code>crypto.createCipher(algorithm, password[, options])</code><span><a class="mark" href="#cryptocreatecipheralgorithm-password-options" id="cryptocreatecipheralgorithm-password-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createcipher_algorithm_password_options"></a></h4> 3254<div class="api_metadata"> 3255<details class="changelog"><summary>History</summary> 3256<table> 3257<tbody><tr><th>Version</th><th>Changes</th></tr> 3258<tr><td>v17.9.0</td> 3259<td><p>The <code>authTagLength</code> option is now optional when using the <code>chacha20-poly1305</code> cipher and defaults to 16 bytes.</p></td></tr> 3260<tr><td>v15.0.0</td> 3261<td><p>The password argument can be an ArrayBuffer and is limited to a maximum of 2 ** 31 - 1 bytes.</p></td></tr> 3262<tr><td>v10.10.0</td> 3263<td><p>Ciphers in OCB mode are now supported.</p></td></tr> 3264<tr><td>v10.2.0</td> 3265<td><p>The <code>authTagLength</code> option can now be used to produce shorter authentication tags in GCM mode and defaults to 16 bytes.</p></td></tr> 3266<tr><td>v10.0.0</td> 3267<td><p><span>Deprecated since: v10.0.0</span></p></td></tr> 3268<tr><td>v0.1.94</td> 3269<td><p><span>Added in: v0.1.94</span></p></td></tr> 3270</tbody></table> 3271</details> 3272</div> 3273<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated: Use <a href="#cryptocreatecipherivalgorithm-key-iv-options"><code>crypto.createCipheriv()</code></a> instead.</div><p></p> 3274<ul> 3275<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3276<li><code>password</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> 3277<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a></li> 3278<li>Returns: <a href="crypto.html#class-cipher" class="type"><Cipher></a></li> 3279</ul> 3280<p>Creates and returns a <code>Cipher</code> object that uses the given <code>algorithm</code> and 3281<code>password</code>.</p> 3282<p>The <code>options</code> argument controls stream behavior and is optional except when a 3283cipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the 3284<code>authTagLength</code> option is required and specifies the length of the 3285authentication tag in bytes, see <a href="#ccm-mode">CCM mode</a>. In GCM mode, the <code>authTagLength</code> 3286option is not required but can be used to set the length of the authentication 3287tag that will be returned by <code>getAuthTag()</code> and defaults to 16 bytes. 3288For <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p> 3289<p>The <code>algorithm</code> is dependent on OpenSSL, examples are <code>'aes192'</code>, etc. On 3290recent OpenSSL releases, <code>openssl list -cipher-algorithms</code> will 3291display the available cipher algorithms.</p> 3292<p>The <code>password</code> is used to derive the cipher key and initialization vector (IV). 3293The value must be either a <code>'latin1'</code> encoded string, a <a href="buffer.html"><code>Buffer</code></a>, a 3294<code>TypedArray</code>, or a <code>DataView</code>.</p> 3295<p><strong class="critical">This function is semantically insecure for all 3296supported ciphers and fatally flawed for ciphers in counter mode (such as CTR, 3297GCM, or CCM).</strong></p> 3298<p>The implementation of <code>crypto.createCipher()</code> derives keys using the OpenSSL 3299function <a href="https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html"><code>EVP_BytesToKey</code></a> with the digest algorithm set to MD5, one 3300iteration, and no salt. The lack of salt allows dictionary attacks as the same 3301password always creates the same key. The low iteration count and 3302non-cryptographically secure hash algorithm allow passwords to be tested very 3303rapidly.</p> 3304<p>In line with OpenSSL's recommendation to use a more modern algorithm instead of 3305<a href="https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html"><code>EVP_BytesToKey</code></a> it is recommended that developers derive a key and IV on 3306their 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> 3307to create the <code>Cipher</code> object. Users should not use ciphers with counter mode 3308(e.g. CTR, GCM, or CCM) in <code>crypto.createCipher()</code>. A warning is emitted when 3309they are used in order to avoid the risk of IV reuse that causes 3310vulnerabilities. For the case when IV is reused in GCM, see <a href="https://github.com/nonce-disrespect/nonce-disrespect">Nonce-Disrespecting 3311Adversaries</a> for details.</p> 3312<h4><code>crypto.createCipheriv(algorithm, key, iv[, options])</code><span><a class="mark" href="#cryptocreatecipherivalgorithm-key-iv-options" id="cryptocreatecipherivalgorithm-key-iv-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createcipheriv_algorithm_key_iv_options"></a></h4> 3313<div class="api_metadata"> 3314<details class="changelog"><summary>History</summary> 3315<table> 3316<tbody><tr><th>Version</th><th>Changes</th></tr> 3317<tr><td>v17.9.0</td> 3318<td><p>The <code>authTagLength</code> option is now optional when using the <code>chacha20-poly1305</code> cipher and defaults to 16 bytes.</p></td></tr> 3319<tr><td>v15.0.0</td> 3320<td><p>The password and iv arguments can be an ArrayBuffer and are each limited to a maximum of 2 ** 31 - 1 bytes.</p></td></tr> 3321<tr><td>v11.6.0</td> 3322<td><p>The <code>key</code> argument can now be a <code>KeyObject</code>.</p></td></tr> 3323<tr><td>v11.2.0, v10.17.0</td> 3324<td><p>The cipher <code>chacha20-poly1305</code> (the IETF variant of ChaCha20-Poly1305) is now supported.</p></td></tr> 3325<tr><td>v10.10.0</td> 3326<td><p>Ciphers in OCB mode are now supported.</p></td></tr> 3327<tr><td>v10.2.0</td> 3328<td><p>The <code>authTagLength</code> option can now be used to produce shorter authentication tags in GCM mode and defaults to 16 bytes.</p></td></tr> 3329<tr><td>v9.9.0</td> 3330<td><p>The <code>iv</code> parameter may now be <code>null</code> for ciphers which do not need an initialization vector.</p></td></tr> 3331<tr><td>v0.1.94</td> 3332<td><p><span>Added in: v0.1.94</span></p></td></tr> 3333</tbody></table> 3334</details> 3335</div> 3336<ul> 3337<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3338<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></li> 3339<li><code>iv</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/Data_structures#Null_type" class="type"><null></a></li> 3340<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a></li> 3341<li>Returns: <a href="crypto.html#class-cipher" class="type"><Cipher></a></li> 3342</ul> 3343<p>Creates and returns a <code>Cipher</code> object, with the given <code>algorithm</code>, <code>key</code> and 3344initialization vector (<code>iv</code>).</p> 3345<p>The <code>options</code> argument controls stream behavior and is optional except when a 3346cipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the 3347<code>authTagLength</code> option is required and specifies the length of the 3348authentication tag in bytes, see <a href="#ccm-mode">CCM mode</a>. In GCM mode, the <code>authTagLength</code> 3349option is not required but can be used to set the length of the authentication 3350tag that will be returned by <code>getAuthTag()</code> and defaults to 16 bytes. 3351For <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p> 3352<p>The <code>algorithm</code> is dependent on OpenSSL, examples are <code>'aes192'</code>, etc. On 3353recent OpenSSL releases, <code>openssl list -cipher-algorithms</code> will 3354display the available cipher algorithms.</p> 3355<p>The <code>key</code> is the raw key used by the <code>algorithm</code> and <code>iv</code> is an 3356<a href="https://en.wikipedia.org/wiki/Initialization_vector">initialization vector</a>. Both arguments must be <code>'utf8'</code> encoded strings, 3357<a href="buffer.html">Buffers</a>, <code>TypedArray</code>, or <code>DataView</code>s. The <code>key</code> may optionally be 3358a <a href="#class-keyobject"><code>KeyObject</code></a> of type <code>secret</code>. If the cipher does not need 3359an initialization vector, <code>iv</code> may be <code>null</code>.</p> 3360<p>When passing strings for <code>key</code> or <code>iv</code>, please consider 3361<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 3362<p>Initialization vectors should be unpredictable and unique; ideally, they will be 3363cryptographically random. They do not have to be secret: IVs are typically just 3364added to ciphertext messages unencrypted. It may sound contradictory that 3365something has to be unpredictable and unique, but does not have to be secret; 3366remember that an attacker must not be able to predict ahead of time what a 3367given IV will be.</p> 3368<h4><code>crypto.createDecipher(algorithm, password[, options])</code><span><a class="mark" href="#cryptocreatedecipheralgorithm-password-options" id="cryptocreatedecipheralgorithm-password-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createdecipher_algorithm_password_options"></a></h4> 3369<div class="api_metadata"> 3370<details class="changelog"><summary>History</summary> 3371<table> 3372<tbody><tr><th>Version</th><th>Changes</th></tr> 3373<tr><td>v17.9.0</td> 3374<td><p>The <code>authTagLength</code> option is now optional when using the <code>chacha20-poly1305</code> cipher and defaults to 16 bytes.</p></td></tr> 3375<tr><td>v10.10.0</td> 3376<td><p>Ciphers in OCB mode are now supported.</p></td></tr> 3377<tr><td>v10.0.0</td> 3378<td><p><span>Deprecated since: v10.0.0</span></p></td></tr> 3379<tr><td>v0.1.94</td> 3380<td><p><span>Added in: v0.1.94</span></p></td></tr> 3381</tbody></table> 3382</details> 3383</div> 3384<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated: Use <a href="#cryptocreatedecipherivalgorithm-key-iv-options"><code>crypto.createDecipheriv()</code></a> instead.</div><p></p> 3385<ul> 3386<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3387<li><code>password</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> 3388<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a></li> 3389<li>Returns: <a href="crypto.html#class-decipher" class="type"><Decipher></a></li> 3390</ul> 3391<p>Creates and returns a <code>Decipher</code> object that uses the given <code>algorithm</code> and 3392<code>password</code> (key).</p> 3393<p>The <code>options</code> argument controls stream behavior and is optional except when a 3394cipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the 3395<code>authTagLength</code> option is required and specifies the length of the 3396authentication tag in bytes, see <a href="#ccm-mode">CCM mode</a>. 3397For <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p> 3398<p><strong class="critical">This function is semantically insecure for all 3399supported ciphers and fatally flawed for ciphers in counter mode (such as CTR, 3400GCM, or CCM).</strong></p> 3401<p>The implementation of <code>crypto.createDecipher()</code> derives keys using the OpenSSL 3402function <a href="https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html"><code>EVP_BytesToKey</code></a> with the digest algorithm set to MD5, one 3403iteration, and no salt. The lack of salt allows dictionary attacks as the same 3404password always creates the same key. The low iteration count and 3405non-cryptographically secure hash algorithm allow passwords to be tested very 3406rapidly.</p> 3407<p>In line with OpenSSL's recommendation to use a more modern algorithm instead of 3408<a href="https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html"><code>EVP_BytesToKey</code></a> it is recommended that developers derive a key and IV on 3409their 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> 3410to create the <code>Decipher</code> object.</p> 3411<h4><code>crypto.createDecipheriv(algorithm, key, iv[, options])</code><span><a class="mark" href="#cryptocreatedecipherivalgorithm-key-iv-options" id="cryptocreatedecipherivalgorithm-key-iv-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createdecipheriv_algorithm_key_iv_options"></a></h4> 3412<div class="api_metadata"> 3413<details class="changelog"><summary>History</summary> 3414<table> 3415<tbody><tr><th>Version</th><th>Changes</th></tr> 3416<tr><td>v17.9.0</td> 3417<td><p>The <code>authTagLength</code> option is now optional when using the <code>chacha20-poly1305</code> cipher and defaults to 16 bytes.</p></td></tr> 3418<tr><td>v11.6.0</td> 3419<td><p>The <code>key</code> argument can now be a <code>KeyObject</code>.</p></td></tr> 3420<tr><td>v11.2.0, v10.17.0</td> 3421<td><p>The cipher <code>chacha20-poly1305</code> (the IETF variant of ChaCha20-Poly1305) is now supported.</p></td></tr> 3422<tr><td>v10.10.0</td> 3423<td><p>Ciphers in OCB mode are now supported.</p></td></tr> 3424<tr><td>v10.2.0</td> 3425<td><p>The <code>authTagLength</code> option can now be used to restrict accepted GCM authentication tag lengths.</p></td></tr> 3426<tr><td>v9.9.0</td> 3427<td><p>The <code>iv</code> parameter may now be <code>null</code> for ciphers which do not need an initialization vector.</p></td></tr> 3428<tr><td>v0.1.94</td> 3429<td><p><span>Added in: v0.1.94</span></p></td></tr> 3430</tbody></table> 3431</details> 3432</div> 3433<ul> 3434<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3435<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></li> 3436<li><code>iv</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/Data_structures#Null_type" class="type"><null></a></li> 3437<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a></li> 3438<li>Returns: <a href="crypto.html#class-decipher" class="type"><Decipher></a></li> 3439</ul> 3440<p>Creates and returns a <code>Decipher</code> object that uses the given <code>algorithm</code>, <code>key</code> 3441and initialization vector (<code>iv</code>).</p> 3442<p>The <code>options</code> argument controls stream behavior and is optional except when a 3443cipher in CCM or OCB mode (e.g. <code>'aes-128-ccm'</code>) is used. In that case, the 3444<code>authTagLength</code> option is required and specifies the length of the 3445authentication tag in bytes, see <a href="#ccm-mode">CCM mode</a>. In GCM mode, the <code>authTagLength</code> 3446option is not required but can be used to restrict accepted authentication tags 3447to those with the specified length. 3448For <code>chacha20-poly1305</code>, the <code>authTagLength</code> option defaults to 16 bytes.</p> 3449<p>The <code>algorithm</code> is dependent on OpenSSL, examples are <code>'aes192'</code>, etc. On 3450recent OpenSSL releases, <code>openssl list -cipher-algorithms</code> will 3451display the available cipher algorithms.</p> 3452<p>The <code>key</code> is the raw key used by the <code>algorithm</code> and <code>iv</code> is an 3453<a href="https://en.wikipedia.org/wiki/Initialization_vector">initialization vector</a>. Both arguments must be <code>'utf8'</code> encoded strings, 3454<a href="buffer.html">Buffers</a>, <code>TypedArray</code>, or <code>DataView</code>s. The <code>key</code> may optionally be 3455a <a href="#class-keyobject"><code>KeyObject</code></a> of type <code>secret</code>. If the cipher does not need 3456an initialization vector, <code>iv</code> may be <code>null</code>.</p> 3457<p>When passing strings for <code>key</code> or <code>iv</code>, please consider 3458<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 3459<p>Initialization vectors should be unpredictable and unique; ideally, they will be 3460cryptographically random. They do not have to be secret: IVs are typically just 3461added to ciphertext messages unencrypted. It may sound contradictory that 3462something has to be unpredictable and unique, but does not have to be secret; 3463remember that an attacker must not be able to predict ahead of time what a given 3464IV will be.</p> 3465<h4><code>crypto.createDiffieHellman(prime[, primeEncoding][, generator][, generatorEncoding])</code><span><a class="mark" href="#cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding" id="cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_creatediffiehellman_prime_primeencoding_generator_generatorencoding"></a></h4> 3466<div class="api_metadata"> 3467<details class="changelog"><summary>History</summary> 3468<table> 3469<tbody><tr><th>Version</th><th>Changes</th></tr> 3470<tr><td>v8.0.0</td> 3471<td><p>The <code>prime</code> argument can be any <code>TypedArray</code> or <code>DataView</code> now.</p></td></tr> 3472<tr><td>v8.0.0</td> 3473<td><p>The <code>prime</code> argument can be a <code>Uint8Array</code> now.</p></td></tr> 3474<tr><td>v6.0.0</td> 3475<td><p>The default for the encoding parameters changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 3476<tr><td>v0.11.12</td> 3477<td><p><span>Added in: v0.11.12</span></p></td></tr> 3478</tbody></table> 3479</details> 3480</div> 3481<ul> 3482<li><code>prime</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> 3483<li><code>primeEncoding</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>prime</code> string.</li> 3484<li><code>generator</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></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> 3485<strong>Default:</strong> <code>2</code></li> 3486<li><code>generatorEncoding</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>generator</code> string.</li> 3487<li>Returns: <a href="crypto.html#class-diffiehellman" class="type"><DiffieHellman></a></li> 3488</ul> 3489<p>Creates a <code>DiffieHellman</code> key exchange object using the supplied <code>prime</code> and an 3490optional specific <code>generator</code>.</p> 3491<p>The <code>generator</code> argument can be a number, string, or <a href="buffer.html"><code>Buffer</code></a>. If 3492<code>generator</code> is not specified, the value <code>2</code> is used.</p> 3493<p>If <code>primeEncoding</code> is specified, <code>prime</code> is expected to be a string; otherwise 3494a <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code> is expected.</p> 3495<p>If <code>generatorEncoding</code> is specified, <code>generator</code> is expected to be a string; 3496otherwise a number, <a href="buffer.html"><code>Buffer</code></a>, <code>TypedArray</code>, or <code>DataView</code> is expected.</p> 3497<h4><code>crypto.createDiffieHellman(primeLength[, generator])</code><span><a class="mark" href="#cryptocreatediffiehellmanprimelength-generator" id="cryptocreatediffiehellmanprimelength-generator">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_creatediffiehellman_primelength_generator"></a></h4> 3498<div class="api_metadata"> 3499<span>Added in: v0.5.0</span> 3500</div> 3501<ul> 3502<li><code>primeLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 3503<li><code>generator</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>2</code></li> 3504<li>Returns: <a href="crypto.html#class-diffiehellman" class="type"><DiffieHellman></a></li> 3505</ul> 3506<p>Creates a <code>DiffieHellman</code> key exchange object and generates a prime of 3507<code>primeLength</code> bits using an optional specific numeric <code>generator</code>. 3508If <code>generator</code> is not specified, the value <code>2</code> is used.</p> 3509<h4><code>crypto.createDiffieHellmanGroup(name)</code><span><a class="mark" href="#cryptocreatediffiehellmangroupname" id="cryptocreatediffiehellmangroupname">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_creatediffiehellmangroup_name"></a></h4> 3510<div class="api_metadata"> 3511<span>Added in: v0.9.3</span> 3512</div> 3513<ul> 3514<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3515<li>Returns: <a href="crypto.html#class-diffiehellmangroup" class="type"><DiffieHellmanGroup></a></li> 3516</ul> 3517<p>An alias for <a href="#cryptogetdiffiehellmangroupname"><code>crypto.getDiffieHellman()</code></a></p> 3518<h4><code>crypto.createECDH(curveName)</code><span><a class="mark" href="#cryptocreateecdhcurvename" id="cryptocreateecdhcurvename">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createecdh_curvename"></a></h4> 3519<div class="api_metadata"> 3520<span>Added in: v0.11.14</span> 3521</div> 3522<ul> 3523<li><code>curveName</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3524<li>Returns: <a href="crypto.html#class-ecdh" class="type"><ECDH></a></li> 3525</ul> 3526<p>Creates an Elliptic Curve Diffie-Hellman (<code>ECDH</code>) key exchange object using a 3527predefined curve specified by the <code>curveName</code> string. Use 3528<a href="#cryptogetcurves"><code>crypto.getCurves()</code></a> to obtain a list of available curve names. On recent 3529OpenSSL releases, <code>openssl ecparam -list_curves</code> will also display the name 3530and description of each available elliptic curve.</p> 3531<h4><code>crypto.createHash(algorithm[, options])</code><span><a class="mark" href="#cryptocreatehashalgorithm-options" id="cryptocreatehashalgorithm-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createhash_algorithm_options"></a></h4> 3532<div class="api_metadata"> 3533<details class="changelog"><summary>History</summary> 3534<table> 3535<tbody><tr><th>Version</th><th>Changes</th></tr> 3536<tr><td>v12.8.0</td> 3537<td><p>The <code>outputLength</code> option was added for XOF hash functions.</p></td></tr> 3538<tr><td>v0.1.92</td> 3539<td><p><span>Added in: v0.1.92</span></p></td></tr> 3540</tbody></table> 3541</details> 3542</div> 3543<ul> 3544<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3545<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a></li> 3546<li>Returns: <a href="crypto.html#class-hash" class="type"><Hash></a></li> 3547</ul> 3548<p>Creates and returns a <code>Hash</code> object that can be used to generate hash digests 3549using the given <code>algorithm</code>. Optional <code>options</code> argument controls stream 3550behavior. For XOF hash functions such as <code>'shake256'</code>, the <code>outputLength</code> option 3551can be used to specify the desired output length in bytes.</p> 3552<p>The <code>algorithm</code> is dependent on the available algorithms supported by the 3553version of OpenSSL on the platform. Examples are <code>'sha256'</code>, <code>'sha512'</code>, etc. 3554On recent releases of OpenSSL, <code>openssl list -digest-algorithms</code> will 3555display the available digest algorithms.</p> 3556<p>Example: generating the sha256 sum of a file</p> 3557 3558<pre class="with-19-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 3559 createReadStream, 3560} <span class="hljs-keyword">from</span> <span class="hljs-string">'node:fs'</span>; 3561<span class="hljs-keyword">import</span> { argv } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:process'</span>; 3562<span class="hljs-keyword">const</span> { 3563 createHash, 3564} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 3565 3566<span class="hljs-keyword">const</span> filename = argv[<span class="hljs-number">2</span>]; 3567 3568<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 3569 3570<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(filename); 3571input.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 3572 <span class="hljs-comment">// Only one element is going to be produced by the</span> 3573 <span class="hljs-comment">// hash stream.</span> 3574 <span class="hljs-keyword">const</span> data = input.<span class="hljs-title function_">read</span>(); 3575 <span class="hljs-keyword">if</span> (data) 3576 hash.<span class="hljs-title function_">update</span>(data); 3577 <span class="hljs-keyword">else</span> { 3578 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${hash.digest(<span class="hljs-string">'hex'</span>)}</span> <span class="hljs-subst">${filename}</span>`</span>); 3579 } 3580});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 3581 createReadStream, 3582} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 3583<span class="hljs-keyword">const</span> { 3584 createHash, 3585} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 3586<span class="hljs-keyword">const</span> { argv } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:process'</span>); 3587 3588<span class="hljs-keyword">const</span> filename = argv[<span class="hljs-number">2</span>]; 3589 3590<span class="hljs-keyword">const</span> hash = <span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 3591 3592<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(filename); 3593input.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 3594 <span class="hljs-comment">// Only one element is going to be produced by the</span> 3595 <span class="hljs-comment">// hash stream.</span> 3596 <span class="hljs-keyword">const</span> data = input.<span class="hljs-title function_">read</span>(); 3597 <span class="hljs-keyword">if</span> (data) 3598 hash.<span class="hljs-title function_">update</span>(data); 3599 <span class="hljs-keyword">else</span> { 3600 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${hash.digest(<span class="hljs-string">'hex'</span>)}</span> <span class="hljs-subst">${filename}</span>`</span>); 3601 } 3602});</code><button class="copy-button">copy</button></pre> 3603<h4><code>crypto.createHmac(algorithm, key[, options])</code><span><a class="mark" href="#cryptocreatehmacalgorithm-key-options" id="cryptocreatehmacalgorithm-key-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createhmac_algorithm_key_options"></a></h4> 3604<div class="api_metadata"> 3605<details class="changelog"><summary>History</summary> 3606<table> 3607<tbody><tr><th>Version</th><th>Changes</th></tr> 3608<tr><td>v15.0.0</td> 3609<td><p>The key can also be an ArrayBuffer or CryptoKey. The encoding option was added. The key cannot contain more than 2 ** 32 - 1 bytes.</p></td></tr> 3610<tr><td>v11.6.0</td> 3611<td><p>The <code>key</code> argument can now be a <code>KeyObject</code>.</p></td></tr> 3612<tr><td>v0.1.94</td> 3613<td><p><span>Added in: v0.1.94</span></p></td></tr> 3614</tbody></table> 3615</details> 3616</div> 3617<ul> 3618<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3619<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></li> 3620<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamtransformoptions"><code>stream.transform</code> options</a> 3621<ul> 3622<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> 3623</ul> 3624</li> 3625<li>Returns: <a href="crypto.html#class-hmac" class="type"><Hmac></a></li> 3626</ul> 3627<p>Creates and returns an <code>Hmac</code> object that uses the given <code>algorithm</code> and <code>key</code>. 3628Optional <code>options</code> argument controls stream behavior.</p> 3629<p>The <code>algorithm</code> is dependent on the available algorithms supported by the 3630version of OpenSSL on the platform. Examples are <code>'sha256'</code>, <code>'sha512'</code>, etc. 3631On recent releases of OpenSSL, <code>openssl list -digest-algorithms</code> will 3632display the available digest algorithms.</p> 3633<p>The <code>key</code> is the HMAC key used to generate the cryptographic HMAC hash. If it is 3634a <a href="#class-keyobject"><code>KeyObject</code></a>, its type must be <code>secret</code>. If it is a string, please consider 3635<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>. If it was 3636obtained from a cryptographically secure source of entropy, such as 3637<a href="#cryptorandombytessize-callback"><code>crypto.randomBytes()</code></a> or <a href="#cryptogeneratekeytype-options-callback"><code>crypto.generateKey()</code></a>, its length should not 3638exceed the block size of <code>algorithm</code> (e.g., 512 bits for SHA-256).</p> 3639<p>Example: generating the sha256 HMAC of a file</p> 3640 3641<pre class="with-19-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 3642 createReadStream, 3643} <span class="hljs-keyword">from</span> <span class="hljs-string">'node:fs'</span>; 3644<span class="hljs-keyword">import</span> { argv } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:process'</span>; 3645<span class="hljs-keyword">const</span> { 3646 createHmac, 3647} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 3648 3649<span class="hljs-keyword">const</span> filename = argv[<span class="hljs-number">2</span>]; 3650 3651<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 3652 3653<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(filename); 3654input.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 3655 <span class="hljs-comment">// Only one element is going to be produced by the</span> 3656 <span class="hljs-comment">// hash stream.</span> 3657 <span class="hljs-keyword">const</span> data = input.<span class="hljs-title function_">read</span>(); 3658 <span class="hljs-keyword">if</span> (data) 3659 hmac.<span class="hljs-title function_">update</span>(data); 3660 <span class="hljs-keyword">else</span> { 3661 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${hmac.digest(<span class="hljs-string">'hex'</span>)}</span> <span class="hljs-subst">${filename}</span>`</span>); 3662 } 3663});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 3664 createReadStream, 3665} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 3666<span class="hljs-keyword">const</span> { 3667 createHmac, 3668} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 3669<span class="hljs-keyword">const</span> { argv } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:process'</span>); 3670 3671<span class="hljs-keyword">const</span> filename = argv[<span class="hljs-number">2</span>]; 3672 3673<span class="hljs-keyword">const</span> hmac = <span class="hljs-title function_">createHmac</span>(<span class="hljs-string">'sha256'</span>, <span class="hljs-string">'a secret'</span>); 3674 3675<span class="hljs-keyword">const</span> input = <span class="hljs-title function_">createReadStream</span>(filename); 3676input.<span class="hljs-title function_">on</span>(<span class="hljs-string">'readable'</span>, <span class="hljs-function">() =></span> { 3677 <span class="hljs-comment">// Only one element is going to be produced by the</span> 3678 <span class="hljs-comment">// hash stream.</span> 3679 <span class="hljs-keyword">const</span> data = input.<span class="hljs-title function_">read</span>(); 3680 <span class="hljs-keyword">if</span> (data) 3681 hmac.<span class="hljs-title function_">update</span>(data); 3682 <span class="hljs-keyword">else</span> { 3683 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${hmac.digest(<span class="hljs-string">'hex'</span>)}</span> <span class="hljs-subst">${filename}</span>`</span>); 3684 } 3685});</code><button class="copy-button">copy</button></pre> 3686<h4><code>crypto.createPrivateKey(key)</code><span><a class="mark" href="#cryptocreateprivatekeykey" id="cryptocreateprivatekeykey">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createprivatekey_key"></a></h4> 3687<div class="api_metadata"> 3688<details class="changelog"><summary>History</summary> 3689<table> 3690<tbody><tr><th>Version</th><th>Changes</th></tr> 3691<tr><td>v15.12.0</td> 3692<td><p>The key can also be a JWK object.</p></td></tr> 3693<tr><td>v15.0.0</td> 3694<td><p>The key can also be an ArrayBuffer. The encoding option was added. The key cannot contain more than 2 ** 32 - 1 bytes.</p></td></tr> 3695<tr><td>v11.6.0</td> 3696<td><p><span>Added in: v11.6.0</span></p></td></tr> 3697</tbody></table> 3698</details> 3699</div> 3700<!--lint disable maximum-line-length remark-lint--> 3701<ul> 3702<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> 3703<ul> 3704<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 3705material, either in PEM, DER, or JWK format.</li> 3706<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>. 3707<strong>Default:</strong> <code>'pem'</code>.</li> 3708<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 3709required only if the <code>format</code> is <code>'der'</code> and ignored otherwise.</li> 3710<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> 3711<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> 3712</ul> 3713</li> 3714<li>Returns: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3715</ul> 3716<!--lint enable maximum-line-length remark-lint--> 3717<p>Creates and returns a new key object containing a private key. If <code>key</code> is a 3718string or <code>Buffer</code>, <code>format</code> is assumed to be <code>'pem'</code>; otherwise, <code>key</code> 3719must be an object with the properties described above.</p> 3720<p>If the private key is encrypted, a <code>passphrase</code> must be specified. The length 3721of the passphrase is limited to 1024 bytes.</p> 3722<h4><code>crypto.createPublicKey(key)</code><span><a class="mark" href="#cryptocreatepublickeykey" id="cryptocreatepublickeykey">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createpublickey_key"></a></h4> 3723<div class="api_metadata"> 3724<details class="changelog"><summary>History</summary> 3725<table> 3726<tbody><tr><th>Version</th><th>Changes</th></tr> 3727<tr><td>v15.12.0</td> 3728<td><p>The key can also be a JWK object.</p></td></tr> 3729<tr><td>v15.0.0</td> 3730<td><p>The key can also be an ArrayBuffer. The encoding option was added. The key cannot contain more than 2 ** 32 - 1 bytes.</p></td></tr> 3731<tr><td>v11.13.0</td> 3732<td><p>The <code>key</code> argument can now be a <code>KeyObject</code> with type <code>private</code>.</p></td></tr> 3733<tr><td>v11.7.0</td> 3734<td><p>The <code>key</code> argument can now be a private key.</p></td></tr> 3735<tr><td>v11.6.0</td> 3736<td><p><span>Added in: v11.6.0</span></p></td></tr> 3737</tbody></table> 3738</details> 3739</div> 3740<!--lint disable maximum-line-length remark-lint--> 3741<ul> 3742<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> 3743<ul> 3744<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 3745material, either in PEM, DER, or JWK format.</li> 3746<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>. 3747<strong>Default:</strong> <code>'pem'</code>.</li> 3748<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 3749required only if the <code>format</code> is <code>'der'</code> and ignored otherwise.</li> 3750<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> 3751</ul> 3752</li> 3753<li>Returns: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3754</ul> 3755<!--lint enable maximum-line-length remark-lint--> 3756<p>Creates and returns a new key object containing a public key. If <code>key</code> is a 3757string or <code>Buffer</code>, <code>format</code> is assumed to be <code>'pem'</code>; if <code>key</code> is a <code>KeyObject</code> 3758with type <code>'private'</code>, the public key is derived from the given private key; 3759otherwise, <code>key</code> must be an object with the properties described above.</p> 3760<p>If the format is <code>'pem'</code>, the <code>'key'</code> may also be an X.509 certificate.</p> 3761<p>Because public keys can be derived from private keys, a private key may be 3762passed instead of a public key. In that case, this function behaves as if 3763<a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey()</code></a> had been called, except that the type of the 3764returned <code>KeyObject</code> will be <code>'public'</code> and that the private key cannot be 3765extracted from the returned <code>KeyObject</code>. Similarly, if a <code>KeyObject</code> with type 3766<code>'private'</code> is given, a new <code>KeyObject</code> with type <code>'public'</code> will be returned 3767and it will be impossible to extract the private key from the returned object.</p> 3768<h4><code>crypto.createSecretKey(key[, encoding])</code><span><a class="mark" href="#cryptocreatesecretkeykey-encoding" id="cryptocreatesecretkeykey-encoding">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createsecretkey_key_encoding"></a></h4> 3769<div class="api_metadata"> 3770<details class="changelog"><summary>History</summary> 3771<table> 3772<tbody><tr><th>Version</th><th>Changes</th></tr> 3773<tr><td>v18.8.0</td> 3774<td><p>The key can now be zero-length.</p></td></tr> 3775<tr><td>v15.0.0</td> 3776<td><p>The key can also be an ArrayBuffer or string. The encoding argument was added. The key cannot contain more than 2 ** 32 - 1 bytes.</p></td></tr> 3777<tr><td>v11.6.0</td> 3778<td><p><span>Added in: v11.6.0</span></p></td></tr> 3779</tbody></table> 3780</details> 3781</div> 3782<ul> 3783<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></li> 3784<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 when <code>key</code> is a string.</li> 3785<li>Returns: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3786</ul> 3787<p>Creates and returns a new key object containing a secret key for symmetric 3788encryption or <code>Hmac</code>.</p> 3789<h4><code>crypto.createSign(algorithm[, options])</code><span><a class="mark" href="#cryptocreatesignalgorithm-options" id="cryptocreatesignalgorithm-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createsign_algorithm_options"></a></h4> 3790<div class="api_metadata"> 3791<span>Added in: v0.1.92</span> 3792</div> 3793<ul> 3794<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3795<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamwritableoptions"><code>stream.Writable</code> options</a></li> 3796<li>Returns: <a href="crypto.html#class-sign" class="type"><Sign></a></li> 3797</ul> 3798<p>Creates and returns a <code>Sign</code> object that uses the given <code>algorithm</code>. Use 3799<a href="#cryptogethashes"><code>crypto.getHashes()</code></a> to obtain the names of the available digest algorithms. 3800Optional <code>options</code> argument controls the <code>stream.Writable</code> behavior.</p> 3801<p>In some cases, a <code>Sign</code> instance can be created using the name of a signature 3802algorithm, such as <code>'RSA-SHA256'</code>, instead of a digest algorithm. This will use 3803the corresponding digest algorithm. This does not work for all signature 3804algorithms, such as <code>'ecdsa-with-SHA256'</code>, so it is best to always use digest 3805algorithm names.</p> 3806<h4><code>crypto.createVerify(algorithm[, options])</code><span><a class="mark" href="#cryptocreateverifyalgorithm-options" id="cryptocreateverifyalgorithm-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_createverify_algorithm_options"></a></h4> 3807<div class="api_metadata"> 3808<span>Added in: v0.1.92</span> 3809</div> 3810<ul> 3811<li><code>algorithm</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3812<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <a href="stream.html#new-streamwritableoptions"><code>stream.Writable</code> options</a></li> 3813<li>Returns: <a href="crypto.html#class-verify" class="type"><Verify></a></li> 3814</ul> 3815<p>Creates and returns a <code>Verify</code> object that uses the given algorithm. 3816Use <a href="#cryptogethashes"><code>crypto.getHashes()</code></a> to obtain an array of names of the available 3817signing algorithms. Optional <code>options</code> argument controls the 3818<code>stream.Writable</code> behavior.</p> 3819<p>In some cases, a <code>Verify</code> instance can be created using the name of a signature 3820algorithm, such as <code>'RSA-SHA256'</code>, instead of a digest algorithm. This will use 3821the corresponding digest algorithm. This does not work for all signature 3822algorithms, such as <code>'ecdsa-with-SHA256'</code>, so it is best to always use digest 3823algorithm names.</p> 3824<h4><code>crypto.diffieHellman(options)</code><span><a class="mark" href="#cryptodiffiehellmanoptions" id="cryptodiffiehellmanoptions">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_diffiehellman_options"></a></h4> 3825<div class="api_metadata"> 3826<span>Added in: v13.9.0, v12.17.0</span> 3827</div> 3828<ul> 3829<li><code>options</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 3830<ul> 3831<li><code>privateKey</code>: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3832<li><code>publicKey</code>: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3833</ul> 3834</li> 3835<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 3836</ul> 3837<p>Computes the Diffie-Hellman secret based on a <code>privateKey</code> and a <code>publicKey</code>. 3838Both keys must have the same <code>asymmetricKeyType</code>, which must be one of <code>'dh'</code> 3839(for Diffie-Hellman), <code>'ec'</code> (for ECDH), <code>'x448'</code>, or <code>'x25519'</code> (for ECDH-ES).</p> 3840<h4><code>crypto.generateKey(type, options, callback)</code><span><a class="mark" href="#cryptogeneratekeytype-options-callback" id="cryptogeneratekeytype-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_generatekey_type_options_callback"></a></h4> 3841<div class="api_metadata"> 3842<details class="changelog"><summary>History</summary> 3843<table> 3844<tbody><tr><th>Version</th><th>Changes</th></tr> 3845<tr><td>v18.0.0</td> 3846<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 3847<tr><td>v15.0.0</td> 3848<td><p><span>Added in: v15.0.0</span></p></td></tr> 3849</tbody></table> 3850</details> 3851</div> 3852<ul> 3853<li><code>type</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The intended use of the generated secret key. Currently 3854accepted values are <code>'hmac'</code> and <code>'aes'</code>.</li> 3855<li><code>options</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 3856<ul> 3857<li><code>length</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The bit length of the key to generate. This must be a 3858value greater than 0. 3859<ul> 3860<li>If <code>type</code> is <code>'hmac'</code>, the minimum is 8, and the maximum length is 38612<sup>31</sup>-1. If the value is not a multiple of 8, the generated 3862key will be truncated to <code>Math.floor(length / 8)</code>.</li> 3863<li>If <code>type</code> is <code>'aes'</code>, the length must be one of <code>128</code>, <code>192</code>, or <code>256</code>.</li> 3864</ul> 3865</li> 3866</ul> 3867</li> 3868<li><code>callback</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 3869<ul> 3870<li><code>err</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 3871<li><code>key</code>: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3872</ul> 3873</li> 3874</ul> 3875<p>Asynchronously generates a new random secret key of the given <code>length</code>. The 3876<code>type</code> will determine which validations will be performed on the <code>length</code>.</p> 3877 3878<pre class="with-14-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 3879 generateKey, 3880} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 3881 3882<span class="hljs-title function_">generateKey</span>(<span class="hljs-string">'hmac'</span>, { <span class="hljs-attr">length</span>: <span class="hljs-number">512</span> }, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 3883 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 3884 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key.<span class="hljs-title function_">export</span>().<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// 46e..........620</span> 3885});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 3886 generateKey, 3887} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 3888 3889<span class="hljs-title function_">generateKey</span>(<span class="hljs-string">'hmac'</span>, { <span class="hljs-attr">length</span>: <span class="hljs-number">512</span> }, <span class="hljs-function">(<span class="hljs-params">err, key</span>) =></span> { 3890 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 3891 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key.<span class="hljs-title function_">export</span>().<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// 46e..........620</span> 3892});</code><button class="copy-button">copy</button></pre> 3893<p>The size of a generated HMAC key should not exceed the block size of the 3894underlying hash function. See <a href="#cryptocreatehmacalgorithm-key-options"><code>crypto.createHmac()</code></a> for more information.</p> 3895<h4><code>crypto.generateKeyPair(type, options, callback)</code><span><a class="mark" href="#cryptogeneratekeypairtype-options-callback" id="cryptogeneratekeypairtype-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_generatekeypair_type_options_callback"></a></h4> 3896<div class="api_metadata"> 3897<details class="changelog"><summary>History</summary> 3898<table> 3899<tbody><tr><th>Version</th><th>Changes</th></tr> 3900<tr><td>v18.0.0</td> 3901<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 3902<tr><td>v16.10.0</td> 3903<td><p>Add ability to define <code>RSASSA-PSS-params</code> sequence parameters for RSA-PSS keys pairs.</p></td></tr> 3904<tr><td>v13.9.0, v12.17.0</td> 3905<td><p>Add support for Diffie-Hellman.</p></td></tr> 3906<tr><td>v12.0.0</td> 3907<td><p>Add support for RSA-PSS key pairs.</p></td></tr> 3908<tr><td>v12.0.0</td> 3909<td><p>Add ability to generate X25519 and X448 key pairs.</p></td></tr> 3910<tr><td>v12.0.0</td> 3911<td><p>Add ability to generate Ed25519 and Ed448 key pairs.</p></td></tr> 3912<tr><td>v11.6.0</td> 3913<td><p>The <code>generateKeyPair</code> and <code>generateKeyPairSync</code> functions now produce key objects if no encoding was specified.</p></td></tr> 3914<tr><td>v10.12.0</td> 3915<td><p><span>Added in: v10.12.0</span></p></td></tr> 3916</tbody></table> 3917</details> 3918</div> 3919<ul> 3920<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>'rsa'</code>, <code>'rsa-pss'</code>, <code>'dsa'</code>, <code>'ec'</code>, <code>'ed25519'</code>, 3921<code>'ed448'</code>, <code>'x25519'</code>, <code>'x448'</code>, or <code>'dh'</code>.</li> 3922<li><code>options</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 3923<ul> 3924<li><code>modulusLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Key size in bits (RSA, DSA).</li> 3925<li><code>publicExponent</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Public exponent (RSA). <strong>Default:</strong> <code>0x10001</code>.</li> 3926<li><code>hashAlgorithm</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the message digest (RSA-PSS).</li> 3927<li><code>mgf1HashAlgorithm</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the message digest used by 3928MGF1 (RSA-PSS).</li> 3929<li><code>saltLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Minimal salt length in bytes (RSA-PSS).</li> 3930<li><code>divisorLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Size of <code>q</code> in bits (DSA).</li> 3931<li><code>namedCurve</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the curve to use (EC).</li> 3932<li><code>prime</code>: <a href="buffer.html#class-buffer" class="type"><Buffer></a> The prime parameter (DH).</li> 3933<li><code>primeLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Prime length in bits (DH).</li> 3934<li><code>generator</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Custom generator (DH). <strong>Default:</strong> <code>2</code>.</li> 3935<li><code>groupName</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Diffie-Hellman group name (DH). See 3936<a href="#cryptogetdiffiehellmangroupname"><code>crypto.getDiffieHellman()</code></a>.</li> 3937<li><code>paramEncoding</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Must be <code>'named'</code> or <code>'explicit'</code> (EC). 3938<strong>Default:</strong> <code>'named'</code>.</li> 3939<li><code>publicKeyEncoding</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> See <a href="#keyobjectexportoptions"><code>keyObject.export()</code></a>.</li> 3940<li><code>privateKeyEncoding</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> See <a href="#keyobjectexportoptions"><code>keyObject.export()</code></a>.</li> 3941</ul> 3942</li> 3943<li><code>callback</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 3944<ul> 3945<li><code>err</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 3946<li><code>publicKey</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> | <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3947<li><code>privateKey</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> | <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 3948</ul> 3949</li> 3950</ul> 3951<p>Generates a new asymmetric key pair of the given <code>type</code>. RSA, RSA-PSS, DSA, EC, 3952Ed25519, Ed448, X25519, X448, and DH are currently supported.</p> 3953<p>If a <code>publicKeyEncoding</code> or <code>privateKeyEncoding</code> was specified, this function 3954behaves as if <a href="#keyobjectexportoptions"><code>keyObject.export()</code></a> had been called on its result. Otherwise, 3955the respective part of the key is returned as a <a href="#class-keyobject"><code>KeyObject</code></a>.</p> 3956<p>It is recommended to encode public keys as <code>'spki'</code> and private keys as 3957<code>'pkcs8'</code> with encryption for long-term storage:</p> 3958 3959<pre class="with-18-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 3960 generateKeyPair, 3961} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 3962 3963<span class="hljs-title function_">generateKeyPair</span>(<span class="hljs-string">'rsa'</span>, { 3964 <span class="hljs-attr">modulusLength</span>: <span class="hljs-number">4096</span>, 3965 <span class="hljs-attr">publicKeyEncoding</span>: { 3966 <span class="hljs-attr">type</span>: <span class="hljs-string">'spki'</span>, 3967 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 3968 }, 3969 <span class="hljs-attr">privateKeyEncoding</span>: { 3970 <span class="hljs-attr">type</span>: <span class="hljs-string">'pkcs8'</span>, 3971 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 3972 <span class="hljs-attr">cipher</span>: <span class="hljs-string">'aes-256-cbc'</span>, 3973 <span class="hljs-attr">passphrase</span>: <span class="hljs-string">'top secret'</span>, 3974 }, 3975}, <span class="hljs-function">(<span class="hljs-params">err, publicKey, privateKey</span>) =></span> { 3976 <span class="hljs-comment">// Handle errors and use the generated key pair.</span> 3977});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 3978 generateKeyPair, 3979} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 3980 3981<span class="hljs-title function_">generateKeyPair</span>(<span class="hljs-string">'rsa'</span>, { 3982 <span class="hljs-attr">modulusLength</span>: <span class="hljs-number">4096</span>, 3983 <span class="hljs-attr">publicKeyEncoding</span>: { 3984 <span class="hljs-attr">type</span>: <span class="hljs-string">'spki'</span>, 3985 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 3986 }, 3987 <span class="hljs-attr">privateKeyEncoding</span>: { 3988 <span class="hljs-attr">type</span>: <span class="hljs-string">'pkcs8'</span>, 3989 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 3990 <span class="hljs-attr">cipher</span>: <span class="hljs-string">'aes-256-cbc'</span>, 3991 <span class="hljs-attr">passphrase</span>: <span class="hljs-string">'top secret'</span>, 3992 }, 3993}, <span class="hljs-function">(<span class="hljs-params">err, publicKey, privateKey</span>) =></span> { 3994 <span class="hljs-comment">// Handle errors and use the generated key pair.</span> 3995});</code><button class="copy-button">copy</button></pre> 3996<p>On completion, <code>callback</code> will be called with <code>err</code> set to <code>undefined</code> and 3997<code>publicKey</code> / <code>privateKey</code> representing the generated key pair.</p> 3998<p>If this method is invoked as its <a href="util.html#utilpromisifyoriginal"><code>util.promisify()</code></a>ed version, it returns 3999a <code>Promise</code> for an <code>Object</code> with <code>publicKey</code> and <code>privateKey</code> properties.</p> 4000<h4><code>crypto.generateKeyPairSync(type, options)</code><span><a class="mark" href="#cryptogeneratekeypairsynctype-options" id="cryptogeneratekeypairsynctype-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_generatekeypairsync_type_options"></a></h4> 4001<div class="api_metadata"> 4002<details class="changelog"><summary>History</summary> 4003<table> 4004<tbody><tr><th>Version</th><th>Changes</th></tr> 4005<tr><td>v16.10.0</td> 4006<td><p>Add ability to define <code>RSASSA-PSS-params</code> sequence parameters for RSA-PSS keys pairs.</p></td></tr> 4007<tr><td>v13.9.0, v12.17.0</td> 4008<td><p>Add support for Diffie-Hellman.</p></td></tr> 4009<tr><td>v12.0.0</td> 4010<td><p>Add support for RSA-PSS key pairs.</p></td></tr> 4011<tr><td>v12.0.0</td> 4012<td><p>Add ability to generate X25519 and X448 key pairs.</p></td></tr> 4013<tr><td>v12.0.0</td> 4014<td><p>Add ability to generate Ed25519 and Ed448 key pairs.</p></td></tr> 4015<tr><td>v11.6.0</td> 4016<td><p>The <code>generateKeyPair</code> and <code>generateKeyPairSync</code> functions now produce key objects if no encoding was specified.</p></td></tr> 4017<tr><td>v10.12.0</td> 4018<td><p><span>Added in: v10.12.0</span></p></td></tr> 4019</tbody></table> 4020</details> 4021</div> 4022<ul> 4023<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>'rsa'</code>, <code>'rsa-pss'</code>, <code>'dsa'</code>, <code>'ec'</code>, <code>'ed25519'</code>, 4024<code>'ed448'</code>, <code>'x25519'</code>, <code>'x448'</code>, or <code>'dh'</code>.</li> 4025<li><code>options</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 4026<ul> 4027<li><code>modulusLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Key size in bits (RSA, DSA).</li> 4028<li><code>publicExponent</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Public exponent (RSA). <strong>Default:</strong> <code>0x10001</code>.</li> 4029<li><code>hashAlgorithm</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the message digest (RSA-PSS).</li> 4030<li><code>mgf1HashAlgorithm</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the message digest used by 4031MGF1 (RSA-PSS).</li> 4032<li><code>saltLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Minimal salt length in bytes (RSA-PSS).</li> 4033<li><code>divisorLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Size of <code>q</code> in bits (DSA).</li> 4034<li><code>namedCurve</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of the curve to use (EC).</li> 4035<li><code>prime</code>: <a href="buffer.html#class-buffer" class="type"><Buffer></a> The prime parameter (DH).</li> 4036<li><code>primeLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Prime length in bits (DH).</li> 4037<li><code>generator</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Custom generator (DH). <strong>Default:</strong> <code>2</code>.</li> 4038<li><code>groupName</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Diffie-Hellman group name (DH). See 4039<a href="#cryptogetdiffiehellmangroupname"><code>crypto.getDiffieHellman()</code></a>.</li> 4040<li><code>paramEncoding</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Must be <code>'named'</code> or <code>'explicit'</code> (EC). 4041<strong>Default:</strong> <code>'named'</code>.</li> 4042<li><code>publicKeyEncoding</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> See <a href="#keyobjectexportoptions"><code>keyObject.export()</code></a>.</li> 4043<li><code>privateKeyEncoding</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> See <a href="#keyobjectexportoptions"><code>keyObject.export()</code></a>.</li> 4044</ul> 4045</li> 4046<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 4047<ul> 4048<li><code>publicKey</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> | <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 4049<li><code>privateKey</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> | <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 4050</ul> 4051</li> 4052</ul> 4053<p>Generates a new asymmetric key pair of the given <code>type</code>. RSA, RSA-PSS, DSA, EC, 4054Ed25519, Ed448, X25519, X448, and DH are currently supported.</p> 4055<p>If a <code>publicKeyEncoding</code> or <code>privateKeyEncoding</code> was specified, this function 4056behaves as if <a href="#keyobjectexportoptions"><code>keyObject.export()</code></a> had been called on its result. Otherwise, 4057the respective part of the key is returned as a <a href="#class-keyobject"><code>KeyObject</code></a>.</p> 4058<p>When encoding public keys, it is recommended to use <code>'spki'</code>. When encoding 4059private keys, it is recommended to use <code>'pkcs8'</code> with a strong passphrase, 4060and to keep the passphrase confidential.</p> 4061 4062<pre class="with-22-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4063 generateKeyPairSync, 4064} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4065 4066<span class="hljs-keyword">const</span> { 4067 publicKey, 4068 privateKey, 4069} = <span class="hljs-title function_">generateKeyPairSync</span>(<span class="hljs-string">'rsa'</span>, { 4070 <span class="hljs-attr">modulusLength</span>: <span class="hljs-number">4096</span>, 4071 <span class="hljs-attr">publicKeyEncoding</span>: { 4072 <span class="hljs-attr">type</span>: <span class="hljs-string">'spki'</span>, 4073 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 4074 }, 4075 <span class="hljs-attr">privateKeyEncoding</span>: { 4076 <span class="hljs-attr">type</span>: <span class="hljs-string">'pkcs8'</span>, 4077 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 4078 <span class="hljs-attr">cipher</span>: <span class="hljs-string">'aes-256-cbc'</span>, 4079 <span class="hljs-attr">passphrase</span>: <span class="hljs-string">'top secret'</span>, 4080 }, 4081});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4082 generateKeyPairSync, 4083} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4084 4085<span class="hljs-keyword">const</span> { 4086 publicKey, 4087 privateKey, 4088} = <span class="hljs-title function_">generateKeyPairSync</span>(<span class="hljs-string">'rsa'</span>, { 4089 <span class="hljs-attr">modulusLength</span>: <span class="hljs-number">4096</span>, 4090 <span class="hljs-attr">publicKeyEncoding</span>: { 4091 <span class="hljs-attr">type</span>: <span class="hljs-string">'spki'</span>, 4092 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 4093 }, 4094 <span class="hljs-attr">privateKeyEncoding</span>: { 4095 <span class="hljs-attr">type</span>: <span class="hljs-string">'pkcs8'</span>, 4096 <span class="hljs-attr">format</span>: <span class="hljs-string">'pem'</span>, 4097 <span class="hljs-attr">cipher</span>: <span class="hljs-string">'aes-256-cbc'</span>, 4098 <span class="hljs-attr">passphrase</span>: <span class="hljs-string">'top secret'</span>, 4099 }, 4100});</code><button class="copy-button">copy</button></pre> 4101<p>The return value <code>{ publicKey, privateKey }</code> represents the generated key pair. 4102When PEM encoding was selected, the respective key will be a string, otherwise 4103it will be a buffer containing the data encoded as DER.</p> 4104<h4><code>crypto.generateKeySync(type, options)</code><span><a class="mark" href="#cryptogeneratekeysynctype-options" id="cryptogeneratekeysynctype-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_generatekeysync_type_options"></a></h4> 4105<div class="api_metadata"> 4106<span>Added in: v15.0.0</span> 4107</div> 4108<ul> 4109<li><code>type</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The intended use of the generated secret key. Currently 4110accepted values are <code>'hmac'</code> and <code>'aes'</code>.</li> 4111<li><code>options</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 4112<ul> 4113<li><code>length</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The bit length of the key to generate. 4114<ul> 4115<li>If <code>type</code> is <code>'hmac'</code>, the minimum is 8, and the maximum length is 41162<sup>31</sup>-1. If the value is not a multiple of 8, the generated 4117key will be truncated to <code>Math.floor(length / 8)</code>.</li> 4118<li>If <code>type</code> is <code>'aes'</code>, the length must be one of <code>128</code>, <code>192</code>, or <code>256</code>.</li> 4119</ul> 4120</li> 4121</ul> 4122</li> 4123<li>Returns: <a href="crypto.html#class-keyobject" class="type"><KeyObject></a></li> 4124</ul> 4125<p>Synchronously generates a new random secret key of the given <code>length</code>. The 4126<code>type</code> will determine which validations will be performed on the <code>length</code>.</p> 4127 4128<pre class="with-18-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4129 generateKeySync, 4130} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4131 4132<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">generateKeySync</span>(<span class="hljs-string">'hmac'</span>, { <span class="hljs-attr">length</span>: <span class="hljs-number">512</span> }); 4133<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key.<span class="hljs-title function_">export</span>().<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// e89..........41e</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4134 generateKeySync, 4135} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4136 4137<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">generateKeySync</span>(<span class="hljs-string">'hmac'</span>, { <span class="hljs-attr">length</span>: <span class="hljs-number">512</span> }); 4138<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key.<span class="hljs-title function_">export</span>().<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// e89..........41e</span></code><button class="copy-button">copy</button></pre> 4139<p>The size of a generated HMAC key should not exceed the block size of the 4140underlying hash function. See <a href="#cryptocreatehmacalgorithm-key-options"><code>crypto.createHmac()</code></a> for more information.</p> 4141<h4><code>crypto.generatePrime(size[, options[, callback]])</code><span><a class="mark" href="#cryptogenerateprimesize-options-callback" id="cryptogenerateprimesize-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_generateprime_size_options_callback"></a></h4> 4142<div class="api_metadata"> 4143<details class="changelog"><summary>History</summary> 4144<table> 4145<tbody><tr><th>Version</th><th>Changes</th></tr> 4146<tr><td>v18.0.0</td> 4147<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 4148<tr><td>v15.8.0</td> 4149<td><p><span>Added in: v15.8.0</span></p></td></tr> 4150</tbody></table> 4151</details> 4152</div> 4153<ul> 4154<li><code>size</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The size (in bits) of the prime to generate.</li> 4155<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 4156<ul> 4157<li><code>add</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer" class="type"><SharedArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></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/DataView" class="type"><DataView></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a></li> 4158<li><code>rem</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer" class="type"><SharedArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></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/DataView" class="type"><DataView></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a></li> 4159<li><code>safe</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>false</code>.</li> 4160<li><code>bigint</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, the generated prime is returned 4161as a <code>bigint</code>.</li> 4162</ul> 4163</li> 4164<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 4165<ul> 4166<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 4167<li><code>prime</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a></li> 4168</ul> 4169</li> 4170</ul> 4171<p>Generates a pseudorandom prime of <code>size</code> bits.</p> 4172<p>If <code>options.safe</code> is <code>true</code>, the prime will be a safe prime -- that is, 4173<code>(prime - 1) / 2</code> will also be a prime.</p> 4174<p>The <code>options.add</code> and <code>options.rem</code> parameters can be used to enforce additional 4175requirements, e.g., for Diffie-Hellman:</p> 4176<ul> 4177<li>If <code>options.add</code> and <code>options.rem</code> are both set, the prime will satisfy the 4178condition that <code>prime % add = rem</code>.</li> 4179<li>If only <code>options.add</code> is set and <code>options.safe</code> is not <code>true</code>, the prime will 4180satisfy the condition that <code>prime % add = 1</code>.</li> 4181<li>If only <code>options.add</code> is set and <code>options.safe</code> is set to <code>true</code>, the prime 4182will instead satisfy the condition that <code>prime % add = 3</code>. This is necessary 4183because <code>prime % add = 1</code> for <code>options.add > 2</code> would contradict the condition 4184enforced by <code>options.safe</code>.</li> 4185<li><code>options.rem</code> is ignored if <code>options.add</code> is not given.</li> 4186</ul> 4187<p>Both <code>options.add</code> and <code>options.rem</code> must be encoded as big-endian sequences 4188if given as an <code>ArrayBuffer</code>, <code>SharedArrayBuffer</code>, <code>TypedArray</code>, <code>Buffer</code>, or 4189<code>DataView</code>.</p> 4190<p>By default, the prime is encoded as a big-endian sequence of octets 4191in 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> 4192is provided.</p> 4193<h4><code>crypto.generatePrimeSync(size[, options])</code><span><a class="mark" href="#cryptogenerateprimesyncsize-options" id="cryptogenerateprimesyncsize-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_generateprimesync_size_options"></a></h4> 4194<div class="api_metadata"> 4195<span>Added in: v15.8.0</span> 4196</div> 4197<ul> 4198<li><code>size</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The size (in bits) of the prime to generate.</li> 4199<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 4200<ul> 4201<li><code>add</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer" class="type"><SharedArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></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/DataView" class="type"><DataView></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a></li> 4202<li><code>rem</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer" class="type"><SharedArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></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/DataView" class="type"><DataView></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a></li> 4203<li><code>safe</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <strong>Default:</strong> <code>false</code>.</li> 4204<li><code>bigint</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, the generated prime is returned 4205as a <code>bigint</code>.</li> 4206</ul> 4207</li> 4208<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt" class="type"><bigint></a></li> 4209</ul> 4210<p>Generates a pseudorandom prime of <code>size</code> bits.</p> 4211<p>If <code>options.safe</code> is <code>true</code>, the prime will be a safe prime -- that is, 4212<code>(prime - 1) / 2</code> will also be a prime.</p> 4213<p>The <code>options.add</code> and <code>options.rem</code> parameters can be used to enforce additional 4214requirements, e.g., for Diffie-Hellman:</p> 4215<ul> 4216<li>If <code>options.add</code> and <code>options.rem</code> are both set, the prime will satisfy the 4217condition that <code>prime % add = rem</code>.</li> 4218<li>If only <code>options.add</code> is set and <code>options.safe</code> is not <code>true</code>, the prime will 4219satisfy the condition that <code>prime % add = 1</code>.</li> 4220<li>If only <code>options.add</code> is set and <code>options.safe</code> is set to <code>true</code>, the prime 4221will instead satisfy the condition that <code>prime % add = 3</code>. This is necessary 4222because <code>prime % add = 1</code> for <code>options.add > 2</code> would contradict the condition 4223enforced by <code>options.safe</code>.</li> 4224<li><code>options.rem</code> is ignored if <code>options.add</code> is not given.</li> 4225</ul> 4226<p>Both <code>options.add</code> and <code>options.rem</code> must be encoded as big-endian sequences 4227if given as an <code>ArrayBuffer</code>, <code>SharedArrayBuffer</code>, <code>TypedArray</code>, <code>Buffer</code>, or 4228<code>DataView</code>.</p> 4229<p>By default, the prime is encoded as a big-endian sequence of octets 4230in 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> 4231is provided.</p> 4232<h4><code>crypto.getCipherInfo(nameOrNid[, options])</code><span><a class="mark" href="#cryptogetcipherinfonameornid-options" id="cryptogetcipherinfonameornid-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_getcipherinfo_nameornid_options"></a></h4> 4233<div class="api_metadata"> 4234<span>Added in: v15.0.0</span> 4235</div> 4236<ul> 4237<li><code>nameOrNid</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#Number_type" class="type"><number></a> The name or nid of the cipher to query.</li> 4238<li><code>options</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 4239<ul> 4240<li><code>keyLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> A test key length.</li> 4241<li><code>ivLength</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> A test IV length.</li> 4242</ul> 4243</li> 4244<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 4245<ul> 4246<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The name of the cipher</li> 4247<li><code>nid</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The nid of the cipher</li> 4248<li><code>blockSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The block size of the cipher in bytes. This property 4249is omitted when <code>mode</code> is <code>'stream'</code>.</li> 4250<li><code>ivLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The expected or default initialization vector length in 4251bytes. This property is omitted if the cipher does not use an initialization 4252vector.</li> 4253<li><code>keyLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The expected or default key length in bytes.</li> 4254<li><code>mode</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The cipher mode. One of <code>'cbc'</code>, <code>'ccm'</code>, <code>'cfb'</code>, <code>'ctr'</code>, 4255<code>'ecb'</code>, <code>'gcm'</code>, <code>'ocb'</code>, <code>'ofb'</code>, <code>'stream'</code>, <code>'wrap'</code>, <code>'xts'</code>.</li> 4256</ul> 4257</li> 4258</ul> 4259<p>Returns information about a given cipher.</p> 4260<p>Some ciphers accept variable length keys and initialization vectors. By default, 4261the <code>crypto.getCipherInfo()</code> method will return the default values for these 4262ciphers. To test if a given key length or iv length is acceptable for given 4263cipher, use the <code>keyLength</code> and <code>ivLength</code> options. If the given values are 4264unacceptable, <code>undefined</code> will be returned.</p> 4265<h4><code>crypto.getCiphers()</code><span><a class="mark" href="#cryptogetciphers" id="cryptogetciphers">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_getciphers"></a></h4> 4266<div class="api_metadata"> 4267<span>Added in: v0.9.3</span> 4268</div> 4269<ul> 4270<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a> An array with the names of the supported cipher 4271algorithms.</li> 4272</ul> 4273 4274<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4275 getCiphers, 4276} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4277 4278<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">getCiphers</span>()); <span class="hljs-comment">// ['aes-128-cbc', 'aes-128-ccm', ...]</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4279 getCiphers, 4280} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4281 4282<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">getCiphers</span>()); <span class="hljs-comment">// ['aes-128-cbc', 'aes-128-ccm', ...]</span></code><button class="copy-button">copy</button></pre> 4283<h4><code>crypto.getCurves()</code><span><a class="mark" href="#cryptogetcurves" id="cryptogetcurves">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_getcurves"></a></h4> 4284<div class="api_metadata"> 4285<span>Added in: v2.3.0</span> 4286</div> 4287<ul> 4288<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a> An array with the names of the supported elliptic curves.</li> 4289</ul> 4290 4291<pre class="with-12-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4292 getCurves, 4293} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4294 4295<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">getCurves</span>()); <span class="hljs-comment">// ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...]</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4296 getCurves, 4297} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4298 4299<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">getCurves</span>()); <span class="hljs-comment">// ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...]</span></code><button class="copy-button">copy</button></pre> 4300<h4><code>crypto.getDiffieHellman(groupName)</code><span><a class="mark" href="#cryptogetdiffiehellmangroupname" id="cryptogetdiffiehellmangroupname">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_getdiffiehellman_groupname"></a></h4> 4301<div class="api_metadata"> 4302<span>Added in: v0.7.5</span> 4303</div> 4304<ul> 4305<li><code>groupName</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4306<li>Returns: <a href="crypto.html#class-diffiehellmangroup" class="type"><DiffieHellmanGroup></a></li> 4307</ul> 4308<p>Creates a predefined <code>DiffieHellmanGroup</code> key exchange object. The 4309supported groups are listed in the documentation for <a href="#class-diffiehellmangroup"><code>DiffieHellmanGroup</code></a>.</p> 4310<p>The returned object mimics the interface of objects created by 4311<a href="#cryptocreatediffiehellmanprime-primeencoding-generator-generatorencoding"><code>crypto.createDiffieHellman()</code></a>, but will not allow changing 4312the keys (with <a href="#diffiehellmansetpublickeypublickey-encoding"><code>diffieHellman.setPublicKey()</code></a>, for example). The 4313advantage of using this method is that the parties do not have to 4314generate nor exchange a group modulus beforehand, saving both processor 4315and communication time.</p> 4316<p>Example (obtaining a shared secret):</p> 4317 4318<pre class="with-19-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4319 getDiffieHellman, 4320} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4321<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">getDiffieHellman</span>(<span class="hljs-string">'modp14'</span>); 4322<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">getDiffieHellman</span>(<span class="hljs-string">'modp14'</span>); 4323 4324alice.<span class="hljs-title function_">generateKeys</span>(); 4325bob.<span class="hljs-title function_">generateKeys</span>(); 4326 4327<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bob.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 4328<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(alice.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 4329 4330<span class="hljs-comment">/* aliceSecret and bobSecret should be the same */</span> 4331<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(aliceSecret === bobSecret);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4332 getDiffieHellman, 4333} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4334 4335<span class="hljs-keyword">const</span> alice = <span class="hljs-title function_">getDiffieHellman</span>(<span class="hljs-string">'modp14'</span>); 4336<span class="hljs-keyword">const</span> bob = <span class="hljs-title function_">getDiffieHellman</span>(<span class="hljs-string">'modp14'</span>); 4337 4338alice.<span class="hljs-title function_">generateKeys</span>(); 4339bob.<span class="hljs-title function_">generateKeys</span>(); 4340 4341<span class="hljs-keyword">const</span> aliceSecret = alice.<span class="hljs-title function_">computeSecret</span>(bob.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 4342<span class="hljs-keyword">const</span> bobSecret = bob.<span class="hljs-title function_">computeSecret</span>(alice.<span class="hljs-title function_">getPublicKey</span>(), <span class="hljs-literal">null</span>, <span class="hljs-string">'hex'</span>); 4343 4344<span class="hljs-comment">/* aliceSecret and bobSecret should be the same */</span> 4345<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(aliceSecret === bobSecret);</code><button class="copy-button">copy</button></pre> 4346<h4><code>crypto.getFips()</code><span><a class="mark" href="#cryptogetfips" id="cryptogetfips">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_getfips"></a></h4> 4347<div class="api_metadata"> 4348<span>Added in: v10.0.0</span> 4349</div> 4350<ul> 4351<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <code>1</code> if and only if a FIPS compliant crypto provider is 4352currently in use, <code>0</code> otherwise. A future semver-major release may change 4353the return type of this API to a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a>.</li> 4354</ul> 4355<h4><code>crypto.getHashes()</code><span><a class="mark" href="#cryptogethashes" id="cryptogethashes">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_gethashes"></a></h4> 4356<div class="api_metadata"> 4357<span>Added in: v0.9.3</span> 4358</div> 4359<ul> 4360<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a> An array of the names of the supported hash algorithms, 4361such as <code>'RSA-SHA256'</code>. Hash algorithms are also called "digest" algorithms.</li> 4362</ul> 4363 4364<pre class="with-12-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4365 getHashes, 4366} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4367 4368<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">getHashes</span>()); <span class="hljs-comment">// ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4369 getHashes, 4370} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4371 4372<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">getHashes</span>()); <span class="hljs-comment">// ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]</span></code><button class="copy-button">copy</button></pre> 4373<h4><code>crypto.getRandomValues(typedArray)</code><span><a class="mark" href="#cryptogetrandomvaluestypedarray" id="cryptogetrandomvaluestypedarray">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_getrandomvalues_typedarray"></a></h4> 4374<div class="api_metadata"> 4375<span>Added in: v17.4.0</span> 4376</div> 4377<ul> 4378<li><code>typedArray</code> <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/ArrayBuffer" class="type"><ArrayBuffer></a></li> 4379<li>Returns: <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/ArrayBuffer" class="type"><ArrayBuffer></a> Returns <code>typedArray</code>.</li> 4380</ul> 4381<p>A convenient alias for <a href="webcrypto.html#cryptogetrandomvaluestypedarray"><code>crypto.webcrypto.getRandomValues()</code></a>. This 4382implementation is not compliant with the Web Crypto spec, to write 4383web-compatible code use <a href="webcrypto.html#cryptogetrandomvaluestypedarray"><code>crypto.webcrypto.getRandomValues()</code></a> instead.</p> 4384<h4><code>crypto.hkdf(digest, ikm, salt, info, keylen, callback)</code><span><a class="mark" href="#cryptohkdfdigest-ikm-salt-info-keylen-callback" id="cryptohkdfdigest-ikm-salt-info-keylen-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_hkdf_digest_ikm_salt_info_keylen_callback"></a></h4> 4385<div class="api_metadata"> 4386<details class="changelog"><summary>History</summary> 4387<table> 4388<tbody><tr><th>Version</th><th>Changes</th></tr> 4389<tr><td>v18.8.0</td> 4390<td><p>The input keying material can now be zero-length.</p></td></tr> 4391<tr><td>v18.0.0</td> 4392<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 4393<tr><td>v15.0.0</td> 4394<td><p><span>Added in: v15.0.0</span></p></td></tr> 4395</tbody></table> 4396</details> 4397</div> 4398<ul> 4399<li><code>digest</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The digest algorithm to use.</li> 4400<li><code>ikm</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> The input 4401keying material. Must be provided but can be zero-length.</li> 4402<li><code>salt</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 salt value. Must 4403be provided but can be zero-length.</li> 4404<li><code>info</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> Additional info value. 4405Must be provided but can be zero-length, and cannot be more than 1024 bytes.</li> 4406<li><code>keylen</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The length of the key to generate. Must be greater than 0. 4407The maximum allowable value is <code>255</code> times the number of bytes produced by 4408the selected digest function (e.g. <code>sha512</code> generates 64-byte hashes, making 4409the maximum HKDF output 16320 bytes).</li> 4410<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 4411<ul> 4412<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 4413<li><code>derivedKey</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a></li> 4414</ul> 4415</li> 4416</ul> 4417<p>HKDF is a simple key derivation function defined in RFC 5869. The given <code>ikm</code>, 4418<code>salt</code> and <code>info</code> are used with the <code>digest</code> to derive a key of <code>keylen</code> bytes.</p> 4419<p>The supplied <code>callback</code> function is called with two arguments: <code>err</code> and 4420<code>derivedKey</code>. If an errors occurs while deriving the key, <code>err</code> will be set; 4421otherwise <code>err</code> will be <code>null</code>. The successfully generated <code>derivedKey</code> will 4422be 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 4423of the input arguments specify invalid values or types.</p> 4424 4425<pre class="with-37-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 4426<span class="hljs-keyword">const</span> { 4427 hkdf, 4428} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4429 4430<span class="hljs-title function_">hkdf</span>(<span class="hljs-string">'sha512'</span>, <span class="hljs-string">'key'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-string">'info'</span>, <span class="hljs-number">64</span>, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 4431 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4432 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(derivedKey).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '24156e2...5391653'</span> 4433});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4434 hkdf, 4435} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4436<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 4437 4438<span class="hljs-title function_">hkdf</span>(<span class="hljs-string">'sha512'</span>, <span class="hljs-string">'key'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-string">'info'</span>, <span class="hljs-number">64</span>, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 4439 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4440 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(derivedKey).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '24156e2...5391653'</span> 4441});</code><button class="copy-button">copy</button></pre> 4442<h4><code>crypto.hkdfSync(digest, ikm, salt, info, keylen)</code><span><a class="mark" href="#cryptohkdfsyncdigest-ikm-salt-info-keylen" id="cryptohkdfsyncdigest-ikm-salt-info-keylen">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_hkdfsync_digest_ikm_salt_info_keylen"></a></h4> 4443<div class="api_metadata"> 4444<details class="changelog"><summary>History</summary> 4445<table> 4446<tbody><tr><th>Version</th><th>Changes</th></tr> 4447<tr><td>v18.8.0</td> 4448<td><p>The input keying material can now be zero-length.</p></td></tr> 4449<tr><td>v15.0.0</td> 4450<td><p><span>Added in: v15.0.0</span></p></td></tr> 4451</tbody></table> 4452</details> 4453</div> 4454<ul> 4455<li><code>digest</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The digest algorithm to use.</li> 4456<li><code>ikm</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> The input 4457keying material. Must be provided but can be zero-length.</li> 4458<li><code>salt</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 salt value. Must 4459be provided but can be zero-length.</li> 4460<li><code>info</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> Additional info value. 4461Must be provided but can be zero-length, and cannot be more than 1024 bytes.</li> 4462<li><code>keylen</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The length of the key to generate. Must be greater than 0. 4463The maximum allowable value is <code>255</code> times the number of bytes produced by 4464the selected digest function (e.g. <code>sha512</code> generates 64-byte hashes, making 4465the maximum HKDF output 16320 bytes).</li> 4466<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a></li> 4467</ul> 4468<p>Provides a synchronous HKDF key derivation function as defined in RFC 5869. The 4469given <code>ikm</code>, <code>salt</code> and <code>info</code> are used with the <code>digest</code> to derive a key of 4470<code>keylen</code> bytes.</p> 4471<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> 4472<p>An error will be thrown if any of the input arguments specify invalid values or 4473types, or if the derived key cannot be generated.</p> 4474 4475<pre class="with-37-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 4476<span class="hljs-keyword">const</span> { 4477 hkdfSync, 4478} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4479 4480<span class="hljs-keyword">const</span> derivedKey = <span class="hljs-title function_">hkdfSync</span>(<span class="hljs-string">'sha512'</span>, <span class="hljs-string">'key'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-string">'info'</span>, <span class="hljs-number">64</span>); 4481<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(derivedKey).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '24156e2...5391653'</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4482 hkdfSync, 4483} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4484<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 4485 4486<span class="hljs-keyword">const</span> derivedKey = <span class="hljs-title function_">hkdfSync</span>(<span class="hljs-string">'sha512'</span>, <span class="hljs-string">'key'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-string">'info'</span>, <span class="hljs-number">64</span>); 4487<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(derivedKey).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '24156e2...5391653'</span></code><button class="copy-button">copy</button></pre> 4488<h4><code>crypto.pbkdf2(password, salt, iterations, keylen, digest, callback)</code><span><a class="mark" href="#cryptopbkdf2password-salt-iterations-keylen-digest-callback" id="cryptopbkdf2password-salt-iterations-keylen-digest-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback"></a></h4> 4489<div class="api_metadata"> 4490<details class="changelog"><summary>History</summary> 4491<table> 4492<tbody><tr><th>Version</th><th>Changes</th></tr> 4493<tr><td>v18.0.0</td> 4494<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 4495<tr><td>v15.0.0</td> 4496<td><p>The password and salt arguments can also be ArrayBuffer instances.</p></td></tr> 4497<tr><td>v14.0.0</td> 4498<td><p>The <code>iterations</code> parameter is now restricted to positive values. Earlier releases treated other values as one.</p></td></tr> 4499<tr><td>v8.0.0</td> 4500<td><p>The <code>digest</code> parameter is always required now.</p></td></tr> 4501<tr><td>v6.0.0</td> 4502<td><p>Calling this function without passing the <code>digest</code> parameter is deprecated now and will emit a warning.</p></td></tr> 4503<tr><td>v6.0.0</td> 4504<td><p>The default encoding for <code>password</code> if it is a string changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 4505<tr><td>v0.5.5</td> 4506<td><p><span>Added in: v0.5.5</span></p></td></tr> 4507</tbody></table> 4508</details> 4509</div> 4510<ul> 4511<li><code>password</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> 4512<li><code>salt</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> 4513<li><code>iterations</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4514<li><code>keylen</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4515<li><code>digest</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4516<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 4517<ul> 4518<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 4519<li><code>derivedKey</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 4520</ul> 4521</li> 4522</ul> 4523<p>Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2) 4524implementation. A selected HMAC digest algorithm specified by <code>digest</code> is 4525applied to derive a key of the requested byte length (<code>keylen</code>) from the 4526<code>password</code>, <code>salt</code> and <code>iterations</code>.</p> 4527<p>The supplied <code>callback</code> function is called with two arguments: <code>err</code> and 4528<code>derivedKey</code>. If an error occurs while deriving the key, <code>err</code> will be set; 4529otherwise <code>err</code> will be <code>null</code>. By default, the successfully generated 4530<code>derivedKey</code> will be passed to the callback as a <a href="buffer.html"><code>Buffer</code></a>. An error will be 4531thrown if any of the input arguments specify invalid values or types.</p> 4532<p>The <code>iterations</code> argument must be a number set as high as possible. The 4533higher the number of iterations, the more secure the derived key will be, 4534but will take a longer amount of time to complete.</p> 4535<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is 4536random 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> 4537<p>When passing strings for <code>password</code> or <code>salt</code>, please consider 4538<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 4539 4540<pre class="with-9-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4541 pbkdf2, 4542} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4543 4544<span class="hljs-title function_">pbkdf2</span>(<span class="hljs-string">'secret'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">100000</span>, <span class="hljs-number">64</span>, <span class="hljs-string">'sha512'</span>, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 4545 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4546 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(derivedKey.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span> 4547});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4548 pbkdf2, 4549} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4550 4551<span class="hljs-title function_">pbkdf2</span>(<span class="hljs-string">'secret'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">100000</span>, <span class="hljs-number">64</span>, <span class="hljs-string">'sha512'</span>, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 4552 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4553 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(derivedKey.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span> 4554});</code><button class="copy-button">copy</button></pre> 4555<p>An array of supported digest functions can be retrieved using 4556<a href="#cryptogethashes"><code>crypto.getHashes()</code></a>.</p> 4557<p>This API uses libuv's threadpool, which can have surprising and 4558negative performance implications for some applications; see the 4559<a href="cli.html#uv_threadpool_sizesize"><code>UV_THREADPOOL_SIZE</code></a> documentation for more information.</p> 4560<h4><code>crypto.pbkdf2Sync(password, salt, iterations, keylen, digest)</code><span><a class="mark" href="#cryptopbkdf2syncpassword-salt-iterations-keylen-digest" id="cryptopbkdf2syncpassword-salt-iterations-keylen-digest">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_pbkdf2sync_password_salt_iterations_keylen_digest"></a></h4> 4561<div class="api_metadata"> 4562<details class="changelog"><summary>History</summary> 4563<table> 4564<tbody><tr><th>Version</th><th>Changes</th></tr> 4565<tr><td>v14.0.0</td> 4566<td><p>The <code>iterations</code> parameter is now restricted to positive values. Earlier releases treated other values as one.</p></td></tr> 4567<tr><td>v6.0.0</td> 4568<td><p>Calling this function without passing the <code>digest</code> parameter is deprecated now and will emit a warning.</p></td></tr> 4569<tr><td>v6.0.0</td> 4570<td><p>The default encoding for <code>password</code> if it is a string changed from <code>binary</code> to <code>utf8</code>.</p></td></tr> 4571<tr><td>v0.9.3</td> 4572<td><p><span>Added in: v0.9.3</span></p></td></tr> 4573</tbody></table> 4574</details> 4575</div> 4576<ul> 4577<li><code>password</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> | <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> 4578<li><code>salt</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> | <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> 4579<li><code>iterations</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4580<li><code>keylen</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4581<li><code>digest</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4582<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 4583</ul> 4584<p>Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2) 4585implementation. A selected HMAC digest algorithm specified by <code>digest</code> is 4586applied to derive a key of the requested byte length (<code>keylen</code>) from the 4587<code>password</code>, <code>salt</code> and <code>iterations</code>.</p> 4588<p>If an error occurs an <code>Error</code> will be thrown, otherwise the derived key will be 4589returned as a <a href="buffer.html"><code>Buffer</code></a>.</p> 4590<p>The <code>iterations</code> argument must be a number set as high as possible. The 4591higher the number of iterations, the more secure the derived key will be, 4592but will take a longer amount of time to complete.</p> 4593<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is 4594random 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> 4595<p>When passing strings for <code>password</code> or <code>salt</code>, please consider 4596<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 4597 4598<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 4599 pbkdf2Sync, 4600} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4601 4602<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">pbkdf2Sync</span>(<span class="hljs-string">'secret'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">100000</span>, <span class="hljs-number">64</span>, <span class="hljs-string">'sha512'</span>); 4603<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 4604 pbkdf2Sync, 4605} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4606 4607<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">pbkdf2Sync</span>(<span class="hljs-string">'secret'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">100000</span>, <span class="hljs-number">64</span>, <span class="hljs-string">'sha512'</span>); 4608<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span></code><button class="copy-button">copy</button></pre> 4609<p>An array of supported digest functions can be retrieved using 4610<a href="#cryptogethashes"><code>crypto.getHashes()</code></a>.</p> 4611<h4><code>crypto.privateDecrypt(privateKey, buffer)</code><span><a class="mark" href="#cryptoprivatedecryptprivatekey-buffer" id="cryptoprivatedecryptprivatekey-buffer">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_privatedecrypt_privatekey_buffer"></a></h4> 4612<div class="api_metadata"> 4613<details class="changelog"><summary>History</summary> 4614<table> 4615<tbody><tr><th>Version</th><th>Changes</th></tr> 4616<tr><td>v15.0.0</td> 4617<td><p>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.</p></td></tr> 4618<tr><td>v12.11.0</td> 4619<td><p>The <code>oaepLabel</code> option was added.</p></td></tr> 4620<tr><td>v12.9.0</td> 4621<td><p>The <code>oaepHash</code> option was added.</p></td></tr> 4622<tr><td>v11.6.0</td> 4623<td><p>This function now supports key objects.</p></td></tr> 4624<tr><td>v0.11.14</td> 4625<td><p><span>Added in: v0.11.14</span></p></td></tr> 4626</tbody></table> 4627</details> 4628</div> 4629<!--lint disable maximum-line-length remark-lint--> 4630<ul> 4631<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> 4632<ul> 4633<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. 4634<strong>Default:</strong> <code>'sha1'</code></li> 4635<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 4636use for OAEP padding. If not specified, no label is used.</li> 4637<li><code>padding</code> <a href="crypto.html#cryptoconstants" class="type"><crypto.constants></a> An optional padding value defined in 4638<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code>, 4639<code>crypto.constants.RSA_PKCS1_PADDING</code>, or 4640<code>crypto.constants.RSA_PKCS1_OAEP_PADDING</code>.</li> 4641</ul> 4642</li> 4643<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> 4644<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> A new <code>Buffer</code> with the decrypted content.</li> 4645</ul> 4646<!--lint enable maximum-line-length remark-lint--> 4647<p>Decrypts <code>buffer</code> with <code>privateKey</code>. <code>buffer</code> was previously encrypted using 4648the corresponding public key, for example using <a href="#cryptopublicencryptkey-buffer"><code>crypto.publicEncrypt()</code></a>.</p> 4649<p>If <code>privateKey</code> is not a <a href="#class-keyobject"><code>KeyObject</code></a>, this function behaves as if 4650<code>privateKey</code> had been passed to <a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey()</code></a>. If it is an 4651object, the <code>padding</code> property can be passed. Otherwise, this function uses 4652<code>RSA_PKCS1_OAEP_PADDING</code>.</p> 4653<h4><code>crypto.privateEncrypt(privateKey, buffer)</code><span><a class="mark" href="#cryptoprivateencryptprivatekey-buffer" id="cryptoprivateencryptprivatekey-buffer">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_privateencrypt_privatekey_buffer"></a></h4> 4654<div class="api_metadata"> 4655<details class="changelog"><summary>History</summary> 4656<table> 4657<tbody><tr><th>Version</th><th>Changes</th></tr> 4658<tr><td>v15.0.0</td> 4659<td><p>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.</p></td></tr> 4660<tr><td>v11.6.0</td> 4661<td><p>This function now supports key objects.</p></td></tr> 4662<tr><td>v1.1.0</td> 4663<td><p><span>Added in: v1.1.0</span></p></td></tr> 4664</tbody></table> 4665</details> 4666</div> 4667<!--lint disable maximum-line-length remark-lint--> 4668<ul> 4669<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> 4670<ul> 4671<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> 4672A PEM encoded private key.</li> 4673<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 4674passphrase for the private key.</li> 4675<li><code>padding</code> <a href="crypto.html#cryptoconstants" class="type"><crypto.constants></a> An optional padding value defined in 4676<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code> or 4677<code>crypto.constants.RSA_PKCS1_PADDING</code>.</li> 4678<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>, 4679or <code>passphrase</code> are strings.</li> 4680</ul> 4681</li> 4682<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> 4683<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> A new <code>Buffer</code> with the encrypted content.</li> 4684</ul> 4685<!--lint enable maximum-line-length remark-lint--> 4686<p>Encrypts <code>buffer</code> with <code>privateKey</code>. The returned data can be decrypted using 4687the corresponding public key, for example using <a href="#cryptopublicdecryptkey-buffer"><code>crypto.publicDecrypt()</code></a>.</p> 4688<p>If <code>privateKey</code> is not a <a href="#class-keyobject"><code>KeyObject</code></a>, this function behaves as if 4689<code>privateKey</code> had been passed to <a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey()</code></a>. If it is an 4690object, the <code>padding</code> property can be passed. Otherwise, this function uses 4691<code>RSA_PKCS1_PADDING</code>.</p> 4692<h4><code>crypto.publicDecrypt(key, buffer)</code><span><a class="mark" href="#cryptopublicdecryptkey-buffer" id="cryptopublicdecryptkey-buffer">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_publicdecrypt_key_buffer"></a></h4> 4693<div class="api_metadata"> 4694<details class="changelog"><summary>History</summary> 4695<table> 4696<tbody><tr><th>Version</th><th>Changes</th></tr> 4697<tr><td>v15.0.0</td> 4698<td><p>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.</p></td></tr> 4699<tr><td>v11.6.0</td> 4700<td><p>This function now supports key objects.</p></td></tr> 4701<tr><td>v1.1.0</td> 4702<td><p><span>Added in: v1.1.0</span></p></td></tr> 4703</tbody></table> 4704</details> 4705</div> 4706<!--lint disable maximum-line-length remark-lint--> 4707<ul> 4708<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> 4709<ul> 4710<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 4711passphrase for the private key.</li> 4712<li><code>padding</code> <a href="crypto.html#cryptoconstants" class="type"><crypto.constants></a> An optional padding value defined in 4713<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code> or 4714<code>crypto.constants.RSA_PKCS1_PADDING</code>.</li> 4715<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>, 4716or <code>passphrase</code> are strings.</li> 4717</ul> 4718</li> 4719<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> 4720<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> A new <code>Buffer</code> with the decrypted content.</li> 4721</ul> 4722<!--lint enable maximum-line-length remark-lint--> 4723<p>Decrypts <code>buffer</code> with <code>key</code>.<code>buffer</code> was previously encrypted using 4724the corresponding private key, for example using <a href="#cryptoprivateencryptprivatekey-buffer"><code>crypto.privateEncrypt()</code></a>.</p> 4725<p>If <code>key</code> is not a <a href="#class-keyobject"><code>KeyObject</code></a>, this function behaves as if 4726<code>key</code> had been passed to <a href="#cryptocreatepublickeykey"><code>crypto.createPublicKey()</code></a>. If it is an 4727object, the <code>padding</code> property can be passed. Otherwise, this function uses 4728<code>RSA_PKCS1_PADDING</code>.</p> 4729<p>Because RSA public keys can be derived from private keys, a private key may 4730be passed instead of a public key.</p> 4731<h4><code>crypto.publicEncrypt(key, buffer)</code><span><a class="mark" href="#cryptopublicencryptkey-buffer" id="cryptopublicencryptkey-buffer">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_publicencrypt_key_buffer"></a></h4> 4732<div class="api_metadata"> 4733<details class="changelog"><summary>History</summary> 4734<table> 4735<tbody><tr><th>Version</th><th>Changes</th></tr> 4736<tr><td>v15.0.0</td> 4737<td><p>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.</p></td></tr> 4738<tr><td>v12.11.0</td> 4739<td><p>The <code>oaepLabel</code> option was added.</p></td></tr> 4740<tr><td>v12.9.0</td> 4741<td><p>The <code>oaepHash</code> option was added.</p></td></tr> 4742<tr><td>v11.6.0</td> 4743<td><p>This function now supports key objects.</p></td></tr> 4744<tr><td>v0.11.14</td> 4745<td><p><span>Added in: v0.11.14</span></p></td></tr> 4746</tbody></table> 4747</details> 4748</div> 4749<!--lint disable maximum-line-length remark-lint--> 4750<ul> 4751<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> 4752<ul> 4753<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> 4754A 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> 4755<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. 4756<strong>Default:</strong> <code>'sha1'</code></li> 4757<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 4758use for OAEP padding. If not specified, no label is used.</li> 4759<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 4760passphrase for the private key.</li> 4761<li><code>padding</code> <a href="crypto.html#cryptoconstants" class="type"><crypto.constants></a> An optional padding value defined in 4762<code>crypto.constants</code>, which may be: <code>crypto.constants.RSA_NO_PADDING</code>, 4763<code>crypto.constants.RSA_PKCS1_PADDING</code>, or 4764<code>crypto.constants.RSA_PKCS1_OAEP_PADDING</code>.</li> 4765<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>, 4766<code>oaepLabel</code>, or <code>passphrase</code> are strings.</li> 4767</ul> 4768</li> 4769<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> 4770<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> A new <code>Buffer</code> with the encrypted content.</li> 4771</ul> 4772<!--lint enable maximum-line-length remark-lint--> 4773<p>Encrypts the content of <code>buffer</code> with <code>key</code> and returns a new 4774<a href="buffer.html"><code>Buffer</code></a> with encrypted content. The returned data can be decrypted using 4775the corresponding private key, for example using <a href="#cryptoprivatedecryptprivatekey-buffer"><code>crypto.privateDecrypt()</code></a>.</p> 4776<p>If <code>key</code> is not a <a href="#class-keyobject"><code>KeyObject</code></a>, this function behaves as if 4777<code>key</code> had been passed to <a href="#cryptocreatepublickeykey"><code>crypto.createPublicKey()</code></a>. If it is an 4778object, the <code>padding</code> property can be passed. Otherwise, this function uses 4779<code>RSA_PKCS1_OAEP_PADDING</code>.</p> 4780<p>Because RSA public keys can be derived from private keys, a private key may 4781be passed instead of a public key.</p> 4782<h4><code>crypto.randomBytes(size[, callback])</code><span><a class="mark" href="#cryptorandombytessize-callback" id="cryptorandombytessize-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_randombytes_size_callback"></a></h4> 4783<div class="api_metadata"> 4784<details class="changelog"><summary>History</summary> 4785<table> 4786<tbody><tr><th>Version</th><th>Changes</th></tr> 4787<tr><td>v18.0.0</td> 4788<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 4789<tr><td>v9.0.0</td> 4790<td><p>Passing <code>null</code> as the <code>callback</code> argument now throws <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 4791<tr><td>v0.5.8</td> 4792<td><p><span>Added in: v0.5.8</span></p></td></tr> 4793</tbody></table> 4794</details> 4795</div> 4796<ul> 4797<li><code>size</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of bytes to generate. The <code>size</code> must 4798not be larger than <code>2**31 - 1</code>.</li> 4799<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 4800<ul> 4801<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 4802<li><code>buf</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 4803</ul> 4804</li> 4805<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> if the <code>callback</code> function is not provided.</li> 4806</ul> 4807<p>Generates cryptographically strong pseudorandom data. The <code>size</code> argument 4808is a number indicating the number of bytes to generate.</p> 4809<p>If a <code>callback</code> function is provided, the bytes are generated asynchronously 4810and the <code>callback</code> function is invoked with two arguments: <code>err</code> and <code>buf</code>. 4811If an error occurs, <code>err</code> will be an <code>Error</code> object; otherwise it is <code>null</code>. The 4812<code>buf</code> argument is a <a href="buffer.html"><code>Buffer</code></a> containing the generated bytes.</p> 4813 4814<pre class="with-15-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// Asynchronous</span> 4815<span class="hljs-keyword">const</span> { 4816 randomBytes, 4817} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4818 4819<span class="hljs-title function_">randomBytes</span>(<span class="hljs-number">256</span>, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4820 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4821 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${buf.length}</span> bytes of random data: <span class="hljs-subst">${buf.toString(<span class="hljs-string">'hex'</span>)}</span>`</span>); 4822});</code><code class="language-js cjs"><span class="hljs-comment">// Asynchronous</span> 4823<span class="hljs-keyword">const</span> { 4824 randomBytes, 4825} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4826 4827<span class="hljs-title function_">randomBytes</span>(<span class="hljs-number">256</span>, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4828 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4829 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${buf.length}</span> bytes of random data: <span class="hljs-subst">${buf.toString(<span class="hljs-string">'hex'</span>)}</span>`</span>); 4830});</code><button class="copy-button">copy</button></pre> 4831<p>If the <code>callback</code> function is not provided, the random bytes are generated 4832synchronously and returned as a <a href="buffer.html"><code>Buffer</code></a>. An error will be thrown if 4833there is a problem generating the bytes.</p> 4834 4835<pre class="with-14-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// Synchronous</span> 4836<span class="hljs-keyword">const</span> { 4837 randomBytes, 4838} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4839 4840<span class="hljs-keyword">const</span> buf = <span class="hljs-title function_">randomBytes</span>(<span class="hljs-number">256</span>); 4841<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>( 4842 <span class="hljs-string">`<span class="hljs-subst">${buf.length}</span> bytes of random data: <span class="hljs-subst">${buf.toString(<span class="hljs-string">'hex'</span>)}</span>`</span>);</code><code class="language-js cjs"><span class="hljs-comment">// Synchronous</span> 4843<span class="hljs-keyword">const</span> { 4844 randomBytes, 4845} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4846 4847<span class="hljs-keyword">const</span> buf = <span class="hljs-title function_">randomBytes</span>(<span class="hljs-number">256</span>); 4848<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>( 4849 <span class="hljs-string">`<span class="hljs-subst">${buf.length}</span> bytes of random data: <span class="hljs-subst">${buf.toString(<span class="hljs-string">'hex'</span>)}</span>`</span>);</code><button class="copy-button">copy</button></pre> 4850<p>The <code>crypto.randomBytes()</code> method will not complete until there is 4851sufficient entropy available. 4852This should normally never take longer than a few milliseconds. The only time 4853when generating the random bytes may conceivably block for a longer period of 4854time is right after boot, when the whole system is still low on entropy.</p> 4855<p>This API uses libuv's threadpool, which can have surprising and 4856negative performance implications for some applications; see the 4857<a href="cli.html#uv_threadpool_sizesize"><code>UV_THREADPOOL_SIZE</code></a> documentation for more information.</p> 4858<p>The asynchronous version of <code>crypto.randomBytes()</code> is carried out in a single 4859threadpool request. To minimize threadpool task length variation, partition 4860large <code>randomBytes</code> requests when doing so as part of fulfilling a client 4861request.</p> 4862<h4><code>crypto.randomFillSync(buffer[, offset][, size])</code><span><a class="mark" href="#cryptorandomfillsyncbuffer-offset-size" id="cryptorandomfillsyncbuffer-offset-size">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_randomfillsync_buffer_offset_size"></a></h4> 4863<div class="api_metadata"> 4864<details class="changelog"><summary>History</summary> 4865<table> 4866<tbody><tr><th>Version</th><th>Changes</th></tr> 4867<tr><td>v9.0.0</td> 4868<td><p>The <code>buffer</code> argument may be any <code>TypedArray</code> or <code>DataView</code>.</p></td></tr> 4869<tr><td>v7.10.0, v6.13.0</td> 4870<td><p><span>Added in: v7.10.0, v6.13.0</span></p></td></tr> 4871</tbody></table> 4872</details> 4873</div> 4874<ul> 4875<li><code>buffer</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> Must be supplied. The 4876size of the provided <code>buffer</code> must not be larger than <code>2**31 - 1</code>.</li> 4877<li><code>offset</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>0</code></li> 4878<li><code>size</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>buffer.length - offset</code>. The <code>size</code> must 4879not be larger than <code>2**31 - 1</code>.</li> 4880<li>Returns: <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 object passed as 4881<code>buffer</code> argument.</li> 4882</ul> 4883<p>Synchronous version of <a href="#cryptorandomfillbuffer-offset-size-callback"><code>crypto.randomFill()</code></a>.</p> 4884 4885<pre class="with-55-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 4886<span class="hljs-keyword">const</span> { randomFillSync } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4887 4888<span class="hljs-keyword">const</span> buf = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">10</span>); 4889<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">randomFillSync</span>(buf).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4890 4891<span class="hljs-title function_">randomFillSync</span>(buf, <span class="hljs-number">5</span>); 4892<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4893 4894<span class="hljs-comment">// The above is equivalent to the following:</span> 4895<span class="hljs-title function_">randomFillSync</span>(buf, <span class="hljs-number">5</span>, <span class="hljs-number">5</span>); 4896<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>));</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { randomFillSync } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4897<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 4898 4899<span class="hljs-keyword">const</span> buf = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">10</span>); 4900<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">randomFillSync</span>(buf).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4901 4902<span class="hljs-title function_">randomFillSync</span>(buf, <span class="hljs-number">5</span>); 4903<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4904 4905<span class="hljs-comment">// The above is equivalent to the following:</span> 4906<span class="hljs-title function_">randomFillSync</span>(buf, <span class="hljs-number">5</span>, <span class="hljs-number">5</span>); 4907<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>));</code><button class="copy-button">copy</button></pre> 4908<p>Any <code>ArrayBuffer</code>, <code>TypedArray</code> or <code>DataView</code> instance may be passed as 4909<code>buffer</code>.</p> 4910 4911<pre class="with-55-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 4912<span class="hljs-keyword">const</span> { randomFillSync } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4913 4914<span class="hljs-keyword">const</span> a = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint32Array</span>(<span class="hljs-number">10</span>); 4915<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-title function_">randomFillSync</span>(a).<span class="hljs-property">buffer</span>, 4916 a.<span class="hljs-property">byteOffset</span>, a.<span class="hljs-property">byteLength</span>).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4917 4918<span class="hljs-keyword">const</span> b = <span class="hljs-keyword">new</span> <span class="hljs-title class_">DataView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>)); 4919<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-title function_">randomFillSync</span>(b).<span class="hljs-property">buffer</span>, 4920 b.<span class="hljs-property">byteOffset</span>, b.<span class="hljs-property">byteLength</span>).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4921 4922<span class="hljs-keyword">const</span> c = <span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>); 4923<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-title function_">randomFillSync</span>(c)).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>));</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { randomFillSync } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4924<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 4925 4926<span class="hljs-keyword">const</span> a = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint32Array</span>(<span class="hljs-number">10</span>); 4927<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-title function_">randomFillSync</span>(a).<span class="hljs-property">buffer</span>, 4928 a.<span class="hljs-property">byteOffset</span>, a.<span class="hljs-property">byteLength</span>).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4929 4930<span class="hljs-keyword">const</span> b = <span class="hljs-keyword">new</span> <span class="hljs-title class_">DataView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>)); 4931<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-title function_">randomFillSync</span>(b).<span class="hljs-property">buffer</span>, 4932 b.<span class="hljs-property">byteOffset</span>, b.<span class="hljs-property">byteLength</span>).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4933 4934<span class="hljs-keyword">const</span> c = <span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>); 4935<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-title function_">randomFillSync</span>(c)).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>));</code><button class="copy-button">copy</button></pre> 4936<h4><code>crypto.randomFill(buffer[, offset][, size], callback)</code><span><a class="mark" href="#cryptorandomfillbuffer-offset-size-callback" id="cryptorandomfillbuffer-offset-size-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_randomfill_buffer_offset_size_callback"></a></h4> 4937<div class="api_metadata"> 4938<details class="changelog"><summary>History</summary> 4939<table> 4940<tbody><tr><th>Version</th><th>Changes</th></tr> 4941<tr><td>v18.0.0</td> 4942<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 4943<tr><td>v9.0.0</td> 4944<td><p>The <code>buffer</code> argument may be any <code>TypedArray</code> or <code>DataView</code>.</p></td></tr> 4945<tr><td>v7.10.0, v6.13.0</td> 4946<td><p><span>Added in: v7.10.0, v6.13.0</span></p></td></tr> 4947</tbody></table> 4948</details> 4949</div> 4950<ul> 4951<li><code>buffer</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> Must be supplied. The 4952size of the provided <code>buffer</code> must not be larger than <code>2**31 - 1</code>.</li> 4953<li><code>offset</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>0</code></li> 4954<li><code>size</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>buffer.length - offset</code>. The <code>size</code> must 4955not be larger than <code>2**31 - 1</code>.</li> 4956<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> <code>function(err, buf) {}</code>.</li> 4957</ul> 4958<p>This function is similar to <a href="#cryptorandombytessize-callback"><code>crypto.randomBytes()</code></a> but requires the first 4959argument to be a <a href="buffer.html"><code>Buffer</code></a> that will be filled. It also 4960requires that a callback is passed in.</p> 4961<p>If the <code>callback</code> function is not provided, an error will be thrown.</p> 4962 4963<pre class="with-51-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 4964<span class="hljs-keyword">const</span> { randomFill } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 4965 4966<span class="hljs-keyword">const</span> buf = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">10</span>); 4967<span class="hljs-title function_">randomFill</span>(buf, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4968 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4969 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4970}); 4971 4972<span class="hljs-title function_">randomFill</span>(buf, <span class="hljs-number">5</span>, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4973 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4974 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4975}); 4976 4977<span class="hljs-comment">// The above is equivalent to the following:</span> 4978<span class="hljs-title function_">randomFill</span>(buf, <span class="hljs-number">5</span>, <span class="hljs-number">5</span>, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4979 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4980 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4981});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { randomFill } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 4982<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 4983 4984<span class="hljs-keyword">const</span> buf = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">alloc</span>(<span class="hljs-number">10</span>); 4985<span class="hljs-title function_">randomFill</span>(buf, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4986 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4987 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4988}); 4989 4990<span class="hljs-title function_">randomFill</span>(buf, <span class="hljs-number">5</span>, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4991 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4992 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4993}); 4994 4995<span class="hljs-comment">// The above is equivalent to the following:</span> 4996<span class="hljs-title function_">randomFill</span>(buf, <span class="hljs-number">5</span>, <span class="hljs-number">5</span>, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 4997 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 4998 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(buf.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 4999});</code><button class="copy-button">copy</button></pre> 5000<p>Any <code>ArrayBuffer</code>, <code>TypedArray</code>, or <code>DataView</code> instance may be passed as 5001<code>buffer</code>.</p> 5002<p>While this includes instances of <code>Float32Array</code> and <code>Float64Array</code>, this 5003function should not be used to generate random floating-point numbers. The 5004result may contain <code>+Infinity</code>, <code>-Infinity</code>, and <code>NaN</code>, and even if the array 5005contains finite numbers only, they are not drawn from a uniform random 5006distribution and have no meaningful lower or upper bounds.</p> 5007 5008<pre class="with-51-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 5009<span class="hljs-keyword">const</span> { randomFill } = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 5010 5011<span class="hljs-keyword">const</span> a = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint32Array</span>(<span class="hljs-number">10</span>); 5012<span class="hljs-title function_">randomFill</span>(a, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 5013 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5014 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(buf.<span class="hljs-property">buffer</span>, buf.<span class="hljs-property">byteOffset</span>, buf.<span class="hljs-property">byteLength</span>) 5015 .<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 5016}); 5017 5018<span class="hljs-keyword">const</span> b = <span class="hljs-keyword">new</span> <span class="hljs-title class_">DataView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>)); 5019<span class="hljs-title function_">randomFill</span>(b, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 5020 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5021 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(buf.<span class="hljs-property">buffer</span>, buf.<span class="hljs-property">byteOffset</span>, buf.<span class="hljs-property">byteLength</span>) 5022 .<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 5023}); 5024 5025<span class="hljs-keyword">const</span> c = <span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>); 5026<span class="hljs-title function_">randomFill</span>(c, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 5027 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5028 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(buf).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 5029});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { randomFill } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 5030<span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 5031 5032<span class="hljs-keyword">const</span> a = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint32Array</span>(<span class="hljs-number">10</span>); 5033<span class="hljs-title function_">randomFill</span>(a, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 5034 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5035 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(buf.<span class="hljs-property">buffer</span>, buf.<span class="hljs-property">byteOffset</span>, buf.<span class="hljs-property">byteLength</span>) 5036 .<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 5037}); 5038 5039<span class="hljs-keyword">const</span> b = <span class="hljs-keyword">new</span> <span class="hljs-title class_">DataView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>)); 5040<span class="hljs-title function_">randomFill</span>(b, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 5041 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5042 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(buf.<span class="hljs-property">buffer</span>, buf.<span class="hljs-property">byteOffset</span>, buf.<span class="hljs-property">byteLength</span>) 5043 .<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 5044}); 5045 5046<span class="hljs-keyword">const</span> c = <span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">10</span>); 5047<span class="hljs-title function_">randomFill</span>(c, <span class="hljs-function">(<span class="hljs-params">err, buf</span>) =></span> { 5048 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5049 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(buf).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); 5050});</code><button class="copy-button">copy</button></pre> 5051<p>This API uses libuv's threadpool, which can have surprising and 5052negative performance implications for some applications; see the 5053<a href="cli.html#uv_threadpool_sizesize"><code>UV_THREADPOOL_SIZE</code></a> documentation for more information.</p> 5054<p>The asynchronous version of <code>crypto.randomFill()</code> is carried out in a single 5055threadpool request. To minimize threadpool task length variation, partition 5056large <code>randomFill</code> requests when doing so as part of fulfilling a client 5057request.</p> 5058<h4><code>crypto.randomInt([min, ]max[, callback])</code><span><a class="mark" href="#cryptorandomintmin-max-callback" id="cryptorandomintmin-max-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_randomint_min_max_callback"></a></h4> 5059<div class="api_metadata"> 5060<details class="changelog"><summary>History</summary> 5061<table> 5062<tbody><tr><th>Version</th><th>Changes</th></tr> 5063<tr><td>v18.0.0</td> 5064<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 5065<tr><td>v14.10.0, v12.19.0</td> 5066<td><p><span>Added in: v14.10.0, v12.19.0</span></p></td></tr> 5067</tbody></table> 5068</details> 5069</div> 5070<ul> 5071<li><code>min</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Start of random range (inclusive). <strong>Default:</strong> <code>0</code>.</li> 5072<li><code>max</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> End of random range (exclusive).</li> 5073<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> <code>function(err, n) {}</code>.</li> 5074</ul> 5075<p>Return a random integer <code>n</code> such that <code>min <= n < max</code>. This 5076implementation avoids <a href="https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#Modulo_bias">modulo bias</a>.</p> 5077<p>The range (<code>max - min</code>) must be less than 2<sup>48</sup>. <code>min</code> and <code>max</code> must 5078be <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger">safe integers</a>.</p> 5079<p>If the <code>callback</code> function is not provided, the random integer is 5080generated synchronously.</p> 5081 5082<pre class="with-15-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// Asynchronous</span> 5083<span class="hljs-keyword">const</span> { 5084 randomInt, 5085} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 5086 5087<span class="hljs-title function_">randomInt</span>(<span class="hljs-number">3</span>, <span class="hljs-function">(<span class="hljs-params">err, n</span>) =></span> { 5088 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5089 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Random number chosen from (0, 1, 2): <span class="hljs-subst">${n}</span>`</span>); 5090});</code><code class="language-js cjs"><span class="hljs-comment">// Asynchronous</span> 5091<span class="hljs-keyword">const</span> { 5092 randomInt, 5093} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 5094 5095<span class="hljs-title function_">randomInt</span>(<span class="hljs-number">3</span>, <span class="hljs-function">(<span class="hljs-params">err, n</span>) =></span> { 5096 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5097 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Random number chosen from (0, 1, 2): <span class="hljs-subst">${n}</span>`</span>); 5098});</code><button class="copy-button">copy</button></pre> 5099 5100<pre class="with-14-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// Synchronous</span> 5101<span class="hljs-keyword">const</span> { 5102 randomInt, 5103} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 5104 5105<span class="hljs-keyword">const</span> n = <span class="hljs-title function_">randomInt</span>(<span class="hljs-number">3</span>); 5106<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Random number chosen from (0, 1, 2): <span class="hljs-subst">${n}</span>`</span>);</code><code class="language-js cjs"><span class="hljs-comment">// Synchronous</span> 5107<span class="hljs-keyword">const</span> { 5108 randomInt, 5109} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 5110 5111<span class="hljs-keyword">const</span> n = <span class="hljs-title function_">randomInt</span>(<span class="hljs-number">3</span>); 5112<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Random number chosen from (0, 1, 2): <span class="hljs-subst">${n}</span>`</span>);</code><button class="copy-button">copy</button></pre> 5113 5114<pre class="with-22-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// With `min` argument</span> 5115<span class="hljs-keyword">const</span> { 5116 randomInt, 5117} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 5118 5119<span class="hljs-keyword">const</span> n = <span class="hljs-title function_">randomInt</span>(<span class="hljs-number">1</span>, <span class="hljs-number">7</span>); 5120<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`The dice rolled: <span class="hljs-subst">${n}</span>`</span>);</code><code class="language-js cjs"><span class="hljs-comment">// With `min` argument</span> 5121<span class="hljs-keyword">const</span> { 5122 randomInt, 5123} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 5124 5125<span class="hljs-keyword">const</span> n = <span class="hljs-title function_">randomInt</span>(<span class="hljs-number">1</span>, <span class="hljs-number">7</span>); 5126<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`The dice rolled: <span class="hljs-subst">${n}</span>`</span>);</code><button class="copy-button">copy</button></pre> 5127<h4><code>crypto.randomUUID([options])</code><span><a class="mark" href="#cryptorandomuuidoptions" id="cryptorandomuuidoptions">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_randomuuid_options"></a></h4> 5128<div class="api_metadata"> 5129<span>Added in: v15.6.0, v14.17.0</span> 5130</div> 5131<ul> 5132<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 5133<ul> 5134<li><code>disableEntropyCache</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> By default, to improve performance, 5135Node.js generates and caches enough 5136random data to generate up to 128 random UUIDs. To generate a UUID 5137without using the cache, set <code>disableEntropyCache</code> to <code>true</code>. 5138<strong>Default:</strong> <code>false</code>.</li> 5139</ul> 5140</li> 5141<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 5142</ul> 5143<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 5144cryptographic pseudorandom number generator.</p> 5145<h4><code>crypto.scrypt(password, salt, keylen[, options], callback)</code><span><a class="mark" href="#cryptoscryptpassword-salt-keylen-options-callback" id="cryptoscryptpassword-salt-keylen-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_scrypt_password_salt_keylen_options_callback"></a></h4> 5146<div class="api_metadata"> 5147<details class="changelog"><summary>History</summary> 5148<table> 5149<tbody><tr><th>Version</th><th>Changes</th></tr> 5150<tr><td>v18.0.0</td> 5151<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 5152<tr><td>v15.0.0</td> 5153<td><p>The password and salt arguments can also be ArrayBuffer instances.</p></td></tr> 5154<tr><td>v12.8.0, v10.17.0</td> 5155<td><p>The <code>maxmem</code> value can now be any safe integer.</p></td></tr> 5156<tr><td>v10.9.0</td> 5157<td><p>The <code>cost</code>, <code>blockSize</code> and <code>parallelization</code> option names have been added.</p></td></tr> 5158<tr><td>v10.5.0</td> 5159<td><p><span>Added in: v10.5.0</span></p></td></tr> 5160</tbody></table> 5161</details> 5162</div> 5163<ul> 5164<li><code>password</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> 5165<li><code>salt</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> 5166<li><code>keylen</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 5167<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 5168<ul> 5169<li><code>cost</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> CPU/memory cost parameter. Must be a power of two greater 5170than one. <strong>Default:</strong> <code>16384</code>.</li> 5171<li><code>blockSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Block size parameter. <strong>Default:</strong> <code>8</code>.</li> 5172<li><code>parallelization</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Parallelization parameter. <strong>Default:</strong> <code>1</code>.</li> 5173<li><code>N</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Alias for <code>cost</code>. Only one of both may be specified.</li> 5174<li><code>r</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Alias for <code>blockSize</code>. Only one of both may be specified.</li> 5175<li><code>p</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Alias for <code>parallelization</code>. Only one of both may be specified.</li> 5176<li><code>maxmem</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Memory upper bound. It is an error when (approximately) 5177<code>128 * N * r > maxmem</code>. <strong>Default:</strong> <code>32 * 1024 * 1024</code>.</li> 5178</ul> 5179</li> 5180<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 5181<ul> 5182<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 5183<li><code>derivedKey</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 5184</ul> 5185</li> 5186</ul> 5187<p>Provides an asynchronous <a href="https://en.wikipedia.org/wiki/Scrypt">scrypt</a> implementation. Scrypt is a password-based 5188key derivation function that is designed to be expensive computationally and 5189memory-wise in order to make brute-force attacks unrewarding.</p> 5190<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is 5191random 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> 5192<p>When passing strings for <code>password</code> or <code>salt</code>, please consider 5193<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 5194<p>The <code>callback</code> function is called with two arguments: <code>err</code> and <code>derivedKey</code>. 5195<code>err</code> is an exception object when key derivation fails, otherwise <code>err</code> is 5196<code>null</code>. <code>derivedKey</code> is passed to the callback as a <a href="buffer.html"><code>Buffer</code></a>.</p> 5197<p>An exception is thrown when any of the input arguments specify invalid values 5198or types.</p> 5199 5200<pre class="with-9-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 5201 scrypt, 5202} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 5203 5204<span class="hljs-comment">// Using the factory defaults.</span> 5205<span class="hljs-title function_">scrypt</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 5206 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5207 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(derivedKey.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span> 5208}); 5209<span class="hljs-comment">// Using a custom N parameter. Must be a power of two.</span> 5210<span class="hljs-title function_">scrypt</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>, { <span class="hljs-attr">N</span>: <span class="hljs-number">1024</span> }, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 5211 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5212 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(derivedKey.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...aa39b34'</span> 5213});</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 5214 scrypt, 5215} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 5216 5217<span class="hljs-comment">// Using the factory defaults.</span> 5218<span class="hljs-title function_">scrypt</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 5219 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5220 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(derivedKey.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span> 5221}); 5222<span class="hljs-comment">// Using a custom N parameter. Must be a power of two.</span> 5223<span class="hljs-title function_">scrypt</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>, { <span class="hljs-attr">N</span>: <span class="hljs-number">1024</span> }, <span class="hljs-function">(<span class="hljs-params">err, derivedKey</span>) =></span> { 5224 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 5225 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(derivedKey.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...aa39b34'</span> 5226});</code><button class="copy-button">copy</button></pre> 5227<h4><code>crypto.scryptSync(password, salt, keylen[, options])</code><span><a class="mark" href="#cryptoscryptsyncpassword-salt-keylen-options" id="cryptoscryptsyncpassword-salt-keylen-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_scryptsync_password_salt_keylen_options"></a></h4> 5228<div class="api_metadata"> 5229<details class="changelog"><summary>History</summary> 5230<table> 5231<tbody><tr><th>Version</th><th>Changes</th></tr> 5232<tr><td>v12.8.0, v10.17.0</td> 5233<td><p>The <code>maxmem</code> value can now be any safe integer.</p></td></tr> 5234<tr><td>v10.9.0</td> 5235<td><p>The <code>cost</code>, <code>blockSize</code> and <code>parallelization</code> option names have been added.</p></td></tr> 5236<tr><td>v10.5.0</td> 5237<td><p><span>Added in: v10.5.0</span></p></td></tr> 5238</tbody></table> 5239</details> 5240</div> 5241<ul> 5242<li><code>password</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> | <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> 5243<li><code>salt</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> | <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> 5244<li><code>keylen</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 5245<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 5246<ul> 5247<li><code>cost</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> CPU/memory cost parameter. Must be a power of two greater 5248than one. <strong>Default:</strong> <code>16384</code>.</li> 5249<li><code>blockSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Block size parameter. <strong>Default:</strong> <code>8</code>.</li> 5250<li><code>parallelization</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Parallelization parameter. <strong>Default:</strong> <code>1</code>.</li> 5251<li><code>N</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Alias for <code>cost</code>. Only one of both may be specified.</li> 5252<li><code>r</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Alias for <code>blockSize</code>. Only one of both may be specified.</li> 5253<li><code>p</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Alias for <code>parallelization</code>. Only one of both may be specified.</li> 5254<li><code>maxmem</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Memory upper bound. It is an error when (approximately) 5255<code>128 * N * r > maxmem</code>. <strong>Default:</strong> <code>32 * 1024 * 1024</code>.</li> 5256</ul> 5257</li> 5258<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 5259</ul> 5260<p>Provides a synchronous <a href="https://en.wikipedia.org/wiki/Scrypt">scrypt</a> implementation. Scrypt is a password-based 5261key derivation function that is designed to be expensive computationally and 5262memory-wise in order to make brute-force attacks unrewarding.</p> 5263<p>The <code>salt</code> should be as unique as possible. It is recommended that a salt is 5264random 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> 5265<p>When passing strings for <code>password</code> or <code>salt</code>, please consider 5266<a href="#using-strings-as-inputs-to-cryptographic-apis">caveats when using strings as inputs to cryptographic APIs</a>.</p> 5267<p>An exception is thrown when key derivation fails, otherwise the derived key is 5268returned as a <a href="buffer.html"><code>Buffer</code></a>.</p> 5269<p>An exception is thrown when any of the input arguments specify invalid values 5270or types.</p> 5271 5272<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">const</span> { 5273 scryptSync, 5274} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 5275<span class="hljs-comment">// Using the factory defaults.</span> 5276 5277<span class="hljs-keyword">const</span> key1 = <span class="hljs-title function_">scryptSync</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>); 5278<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key1.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span> 5279<span class="hljs-comment">// Using a custom N parameter. Must be a power of two.</span> 5280<span class="hljs-keyword">const</span> key2 = <span class="hljs-title function_">scryptSync</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>, { <span class="hljs-attr">N</span>: <span class="hljs-number">1024</span> }); 5281<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key2.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...aa39b34'</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 5282 scryptSync, 5283} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 5284<span class="hljs-comment">// Using the factory defaults.</span> 5285 5286<span class="hljs-keyword">const</span> key1 = <span class="hljs-title function_">scryptSync</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>); 5287<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key1.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...08d59ae'</span> 5288<span class="hljs-comment">// Using a custom N parameter. Must be a power of two.</span> 5289<span class="hljs-keyword">const</span> key2 = <span class="hljs-title function_">scryptSync</span>(<span class="hljs-string">'password'</span>, <span class="hljs-string">'salt'</span>, <span class="hljs-number">64</span>, { <span class="hljs-attr">N</span>: <span class="hljs-number">1024</span> }); 5290<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(key2.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'hex'</span>)); <span class="hljs-comment">// '3745e48...aa39b34'</span></code><button class="copy-button">copy</button></pre> 5291<h4><code>crypto.secureHeapUsed()</code><span><a class="mark" href="#cryptosecureheapused" id="cryptosecureheapused">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_secureheapused"></a></h4> 5292<div class="api_metadata"> 5293<span>Added in: v15.6.0</span> 5294</div> 5295<ul> 5296<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 5297<ul> 5298<li><code>total</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The total allocated secure heap size as specified 5299using the <code>--secure-heap=n</code> command-line flag.</li> 5300<li><code>min</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The minimum allocation from the secure heap as 5301specified using the <code>--secure-heap-min</code> command-line flag.</li> 5302<li><code>used</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The total number of bytes currently allocated from 5303the secure heap.</li> 5304<li><code>utilization</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The calculated ratio of <code>used</code> to <code>total</code> 5305allocated bytes.</li> 5306</ul> 5307</li> 5308</ul> 5309<h4><code>crypto.setEngine(engine[, flags])</code><span><a class="mark" href="#cryptosetengineengine-flags" id="cryptosetengineengine-flags">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_setengine_engine_flags"></a></h4> 5310<div class="api_metadata"> 5311<span>Added in: v0.11.11</span> 5312</div> 5313<ul> 5314<li><code>engine</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 5315<li><code>flags</code> <a href="crypto.html#cryptoconstants" class="type"><crypto.constants></a> <strong>Default:</strong> <code>crypto.constants.ENGINE_METHOD_ALL</code></li> 5316</ul> 5317<p>Load and set the <code>engine</code> for some or all OpenSSL functions (selected by flags).</p> 5318<p><code>engine</code> could be either an id or a path to the engine's shared library.</p> 5319<p>The optional <code>flags</code> argument uses <code>ENGINE_METHOD_ALL</code> by default. The <code>flags</code> 5320is a bit field taking one of or a mix of the following flags (defined in 5321<code>crypto.constants</code>):</p> 5322<ul> 5323<li><code>crypto.constants.ENGINE_METHOD_RSA</code></li> 5324<li><code>crypto.constants.ENGINE_METHOD_DSA</code></li> 5325<li><code>crypto.constants.ENGINE_METHOD_DH</code></li> 5326<li><code>crypto.constants.ENGINE_METHOD_RAND</code></li> 5327<li><code>crypto.constants.ENGINE_METHOD_EC</code></li> 5328<li><code>crypto.constants.ENGINE_METHOD_CIPHERS</code></li> 5329<li><code>crypto.constants.ENGINE_METHOD_DIGESTS</code></li> 5330<li><code>crypto.constants.ENGINE_METHOD_PKEY_METHS</code></li> 5331<li><code>crypto.constants.ENGINE_METHOD_PKEY_ASN1_METHS</code></li> 5332<li><code>crypto.constants.ENGINE_METHOD_ALL</code></li> 5333<li><code>crypto.constants.ENGINE_METHOD_NONE</code></li> 5334</ul> 5335<h4><code>crypto.setFips(bool)</code><span><a class="mark" href="#cryptosetfipsbool" id="cryptosetfipsbool">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_setfips_bool"></a></h4> 5336<div class="api_metadata"> 5337<span>Added in: v10.0.0</span> 5338</div> 5339<ul> 5340<li><code>bool</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> to enable FIPS mode.</li> 5341</ul> 5342<p>Enables the FIPS compliant crypto provider in a FIPS-enabled Node.js build. 5343Throws an error if FIPS mode is not available.</p> 5344<h4><code>crypto.sign(algorithm, data, key[, callback])</code><span><a class="mark" href="#cryptosignalgorithm-data-key-callback" id="cryptosignalgorithm-data-key-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_sign_algorithm_data_key_callback"></a></h4> 5345<div class="api_metadata"> 5346<details class="changelog"><summary>History</summary> 5347<table> 5348<tbody><tr><th>Version</th><th>Changes</th></tr> 5349<tr><td>v18.0.0</td> 5350<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 5351<tr><td>v15.12.0</td> 5352<td><p>Optional callback argument added.</p></td></tr> 5353<tr><td>v13.2.0, v12.16.0</td> 5354<td><p>This function now supports IEEE-P1363 DSA and ECDSA signatures.</p></td></tr> 5355<tr><td>v12.0.0</td> 5356<td><p><span>Added in: v12.0.0</span></p></td></tr> 5357</tbody></table> 5358</details> 5359</div> 5360<!--lint disable maximum-line-length remark-lint--> 5361<ul> 5362<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> 5363<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> 5364<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> 5365<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 5366<ul> 5367<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 5368<li><code>signature</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 5369</ul> 5370</li> 5371<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a> if the <code>callback</code> function is not provided.</li> 5372</ul> 5373<!--lint enable maximum-line-length remark-lint--> 5374<p>Calculates and returns the signature for <code>data</code> using the given private key and 5375algorithm. If <code>algorithm</code> is <code>null</code> or <code>undefined</code>, then the algorithm is 5376dependent upon the key type (especially Ed25519 and Ed448).</p> 5377<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 5378passed to <a href="#cryptocreateprivatekeykey"><code>crypto.createPrivateKey()</code></a>. If it is an object, the following 5379additional properties can be passed:</p> 5380<ul> 5381<li> 5382<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 5383format of the generated signature. It can be one of the following:</p> 5384<ul> 5385<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li> 5386<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li> 5387</ul> 5388</li> 5389<li> 5390<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> 5391<ul> 5392<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li> 5393<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li> 5394</ul> 5395<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function 5396used 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> 5397</li> 5398<li> 5399<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 5400<code>RSA_PKCS1_PSS_PADDING</code>. The special value 5401<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest 5402size, <code>crypto.constants.RSA_PSS_SALTLEN_MAX_SIGN</code> (default) sets it to the 5403maximum permissible value.</p> 5404</li> 5405</ul> 5406<p>If the <code>callback</code> function is provided this function uses libuv's threadpool.</p> 5407<h4><code>crypto.subtle</code><span><a class="mark" href="#cryptosubtle" id="cryptosubtle">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_subtle"></a></h4> 5408<div class="api_metadata"> 5409<span>Added in: v17.4.0</span> 5410</div> 5411<ul> 5412<li>Type: <a href="webcrypto.html#class-subtlecrypto" class="type"><SubtleCrypto></a></li> 5413</ul> 5414<p>A convenient alias for <a href="webcrypto.html#class-subtlecrypto"><code>crypto.webcrypto.subtle</code></a>.</p> 5415<h4><code>crypto.timingSafeEqual(a, b)</code><span><a class="mark" href="#cryptotimingsafeequala-b" id="cryptotimingsafeequala-b">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_timingsafeequal_a_b"></a></h4> 5416<div class="api_metadata"> 5417<details class="changelog"><summary>History</summary> 5418<table> 5419<tbody><tr><th>Version</th><th>Changes</th></tr> 5420<tr><td>v15.0.0</td> 5421<td><p>The a and b arguments can also be ArrayBuffer.</p></td></tr> 5422<tr><td>v6.6.0</td> 5423<td><p><span>Added in: v6.6.0</span></p></td></tr> 5424</tbody></table> 5425</details> 5426</div> 5427<ul> 5428<li><code>a</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> 5429<li><code>b</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> 5430<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 5431</ul> 5432<p>This function compares the underlying bytes that represent the given 5433<code>ArrayBuffer</code>, <code>TypedArray</code>, or <code>DataView</code> instances using a constant-time 5434algorithm.</p> 5435<p>This function does not leak timing information that 5436would allow an attacker to guess one of the values. This is suitable for 5437comparing HMAC digests or secret values like authentication cookies or 5438<a href="https://www.w3.org/TR/capability-urls/">capability urls</a>.</p> 5439<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 5440must have the same byte length. An error is thrown if <code>a</code> and <code>b</code> have 5441different byte lengths.</p> 5442<p>If at least one of <code>a</code> and <code>b</code> is a <code>TypedArray</code> with more than one byte per 5443entry, such as <code>Uint16Array</code>, the result will be computed using the platform 5444byte order.</p> 5445<p><strong class="critical">When both of the inputs are <code>Float32Array</code>s or 5446<code>Float64Array</code>s, this function might return unexpected results due to IEEE 754 5447encoding of floating-point numbers. In particular, neither <code>x === y</code> nor 5448<code>Object.is(x, y)</code> implies that the byte representations of two floating-point 5449numbers <code>x</code> and <code>y</code> are equal.</strong></p> 5450<p>Use of <code>crypto.timingSafeEqual</code> does not guarantee that the <em>surrounding</em> code 5451is timing-safe. Care should be taken to ensure that the surrounding code does 5452not introduce timing vulnerabilities.</p> 5453<h4><code>crypto.verify(algorithm, data, key, signature[, callback])</code><span><a class="mark" href="#cryptoverifyalgorithm-data-key-signature-callback" id="cryptoverifyalgorithm-data-key-signature-callback">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_verify_algorithm_data_key_signature_callback"></a></h4> 5454<div class="api_metadata"> 5455<details class="changelog"><summary>History</summary> 5456<table> 5457<tbody><tr><th>Version</th><th>Changes</th></tr> 5458<tr><td>v18.0.0</td> 5459<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 5460<tr><td>v15.12.0</td> 5461<td><p>Optional callback argument added.</p></td></tr> 5462<tr><td>v15.0.0</td> 5463<td><p>The data, key, and signature arguments can also be ArrayBuffer.</p></td></tr> 5464<tr><td>v13.2.0, v12.16.0</td> 5465<td><p>This function now supports IEEE-P1363 DSA and ECDSA signatures.</p></td></tr> 5466<tr><td>v12.0.0</td> 5467<td><p><span>Added in: v12.0.0</span></p></td></tr> 5468</tbody></table> 5469</details> 5470</div> 5471<!--lint disable maximum-line-length remark-lint--> 5472<ul> 5473<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> 5474<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> 5475<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> 5476<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> 5477<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> 5478<ul> 5479<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 5480<li><code>result</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 5481</ul> 5482</li> 5483<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 5484signature for the data and public key if the <code>callback</code> function is not 5485provided.</li> 5486</ul> 5487<!--lint enable maximum-line-length remark-lint--> 5488<p>Verifies the given signature for <code>data</code> using the given key and algorithm. If 5489<code>algorithm</code> is <code>null</code> or <code>undefined</code>, then the algorithm is dependent upon the 5490key type (especially Ed25519 and Ed448).</p> 5491<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 5492passed to <a href="#cryptocreatepublickeykey"><code>crypto.createPublicKey()</code></a>. If it is an object, the following 5493additional properties can be passed:</p> 5494<ul> 5495<li> 5496<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 5497format of the signature. It can be one of the following:</p> 5498<ul> 5499<li><code>'der'</code> (default): DER-encoded ASN.1 signature structure encoding <code>(r, s)</code>.</li> 5500<li><code>'ieee-p1363'</code>: Signature format <code>r || s</code> as proposed in IEEE-P1363.</li> 5501</ul> 5502</li> 5503<li> 5504<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> 5505<ul> 5506<li><code>crypto.constants.RSA_PKCS1_PADDING</code> (default)</li> 5507<li><code>crypto.constants.RSA_PKCS1_PSS_PADDING</code></li> 5508</ul> 5509<p><code>RSA_PKCS1_PSS_PADDING</code> will use MGF1 with the same hash function 5510used 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> 5511</li> 5512<li> 5513<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 5514<code>RSA_PKCS1_PSS_PADDING</code>. The special value 5515<code>crypto.constants.RSA_PSS_SALTLEN_DIGEST</code> sets the salt length to the digest 5516size, <code>crypto.constants.RSA_PSS_SALTLEN_MAX_SIGN</code> (default) sets it to the 5517maximum permissible value.</p> 5518</li> 5519</ul> 5520<p>The <code>signature</code> argument is the previously calculated signature for the <code>data</code>.</p> 5521<p>Because public keys can be derived from private keys, a private key or a public 5522key may be passed for <code>key</code>.</p> 5523<p>If the <code>callback</code> function is provided this function uses libuv's threadpool.</p> 5524<h4><code>crypto.webcrypto</code><span><a class="mark" href="#cryptowebcrypto" id="cryptowebcrypto">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_webcrypto"></a></h4> 5525<div class="api_metadata"> 5526<span>Added in: v15.0.0</span> 5527</div> 5528<p>Type: <a href="webcrypto.html#class-crypto" class="type"><Crypto></a> An implementation of the Web Crypto API standard.</p> 5529<p>See the <a href="webcrypto.html">Web Crypto API documentation</a> for details.</p> 5530</section><section><h3>Notes<span><a class="mark" href="#notes" id="notes">#</a></span><a aria-hidden="true" class="legacy" id="crypto_notes"></a></h3> 5531<h4>Using strings as inputs to cryptographic APIs<span><a class="mark" href="#using-strings-as-inputs-to-cryptographic-apis" id="using-strings-as-inputs-to-cryptographic-apis">#</a></span><a aria-hidden="true" class="legacy" id="crypto_using_strings_as_inputs_to_cryptographic_apis"></a></h4> 5532<p>For historical reasons, many cryptographic APIs provided by Node.js accept 5533strings as inputs where the underlying cryptographic algorithm works on byte 5534sequences. These instances include plaintexts, ciphertexts, symmetric keys, 5535initialization vectors, passphrases, salts, authentication tags, 5536and additional authenticated data.</p> 5537<p>When passing strings to cryptographic APIs, consider the following factors.</p> 5538<ul> 5539<li> 5540<p>Not all byte sequences are valid UTF-8 strings. Therefore, when a byte 5541sequence of length <code>n</code> is derived from a string, its entropy is generally 5542lower than the entropy of a random or pseudorandom <code>n</code> byte sequence. 5543For example, no UTF-8 string will result in the byte sequence <code>c0 af</code>. Secret 5544keys should almost exclusively be random or pseudorandom byte sequences.</p> 5545</li> 5546<li> 5547<p>Similarly, when converting random or pseudorandom byte sequences to UTF-8 5548strings, subsequences that do not represent valid code points may be replaced 5549by the Unicode replacement character (<code>U+FFFD</code>). The byte representation of 5550the resulting Unicode string may, therefore, not be equal to the byte sequence 5551that the string was created from.</p> 5552<pre><code class="language-js"><span class="hljs-keyword">const</span> original = [<span class="hljs-number">0xc0</span>, <span class="hljs-number">0xaf</span>]; 5553<span class="hljs-keyword">const</span> bytesAsString = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(original).<span class="hljs-title function_">toString</span>(<span class="hljs-string">'utf8'</span>); 5554<span class="hljs-keyword">const</span> stringAsBytes = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(bytesAsString, <span class="hljs-string">'utf8'</span>); 5555<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(stringAsBytes); 5556<span class="hljs-comment">// Prints '<Buffer ef bf bd ef bf bd>'.</span></code> <button class="copy-button">copy</button></pre> 5557<p>The outputs of ciphers, hash functions, signature algorithms, and key 5558derivation functions are pseudorandom byte sequences and should not be 5559used as Unicode strings.</p> 5560</li> 5561<li> 5562<p>When strings are obtained from user input, some Unicode characters can be 5563represented in multiple equivalent ways that result in different byte 5564sequences. For example, when passing a user passphrase to a key derivation 5565function, such as PBKDF2 or scrypt, the result of the key derivation function 5566depends on whether the string uses composed or decomposed characters. Node.js 5567does not normalize character representations. Developers should consider using 5568<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 5569cryptographic APIs.</p> 5570</li> 5571</ul> 5572<h4>Legacy streams API (prior to Node.js 0.10)<span><a class="mark" href="#legacy-streams-api-prior-to-nodejs-010" id="legacy-streams-api-prior-to-nodejs-010">#</a></span><a aria-hidden="true" class="legacy" id="crypto_legacy_streams_api_prior_to_node_js_0_10"></a></h4> 5573<p>The Crypto module was added to Node.js before there was the concept of a 5574unified Stream API, and before there were <a href="buffer.html"><code>Buffer</code></a> objects for handling 5575binary data. As such, many <code>crypto</code> classes have methods not 5576typically found on other Node.js classes that implement the <a href="stream.html">streams</a> 5577API (e.g. <code>update()</code>, <code>final()</code>, or <code>digest()</code>). Also, many methods accepted 5578and returned <code>'latin1'</code> encoded strings by default rather than <code>Buffer</code>s. This 5579default was changed after Node.js v0.8 to use <a href="buffer.html"><code>Buffer</code></a> objects by default 5580instead.</p> 5581<h4>Support for weak or compromised algorithms<span><a class="mark" href="#support-for-weak-or-compromised-algorithms" id="support-for-weak-or-compromised-algorithms">#</a></span><a aria-hidden="true" class="legacy" id="crypto_support_for_weak_or_compromised_algorithms"></a></h4> 5582<p>The <code>node:crypto</code> module still supports some algorithms which are already 5583compromised and are not currently recommended for use. The API also allows 5584the use of ciphers and hashes with a small key size that are too weak for safe 5585use.</p> 5586<p>Users should take full responsibility for selecting the crypto 5587algorithm and key size according to their security requirements.</p> 5588<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> 5589<ul> 5590<li>MD5 and SHA-1 are no longer acceptable where collision resistance is 5591required such as digital signatures.</li> 5592<li>The key used with RSA, DSA, and DH algorithms is recommended to have 5593at least 2048 bits and that of the curve of ECDSA and ECDH at least 5594224 bits, to be safe to use for several years.</li> 5595<li>The DH groups of <code>modp1</code>, <code>modp2</code> and <code>modp5</code> have a key size 5596smaller than 2048 bits and are not recommended.</li> 5597</ul> 5598<p>See the reference for other recommendations and details.</p> 5599<p>Some algorithms that have known weaknesses and are of little relevance in 5600practice are only available through the <a href="cli.html#--openssl-legacy-provider">legacy provider</a>, which is not 5601enabled by default.</p> 5602<h4>CCM mode<span><a class="mark" href="#ccm-mode" id="ccm-mode">#</a></span><a aria-hidden="true" class="legacy" id="crypto_ccm_mode"></a></h4> 5603<p>CCM is one of the supported <a href="https://en.wikipedia.org/wiki/Authenticated_encryption">AEAD algorithms</a>. Applications which use this 5604mode must adhere to certain restrictions when using the cipher API:</p> 5605<ul> 5606<li>The authentication tag length must be specified during cipher creation by 5607setting the <code>authTagLength</code> option and must be one of 4, 6, 8, 10, 12, 14 or 560816 bytes.</li> 5609<li>The length of the initialization vector (nonce) <code>N</code> must be between 7 and 13 5610bytes (<code>7 ≤ N ≤ 13</code>).</li> 5611<li>The length of the plaintext is limited to <code>2 ** (8 * (15 - N))</code> bytes.</li> 5612<li>When decrypting, the authentication tag must be set via <code>setAuthTag()</code> before 5613calling <code>update()</code>. 5614Otherwise, decryption will fail and <code>final()</code> will throw an error in 5615compliance with section 2.6 of <a href="https://www.rfc-editor.org/rfc/rfc3610.txt">RFC 3610</a>.</li> 5616<li>Using stream methods such as <code>write(data)</code>, <code>end(data)</code> or <code>pipe()</code> in CCM 5617mode might fail as CCM cannot handle more than one chunk of data per instance.</li> 5618<li>When passing additional authenticated data (AAD), the length of the actual 5619message in bytes must be passed to <code>setAAD()</code> via the <code>plaintextLength</code> 5620option. 5621Many crypto libraries include the authentication tag in the ciphertext, 5622which means that they produce ciphertexts of the length 5623<code>plaintextLength + authTagLength</code>. Node.js does not include the authentication 5624tag, so the ciphertext length is always <code>plaintextLength</code>. 5625This is not necessary if no AAD is used.</li> 5626<li>As CCM processes the whole message at once, <code>update()</code> must be called exactly 5627once.</li> 5628<li>Even though calling <code>update()</code> is sufficient to encrypt/decrypt the message, 5629applications <em>must</em> call <code>final()</code> to compute or verify the 5630authentication tag.</li> 5631</ul> 5632 5633<pre class="with-42-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">Buffer</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:buffer'</span>; 5634<span class="hljs-keyword">const</span> { 5635 createCipheriv, 5636 createDecipheriv, 5637 randomBytes, 5638} = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:crypto'</span>); 5639 5640<span class="hljs-keyword">const</span> key = <span class="hljs-string">'keykeykeykeykeykeykeykey'</span>; 5641<span class="hljs-keyword">const</span> nonce = <span class="hljs-title function_">randomBytes</span>(<span class="hljs-number">12</span>); 5642 5643<span class="hljs-keyword">const</span> aad = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-string">'0123456789'</span>, <span class="hljs-string">'hex'</span>); 5644 5645<span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(<span class="hljs-string">'aes-192-ccm'</span>, key, nonce, { 5646 <span class="hljs-attr">authTagLength</span>: <span class="hljs-number">16</span>, 5647}); 5648<span class="hljs-keyword">const</span> plaintext = <span class="hljs-string">'Hello world'</span>; 5649cipher.<span class="hljs-title function_">setAAD</span>(aad, { 5650 <span class="hljs-attr">plaintextLength</span>: <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">byteLength</span>(plaintext), 5651}); 5652<span class="hljs-keyword">const</span> ciphertext = cipher.<span class="hljs-title function_">update</span>(plaintext, <span class="hljs-string">'utf8'</span>); 5653cipher.<span class="hljs-title function_">final</span>(); 5654<span class="hljs-keyword">const</span> tag = cipher.<span class="hljs-title function_">getAuthTag</span>(); 5655 5656<span class="hljs-comment">// Now transmit { ciphertext, nonce, tag }.</span> 5657 5658<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(<span class="hljs-string">'aes-192-ccm'</span>, key, nonce, { 5659 <span class="hljs-attr">authTagLength</span>: <span class="hljs-number">16</span>, 5660}); 5661decipher.<span class="hljs-title function_">setAuthTag</span>(tag); 5662decipher.<span class="hljs-title function_">setAAD</span>(aad, { 5663 <span class="hljs-attr">plaintextLength</span>: ciphertext.<span class="hljs-property">length</span>, 5664}); 5665<span class="hljs-keyword">const</span> receivedPlaintext = decipher.<span class="hljs-title function_">update</span>(ciphertext, <span class="hljs-literal">null</span>, <span class="hljs-string">'utf8'</span>); 5666 5667<span class="hljs-keyword">try</span> { 5668 decipher.<span class="hljs-title function_">final</span>(); 5669} <span class="hljs-keyword">catch</span> (err) { 5670 <span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(<span class="hljs-string">'Authentication failed!'</span>, { <span class="hljs-attr">cause</span>: err }); 5671} 5672 5673<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(receivedPlaintext);</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Buffer</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:buffer'</span>); 5674<span class="hljs-keyword">const</span> { 5675 createCipheriv, 5676 createDecipheriv, 5677 randomBytes, 5678} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 5679 5680<span class="hljs-keyword">const</span> key = <span class="hljs-string">'keykeykeykeykeykeykeykey'</span>; 5681<span class="hljs-keyword">const</span> nonce = <span class="hljs-title function_">randomBytes</span>(<span class="hljs-number">12</span>); 5682 5683<span class="hljs-keyword">const</span> aad = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-string">'0123456789'</span>, <span class="hljs-string">'hex'</span>); 5684 5685<span class="hljs-keyword">const</span> cipher = <span class="hljs-title function_">createCipheriv</span>(<span class="hljs-string">'aes-192-ccm'</span>, key, nonce, { 5686 <span class="hljs-attr">authTagLength</span>: <span class="hljs-number">16</span>, 5687}); 5688<span class="hljs-keyword">const</span> plaintext = <span class="hljs-string">'Hello world'</span>; 5689cipher.<span class="hljs-title function_">setAAD</span>(aad, { 5690 <span class="hljs-attr">plaintextLength</span>: <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">byteLength</span>(plaintext), 5691}); 5692<span class="hljs-keyword">const</span> ciphertext = cipher.<span class="hljs-title function_">update</span>(plaintext, <span class="hljs-string">'utf8'</span>); 5693cipher.<span class="hljs-title function_">final</span>(); 5694<span class="hljs-keyword">const</span> tag = cipher.<span class="hljs-title function_">getAuthTag</span>(); 5695 5696<span class="hljs-comment">// Now transmit { ciphertext, nonce, tag }.</span> 5697 5698<span class="hljs-keyword">const</span> decipher = <span class="hljs-title function_">createDecipheriv</span>(<span class="hljs-string">'aes-192-ccm'</span>, key, nonce, { 5699 <span class="hljs-attr">authTagLength</span>: <span class="hljs-number">16</span>, 5700}); 5701decipher.<span class="hljs-title function_">setAuthTag</span>(tag); 5702decipher.<span class="hljs-title function_">setAAD</span>(aad, { 5703 <span class="hljs-attr">plaintextLength</span>: ciphertext.<span class="hljs-property">length</span>, 5704}); 5705<span class="hljs-keyword">const</span> receivedPlaintext = decipher.<span class="hljs-title function_">update</span>(ciphertext, <span class="hljs-literal">null</span>, <span class="hljs-string">'utf8'</span>); 5706 5707<span class="hljs-keyword">try</span> { 5708 decipher.<span class="hljs-title function_">final</span>(); 5709} <span class="hljs-keyword">catch</span> (err) { 5710 <span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(<span class="hljs-string">'Authentication failed!'</span>, { <span class="hljs-attr">cause</span>: err }); 5711} 5712 5713<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(receivedPlaintext);</code><button class="copy-button">copy</button></pre> 5714<h4>FIPS mode<span><a class="mark" href="#fips-mode" id="fips-mode">#</a></span><a aria-hidden="true" class="legacy" id="crypto_fips_mode"></a></h4> 5715<p>When using OpenSSL 3, Node.js supports FIPS 140-2 when used with an appropriate 5716OpenSSL 3 provider, such as the <a href="https://www.openssl.org/docs/man3.0/man7/crypto.html#FIPS-provider">FIPS provider from OpenSSL 3</a> which can be 5717installed by following the instructions in <a href="https://github.com/openssl/openssl/blob/openssl-3.0/README-FIPS.md">OpenSSL's FIPS README file</a>.</p> 5718<p>For FIPS support in Node.js you will need:</p> 5719<ul> 5720<li>A correctly installed OpenSSL 3 FIPS provider.</li> 5721<li>An OpenSSL 3 <a href="https://www.openssl.org/docs/man3.0/man5/fips_config.html">FIPS module configuration file</a>.</li> 5722<li>An OpenSSL 3 configuration file that references the FIPS module 5723configuration file.</li> 5724</ul> 5725<p>Node.js will need to be configured with an OpenSSL configuration file that 5726points to the FIPS provider. An example configuration file looks like this:</p> 5727<pre><code class="language-text">nodejs_conf = nodejs_init 5728 5729.include /<absolute path>/fipsmodule.cnf 5730 5731[nodejs_init] 5732providers = provider_sect 5733 5734[provider_sect] 5735default = default_sect 5736# The fips section name should match the section name inside the 5737# included fipsmodule.cnf. 5738fips = fips_sect 5739 5740[default_sect] 5741activate = 1</code> <button class="copy-button">copy</button></pre> 5742<p>where <code>fipsmodule.cnf</code> is the FIPS module configuration file generated from the 5743FIPS provider installation step:</p> 5744<pre><code class="language-bash">openssl fipsinstall</code> <button class="copy-button">copy</button></pre> 5745<p>Set the <code>OPENSSL_CONF</code> environment variable to point to 5746your configuration file and <code>OPENSSL_MODULES</code> to the location of the FIPS 5747provider dynamic library. e.g.</p> 5748<pre><code class="language-bash"><span class="hljs-built_in">export</span> OPENSSL_CONF=/<path to configuration file>/nodejs.cnf 5749<span class="hljs-built_in">export</span> OPENSSL_MODULES=/<path to openssl lib>/ossl-modules</code> <button class="copy-button">copy</button></pre> 5750<p>FIPS mode can then be enabled in Node.js either by:</p> 5751<ul> 5752<li>Starting Node.js with <code>--enable-fips</code> or <code>--force-fips</code> command line flags.</li> 5753<li>Programmatically calling <code>crypto.setFips(true)</code>.</li> 5754</ul> 5755<p>Optionally FIPS mode can be enabled in Node.js via the OpenSSL configuration 5756file. e.g.</p> 5757<pre><code class="language-text">nodejs_conf = nodejs_init 5758 5759.include /<absolute path>/fipsmodule.cnf 5760 5761[nodejs_init] 5762providers = provider_sect 5763alg_section = algorithm_sect 5764 5765[provider_sect] 5766default = default_sect 5767# The fips section name should match the section name inside the 5768# included fipsmodule.cnf. 5769fips = fips_sect 5770 5771[default_sect] 5772activate = 1 5773 5774[algorithm_sect] 5775default_properties = fips=yes</code> <button class="copy-button">copy</button></pre> 5776</section><section><h3>Crypto constants<span><a class="mark" href="#crypto-constants" id="crypto-constants">#</a></span><a aria-hidden="true" class="legacy" id="crypto_crypto_constants_1"></a></h3> 5777<p>The following constants exported by <code>crypto.constants</code> apply to various uses of 5778the <code>node:crypto</code>, <code>node:tls</code>, and <code>node:https</code> modules and are generally 5779specific to OpenSSL.</p> 5780<h4>OpenSSL options<span><a class="mark" href="#openssl-options" id="openssl-options">#</a></span><a aria-hidden="true" class="legacy" id="crypto_openssl_options"></a></h4> 5781<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> 5782<table> 5783 <tbody><tr> 5784 <th>Constant</th> 5785 <th>Description</th> 5786 </tr> 5787 <tr> 5788 <td><code>SSL_OP_ALL</code></td> 5789 <td>Applies multiple bug workarounds within OpenSSL. See 5790 <a href="https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html">https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html</a> 5791 for detail.</td> 5792 </tr> 5793 <tr> 5794 <td><code>SSL_OP_ALLOW_NO_DHE_KEX</code></td> 5795 <td>Instructs OpenSSL to allow a non-[EC]DHE-based key exchange mode 5796 for TLS v1.3</td> 5797 </tr> 5798 <tr> 5799 <td><code>SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION</code></td> 5800 <td>Allows legacy insecure renegotiation between OpenSSL and unpatched 5801 clients or servers. See 5802 <a href="https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html">https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html</a>.</td> 5803 </tr> 5804 <tr> 5805 <td><code>SSL_OP_CIPHER_SERVER_PREFERENCE</code></td> 5806 <td>Attempts to use the server's preferences instead of the client's when 5807 selecting a cipher. Behavior depends on protocol version. See 5808 <a href="https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html">https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_options.html</a>.</td> 5809 </tr> 5810 <tr> 5811 <td><code>SSL_OP_CISCO_ANYCONNECT</code></td> 5812 <td>Instructs OpenSSL to use Cisco's "speshul" version of DTLS_BAD_VER.</td> 5813 </tr> 5814 <tr> 5815 <td><code>SSL_OP_COOKIE_EXCHANGE</code></td> 5816 <td>Instructs OpenSSL to turn on cookie exchange.</td> 5817 </tr> 5818 <tr> 5819 <td><code>SSL_OP_CRYPTOPRO_TLSEXT_BUG</code></td> 5820 <td>Instructs OpenSSL to add server-hello extension from an early version 5821 of the cryptopro draft.</td> 5822 </tr> 5823 <tr> 5824 <td><code>SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS</code></td> 5825 <td>Instructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability 5826 workaround added in OpenSSL 0.9.6d.</td> 5827 </tr> 5828 <tr> 5829 <td><code>SSL_OP_LEGACY_SERVER_CONNECT</code></td> 5830 <td>Allows initial connection to servers that do not support RI.</td> 5831 </tr> 5832 <tr> 5833 <td><code>SSL_OP_NO_COMPRESSION</code></td> 5834 <td>Instructs OpenSSL to disable support for SSL/TLS compression.</td> 5835 </tr> 5836 <tr> 5837 <td><code>SSL_OP_NO_ENCRYPT_THEN_MAC</code></td> 5838 <td>Instructs OpenSSL to disable encrypt-then-MAC.</td> 5839 </tr> 5840 <tr> 5841 <td><code>SSL_OP_NO_QUERY_MTU</code></td> 5842 <td></td> 5843 </tr> 5844 <tr> 5845 <td><code>SSL_OP_NO_RENEGOTIATION</code></td> 5846 <td>Instructs OpenSSL to disable renegotiation.</td> 5847 </tr> 5848 <tr> 5849 <td><code>SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION</code></td> 5850 <td>Instructs OpenSSL to always start a new session when performing 5851 renegotiation.</td> 5852 </tr> 5853 <tr> 5854 <td><code>SSL_OP_NO_SSLv2</code></td> 5855 <td>Instructs OpenSSL to turn off SSL v2</td> 5856 </tr> 5857 <tr> 5858 <td><code>SSL_OP_NO_SSLv3</code></td> 5859 <td>Instructs OpenSSL to turn off SSL v3</td> 5860 </tr> 5861 <tr> 5862 <td><code>SSL_OP_NO_TICKET</code></td> 5863 <td>Instructs OpenSSL to disable use of RFC4507bis tickets.</td> 5864 </tr> 5865 <tr> 5866 <td><code>SSL_OP_NO_TLSv1</code></td> 5867 <td>Instructs OpenSSL to turn off TLS v1</td> 5868 </tr> 5869 <tr> 5870 <td><code>SSL_OP_NO_TLSv1_1</code></td> 5871 <td>Instructs OpenSSL to turn off TLS v1.1</td> 5872 </tr> 5873 <tr> 5874 <td><code>SSL_OP_NO_TLSv1_2</code></td> 5875 <td>Instructs OpenSSL to turn off TLS v1.2</td> 5876 </tr> 5877 <tr> 5878 <td><code>SSL_OP_NO_TLSv1_3</code></td> 5879 <td>Instructs OpenSSL to turn off TLS v1.3</td> 5880 </tr> 5881 <tr> 5882 <td><code>SSL_OP_PRIORITIZE_CHACHA</code></td> 5883 <td>Instructs OpenSSL server to prioritize ChaCha20-Poly1305 5884 when the client does. 5885 This option has no effect if 5886 <code>SSL_OP_CIPHER_SERVER_PREFERENCE</code> 5887 is not enabled.</td> 5888 </tr> 5889 <tr> 5890 <td><code>SSL_OP_TLS_ROLLBACK_BUG</code></td> 5891 <td>Instructs OpenSSL to disable version rollback attack detection.</td> 5892 </tr> 5893</tbody></table> 5894<h4>OpenSSL engine constants<span><a class="mark" href="#openssl-engine-constants" id="openssl-engine-constants">#</a></span><a aria-hidden="true" class="legacy" id="crypto_openssl_engine_constants"></a></h4> 5895<table> 5896 <tbody><tr> 5897 <th>Constant</th> 5898 <th>Description</th> 5899 </tr> 5900 <tr> 5901 <td><code>ENGINE_METHOD_RSA</code></td> 5902 <td>Limit engine usage to RSA</td> 5903 </tr> 5904 <tr> 5905 <td><code>ENGINE_METHOD_DSA</code></td> 5906 <td>Limit engine usage to DSA</td> 5907 </tr> 5908 <tr> 5909 <td><code>ENGINE_METHOD_DH</code></td> 5910 <td>Limit engine usage to DH</td> 5911 </tr> 5912 <tr> 5913 <td><code>ENGINE_METHOD_RAND</code></td> 5914 <td>Limit engine usage to RAND</td> 5915 </tr> 5916 <tr> 5917 <td><code>ENGINE_METHOD_EC</code></td> 5918 <td>Limit engine usage to EC</td> 5919 </tr> 5920 <tr> 5921 <td><code>ENGINE_METHOD_CIPHERS</code></td> 5922 <td>Limit engine usage to CIPHERS</td> 5923 </tr> 5924 <tr> 5925 <td><code>ENGINE_METHOD_DIGESTS</code></td> 5926 <td>Limit engine usage to DIGESTS</td> 5927 </tr> 5928 <tr> 5929 <td><code>ENGINE_METHOD_PKEY_METHS</code></td> 5930 <td>Limit engine usage to PKEY_METHDS</td> 5931 </tr> 5932 <tr> 5933 <td><code>ENGINE_METHOD_PKEY_ASN1_METHS</code></td> 5934 <td>Limit engine usage to PKEY_ASN1_METHS</td> 5935 </tr> 5936 <tr> 5937 <td><code>ENGINE_METHOD_ALL</code></td> 5938 <td></td> 5939 </tr> 5940 <tr> 5941 <td><code>ENGINE_METHOD_NONE</code></td> 5942 <td></td> 5943 </tr> 5944</tbody></table> 5945<h4>Other OpenSSL constants<span><a class="mark" href="#other-openssl-constants" id="other-openssl-constants">#</a></span><a aria-hidden="true" class="legacy" id="crypto_other_openssl_constants"></a></h4> 5946<table> 5947 <tbody><tr> 5948 <th>Constant</th> 5949 <th>Description</th> 5950 </tr> 5951 <tr> 5952 <td><code>DH_CHECK_P_NOT_SAFE_PRIME</code></td> 5953 <td></td> 5954 </tr> 5955 <tr> 5956 <td><code>DH_CHECK_P_NOT_PRIME</code></td> 5957 <td></td> 5958 </tr> 5959 <tr> 5960 <td><code>DH_UNABLE_TO_CHECK_GENERATOR</code></td> 5961 <td></td> 5962 </tr> 5963 <tr> 5964 <td><code>DH_NOT_SUITABLE_GENERATOR</code></td> 5965 <td></td> 5966 </tr> 5967 <tr> 5968 <td><code>ALPN_ENABLED</code></td> 5969 <td></td> 5970 </tr> 5971 <tr> 5972 <td><code>RSA_PKCS1_PADDING</code></td> 5973 <td></td> 5974 </tr> 5975 <tr> 5976 <td><code>RSA_SSLV23_PADDING</code></td> 5977 <td></td> 5978 </tr> 5979 <tr> 5980 <td><code>RSA_NO_PADDING</code></td> 5981 <td></td> 5982 </tr> 5983 <tr> 5984 <td><code>RSA_PKCS1_OAEP_PADDING</code></td> 5985 <td></td> 5986 </tr> 5987 <tr> 5988 <td><code>RSA_X931_PADDING</code></td> 5989 <td></td> 5990 </tr> 5991 <tr> 5992 <td><code>RSA_PKCS1_PSS_PADDING</code></td> 5993 <td></td> 5994 </tr> 5995 <tr> 5996 <td><code>RSA_PSS_SALTLEN_DIGEST</code></td> 5997 <td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the 5998 digest size when signing or verifying.</td> 5999 </tr> 6000 <tr> 6001 <td><code>RSA_PSS_SALTLEN_MAX_SIGN</code></td> 6002 <td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the 6003 maximum permissible value when signing data.</td> 6004 </tr> 6005 <tr> 6006 <td><code>RSA_PSS_SALTLEN_AUTO</code></td> 6007 <td>Causes the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to be 6008 determined automatically when verifying a signature.</td> 6009 </tr> 6010 <tr> 6011 <td><code>POINT_CONVERSION_COMPRESSED</code></td> 6012 <td></td> 6013 </tr> 6014 <tr> 6015 <td><code>POINT_CONVERSION_UNCOMPRESSED</code></td> 6016 <td></td> 6017 </tr> 6018 <tr> 6019 <td><code>POINT_CONVERSION_HYBRID</code></td> 6020 <td></td> 6021 </tr> 6022</tbody></table> 6023<h4>Node.js crypto constants<span><a class="mark" href="#nodejs-crypto-constants" id="nodejs-crypto-constants">#</a></span><a aria-hidden="true" class="legacy" id="crypto_node_js_crypto_constants"></a></h4> 6024<table> 6025 <tbody><tr> 6026 <th>Constant</th> 6027 <th>Description</th> 6028 </tr> 6029 <tr> 6030 <td><code>defaultCoreCipherList</code></td> 6031 <td>Specifies the built-in default cipher list used by Node.js.</td> 6032 </tr> 6033 <tr> 6034 <td><code>defaultCipherList</code></td> 6035 <td>Specifies the active default cipher list used by the current Node.js 6036 process.</td> 6037 </tr> 6038</tbody></table></section> 6039 <!-- API END --> 6040 </div> 6041 </div> 6042 </div> 6043</body> 6044</html> 6045