11cb0ef41Sopenharmony_ci<!DOCTYPE html> 21cb0ef41Sopenharmony_ci<html lang="en"> 31cb0ef41Sopenharmony_ci<head> 41cb0ef41Sopenharmony_ci <meta charset="utf-8"> 51cb0ef41Sopenharmony_ci <meta name="viewport" content="width=device-width"> 61cb0ef41Sopenharmony_ci <meta name="nodejs.org:node-version" content="v18.20.1"> 71cb0ef41Sopenharmony_ci <title>HTTPS | Node.js v18.20.1 Documentation</title> 81cb0ef41Sopenharmony_ci <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 91cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/style.css"> 101cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/hljs.css"> 111cb0ef41Sopenharmony_ci <link rel="canonical" href="https://nodejs.org/api/https.html"> 121cb0ef41Sopenharmony_ci <script async defer src="assets/api.js" type="text/javascript"></script> 131cb0ef41Sopenharmony_ci 141cb0ef41Sopenharmony_ci</head> 151cb0ef41Sopenharmony_ci<body class="alt apidoc" id="api-section-https"> 161cb0ef41Sopenharmony_ci <div id="content" class="clearfix"> 171cb0ef41Sopenharmony_ci <div id="column2" class="interior"> 181cb0ef41Sopenharmony_ci <div id="intro" class="interior"> 191cb0ef41Sopenharmony_ci <a href="/" title="Go back to the home page"> 201cb0ef41Sopenharmony_ci Node.js 211cb0ef41Sopenharmony_ci </a> 221cb0ef41Sopenharmony_ci </div> 231cb0ef41Sopenharmony_ci <ul> 241cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 251cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 261cb0ef41Sopenharmony_ci</ul> 271cb0ef41Sopenharmony_ci<hr class="line"> 281cb0ef41Sopenharmony_ci<ul> 291cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 301cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 311cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 321cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 331cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 341cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 351cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 361cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 371cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 381cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 391cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 401cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 411cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 421cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 431cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 441cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 451cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 461cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 471cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 481cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 491cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 501cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 511cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 521cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 531cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https active">HTTPS</a></li> 541cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 551cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 561cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 571cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 581cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 591cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 601cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 611cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 621cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 631cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 641cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 651cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 661cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 671cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 681cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 691cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 701cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 711cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 721cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 731cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 741cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 751cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 761cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 771cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 781cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 791cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 801cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 811cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 821cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 831cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 841cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 851cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 861cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 871cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 881cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 891cb0ef41Sopenharmony_ci</ul> 901cb0ef41Sopenharmony_ci<hr class="line"> 911cb0ef41Sopenharmony_ci<ul> 921cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 931cb0ef41Sopenharmony_ci</ul> 941cb0ef41Sopenharmony_ci </div> 951cb0ef41Sopenharmony_ci 961cb0ef41Sopenharmony_ci <div id="column1" data-id="https" class="interior"> 971cb0ef41Sopenharmony_ci <header class="header"> 981cb0ef41Sopenharmony_ci <div class="header-container"> 991cb0ef41Sopenharmony_ci <h1>Node.js v18.20.1 documentation</h1> 1001cb0ef41Sopenharmony_ci <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 1011cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 1021cb0ef41Sopenharmony_ci <path fill="none" d="M0 0h24v24H0z" /> 1031cb0ef41Sopenharmony_ci <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"/> 1041cb0ef41Sopenharmony_ci <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"/> 1051cb0ef41Sopenharmony_ci </svg> 1061cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 1071cb0ef41Sopenharmony_ci <path d="M0 0h24v24H0z" fill="none" /> 1081cb0ef41Sopenharmony_ci <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"/> 1091cb0ef41Sopenharmony_ci </svg> 1101cb0ef41Sopenharmony_ci </button> 1111cb0ef41Sopenharmony_ci </div> 1121cb0ef41Sopenharmony_ci <div id="gtoc"> 1131cb0ef41Sopenharmony_ci <ul> 1141cb0ef41Sopenharmony_ci <li class="pinned-header">Node.js v18.20.1</li> 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_ci <li class="picker-header"> 1171cb0ef41Sopenharmony_ci <a href="#"> 1181cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1191cb0ef41Sopenharmony_ci Table of contents 1201cb0ef41Sopenharmony_ci </a> 1211cb0ef41Sopenharmony_ci 1221cb0ef41Sopenharmony_ci <div class="picker"><div class="toc"><ul> 1231cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#https">HTTPS</a></span> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#determining-if-crypto-support-is-unavailable">Determining if crypto support is unavailable</a></li> 1261cb0ef41Sopenharmony_ci<li><a href="#class-httpsagent">Class: <code>https.Agent</code></a> 1271cb0ef41Sopenharmony_ci<ul> 1281cb0ef41Sopenharmony_ci<li><a href="#new-agentoptions"><code>new Agent([options])</code></a> 1291cb0ef41Sopenharmony_ci<ul> 1301cb0ef41Sopenharmony_ci<li><a href="#event-keylog">Event: <code>'keylog'</code></a></li> 1311cb0ef41Sopenharmony_ci</ul> 1321cb0ef41Sopenharmony_ci</li> 1331cb0ef41Sopenharmony_ci</ul> 1341cb0ef41Sopenharmony_ci</li> 1351cb0ef41Sopenharmony_ci<li><a href="#class-httpsserver">Class: <code>https.Server</code></a> 1361cb0ef41Sopenharmony_ci<ul> 1371cb0ef41Sopenharmony_ci<li><a href="#serverclosecallback"><code>server.close([callback])</code></a></li> 1381cb0ef41Sopenharmony_ci<li><a href="#servercloseallconnections"><code>server.closeAllConnections()</code></a></li> 1391cb0ef41Sopenharmony_ci<li><a href="#servercloseidleconnections"><code>server.closeIdleConnections()</code></a></li> 1401cb0ef41Sopenharmony_ci<li><a href="#serverheaderstimeout"><code>server.headersTimeout</code></a></li> 1411cb0ef41Sopenharmony_ci<li><a href="#serverlisten"><code>server.listen()</code></a></li> 1421cb0ef41Sopenharmony_ci<li><a href="#servermaxheaderscount"><code>server.maxHeadersCount</code></a></li> 1431cb0ef41Sopenharmony_ci<li><a href="#serverrequesttimeout"><code>server.requestTimeout</code></a></li> 1441cb0ef41Sopenharmony_ci<li><a href="#serversettimeoutmsecs-callback"><code>server.setTimeout([msecs][, callback])</code></a></li> 1451cb0ef41Sopenharmony_ci<li><a href="#servertimeout"><code>server.timeout</code></a></li> 1461cb0ef41Sopenharmony_ci<li><a href="#serverkeepalivetimeout"><code>server.keepAliveTimeout</code></a></li> 1471cb0ef41Sopenharmony_ci</ul> 1481cb0ef41Sopenharmony_ci</li> 1491cb0ef41Sopenharmony_ci<li><a href="#httpscreateserveroptions-requestlistener"><code>https.createServer([options][, requestListener])</code></a></li> 1501cb0ef41Sopenharmony_ci<li><a href="#httpsgetoptions-callback"><code>https.get(options[, callback])</code></a></li> 1511cb0ef41Sopenharmony_ci<li><a href="#httpsgeturl-options-callback"><code>https.get(url[, options][, callback])</code></a></li> 1521cb0ef41Sopenharmony_ci<li><a href="#httpsglobalagent"><code>https.globalAgent</code></a></li> 1531cb0ef41Sopenharmony_ci<li><a href="#httpsrequestoptions-callback"><code>https.request(options[, callback])</code></a></li> 1541cb0ef41Sopenharmony_ci<li><a href="#httpsrequesturl-options-callback"><code>https.request(url[, options][, callback])</code></a></li> 1551cb0ef41Sopenharmony_ci</ul> 1561cb0ef41Sopenharmony_ci</li> 1571cb0ef41Sopenharmony_ci</ul></div></div> 1581cb0ef41Sopenharmony_ci </li> 1591cb0ef41Sopenharmony_ci 1601cb0ef41Sopenharmony_ci 1611cb0ef41Sopenharmony_ci <li class="picker-header"> 1621cb0ef41Sopenharmony_ci <a href="#"> 1631cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1641cb0ef41Sopenharmony_ci Index 1651cb0ef41Sopenharmony_ci </a> 1661cb0ef41Sopenharmony_ci 1671cb0ef41Sopenharmony_ci <div class="picker"><ul> 1681cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1691cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1701cb0ef41Sopenharmony_ci 1711cb0ef41Sopenharmony_ci <li> 1721cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1731cb0ef41Sopenharmony_ci </li> 1741cb0ef41Sopenharmony_ci </ul> 1751cb0ef41Sopenharmony_ci 1761cb0ef41Sopenharmony_ci<hr class="line"> 1771cb0ef41Sopenharmony_ci<ul> 1781cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https active">HTTPS</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 2131cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 2141cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 2151cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 2161cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 2171cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 2181cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 2191cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 2201cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 2211cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 2221cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 2231cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 2241cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 2251cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2261cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2271cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2281cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2291cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2301cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2311cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2321cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2331cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2341cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2351cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2361cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2371cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2381cb0ef41Sopenharmony_ci</ul> 2391cb0ef41Sopenharmony_ci<hr class="line"> 2401cb0ef41Sopenharmony_ci<ul> 2411cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2421cb0ef41Sopenharmony_ci</ul></div> 2431cb0ef41Sopenharmony_ci </li> 2441cb0ef41Sopenharmony_ci 2451cb0ef41Sopenharmony_ci 2461cb0ef41Sopenharmony_ci <li class="picker-header"> 2471cb0ef41Sopenharmony_ci <a href="#"> 2481cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2491cb0ef41Sopenharmony_ci Other versions 2501cb0ef41Sopenharmony_ci </a> 2511cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/https.html">21.x</a></li> 2521cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/https.html">20.x <b>LTS</b></a></li> 2531cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/https.html">19.x</a></li> 2541cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/https.html">18.x <b>LTS</b></a></li> 2551cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/https.html">17.x</a></li> 2561cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/https.html">16.x</a></li> 2571cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/https.html">15.x</a></li> 2581cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/https.html">14.x</a></li> 2591cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/https.html">13.x</a></li> 2601cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/https.html">12.x</a></li> 2611cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v11.x/api/https.html">11.x</a></li> 2621cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v10.x/api/https.html">10.x</a></li> 2631cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v9.x/api/https.html">9.x</a></li> 2641cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v8.x/api/https.html">8.x</a></li> 2651cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v7.x/api/https.html">7.x</a></li> 2661cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v6.x/api/https.html">6.x</a></li> 2671cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v5.x/api/https.html">5.x</a></li> 2681cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v4.x/api/https.html">4.x</a></li> 2691cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/https.html">0.12.x</a></li> 2701cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/https.html">0.10.x</a></li></ol></div> 2711cb0ef41Sopenharmony_ci </li> 2721cb0ef41Sopenharmony_ci 2731cb0ef41Sopenharmony_ci <li class="picker-header"> 2741cb0ef41Sopenharmony_ci <a href="#"> 2751cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2761cb0ef41Sopenharmony_ci Options 2771cb0ef41Sopenharmony_ci </a> 2781cb0ef41Sopenharmony_ci 2791cb0ef41Sopenharmony_ci <div class="picker"> 2801cb0ef41Sopenharmony_ci <ul> 2811cb0ef41Sopenharmony_ci <li> 2821cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2831cb0ef41Sopenharmony_ci </li> 2841cb0ef41Sopenharmony_ci <li> 2851cb0ef41Sopenharmony_ci <a href="https.json">View as JSON</a> 2861cb0ef41Sopenharmony_ci </li> 2871cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/https.md">Edit on GitHub</a></li> 2881cb0ef41Sopenharmony_ci </ul> 2891cb0ef41Sopenharmony_ci </div> 2901cb0ef41Sopenharmony_ci </li> 2911cb0ef41Sopenharmony_ci </ul> 2921cb0ef41Sopenharmony_ci </div> 2931cb0ef41Sopenharmony_ci <hr> 2941cb0ef41Sopenharmony_ci </header> 2951cb0ef41Sopenharmony_ci 2961cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2971cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#https">HTTPS</a></span> 2981cb0ef41Sopenharmony_ci<ul> 2991cb0ef41Sopenharmony_ci<li><a href="#determining-if-crypto-support-is-unavailable">Determining if crypto support is unavailable</a></li> 3001cb0ef41Sopenharmony_ci<li><a href="#class-httpsagent">Class: <code>https.Agent</code></a> 3011cb0ef41Sopenharmony_ci<ul> 3021cb0ef41Sopenharmony_ci<li><a href="#new-agentoptions"><code>new Agent([options])</code></a> 3031cb0ef41Sopenharmony_ci<ul> 3041cb0ef41Sopenharmony_ci<li><a href="#event-keylog">Event: <code>'keylog'</code></a></li> 3051cb0ef41Sopenharmony_ci</ul> 3061cb0ef41Sopenharmony_ci</li> 3071cb0ef41Sopenharmony_ci</ul> 3081cb0ef41Sopenharmony_ci</li> 3091cb0ef41Sopenharmony_ci<li><a href="#class-httpsserver">Class: <code>https.Server</code></a> 3101cb0ef41Sopenharmony_ci<ul> 3111cb0ef41Sopenharmony_ci<li><a href="#serverclosecallback"><code>server.close([callback])</code></a></li> 3121cb0ef41Sopenharmony_ci<li><a href="#servercloseallconnections"><code>server.closeAllConnections()</code></a></li> 3131cb0ef41Sopenharmony_ci<li><a href="#servercloseidleconnections"><code>server.closeIdleConnections()</code></a></li> 3141cb0ef41Sopenharmony_ci<li><a href="#serverheaderstimeout"><code>server.headersTimeout</code></a></li> 3151cb0ef41Sopenharmony_ci<li><a href="#serverlisten"><code>server.listen()</code></a></li> 3161cb0ef41Sopenharmony_ci<li><a href="#servermaxheaderscount"><code>server.maxHeadersCount</code></a></li> 3171cb0ef41Sopenharmony_ci<li><a href="#serverrequesttimeout"><code>server.requestTimeout</code></a></li> 3181cb0ef41Sopenharmony_ci<li><a href="#serversettimeoutmsecs-callback"><code>server.setTimeout([msecs][, callback])</code></a></li> 3191cb0ef41Sopenharmony_ci<li><a href="#servertimeout"><code>server.timeout</code></a></li> 3201cb0ef41Sopenharmony_ci<li><a href="#serverkeepalivetimeout"><code>server.keepAliveTimeout</code></a></li> 3211cb0ef41Sopenharmony_ci</ul> 3221cb0ef41Sopenharmony_ci</li> 3231cb0ef41Sopenharmony_ci<li><a href="#httpscreateserveroptions-requestlistener"><code>https.createServer([options][, requestListener])</code></a></li> 3241cb0ef41Sopenharmony_ci<li><a href="#httpsgetoptions-callback"><code>https.get(options[, callback])</code></a></li> 3251cb0ef41Sopenharmony_ci<li><a href="#httpsgeturl-options-callback"><code>https.get(url[, options][, callback])</code></a></li> 3261cb0ef41Sopenharmony_ci<li><a href="#httpsglobalagent"><code>https.globalAgent</code></a></li> 3271cb0ef41Sopenharmony_ci<li><a href="#httpsrequestoptions-callback"><code>https.request(options[, callback])</code></a></li> 3281cb0ef41Sopenharmony_ci<li><a href="#httpsrequesturl-options-callback"><code>https.request(url[, options][, callback])</code></a></li> 3291cb0ef41Sopenharmony_ci</ul> 3301cb0ef41Sopenharmony_ci</li> 3311cb0ef41Sopenharmony_ci</ul></details> 3321cb0ef41Sopenharmony_ci 3331cb0ef41Sopenharmony_ci <div id="apicontent"> 3341cb0ef41Sopenharmony_ci <h2>HTTPS<span><a class="mark" href="#https" id="https">#</a></span><a aria-hidden="true" class="legacy" id="https_https"></a></h2> 3351cb0ef41Sopenharmony_ci 3361cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 3371cb0ef41Sopenharmony_ci<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/https.js">lib/https.js</a></p> 3381cb0ef41Sopenharmony_ci<p>HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a 3391cb0ef41Sopenharmony_ciseparate module.</p> 3401cb0ef41Sopenharmony_ci<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="https_determining_if_crypto_support_is_unavailable"></a></h3> 3411cb0ef41Sopenharmony_ci<p>It is possible for Node.js to be built without including support for the 3421cb0ef41Sopenharmony_ci<code>node:crypto</code> module. In such cases, attempting to <code>import</code> from <code>https</code> or 3431cb0ef41Sopenharmony_cicalling <code>require('node:https')</code> will result in an error being thrown.</p> 3441cb0ef41Sopenharmony_ci<p>When using CommonJS, the error thrown can be caught using try/catch:</p> 3451cb0ef41Sopenharmony_ci<!-- eslint-skip --> 3461cb0ef41Sopenharmony_ci<pre><code class="language-js cjs"><span class="hljs-keyword">let</span> https; 3471cb0ef41Sopenharmony_ci<span class="hljs-keyword">try</span> { 3481cb0ef41Sopenharmony_ci https = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:https'</span>); 3491cb0ef41Sopenharmony_ci} <span class="hljs-keyword">catch</span> (err) { 3501cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'https support is disabled!'</span>); 3511cb0ef41Sopenharmony_ci}</code> <button class="copy-button">copy</button></pre> 3521cb0ef41Sopenharmony_ci<p>When using the lexical ESM <code>import</code> keyword, the error can only be 3531cb0ef41Sopenharmony_cicaught if a handler for <code>process.on('uncaughtException')</code> is registered 3541cb0ef41Sopenharmony_ci<em>before</em> any attempt to load the module is made (using, for instance, 3551cb0ef41Sopenharmony_cia preload module).</p> 3561cb0ef41Sopenharmony_ci<p>When using ESM, if there is a chance that the code may be run on a build 3571cb0ef41Sopenharmony_ciof Node.js where crypto support is not enabled, consider using the 3581cb0ef41Sopenharmony_ci<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> 3591cb0ef41Sopenharmony_ci<pre><code class="language-js mjs"><span class="hljs-keyword">let</span> https; 3601cb0ef41Sopenharmony_ci<span class="hljs-keyword">try</span> { 3611cb0ef41Sopenharmony_ci https = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:https'</span>); 3621cb0ef41Sopenharmony_ci} <span class="hljs-keyword">catch</span> (err) { 3631cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'https support is disabled!'</span>); 3641cb0ef41Sopenharmony_ci}</code> <button class="copy-button">copy</button></pre> 3651cb0ef41Sopenharmony_ci</section><section><h3>Class: <code>https.Agent</code><span><a class="mark" href="#class-httpsagent" id="class-httpsagent">#</a></span><a aria-hidden="true" class="legacy" id="https_class_https_agent"></a></h3> 3661cb0ef41Sopenharmony_ci<div class="api_metadata"> 3671cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 3681cb0ef41Sopenharmony_ci<table> 3691cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 3701cb0ef41Sopenharmony_ci<tr><td>v5.3.0</td> 3711cb0ef41Sopenharmony_ci<td><p>support <code>0</code> <code>maxCachedSessions</code> to disable TLS session caching.</p></td></tr> 3721cb0ef41Sopenharmony_ci<tr><td>v2.5.0</td> 3731cb0ef41Sopenharmony_ci<td><p>parameter <code>maxCachedSessions</code> added to <code>options</code> for TLS sessions reuse.</p></td></tr> 3741cb0ef41Sopenharmony_ci<tr><td>v0.4.5</td> 3751cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.4.5</span></p></td></tr> 3761cb0ef41Sopenharmony_ci</tbody></table> 3771cb0ef41Sopenharmony_ci</details> 3781cb0ef41Sopenharmony_ci</div> 3791cb0ef41Sopenharmony_ci<p>An <a href="#class-httpsagent"><code>Agent</code></a> object for HTTPS similar to <a href="http.html#class-httpagent"><code>http.Agent</code></a>. See 3801cb0ef41Sopenharmony_ci<a href="#httpsrequestoptions-callback"><code>https.request()</code></a> for more information.</p> 3811cb0ef41Sopenharmony_ci<h4><code>new Agent([options])</code><span><a class="mark" href="#new-agentoptions" id="new-agentoptions">#</a></span><a aria-hidden="true" class="legacy" id="https_new_agent_options"></a></h4> 3821cb0ef41Sopenharmony_ci<div class="api_metadata"> 3831cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 3841cb0ef41Sopenharmony_ci<table> 3851cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 3861cb0ef41Sopenharmony_ci<tr><td>v12.5.0</td> 3871cb0ef41Sopenharmony_ci<td><p>do not automatically set servername if the target host was specified using an IP address.</p></td></tr> 3881cb0ef41Sopenharmony_ci</tbody></table> 3891cb0ef41Sopenharmony_ci</details> 3901cb0ef41Sopenharmony_ci</div> 3911cb0ef41Sopenharmony_ci<ul> 3921cb0ef41Sopenharmony_ci<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> Set of configurable options to set on the agent. 3931cb0ef41Sopenharmony_ciCan have the same fields as for <a href="http.html#new-agentoptions"><code>http.Agent(options)</code></a>, and 3941cb0ef41Sopenharmony_ci<ul> 3951cb0ef41Sopenharmony_ci<li> 3961cb0ef41Sopenharmony_ci<p><code>maxCachedSessions</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> maximum number of TLS cached sessions. 3971cb0ef41Sopenharmony_ciUse <code>0</code> to disable TLS session caching. <strong>Default:</strong> <code>100</code>.</p> 3981cb0ef41Sopenharmony_ci</li> 3991cb0ef41Sopenharmony_ci<li> 4001cb0ef41Sopenharmony_ci<p><code>servername</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> the value of 4011cb0ef41Sopenharmony_ci<a href="https://en.wikipedia.org/wiki/Server_Name_Indication">Server Name Indication extension</a> to be sent to the server. Use 4021cb0ef41Sopenharmony_ciempty string <code>''</code> to disable sending the extension. 4031cb0ef41Sopenharmony_ci<strong>Default:</strong> host name of the target server, unless the target server 4041cb0ef41Sopenharmony_ciis specified using an IP address, in which case the default is <code>''</code> (no 4051cb0ef41Sopenharmony_ciextension).</p> 4061cb0ef41Sopenharmony_ci<p>See <a href="tls.html#session-resumption"><code>Session Resumption</code></a> for information about TLS session reuse.</p> 4071cb0ef41Sopenharmony_ci</li> 4081cb0ef41Sopenharmony_ci</ul> 4091cb0ef41Sopenharmony_ci</li> 4101cb0ef41Sopenharmony_ci</ul> 4111cb0ef41Sopenharmony_ci<h5>Event: <code>'keylog'</code><span><a class="mark" href="#event-keylog" id="event-keylog">#</a></span><a aria-hidden="true" class="legacy" id="https_event_keylog"></a></h5> 4121cb0ef41Sopenharmony_ci<div class="api_metadata"> 4131cb0ef41Sopenharmony_ci<span>Added in: v13.2.0, v12.16.0</span> 4141cb0ef41Sopenharmony_ci</div> 4151cb0ef41Sopenharmony_ci<ul> 4161cb0ef41Sopenharmony_ci<li><code>line</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a> Line of ASCII text, in NSS <code>SSLKEYLOGFILE</code> format.</li> 4171cb0ef41Sopenharmony_ci<li><code>tlsSocket</code> <a href="tls.html#class-tlstlssocket" class="type"><tls.TLSSocket></a> The <code>tls.TLSSocket</code> instance on which it was 4181cb0ef41Sopenharmony_cigenerated.</li> 4191cb0ef41Sopenharmony_ci</ul> 4201cb0ef41Sopenharmony_ci<p>The <code>keylog</code> event is emitted when key material is generated or received by a 4211cb0ef41Sopenharmony_ciconnection managed by this agent (typically before handshake has completed, but 4221cb0ef41Sopenharmony_cinot necessarily). This keying material can be stored for debugging, as it 4231cb0ef41Sopenharmony_ciallows captured TLS traffic to be decrypted. It may be emitted multiple times 4241cb0ef41Sopenharmony_cifor each socket.</p> 4251cb0ef41Sopenharmony_ci<p>A typical use case is to append received lines to a common text file, which is 4261cb0ef41Sopenharmony_cilater used by software (such as Wireshark) to decrypt the traffic:</p> 4271cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-comment">// ...</span> 4281cb0ef41Sopenharmony_cihttps.<span class="hljs-property">globalAgent</span>.<span class="hljs-title function_">on</span>(<span class="hljs-string">'keylog'</span>, <span class="hljs-function">(<span class="hljs-params">line, tlsSocket</span>) =></span> { 4291cb0ef41Sopenharmony_ci fs.<span class="hljs-title function_">appendFileSync</span>(<span class="hljs-string">'/tmp/ssl-keys.log'</span>, line, { <span class="hljs-attr">mode</span>: <span class="hljs-number">0o600</span> }); 4301cb0ef41Sopenharmony_ci});</code> <button class="copy-button">copy</button></pre> 4311cb0ef41Sopenharmony_ci</section><section><h3>Class: <code>https.Server</code><span><a class="mark" href="#class-httpsserver" id="class-httpsserver">#</a></span><a aria-hidden="true" class="legacy" id="https_class_https_server"></a></h3> 4321cb0ef41Sopenharmony_ci<div class="api_metadata"> 4331cb0ef41Sopenharmony_ci<span>Added in: v0.3.4</span> 4341cb0ef41Sopenharmony_ci</div> 4351cb0ef41Sopenharmony_ci<ul> 4361cb0ef41Sopenharmony_ci<li>Extends: <a href="tls.html#class-tlsserver" class="type"><tls.Server></a></li> 4371cb0ef41Sopenharmony_ci</ul> 4381cb0ef41Sopenharmony_ci<p>See <a href="http.html#class-httpserver"><code>http.Server</code></a> for more information.</p> 4391cb0ef41Sopenharmony_ci<h4><code>server.close([callback])</code><span><a class="mark" href="#serverclosecallback" id="serverclosecallback">#</a></span><a aria-hidden="true" class="legacy" id="https_server_close_callback"></a></h4> 4401cb0ef41Sopenharmony_ci<div class="api_metadata"> 4411cb0ef41Sopenharmony_ci<span>Added in: v0.1.90</span> 4421cb0ef41Sopenharmony_ci</div> 4431cb0ef41Sopenharmony_ci<ul> 4441cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 4451cb0ef41Sopenharmony_ci<li>Returns: <a href="https.html#class-httpsserver" class="type"><https.Server></a></li> 4461cb0ef41Sopenharmony_ci</ul> 4471cb0ef41Sopenharmony_ci<p>See <a href="http.html#serverclosecallback"><code>server.close()</code></a> in the <code>node:http</code> module.</p> 4481cb0ef41Sopenharmony_ci<h4><code>server.closeAllConnections()</code><span><a class="mark" href="#servercloseallconnections" id="servercloseallconnections">#</a></span><a aria-hidden="true" class="legacy" id="https_server_closeallconnections"></a></h4> 4491cb0ef41Sopenharmony_ci<div class="api_metadata"> 4501cb0ef41Sopenharmony_ci<span>Added in: v18.2.0</span> 4511cb0ef41Sopenharmony_ci</div> 4521cb0ef41Sopenharmony_ci<p>See <a href="http.html#servercloseallconnections"><code>server.closeAllConnections()</code></a> in the <code>node:http</code> module.</p> 4531cb0ef41Sopenharmony_ci<h4><code>server.closeIdleConnections()</code><span><a class="mark" href="#servercloseidleconnections" id="servercloseidleconnections">#</a></span><a aria-hidden="true" class="legacy" id="https_server_closeidleconnections"></a></h4> 4541cb0ef41Sopenharmony_ci<div class="api_metadata"> 4551cb0ef41Sopenharmony_ci<span>Added in: v18.2.0</span> 4561cb0ef41Sopenharmony_ci</div> 4571cb0ef41Sopenharmony_ci<p>See <a href="http.html#servercloseidleconnections"><code>server.closeIdleConnections()</code></a> in the <code>node:http</code> module.</p> 4581cb0ef41Sopenharmony_ci<h4><code>server.headersTimeout</code><span><a class="mark" href="#serverheaderstimeout" id="serverheaderstimeout">#</a></span><a aria-hidden="true" class="legacy" id="https_server_headerstimeout"></a></h4> 4591cb0ef41Sopenharmony_ci<div class="api_metadata"> 4601cb0ef41Sopenharmony_ci<span>Added in: v11.3.0</span> 4611cb0ef41Sopenharmony_ci</div> 4621cb0ef41Sopenharmony_ci<ul> 4631cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>60000</code></li> 4641cb0ef41Sopenharmony_ci</ul> 4651cb0ef41Sopenharmony_ci<p>See <a href="http.html#serverheaderstimeout"><code>server.headersTimeout</code></a> in the <code>node:http</code> module.</p> 4661cb0ef41Sopenharmony_ci<h4><code>server.listen()</code><span><a class="mark" href="#serverlisten" id="serverlisten">#</a></span><a aria-hidden="true" class="legacy" id="https_server_listen"></a></h4> 4671cb0ef41Sopenharmony_ci<p>Starts the HTTPS server listening for encrypted connections. 4681cb0ef41Sopenharmony_ciThis method is identical to <a href="net.html#serverlisten"><code>server.listen()</code></a> from <a href="net.html#class-netserver"><code>net.Server</code></a>.</p> 4691cb0ef41Sopenharmony_ci<h4><code>server.maxHeadersCount</code><span><a class="mark" href="#servermaxheaderscount" id="servermaxheaderscount">#</a></span><a aria-hidden="true" class="legacy" id="https_server_maxheaderscount"></a></h4> 4701cb0ef41Sopenharmony_ci<ul> 4711cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>2000</code></li> 4721cb0ef41Sopenharmony_ci</ul> 4731cb0ef41Sopenharmony_ci<p>See <a href="http.html#servermaxheaderscount"><code>server.maxHeadersCount</code></a> in the <code>node:http</code> module.</p> 4741cb0ef41Sopenharmony_ci<h4><code>server.requestTimeout</code><span><a class="mark" href="#serverrequesttimeout" id="serverrequesttimeout">#</a></span><a aria-hidden="true" class="legacy" id="https_server_requesttimeout"></a></h4> 4751cb0ef41Sopenharmony_ci<div class="api_metadata"> 4761cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 4771cb0ef41Sopenharmony_ci<table> 4781cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 4791cb0ef41Sopenharmony_ci<tr><td>v18.0.0</td> 4801cb0ef41Sopenharmony_ci<td><p>The default request timeout changed from no timeout to 300s (5 minutes).</p></td></tr> 4811cb0ef41Sopenharmony_ci<tr><td>v14.11.0</td> 4821cb0ef41Sopenharmony_ci<td><p><span>Added in: v14.11.0</span></p></td></tr> 4831cb0ef41Sopenharmony_ci</tbody></table> 4841cb0ef41Sopenharmony_ci</details> 4851cb0ef41Sopenharmony_ci</div> 4861cb0ef41Sopenharmony_ci<ul> 4871cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>300000</code></li> 4881cb0ef41Sopenharmony_ci</ul> 4891cb0ef41Sopenharmony_ci<p>See <a href="http.html#serverrequesttimeout"><code>server.requestTimeout</code></a> in the <code>node:http</code> module.</p> 4901cb0ef41Sopenharmony_ci<h4><code>server.setTimeout([msecs][, callback])</code><span><a class="mark" href="#serversettimeoutmsecs-callback" id="serversettimeoutmsecs-callback">#</a></span><a aria-hidden="true" class="legacy" id="https_server_settimeout_msecs_callback"></a></h4> 4911cb0ef41Sopenharmony_ci<div class="api_metadata"> 4921cb0ef41Sopenharmony_ci<span>Added in: v0.11.2</span> 4931cb0ef41Sopenharmony_ci</div> 4941cb0ef41Sopenharmony_ci<ul> 4951cb0ef41Sopenharmony_ci<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>120000</code> (2 minutes)</li> 4961cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 4971cb0ef41Sopenharmony_ci<li>Returns: <a href="https.html#class-httpsserver" class="type"><https.Server></a></li> 4981cb0ef41Sopenharmony_ci</ul> 4991cb0ef41Sopenharmony_ci<p>See <a href="http.html#serversettimeoutmsecs-callback"><code>server.setTimeout()</code></a> in the <code>node:http</code> module.</p> 5001cb0ef41Sopenharmony_ci<h4><code>server.timeout</code><span><a class="mark" href="#servertimeout" id="servertimeout">#</a></span><a aria-hidden="true" class="legacy" id="https_server_timeout"></a></h4> 5011cb0ef41Sopenharmony_ci<div class="api_metadata"> 5021cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 5031cb0ef41Sopenharmony_ci<table> 5041cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 5051cb0ef41Sopenharmony_ci<tr><td>v13.0.0</td> 5061cb0ef41Sopenharmony_ci<td><p>The default timeout changed from 120s to 0 (no timeout).</p></td></tr> 5071cb0ef41Sopenharmony_ci<tr><td>v0.11.2</td> 5081cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.11.2</span></p></td></tr> 5091cb0ef41Sopenharmony_ci</tbody></table> 5101cb0ef41Sopenharmony_ci</details> 5111cb0ef41Sopenharmony_ci</div> 5121cb0ef41Sopenharmony_ci<ul> 5131cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> 0 (no timeout)</li> 5141cb0ef41Sopenharmony_ci</ul> 5151cb0ef41Sopenharmony_ci<p>See <a href="http.html#servertimeout"><code>server.timeout</code></a> in the <code>node:http</code> module.</p> 5161cb0ef41Sopenharmony_ci<h4><code>server.keepAliveTimeout</code><span><a class="mark" href="#serverkeepalivetimeout" id="serverkeepalivetimeout">#</a></span><a aria-hidden="true" class="legacy" id="https_server_keepalivetimeout"></a></h4> 5171cb0ef41Sopenharmony_ci<div class="api_metadata"> 5181cb0ef41Sopenharmony_ci<span>Added in: v8.0.0</span> 5191cb0ef41Sopenharmony_ci</div> 5201cb0ef41Sopenharmony_ci<ul> 5211cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>5000</code> (5 seconds)</li> 5221cb0ef41Sopenharmony_ci</ul> 5231cb0ef41Sopenharmony_ci<p>See <a href="http.html#serverkeepalivetimeout"><code>server.keepAliveTimeout</code></a> in the <code>node:http</code> module.</p> 5241cb0ef41Sopenharmony_ci</section><section><h3><code>https.createServer([options][, requestListener])</code><span><a class="mark" href="#httpscreateserveroptions-requestlistener" id="httpscreateserveroptions-requestlistener">#</a></span><a aria-hidden="true" class="legacy" id="https_https_createserver_options_requestlistener"></a></h3> 5251cb0ef41Sopenharmony_ci<div class="api_metadata"> 5261cb0ef41Sopenharmony_ci<span>Added in: v0.3.4</span> 5271cb0ef41Sopenharmony_ci</div> 5281cb0ef41Sopenharmony_ci<ul> 5291cb0ef41Sopenharmony_ci<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> Accepts <code>options</code> from <a href="tls.html#tlscreateserveroptions-secureconnectionlistener"><code>tls.createServer()</code></a>, 5301cb0ef41Sopenharmony_ci<a href="tls.html#tlscreatesecurecontextoptions"><code>tls.createSecureContext()</code></a> and <a href="http.html#httpcreateserveroptions-requestlistener"><code>http.createServer()</code></a>.</li> 5311cb0ef41Sopenharmony_ci<li><code>requestListener</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> A listener to be added to the <code>'request'</code> event.</li> 5321cb0ef41Sopenharmony_ci<li>Returns: <a href="https.html#class-httpsserver" class="type"><https.Server></a></li> 5331cb0ef41Sopenharmony_ci</ul> 5341cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-comment">// curl -k https://localhost:8000/</span> 5351cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> https = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:https'</span>); 5361cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 5371cb0ef41Sopenharmony_ci 5381cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> options = { 5391cb0ef41Sopenharmony_ci <span class="hljs-attr">key</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'test/fixtures/keys/agent2-key.pem'</span>), 5401cb0ef41Sopenharmony_ci <span class="hljs-attr">cert</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'test/fixtures/keys/agent2-cert.pem'</span>), 5411cb0ef41Sopenharmony_ci}; 5421cb0ef41Sopenharmony_ci 5431cb0ef41Sopenharmony_cihttps.<span class="hljs-title function_">createServer</span>(options, <span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 5441cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>); 5451cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'hello world\n'</span>); 5461cb0ef41Sopenharmony_ci}).<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code> <button class="copy-button">copy</button></pre> 5471cb0ef41Sopenharmony_ci<p>Or</p> 5481cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> https = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:https'</span>); 5491cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 5501cb0ef41Sopenharmony_ci 5511cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> options = { 5521cb0ef41Sopenharmony_ci <span class="hljs-attr">pfx</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'test/fixtures/test_cert.pfx'</span>), 5531cb0ef41Sopenharmony_ci <span class="hljs-attr">passphrase</span>: <span class="hljs-string">'sample'</span>, 5541cb0ef41Sopenharmony_ci}; 5551cb0ef41Sopenharmony_ci 5561cb0ef41Sopenharmony_cihttps.<span class="hljs-title function_">createServer</span>(options, <span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 5571cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>); 5581cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'hello world\n'</span>); 5591cb0ef41Sopenharmony_ci}).<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code> <button class="copy-button">copy</button></pre> 5601cb0ef41Sopenharmony_ci</section><section><h3><code>https.get(options[, callback])</code><span><a class="mark" href="#httpsgetoptions-callback" id="httpsgetoptions-callback">#</a></span><a aria-hidden="true" class="legacy" id="https_https_get_options_callback"></a></h3> 5611cb0ef41Sopenharmony_ci</section><section><h3><code>https.get(url[, options][, callback])</code><span><a class="mark" href="#httpsgeturl-options-callback" id="httpsgeturl-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="https_https_get_url_options_callback"></a></h3> 5621cb0ef41Sopenharmony_ci<div class="api_metadata"> 5631cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 5641cb0ef41Sopenharmony_ci<table> 5651cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 5661cb0ef41Sopenharmony_ci<tr><td>v10.9.0</td> 5671cb0ef41Sopenharmony_ci<td><p>The <code>url</code> parameter can now be passed along with a separate <code>options</code> object.</p></td></tr> 5681cb0ef41Sopenharmony_ci<tr><td>v7.5.0</td> 5691cb0ef41Sopenharmony_ci<td><p>The <code>options</code> parameter can be a WHATWG <code>URL</code> object.</p></td></tr> 5701cb0ef41Sopenharmony_ci<tr><td>v0.3.6</td> 5711cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.3.6</span></p></td></tr> 5721cb0ef41Sopenharmony_ci</tbody></table> 5731cb0ef41Sopenharmony_ci</details> 5741cb0ef41Sopenharmony_ci</div> 5751cb0ef41Sopenharmony_ci<ul> 5761cb0ef41Sopenharmony_ci<li><code>url</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a></li> 5771cb0ef41Sopenharmony_ci<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="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a> Accepts the same <code>options</code> as 5781cb0ef41Sopenharmony_ci<a href="#httpsrequestoptions-callback"><code>https.request()</code></a>, with the method set to GET by default.</li> 5791cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 5801cb0ef41Sopenharmony_ci</ul> 5811cb0ef41Sopenharmony_ci<p>Like <a href="http.html#httpgetoptions-callback"><code>http.get()</code></a> but for HTTPS.</p> 5821cb0ef41Sopenharmony_ci<p><code>options</code> can be an object, a string, or a <a href="url.html#the-whatwg-url-api"><code>URL</code></a> object. If <code>options</code> is a 5831cb0ef41Sopenharmony_cistring, it is automatically parsed with <a href="url.html#new-urlinput-base"><code>new URL()</code></a>. If it is a <a href="url.html#the-whatwg-url-api"><code>URL</code></a> 5841cb0ef41Sopenharmony_ciobject, it will be automatically converted to an ordinary <code>options</code> object.</p> 5851cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> https = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:https'</span>); 5861cb0ef41Sopenharmony_ci 5871cb0ef41Sopenharmony_cihttps.<span class="hljs-title function_">get</span>(<span class="hljs-string">'https://encrypted.google.com/'</span>, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 5881cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'statusCode:'</span>, res.<span class="hljs-property">statusCode</span>); 5891cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'headers:'</span>, res.<span class="hljs-property">headers</span>); 5901cb0ef41Sopenharmony_ci 5911cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">d</span>) =></span> { 5921cb0ef41Sopenharmony_ci process.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">write</span>(d); 5931cb0ef41Sopenharmony_ci }); 5941cb0ef41Sopenharmony_ci 5951cb0ef41Sopenharmony_ci}).<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">e</span>) =></span> { 5961cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(e); 5971cb0ef41Sopenharmony_ci});</code> <button class="copy-button">copy</button></pre> 5981cb0ef41Sopenharmony_ci</section><section><h3><code>https.globalAgent</code><span><a class="mark" href="#httpsglobalagent" id="httpsglobalagent">#</a></span><a aria-hidden="true" class="legacy" id="https_https_globalagent"></a></h3> 5991cb0ef41Sopenharmony_ci<div class="api_metadata"> 6001cb0ef41Sopenharmony_ci<span>Added in: v0.5.9</span> 6011cb0ef41Sopenharmony_ci</div> 6021cb0ef41Sopenharmony_ci<p>Global instance of <a href="#class-httpsagent"><code>https.Agent</code></a> for all HTTPS client requests.</p> 6031cb0ef41Sopenharmony_ci</section><section><h3><code>https.request(options[, callback])</code><span><a class="mark" href="#httpsrequestoptions-callback" id="httpsrequestoptions-callback">#</a></span><a aria-hidden="true" class="legacy" id="https_https_request_options_callback"></a></h3> 6041cb0ef41Sopenharmony_ci</section><section><h3><code>https.request(url[, options][, callback])</code><span><a class="mark" href="#httpsrequesturl-options-callback" id="httpsrequesturl-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="https_https_request_url_options_callback"></a></h3> 6051cb0ef41Sopenharmony_ci<div class="api_metadata"> 6061cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 6071cb0ef41Sopenharmony_ci<table> 6081cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 6091cb0ef41Sopenharmony_ci<tr><td>v16.7.0, v14.18.0</td> 6101cb0ef41Sopenharmony_ci<td><p>When using a <code>URL</code> object parsed username and password will now be properly URI decoded.</p></td></tr> 6111cb0ef41Sopenharmony_ci<tr><td>v14.1.0, v13.14.0</td> 6121cb0ef41Sopenharmony_ci<td><p>The <code>highWaterMark</code> option is accepted now.</p></td></tr> 6131cb0ef41Sopenharmony_ci<tr><td>v10.9.0</td> 6141cb0ef41Sopenharmony_ci<td><p>The <code>url</code> parameter can now be passed along with a separate <code>options</code> object.</p></td></tr> 6151cb0ef41Sopenharmony_ci<tr><td>v9.3.0</td> 6161cb0ef41Sopenharmony_ci<td><p>The <code>options</code> parameter can now include <code>clientCertEngine</code>.</p></td></tr> 6171cb0ef41Sopenharmony_ci<tr><td>v7.5.0</td> 6181cb0ef41Sopenharmony_ci<td><p>The <code>options</code> parameter can be a WHATWG <code>URL</code> object.</p></td></tr> 6191cb0ef41Sopenharmony_ci<tr><td>v0.3.6</td> 6201cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.3.6</span></p></td></tr> 6211cb0ef41Sopenharmony_ci</tbody></table> 6221cb0ef41Sopenharmony_ci</details> 6231cb0ef41Sopenharmony_ci</div> 6241cb0ef41Sopenharmony_ci<ul> 6251cb0ef41Sopenharmony_ci<li><code>url</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a></li> 6261cb0ef41Sopenharmony_ci<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="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a> Accepts all <code>options</code> from 6271cb0ef41Sopenharmony_ci<a href="http.html#httprequestoptions-callback"><code>http.request()</code></a>, with some differences in default values: 6281cb0ef41Sopenharmony_ci<ul> 6291cb0ef41Sopenharmony_ci<li><code>protocol</code> <strong>Default:</strong> <code>'https:'</code></li> 6301cb0ef41Sopenharmony_ci<li><code>port</code> <strong>Default:</strong> <code>443</code></li> 6311cb0ef41Sopenharmony_ci<li><code>agent</code> <strong>Default:</strong> <code>https.globalAgent</code></li> 6321cb0ef41Sopenharmony_ci</ul> 6331cb0ef41Sopenharmony_ci</li> 6341cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 6351cb0ef41Sopenharmony_ci<li>Returns: <a href="http.html#class-httpclientrequest" class="type"><http.ClientRequest></a></li> 6361cb0ef41Sopenharmony_ci</ul> 6371cb0ef41Sopenharmony_ci<p>Makes a request to a secure web server.</p> 6381cb0ef41Sopenharmony_ci<p>The following additional <code>options</code> from <a href="tls.html#tlsconnectoptions-callback"><code>tls.connect()</code></a> are also accepted: 6391cb0ef41Sopenharmony_ci<code>ca</code>, <code>cert</code>, <code>ciphers</code>, <code>clientCertEngine</code>, <code>crl</code>, <code>dhparam</code>, <code>ecdhCurve</code>, 6401cb0ef41Sopenharmony_ci<code>honorCipherOrder</code>, <code>key</code>, <code>passphrase</code>, <code>pfx</code>, <code>rejectUnauthorized</code>, 6411cb0ef41Sopenharmony_ci<code>secureOptions</code>, <code>secureProtocol</code>, <code>servername</code>, <code>sessionIdContext</code>, 6421cb0ef41Sopenharmony_ci<code>highWaterMark</code>.</p> 6431cb0ef41Sopenharmony_ci<p><code>options</code> can be an object, a string, or a <a href="url.html#the-whatwg-url-api"><code>URL</code></a> object. If <code>options</code> is a 6441cb0ef41Sopenharmony_cistring, it is automatically parsed with <a href="url.html#new-urlinput-base"><code>new URL()</code></a>. If it is a <a href="url.html#the-whatwg-url-api"><code>URL</code></a> 6451cb0ef41Sopenharmony_ciobject, it will be automatically converted to an ordinary <code>options</code> object.</p> 6461cb0ef41Sopenharmony_ci<p><code>https.request()</code> returns an instance of the <a href="http.html#class-httpclientrequest"><code>http.ClientRequest</code></a> 6471cb0ef41Sopenharmony_ciclass. The <code>ClientRequest</code> instance is a writable stream. If one needs to 6481cb0ef41Sopenharmony_ciupload a file with a POST request, then write to the <code>ClientRequest</code> object.</p> 6491cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> https = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:https'</span>); 6501cb0ef41Sopenharmony_ci 6511cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> options = { 6521cb0ef41Sopenharmony_ci <span class="hljs-attr">hostname</span>: <span class="hljs-string">'encrypted.google.com'</span>, 6531cb0ef41Sopenharmony_ci <span class="hljs-attr">port</span>: <span class="hljs-number">443</span>, 6541cb0ef41Sopenharmony_ci <span class="hljs-attr">path</span>: <span class="hljs-string">'/'</span>, 6551cb0ef41Sopenharmony_ci <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, 6561cb0ef41Sopenharmony_ci}; 6571cb0ef41Sopenharmony_ci 6581cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> req = https.<span class="hljs-title function_">request</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 6591cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'statusCode:'</span>, res.<span class="hljs-property">statusCode</span>); 6601cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'headers:'</span>, res.<span class="hljs-property">headers</span>); 6611cb0ef41Sopenharmony_ci 6621cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">d</span>) =></span> { 6631cb0ef41Sopenharmony_ci process.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">write</span>(d); 6641cb0ef41Sopenharmony_ci }); 6651cb0ef41Sopenharmony_ci}); 6661cb0ef41Sopenharmony_ci 6671cb0ef41Sopenharmony_cireq.<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">e</span>) =></span> { 6681cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(e); 6691cb0ef41Sopenharmony_ci}); 6701cb0ef41Sopenharmony_cireq.<span class="hljs-title function_">end</span>();</code> <button class="copy-button">copy</button></pre> 6711cb0ef41Sopenharmony_ci<p>Example using options from <a href="tls.html#tlsconnectoptions-callback"><code>tls.connect()</code></a>:</p> 6721cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> options = { 6731cb0ef41Sopenharmony_ci <span class="hljs-attr">hostname</span>: <span class="hljs-string">'encrypted.google.com'</span>, 6741cb0ef41Sopenharmony_ci <span class="hljs-attr">port</span>: <span class="hljs-number">443</span>, 6751cb0ef41Sopenharmony_ci <span class="hljs-attr">path</span>: <span class="hljs-string">'/'</span>, 6761cb0ef41Sopenharmony_ci <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, 6771cb0ef41Sopenharmony_ci <span class="hljs-attr">key</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'test/fixtures/keys/agent2-key.pem'</span>), 6781cb0ef41Sopenharmony_ci <span class="hljs-attr">cert</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'test/fixtures/keys/agent2-cert.pem'</span>), 6791cb0ef41Sopenharmony_ci}; 6801cb0ef41Sopenharmony_cioptions.<span class="hljs-property">agent</span> = <span class="hljs-keyword">new</span> https.<span class="hljs-title class_">Agent</span>(options); 6811cb0ef41Sopenharmony_ci 6821cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> req = https.<span class="hljs-title function_">request</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 6831cb0ef41Sopenharmony_ci <span class="hljs-comment">// ...</span> 6841cb0ef41Sopenharmony_ci});</code> <button class="copy-button">copy</button></pre> 6851cb0ef41Sopenharmony_ci<p>Alternatively, opt out of connection pooling by not using an <a href="#class-httpsagent"><code>Agent</code></a>.</p> 6861cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> options = { 6871cb0ef41Sopenharmony_ci <span class="hljs-attr">hostname</span>: <span class="hljs-string">'encrypted.google.com'</span>, 6881cb0ef41Sopenharmony_ci <span class="hljs-attr">port</span>: <span class="hljs-number">443</span>, 6891cb0ef41Sopenharmony_ci <span class="hljs-attr">path</span>: <span class="hljs-string">'/'</span>, 6901cb0ef41Sopenharmony_ci <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, 6911cb0ef41Sopenharmony_ci <span class="hljs-attr">key</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'test/fixtures/keys/agent2-key.pem'</span>), 6921cb0ef41Sopenharmony_ci <span class="hljs-attr">cert</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'test/fixtures/keys/agent2-cert.pem'</span>), 6931cb0ef41Sopenharmony_ci <span class="hljs-attr">agent</span>: <span class="hljs-literal">false</span>, 6941cb0ef41Sopenharmony_ci}; 6951cb0ef41Sopenharmony_ci 6961cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> req = https.<span class="hljs-title function_">request</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 6971cb0ef41Sopenharmony_ci <span class="hljs-comment">// ...</span> 6981cb0ef41Sopenharmony_ci});</code> <button class="copy-button">copy</button></pre> 6991cb0ef41Sopenharmony_ci<p>Example using a <a href="url.html#the-whatwg-url-api"><code>URL</code></a> as <code>options</code>:</p> 7001cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> options = <span class="hljs-keyword">new</span> <span class="hljs-title function_">URL</span>(<span class="hljs-string">'https://abc:xyz@example.com'</span>); 7011cb0ef41Sopenharmony_ci 7021cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> req = https.<span class="hljs-title function_">request</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 7031cb0ef41Sopenharmony_ci <span class="hljs-comment">// ...</span> 7041cb0ef41Sopenharmony_ci});</code> <button class="copy-button">copy</button></pre> 7051cb0ef41Sopenharmony_ci<p>Example pinning on certificate fingerprint, or the public key (similar to 7061cb0ef41Sopenharmony_ci<code>pin-sha256</code>):</p> 7071cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> tls = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:tls'</span>); 7081cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> https = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:https'</span>); 7091cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> crypto = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:crypto'</span>); 7101cb0ef41Sopenharmony_ci 7111cb0ef41Sopenharmony_ci<span class="hljs-keyword">function</span> <span class="hljs-title function_">sha256</span>(<span class="hljs-params">s</span>) { 7121cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> crypto.<span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>).<span class="hljs-title function_">update</span>(s).<span class="hljs-title function_">digest</span>(<span class="hljs-string">'base64'</span>); 7131cb0ef41Sopenharmony_ci} 7141cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> options = { 7151cb0ef41Sopenharmony_ci <span class="hljs-attr">hostname</span>: <span class="hljs-string">'github.com'</span>, 7161cb0ef41Sopenharmony_ci <span class="hljs-attr">port</span>: <span class="hljs-number">443</span>, 7171cb0ef41Sopenharmony_ci <span class="hljs-attr">path</span>: <span class="hljs-string">'/'</span>, 7181cb0ef41Sopenharmony_ci <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, 7191cb0ef41Sopenharmony_ci <span class="hljs-attr">checkServerIdentity</span>: <span class="hljs-keyword">function</span>(<span class="hljs-params">host, cert</span>) { 7201cb0ef41Sopenharmony_ci <span class="hljs-comment">// Make sure the certificate is issued to the host we are connected to</span> 7211cb0ef41Sopenharmony_ci <span class="hljs-keyword">const</span> err = tls.<span class="hljs-title function_">checkServerIdentity</span>(host, cert); 7221cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (err) { 7231cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> err; 7241cb0ef41Sopenharmony_ci } 7251cb0ef41Sopenharmony_ci 7261cb0ef41Sopenharmony_ci <span class="hljs-comment">// Pin the public key, similar to HPKP pin-sha256 pinning</span> 7271cb0ef41Sopenharmony_ci <span class="hljs-keyword">const</span> pubkey256 = <span class="hljs-string">'pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU='</span>; 7281cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (<span class="hljs-title function_">sha256</span>(cert.<span class="hljs-property">pubkey</span>) !== pubkey256) { 7291cb0ef41Sopenharmony_ci <span class="hljs-keyword">const</span> msg = <span class="hljs-string">'Certificate verification error: '</span> + 7301cb0ef41Sopenharmony_ci <span class="hljs-string">`The public key of '<span class="hljs-subst">${cert.subject.CN}</span>' `</span> + 7311cb0ef41Sopenharmony_ci <span class="hljs-string">'does not match our pinned fingerprint'</span>; 7321cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(msg); 7331cb0ef41Sopenharmony_ci } 7341cb0ef41Sopenharmony_ci 7351cb0ef41Sopenharmony_ci <span class="hljs-comment">// Pin the exact certificate, rather than the pub key</span> 7361cb0ef41Sopenharmony_ci <span class="hljs-keyword">const</span> cert256 = <span class="hljs-string">'25:FE:39:32:D9:63:8C:8A:FC:A1:9A:29:87:'</span> + 7371cb0ef41Sopenharmony_ci <span class="hljs-string">'D8:3E:4C:1D:98:DB:71:E4:1A:48:03:98:EA:22:6A:BD:8B:93:16'</span>; 7381cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (cert.<span class="hljs-property">fingerprint256</span> !== cert256) { 7391cb0ef41Sopenharmony_ci <span class="hljs-keyword">const</span> msg = <span class="hljs-string">'Certificate verification error: '</span> + 7401cb0ef41Sopenharmony_ci <span class="hljs-string">`The certificate of '<span class="hljs-subst">${cert.subject.CN}</span>' `</span> + 7411cb0ef41Sopenharmony_ci <span class="hljs-string">'does not match our pinned fingerprint'</span>; 7421cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(msg); 7431cb0ef41Sopenharmony_ci } 7441cb0ef41Sopenharmony_ci 7451cb0ef41Sopenharmony_ci <span class="hljs-comment">// This loop is informational only.</span> 7461cb0ef41Sopenharmony_ci <span class="hljs-comment">// Print the certificate and public key fingerprints of all certs in the</span> 7471cb0ef41Sopenharmony_ci <span class="hljs-comment">// chain. Its common to pin the public key of the issuer on the public</span> 7481cb0ef41Sopenharmony_ci <span class="hljs-comment">// internet, while pinning the public key of the service in sensitive</span> 7491cb0ef41Sopenharmony_ci <span class="hljs-comment">// environments.</span> 7501cb0ef41Sopenharmony_ci <span class="hljs-keyword">do</span> { 7511cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Subject Common Name:'</span>, cert.<span class="hljs-property">subject</span>.<span class="hljs-property">CN</span>); 7521cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">' Certificate SHA256 fingerprint:'</span>, cert.<span class="hljs-property">fingerprint256</span>); 7531cb0ef41Sopenharmony_ci 7541cb0ef41Sopenharmony_ci hash = crypto.<span class="hljs-title function_">createHash</span>(<span class="hljs-string">'sha256'</span>); 7551cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">' Public key ping-sha256:'</span>, <span class="hljs-title function_">sha256</span>(cert.<span class="hljs-property">pubkey</span>)); 7561cb0ef41Sopenharmony_ci 7571cb0ef41Sopenharmony_ci lastprint256 = cert.<span class="hljs-property">fingerprint256</span>; 7581cb0ef41Sopenharmony_ci cert = cert.<span class="hljs-property">issuerCertificate</span>; 7591cb0ef41Sopenharmony_ci } <span class="hljs-keyword">while</span> (cert.<span class="hljs-property">fingerprint256</span> !== lastprint256); 7601cb0ef41Sopenharmony_ci 7611cb0ef41Sopenharmony_ci }, 7621cb0ef41Sopenharmony_ci}; 7631cb0ef41Sopenharmony_ci 7641cb0ef41Sopenharmony_cioptions.<span class="hljs-property">agent</span> = <span class="hljs-keyword">new</span> https.<span class="hljs-title class_">Agent</span>(options); 7651cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> req = https.<span class="hljs-title function_">request</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 7661cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'All OK. Server matched our pinned cert or public key'</span>); 7671cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'statusCode:'</span>, res.<span class="hljs-property">statusCode</span>); 7681cb0ef41Sopenharmony_ci <span class="hljs-comment">// Print the HPKP values</span> 7691cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'headers:'</span>, res.<span class="hljs-property">headers</span>[<span class="hljs-string">'public-key-pins'</span>]); 7701cb0ef41Sopenharmony_ci 7711cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">d</span>) =></span> {}); 7721cb0ef41Sopenharmony_ci}); 7731cb0ef41Sopenharmony_ci 7741cb0ef41Sopenharmony_cireq.<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">e</span>) =></span> { 7751cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(e.<span class="hljs-property">message</span>); 7761cb0ef41Sopenharmony_ci}); 7771cb0ef41Sopenharmony_cireq.<span class="hljs-title function_">end</span>();</code> <button class="copy-button">copy</button></pre> 7781cb0ef41Sopenharmony_ci<p>Outputs for example:</p> 7791cb0ef41Sopenharmony_ci<pre><code class="language-text">Subject Common Name: github.com 7801cb0ef41Sopenharmony_ci Certificate SHA256 fingerprint: 25:FE:39:32:D9:63:8C:8A:FC:A1:9A:29:87:D8:3E:4C:1D:98:DB:71:E4:1A:48:03:98:EA:22:6A:BD:8B:93:16 7811cb0ef41Sopenharmony_ci Public key ping-sha256: pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU= 7821cb0ef41Sopenharmony_ciSubject Common Name: DigiCert SHA2 Extended Validation Server CA 7831cb0ef41Sopenharmony_ci Certificate SHA256 fingerprint: 40:3E:06:2A:26:53:05:91:13:28:5B:AF:80:A0:D4:AE:42:2C:84:8C:9F:78:FA:D0:1F:C9:4B:C5:B8:7F:EF:1A 7841cb0ef41Sopenharmony_ci Public key ping-sha256: RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho= 7851cb0ef41Sopenharmony_ciSubject Common Name: DigiCert High Assurance EV Root CA 7861cb0ef41Sopenharmony_ci Certificate SHA256 fingerprint: 74:31:E5:F4:C3:C1:CE:46:90:77:4F:0B:61:E0:54:40:88:3B:A9:A0:1E:D0:0B:A6:AB:D7:80:6E:D3:B1:18:CF 7871cb0ef41Sopenharmony_ci Public key ping-sha256: WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18= 7881cb0ef41Sopenharmony_ciAll OK. Server matched our pinned cert or public key 7891cb0ef41Sopenharmony_cistatusCode: 200 7901cb0ef41Sopenharmony_ciheaders: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; pin-sha256="RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho="; pin-sha256="k2v657xBsOVe1PQRwOsHsw3bsGT2VzIqz5K+59sNQws="; pin-sha256="K87oWBWM9UZfyddvDfoxL+8lpNyoUB2ptGtn0fv6G2Q="; pin-sha256="IQBnNBEiFuhj+8x6X8XLgh01V9Ic5/V3IRQLNFFc7v4="; pin-sha256="iie1VXtL7HzAMF+/PVPR9xzT80kQxdZeJ+zduCB3uj0="; pin-sha256="LvRiGEjRqfzurezaWuj8Wie2gyHMrW5Q06LspMnox7A="; includeSubDomains</code> <button class="copy-button">copy</button></pre></section> 7911cb0ef41Sopenharmony_ci <!-- API END --> 7921cb0ef41Sopenharmony_ci </div> 7931cb0ef41Sopenharmony_ci </div> 7941cb0ef41Sopenharmony_ci </div> 7951cb0ef41Sopenharmony_ci</body> 7961cb0ef41Sopenharmony_ci</html> 797