Source Code: lib/tls.js
\nThe tls module provides an implementation of the Transport Layer Security\n(TLS) and Secure Socket Layer (SSL) protocols that is built on top of OpenSSL.\nThe module can be accessed using:
const tls = require('tls');\nThe TLS/SSL is a public/private key infrastructure (PKI). For most common\ncases, each client and server must have a private key.
\nPrivate keys can be generated in multiple ways. The example below illustrates\nuse of the OpenSSL command-line interface to generate a 2048-bit RSA private\nkey:
\nopenssl genrsa -out ryans-key.pem 2048\nWith TLS/SSL, all servers (and some clients) must have a certificate.\nCertificates are public keys that correspond to a private key, and that are\ndigitally signed either by a Certificate Authority or by the owner of the\nprivate key (such certificates are referred to as \"self-signed\"). The first\nstep to obtaining a certificate is to create a Certificate Signing Request\n(CSR) file.
\nThe OpenSSL command-line interface can be used to generate a CSR for a private\nkey:
\nopenssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem\nOnce the CSR file is generated, it can either be sent to a Certificate\nAuthority for signing or used to generate a self-signed certificate.
\nCreating a self-signed certificate using the OpenSSL command-line interface\nis illustrated in the example below:
\nopenssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem\nOnce the certificate is generated, it can be used to generate a .pfx or\n.p12 file:
openssl pkcs12 -export -in ryans-cert.pem -inkey ryans-key.pem \\\n -certfile ca-cert.pem -out ryans.pfx\nWhere:
\nin: is the signed certificateinkey: is the associated private keycertfile: is a concatenation of all Certificate Authority (CA) certs into\na single file, e.g. cat ca1-cert.pem ca2-cert.pem > ca-cert.pemThe term forward secrecy or perfect forward secrecy describes a feature\nof key-agreement (i.e., key-exchange) methods. That is, the server and client\nkeys are used to negotiate new temporary keys that are used specifically and\nonly for the current communication session. Practically, this means that even\nif the server's private key is compromised, communication can only be decrypted\nby eavesdroppers if the attacker manages to obtain the key-pair specifically\ngenerated for the session.
\nPerfect forward secrecy is achieved by randomly generating a key pair for\nkey-agreement on every TLS/SSL handshake (in contrast to using the same key for\nall sessions). Methods implementing this technique are called \"ephemeral\".
\nCurrently two methods are commonly used to achieve perfect forward secrecy (note\nthe character \"E\" appended to the traditional abbreviations):
\nEphemeral methods may have some performance drawbacks, because key generation\nis expensive.
\nTo use perfect forward secrecy using DHE with the tls module, it is required\nto generate Diffie-Hellman parameters and specify them with the dhparam\noption to tls.createSecureContext(). The following illustrates the use of\nthe OpenSSL command-line interface to generate such parameters:
openssl dhparam -outform PEM -out dhparam.pem 2048\nIf using perfect forward secrecy using ECDHE, Diffie-Hellman parameters are\nnot required and a default ECDHE curve will be used. The ecdhCurve property\ncan be used when creating a TLS Server to specify the list of names of supported\ncurves to use, see tls.createServer() for more info.
Perfect forward secrecy was optional up to TLSv1.2, but it is not optional for\nTLSv1.3, because all TLSv1.3 cipher suites use ECDHE.
" }, { "textRaw": "ALPN and SNI", "name": "ALPN and SNI", "type": "misc", "desc": "ALPN (Application-Layer Protocol Negotiation Extension) and\nSNI (Server Name Indication) are TLS handshake extensions:
\nTLS-PSK support is available as an alternative to normal certificate-based\nauthentication. It uses a pre-shared key instead of certificates to\nauthenticate a TLS connection, providing mutual authentication.\nTLS-PSK and public key infrastructure are not mutually exclusive. Clients and\nservers can accommodate both, choosing either of them during the normal cipher\nnegotiation step.
\nTLS-PSK is only a good choice where means exist to securely share a\nkey with every connecting machine, so it does not replace PKI\n(Public Key Infrastructure) for the majority of TLS uses.\nThe TLS-PSK implementation in OpenSSL has seen many security flaws in\nrecent years, mostly because it is used only by a minority of applications.\nPlease consider all alternative solutions before switching to PSK ciphers.\nUpon generating PSK it is of critical importance to use sufficient entropy as\ndiscussed in RFC 4086. Deriving a shared secret from a password or other\nlow-entropy sources is not secure.
\nPSK ciphers are disabled by default, and using TLS-PSK thus requires explicitly\nspecifying a cipher suite with the ciphers option. The list of available\nciphers can be retrieved via openssl ciphers -v 'PSK'. All TLS 1.3\nciphers are eligible for PSK but currently only those that use SHA256 digest are\nsupported they can be retrieved via openssl ciphers -v -s -tls1_3 -psk.
According to the RFC 4279, PSK identities up to 128 bytes in length and\nPSKs up to 64 bytes in length must be supported. As of OpenSSL 1.1.0\nmaximum identity size is 128 bytes, and maximum PSK length is 256 bytes.
\nThe current implementation doesn't support asynchronous PSK callbacks due to the\nlimitations of the underlying OpenSSL API.
" }, { "textRaw": "Client-initiated renegotiation attack mitigation", "name": "Client-initiated renegotiation attack mitigation", "type": "misc", "desc": "The TLS protocol allows clients to renegotiate certain aspects of the TLS\nsession. Unfortunately, session renegotiation requires a disproportionate amount\nof server-side resources, making it a potential vector for denial-of-service\nattacks.
\nTo mitigate the risk, renegotiation is limited to three times every ten minutes.\nAn 'error' event is emitted on the tls.TLSSocket instance when this\nthreshold is exceeded. The limits are configurable:
tls.CLIENT_RENEG_LIMIT <number> Specifies the number of renegotiation\nrequests. Default: 3.tls.CLIENT_RENEG_WINDOW <number> Specifies the time renegotiation window\nin seconds. Default: 600 (10 minutes).The default renegotiation limits should not be modified without a full\nunderstanding of the implications and risks.
\nTLSv1.3 does not support renegotiation.
" } ], "modules": [ { "textRaw": "Session resumption", "name": "session_resumption", "desc": "Establishing a TLS session can be relatively slow. The process can be sped\nup by saving and later reusing the session state. There are several mechanisms\nto do so, discussed here from oldest to newest (and preferred).
", "modules": [ { "textRaw": "Session identifiers", "name": "session_identifiers", "desc": "Servers generate a unique ID for new connections and\nsend it to the client. Clients and servers save the session state. When\nreconnecting, clients send the ID of their saved session state and if the server\nalso has the state for that ID, it can agree to use it. Otherwise, the server\nwill create a new session. See RFC 2246 for more information, page 23 and\n30.
\nResumption using session identifiers is supported by most web browsers when\nmaking HTTPS requests.
\nFor Node.js, clients wait for the 'session' event to get the session data,\nand provide the data to the session option of a subsequent tls.connect()\nto reuse the session. Servers must\nimplement handlers for the 'newSession' and 'resumeSession' events\nto save and restore the session data using the session ID as the lookup key to\nreuse sessions. To reuse sessions across load balancers or cluster workers,\nservers must use a shared session cache (such as Redis) in their session\nhandlers.
The servers encrypt the entire session state and send it\nto the client as a \"ticket\". When reconnecting, the state is sent to the server\nin the initial connection. This mechanism avoids the need for server-side\nsession cache. If the server doesn't use the ticket, for any reason (failure\nto decrypt it, it's too old, etc.), it will create a new session and send a new\nticket. See RFC 5077 for more information.
\nResumption using session tickets is becoming commonly supported by many web\nbrowsers when making HTTPS requests.
\nFor Node.js, clients use the same APIs for resumption with session identifiers\nas for resumption with session tickets. For debugging, if\ntls.TLSSocket.getTLSTicket() returns a value, the session data contains a\nticket, otherwise it contains client-side session state.
With TLSv1.3, be aware that multiple tickets may be sent by the server,\nresulting in multiple 'session' events, see 'session' for more\ninformation.
Single process servers need no specific implementation to use session tickets.\nTo use session tickets across server restarts or load balancers, servers must\nall have the same ticket keys. There are three 16-byte keys internally, but the\ntls API exposes them as a single 48-byte buffer for convenience.
\nIts possible to get the ticket keys by calling server.getTicketKeys() on\none server instance and then distribute them, but it is more reasonable to\nsecurely generate 48 bytes of secure random data and set them with the\nticketKeys option of tls.createServer(). The keys should be regularly\nregenerated and server's keys can be reset with\nserver.setTicketKeys().
Session ticket keys are cryptographic keys, and they must be stored\nsecurely. With TLS 1.2 and below, if they are compromised all sessions that\nused tickets encrypted with them can be decrypted. They should not be stored\non disk, and they should be regenerated regularly.
\nIf clients advertise support for tickets, the server will send them. The\nserver can disable tickets by supplying\nrequire('constants').SSL_OP_NO_TICKET in secureOptions.
Both session identifiers and session tickets timeout, causing the server to\ncreate new sessions. The timeout can be configured with the sessionTimeout\noption of tls.createServer().
For all the mechanisms, when resumption fails, servers will create new sessions.\nSince failing to resume the session does not cause TLS/HTTPS connection\nfailures, it is easy to not notice unnecessarily poor TLS performance. The\nOpenSSL CLI can be used to verify that servers are resuming sessions. Use the\n-reconnect option to openssl s_client, for example:
$ openssl s_client -connect localhost:443 -reconnect\nRead through the debug output. The first connection should say \"New\", for\nexample:
\nNew, TLSv1.2, Cipher is ECDHE-RSA-AES128-GCM-SHA256\nSubsequent connections should say \"Reused\", for example:
\nReused, TLSv1.2, Cipher is ECDHE-RSA-AES128-GCM-SHA256\nNode.js is built with a default suite of enabled and disabled TLS ciphers. This\ndefault cipher list can be configured when building Node.js to allow\ndistributions to provide their own default list.
\nThe following command can be used to show the default cipher suite:
\nnode -p crypto.constants.defaultCoreCipherList | tr ':' '\\n'\nTLS_AES_256_GCM_SHA384\nTLS_CHACHA20_POLY1305_SHA256\nTLS_AES_128_GCM_SHA256\nECDHE-RSA-AES128-GCM-SHA256\nECDHE-ECDSA-AES128-GCM-SHA256\nECDHE-RSA-AES256-GCM-SHA384\nECDHE-ECDSA-AES256-GCM-SHA384\nDHE-RSA-AES128-GCM-SHA256\nECDHE-RSA-AES128-SHA256\nDHE-RSA-AES128-SHA256\nECDHE-RSA-AES256-SHA384\nDHE-RSA-AES256-SHA384\nECDHE-RSA-AES256-SHA256\nDHE-RSA-AES256-SHA256\nHIGH\n!aNULL\n!eNULL\n!EXPORT\n!DES\n!RC4\n!MD5\n!PSK\n!SRP\n!CAMELLIA\nThis default can be replaced entirely using the --tls-cipher-list command\nline switch (directly, or via the NODE_OPTIONS environment variable). For\ninstance, the following makes ECDHE-RSA-AES128-GCM-SHA256:!RC4 the default TLS\ncipher suite:
node --tls-cipher-list='ECDHE-RSA-AES128-GCM-SHA256:!RC4' server.js\n\nexport NODE_OPTIONS=--tls-cipher-list='ECDHE-RSA-AES128-GCM-SHA256:!RC4'\nnode server.js\nThe default can also be replaced on a per client or server basis using the\nciphers option from tls.createSecureContext(), which is also available\nin tls.createServer(), tls.connect(), and when creating new\ntls.TLSSockets.
The ciphers list can contain a mixture of TLSv1.3 cipher suite names, the ones\nthat start with 'TLS_', and specifications for TLSv1.2 and below cipher\nsuites. The TLSv1.2 ciphers support a legacy specification format, consult\nthe OpenSSL cipher list format documentation for details, but those\nspecifications do not apply to TLSv1.3 ciphers. The TLSv1.3 suites can only\nbe enabled by including their full name in the cipher list. They cannot, for\nexample, be enabled or disabled by using the legacy TLSv1.2 'EECDH' or\n'!EECDH' specification.
Despite the relative order of TLSv1.3 and TLSv1.2 cipher suites, the TLSv1.3\nprotocol is significantly more secure than TLSv1.2, and will always be chosen\nover TLSv1.2 if the handshake indicates it is supported, and if any TLSv1.3\ncipher suites are enabled.
\nThe default cipher suite included within Node.js has been carefully\nselected to reflect current security best practices and risk mitigation.\nChanging the default cipher suite can have a significant impact on the security\nof an application. The --tls-cipher-list switch and ciphers option should by\nused only if absolutely necessary.
The default cipher suite prefers GCM ciphers for Chrome's 'modern\ncryptography' setting and also prefers ECDHE and DHE ciphers for perfect\nforward secrecy, while offering some backward compatibility.
\n128 bit AES is preferred over 192 and 256 bit AES in light of specific\nattacks affecting larger AES key sizes.
\nOld clients that rely on insecure and deprecated RC4 or DES-based ciphers\n(like Internet Explorer 6) cannot complete the handshaking process with\nthe default configuration. If these clients must be supported, the\nTLS recommendations may offer a compatible cipher suite. For more details\non the format, see the OpenSSL cipher list format documentation.
\nThere are only 5 TLSv1.3 cipher suites:
\n'TLS_AES_256_GCM_SHA384''TLS_CHACHA20_POLY1305_SHA256''TLS_AES_128_GCM_SHA256''TLS_AES_128_CCM_SHA256''TLS_AES_128_CCM_8_SHA256'The first 3 are enabled by default. The last 2 CCM-based suites are supported\nby TLSv1.3 because they may be more performant on constrained systems, but they\nare not enabled by default since they offer less security.
The tls.CryptoStream class represents a stream of encrypted data. This class\nis deprecated and should no longer be used.
The cryptoStream.bytesWritten property returns the total number of bytes\nwritten to the underlying socket including the bytes required for the\nimplementation of the TLS protocol.
Returned by tls.createSecurePair().
The 'secure' event is emitted by the SecurePair object once a secure\nconnection has been established.
As with checking for the server\n'secureConnection'\nevent, pair.cleartext.authorized should be inspected to confirm whether the\ncertificate used is properly authorized.
Creates a new secure pair object with two streams, one of which reads and writes\nthe encrypted data and the other of which reads and writes the cleartext data.\nGenerally, the encrypted stream is piped to/from an incoming encrypted data\nstream and the cleartext one is used as a replacement for the initial encrypted\nstream.
\ntls.createSecurePair() returns a tls.SecurePair object with cleartext and\nencrypted stream properties.
Using cleartext has the same API as tls.TLSSocket.
The tls.createSecurePair() method is now deprecated in favor of\ntls.TLSSocket(). For example, the code:
pair = tls.createSecurePair(/* ... */);\npair.encrypted.pipe(socket);\nsocket.pipe(pair.encrypted);\ncan be replaced by:
\nsecureSocket = tls.TLSSocket(socket, options);\nwhere secureSocket has the same API as pair.cleartext.
Accepts encrypted connections using TLS or SSL.
", "events": [ { "textRaw": "Event: `'keylog'`", "type": "event", "name": "keylog", "meta": { "added": [ "v12.3.0", "v10.20.0" ], "changes": [] }, "params": [ { "textRaw": "`line` {Buffer} Line of ASCII text, in NSS `SSLKEYLOGFILE` format.", "name": "line", "type": "Buffer", "desc": "Line of ASCII text, in NSS `SSLKEYLOGFILE` format." }, { "textRaw": "`tlsSocket` {tls.TLSSocket} The `tls.TLSSocket` instance on which it was generated.", "name": "tlsSocket", "type": "tls.TLSSocket", "desc": "The `tls.TLSSocket` instance on which it was generated." } ], "desc": "The keylog event is emitted when key material is generated or received by\na connection to this server (typically before handshake has completed, but not\nnecessarily). This keying material can be stored for debugging, as it allows\ncaptured TLS traffic to be decrypted. It may be emitted multiple times for\neach socket.
A typical use case is to append received lines to a common text file, which\nis later used by software (such as Wireshark) to decrypt the traffic:
\nconst logFile = fs.createWriteStream('/tmp/ssl-keys.log', { flags: 'a' });\n// ...\nserver.on('keylog', (line, tlsSocket) => {\n if (tlsSocket.remoteAddress !== '...')\n return; // Only log keys for a particular IP\n logFile.write(line);\n});\nThe 'newSession' event is emitted upon creation of a new TLS session. This may\nbe used to store sessions in external storage. The data should be provided to\nthe 'resumeSession' callback.
The listener callback is passed three arguments when called:
\nsessionId <Buffer> The TLS session identifiersessionData <Buffer> The TLS session datacallback <Function> A callback function taking no arguments that must be\ninvoked in order for data to be sent or received over the secure connection.Listening for this event will have an effect only on connections established\nafter the addition of the event listener.
" }, { "textRaw": "Event: `'OCSPRequest'`", "type": "event", "name": "OCSPRequest", "meta": { "added": [ "v0.11.13" ], "changes": [] }, "params": [], "desc": "The 'OCSPRequest' event is emitted when the client sends a certificate status\nrequest. The listener callback is passed three arguments when called:
certificate <Buffer> The server certificateissuer <Buffer> The issuer's certificatecallback <Function> A callback function that must be invoked to provide\nthe results of the OCSP request.The server's current certificate can be parsed to obtain the OCSP URL\nand certificate ID; after obtaining an OCSP response, callback(null, resp) is\nthen invoked, where resp is a Buffer instance containing the OCSP response.\nBoth certificate and issuer are Buffer DER-representations of the\nprimary and issuer's certificates. These can be used to obtain the OCSP\ncertificate ID and OCSP endpoint URL.
Alternatively, callback(null, null) may be called, indicating that there was\nno OCSP response.
Calling callback(err) will result in a socket.destroy(err) call.
The typical flow of an OCSP Request is as follows:
\n'OCSPRequest' (via the status\ninfo extension in ClientHello).'OCSPRequest' event, calling the\nlistener if registered.certificate or issuer and\nperforms an OCSP request to the CA.'OCSPResponse' from the CA and sends it back to the client\nvia the callback argumentThe issuer can be null if the certificate is either self-signed or the\nissuer is not in the root certificates list. (An issuer may be provided\nvia the ca option when establishing the TLS connection.)
Listening for this event will have an effect only on connections established\nafter the addition of the event listener.
\nAn npm module like asn1.js may be used to parse the certificates.
" }, { "textRaw": "Event: `'resumeSession'`", "type": "event", "name": "resumeSession", "meta": { "added": [ "v0.9.2" ], "changes": [] }, "params": [], "desc": "The 'resumeSession' event is emitted when the client requests to resume a\nprevious TLS session. The listener callback is passed two arguments when\ncalled:
sessionId <Buffer> The TLS session identifiercallback <Function> A callback function to be called when the prior session\nhas been recovered: callback([err[, sessionData]])
The event listener should perform a lookup in external storage for the\nsessionData saved by the 'newSession' event handler using the given\nsessionId. If found, call callback(null, sessionData) to resume the session.\nIf not found, the session cannot be resumed. callback() must be called\nwithout sessionData so that the handshake can continue and a new session can\nbe created. It is possible to call callback(err) to terminate the incoming\nconnection and destroy the socket.
Listening for this event will have an effect only on connections established\nafter the addition of the event listener.
\nThe following illustrates resuming a TLS session:
\nconst tlsSessionStore = {};\nserver.on('newSession', (id, data, cb) => {\n tlsSessionStore[id.toString('hex')] = data;\n cb();\n});\nserver.on('resumeSession', (id, cb) => {\n cb(null, tlsSessionStore[id.toString('hex')] || null);\n});\nThe 'secureConnection' event is emitted after the handshaking process for a\nnew connection has successfully completed. The listener callback is passed a\nsingle argument when called:
tlsSocket <tls.TLSSocket> The established TLS socket.The tlsSocket.authorized property is a boolean indicating whether the\nclient has been verified by one of the supplied Certificate Authorities for the\nserver. If tlsSocket.authorized is false, then socket.authorizationError\nis set to describe how authorization failed. Depending on the settings\nof the TLS server, unauthorized connections may still be accepted.
The tlsSocket.alpnProtocol property is a string that contains the selected\nALPN protocol. When ALPN has no selected protocol, tlsSocket.alpnProtocol\nequals false.
The tlsSocket.servername property is a string containing the server name\nrequested via SNI.
The 'tlsClientError' event is emitted when an error occurs before a secure\nconnection is established. The listener callback is passed two arguments when\ncalled:
exception <Error> The Error object describing the errortlsSocket <tls.TLSSocket> The tls.TLSSocket instance from which the\nerror originated.The server.addContext() method adds a secure context that will be used if\nthe client request's SNI name matches the supplied hostname (or wildcard).
Returns the bound address, the address family name, and port of the\nserver as reported by the operating system. See net.Server.address() for\nmore information.
The server.close() method stops the server from accepting new connections.
This function operates asynchronously. The 'close' event will be emitted\nwhen the server has no more open connections.
Returns the session ticket keys.
\nSee Session Resumption for more information.
" }, { "textRaw": "`server.listen()`", "type": "method", "name": "listen", "signatures": [ { "params": [] } ], "desc": "Starts the server listening for encrypted connections.\nThis method is identical to server.listen() from net.Server.
The server.setSecureContext() method replaces the secure context of an\nexisting server. Existing connections to the server are not interrupted.
Sets the session ticket keys.
\nChanges to the ticket keys are effective only for future server connections.\nExisting or currently pending server connections will use the previous keys.
\nSee Session Resumption for more information.
" } ], "properties": [ { "textRaw": "`connections` {number}", "type": "number", "name": "connections", "meta": { "added": [ "v0.3.2" ], "deprecated": [ "v0.9.7" ], "changes": [] }, "stability": 0, "stabilityText": "Deprecated: Use [`server.getConnections()`][] instead.", "desc": "Returns the current number of concurrent connections on the server.
" } ] }, { "textRaw": "Class: `tls.TLSSocket`", "type": "class", "name": "tls.TLSSocket", "meta": { "added": [ "v0.11.4" ], "changes": [] }, "desc": "Performs transparent encryption of written data and all required TLS\nnegotiation.
\nInstances of tls.TLSSocket implement the duplex Stream interface.
Methods that return TLS connection metadata (e.g.\ntls.TLSSocket.getPeerCertificate() will only return data while the\nconnection is open.
The keylog event is emitted on a tls.TLSSocket when key material\nis generated or received by the socket. This keying material can be stored\nfor debugging, as it allows captured TLS traffic to be decrypted. It may\nbe emitted multiple times, before or after the handshake completes.
A typical use case is to append received lines to a common text file, which\nis later used by software (such as Wireshark) to decrypt the traffic:
\nconst logFile = fs.createWriteStream('/tmp/ssl-keys.log', { flags: 'a' });\n// ...\ntlsSocket.on('keylog', (line) => logFile.write(line));\nThe 'OCSPResponse' event is emitted if the requestOCSP option was set\nwhen the tls.TLSSocket was created and an OCSP response has been received.\nThe listener callback is passed a single argument when called:
response <Buffer> The server's OCSP responseTypically, the response is a digitally signed object from the server's CA that\ncontains information about server's certificate revocation status.
The 'secureConnect' event is emitted after the handshaking process for a new\nconnection has successfully completed. The listener callback will be called\nregardless of whether or not the server's certificate has been authorized. It\nis the client's responsibility to check the tlsSocket.authorized property to\ndetermine if the server certificate was signed by one of the specified CAs. If\ntlsSocket.authorized === false, then the error can be found by examining the\ntlsSocket.authorizationError property. If ALPN was used, the\ntlsSocket.alpnProtocol property can be checked to determine the negotiated\nprotocol.
The 'session' event is emitted on a client tls.TLSSocket when a new session\nor TLS ticket is available. This may or may not be before the handshake is\ncomplete, depending on the TLS protocol version that was negotiated. The event\nis not emitted on the server, or if a new session was not created, for example,\nwhen the connection was resumed. For some TLS protocol versions the event may be\nemitted multiple times, in which case all the sessions can be used for\nresumption.
On the client, the session can be provided to the session option of\ntls.connect() to resume the connection.
See Session Resumption for more information.
\nFor TLSv1.2 and below, tls.TLSSocket.getSession() can be called once\nthe handshake is complete. For TLSv1.3, only ticket-based resumption is allowed\nby the protocol, multiple tickets are sent, and the tickets aren't sent until\nafter the handshake completes. So it is necessary to wait for the\n'session' event to get a resumable session. Applications\nshould use the 'session' event instead of getSession() to ensure\nthey will work for all TLS versions. Applications that only expect to\nget or use one session should listen for this event only once:
tlsSocket.once('session', (session) => {\n // The session can be used immediately or later.\n tls.connect({\n session: session,\n // Other connect options...\n });\n});\nReturns the bound address, the address family name, and port of the\nunderlying socket as reported by the operating system:\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }.
Disables TLS renegotiation for this TLSSocket instance. Once called, attempts\nto renegotiate will trigger an 'error' event on the TLSSocket.
When enabled, TLS packet trace information is written to stderr. This can be\nused to debug TLS connection problems.
Note: The format of the output is identical to the output of openssl s_client -trace or openssl s_server -trace. While it is produced by OpenSSL's\nSSL_trace() function, the format is undocumented, can change without notice,\nand should not be relied on.
Returns an object representing the local certificate. The returned object has\nsome properties corresponding to the fields of the certificate.
\nSee tls.TLSSocket.getPeerCertificate() for an example of the certificate\nstructure.
If there is no local certificate, an empty object will be returned. If the\nsocket has been destroyed, null will be returned.
Returns an object containing information on the negotiated cipher suite.
\nFor example:
\n{\n \"name\": \"AES128-SHA256\",\n \"standardName\": \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"version\": \"TLSv1.2\"\n}\nSee\nSSL_CIPHER_get_name\nfor more information.
" }, { "textRaw": "`tlsSocket.getEphemeralKeyInfo()`", "type": "method", "name": "getEphemeralKeyInfo", "meta": { "added": [ "v5.0.0" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {Object}", "name": "return", "type": "Object" }, "params": [] } ], "desc": "Returns an object representing the type, name, and size of parameter of\nan ephemeral key exchange in perfect forward secrecy on a client\nconnection. It returns an empty object when the key exchange is not\nephemeral. As this is only supported on a client socket; null is returned\nif called on a server socket. The supported types are 'DH' and 'ECDH'. The\nname property is available only when type is 'ECDH'.
For example: { type: 'ECDH', name: 'prime256v1', size: 256 }.
As the Finished messages are message digests of the complete handshake\n(with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can\nbe used for external authentication procedures when the authentication\nprovided by SSL/TLS is not desired or is not enough.
Corresponds to the SSL_get_finished routine in OpenSSL and may be used\nto implement the tls-unique channel binding from RFC 5929.
Returns an object representing the peer's certificate. If the peer does not\nprovide a certificate, an empty object will be returned. If the socket has been\ndestroyed, null will be returned.
If the full certificate chain was requested, each certificate will include an\nissuerCertificate property containing an object representing its issuer's\ncertificate.
A certificate object has properties corresponding to the fields of the\ncertificate.
\nraw <Buffer> The DER encoded X.509 certificate data.subject <Object> The certificate subject, described in terms of\n Country (C:), StateOrProvince (ST), Locality (L), Organization (O),\nOrganizationalUnit (OU), and CommonName (CN). The CommonName is typically\na DNS name with TLS certificates. Example:\n{C: 'UK', ST: 'BC', L: 'Metro', O: 'Node Fans', OU: 'Docs', CN: 'example.com'}.issuer <Object> The certificate issuer, described in the same terms as the\n subject.valid_from <string> The date-time the certificate is valid from.valid_to <string> The date-time the certificate is valid to.serialNumber <string> The certificate serial number, as a hex string.\n Example: 'B9B0D332A1AA5635'.fingerprint <string> The SHA-1 digest of the DER encoded certificate. It is\nreturned as a : separated hexadecimal string. Example: '2A:7A:C2:DD:...'.fingerprint256 <string> The SHA-256 digest of the DER encoded certificate.\n It is returned as a : separated hexadecimal string. Example:\n'2A:7A:C2:DD:...'.ext_key_usage <Array> (Optional) The extended key usage, a set of OIDs.subjectaltname <string> (Optional) A string containing concatenated names\nfor the subject, an alternative to the subject names.infoAccess <Array> (Optional) An array describing the AuthorityInfoAccess,\n used with OCSP.issuerCertificate <Object> (Optional) The issuer certificate object. For\n self-signed certificates, this may be a circular reference.The certificate may contain information about the public key, depending on\nthe key type.
\nFor RSA keys, the following properties may be defined:
\nbits <number> The RSA bit size. Example: 1024.exponent <string> The RSA exponent, as a string in hexadecimal number\nnotation. Example: '0x010001'.modulus <string> The RSA modulus, as a hexadecimal string. Example:\n 'B56CE45CB7...'.pubkey <Buffer> The public key.For EC keys, the following properties may be defined:
\npubkey <Buffer> The public key.bits <number> The key size in bits. Example: 256.asn1Curve <string> (Optional) The ASN.1 name of the OID of the elliptic\ncurve. Well-known curves are identified by an OID. While it is unusual, it is\npossible that the curve is identified by its mathematical properties, in which\ncase it will not have an OID. Example: 'prime256v1'.nistCurve <string> (Optional) The NIST name for the elliptic curve, if it\nhas one (not all well-known curves have been assigned names by NIST). Example:\n'P-256'.Example certificate:
\n{ subject:\n { OU: [ 'Domain Control Validated', 'PositiveSSL Wildcard' ],\n CN: '*.nodejs.org' },\n issuer:\n { C: 'GB',\n ST: 'Greater Manchester',\n L: 'Salford',\n O: 'COMODO CA Limited',\n CN: 'COMODO RSA Domain Validation Secure Server CA' },\n subjectaltname: 'DNS:*.nodejs.org, DNS:nodejs.org',\n infoAccess:\n { 'CA Issuers - URI':\n [ 'http://crt.comodoca.com/COMODORSADomainValidationSecureServerCA.crt' ],\n 'OCSP - URI': [ 'http://ocsp.comodoca.com' ] },\n modulus: 'B56CE45CB740B09A13F64AC543B712FF9EE8E4C284B542A1708A27E82A8D151CA178153E12E6DDA15BF70FFD96CB8A88618641BDFCCA03527E665B70D779C8A349A6F88FD4EF6557180BD4C98192872BCFE3AF56E863C09DDD8BC1EC58DF9D94F914F0369102B2870BECFA1348A0838C9C49BD1C20124B442477572347047506B1FCD658A80D0C44BCC16BC5C5496CFE6E4A8428EF654CD3D8972BF6E5BFAD59C93006830B5EB1056BBB38B53D1464FA6E02BFDF2FF66CD949486F0775EC43034EC2602AEFBF1703AD221DAA2A88353C3B6A688EFE8387811F645CEED7B3FE46E1F8B9F59FAD028F349B9BC14211D5830994D055EEA3D547911E07A0ADDEB8A82B9188E58720D95CD478EEC9AF1F17BE8141BE80906F1A339445A7EB5B285F68039B0F294598A7D1C0005FC22B5271B0752F58CCDEF8C8FD856FB7AE21C80B8A2CE983AE94046E53EDE4CB89F42502D31B5360771C01C80155918637490550E3F555E2EE75CC8C636DDE3633CFEDD62E91BF0F7688273694EEEBA20C2FC9F14A2A435517BC1D7373922463409AB603295CEB0BB53787A334C9CA3CA8B30005C5A62FC0715083462E00719A8FA3ED0A9828C3871360A73F8B04A4FC1E71302844E9BB9940B77E745C9D91F226D71AFCAD4B113AAF68D92B24DDB4A2136B55A1CD1ADF39605B63CB639038ED0F4C987689866743A68769CC55847E4A06D6E2E3F1',\n exponent: '0x10001',\n pubkey: <Buffer ... >,\n valid_from: 'Aug 14 00:00:00 2017 GMT',\n valid_to: 'Nov 20 23:59:59 2019 GMT',\n fingerprint: '01:02:59:D9:C3:D2:0D:08:F7:82:4E:44:A4:B4:53:C5:E2:3A:87:4D',\n fingerprint256: '69:AE:1A:6A:D4:3D:C6:C1:1B:EA:C6:23:DE:BA:2A:14:62:62:93:5C:7A:EA:06:41:9B:0B:BC:87:CE:48:4E:02',\n ext_key_usage: [ '1.3.6.1.5.5.7.3.1', '1.3.6.1.5.5.7.3.2' ],\n serialNumber: '66593D57F20CBC573E433381B5FEC280',\n raw: <Buffer ... > }\nAs the Finished messages are message digests of the complete handshake\n(with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can\nbe used for external authentication procedures when the authentication\nprovided by SSL/TLS is not desired or is not enough.
Corresponds to the SSL_get_peer_finished routine in OpenSSL and may be used\nto implement the tls-unique channel binding from RFC 5929.
Returns a string containing the negotiated SSL/TLS protocol version of the\ncurrent connection. The value 'unknown' will be returned for connected\nsockets that have not completed the handshaking process. The value null will\nbe returned for server sockets or disconnected client sockets.
Protocol versions are:
\n'SSLv3''TLSv1''TLSv1.1''TLSv1.2''TLSv1.3'See the OpenSSL SSL_get_version documentation for more information.
Returns the TLS session data or undefined if no session was\nnegotiated. On the client, the data can be provided to the session option of\ntls.connect() to resume the connection. On the server, it may be useful\nfor debugging.
See Session Resumption for more information.
\nNote: getSession() works only for TLSv1.2 and below. For TLSv1.3, applications\nmust use the 'session' event (it also works for TLSv1.2 and below).
See\nSSL_get_shared_sigalgs\nfor more information.
" }, { "textRaw": "`tlsSocket.exportKeyingMaterial(length, label[, context])`", "type": "method", "name": "exportKeyingMaterial", "meta": { "added": [ "v13.10.0" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {Buffer} requested bytes of the keying material", "name": "return", "type": "Buffer", "desc": "requested bytes of the keying material" }, "params": [ { "textRaw": "`length` {number} number of bytes to retrieve from keying material", "name": "length", "type": "number", "desc": "number of bytes to retrieve from keying material" }, { "textRaw": "`label` {string} an application specific label, typically this will be a value from the [IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels).", "name": "label", "type": "string", "desc": "an application specific label, typically this will be a value from the [IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels)." }, { "textRaw": "`context` {Buffer} Optionally provide a context.", "name": "context", "type": "Buffer", "desc": "Optionally provide a context." } ] } ], "desc": "Keying material is used for validations to prevent different kind of attacks in\nnetwork protocols, for example in the specifications of IEEE 802.1X.
\nExample
\nconst keyingMaterial = tlsSocket.exportKeyingMaterial(\n 128,\n 'client finished');\n\n/**\n Example return value of keyingMaterial:\n <Buffer 76 26 af 99 c5 56 8e 42 09 91 ef 9f 93 cb ad 6c 7b 65 f8 53 f1 d8 d9\n 12 5a 33 b8 b5 25 df 7b 37 9f e0 e2 4f b8 67 83 a3 2f cd 5d 41 42 4c 91\n 74 ef 2c ... 78 more bytes>\n*/\nSee the OpenSSL SSL_export_keying_material documentation for more\ninformation.
For a client, returns the TLS session ticket if one is available, or\nundefined. For a server, always returns undefined.
It may be useful for debugging.
\nSee Session Resumption for more information.
" }, { "textRaw": "`tlsSocket.isSessionReused()`", "type": "method", "name": "isSessionReused", "meta": { "added": [ "v0.5.6" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {boolean} `true` if the session was reused, `false` otherwise.", "name": "return", "type": "boolean", "desc": "`true` if the session was reused, `false` otherwise." }, "params": [] } ], "desc": "See Session Resumption for more information.
" }, { "textRaw": "`tlsSocket.renegotiate(options, callback)`", "type": "method", "name": "renegotiate", "meta": { "added": [ "v0.11.8" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {boolean} `true` if renegotiation was initiated, `false` otherwise.", "name": "return", "type": "boolean", "desc": "`true` if renegotiation was initiated, `false` otherwise." }, "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`rejectUnauthorized` {boolean} If not `false`, the server certificate is verified against the list of supplied CAs. An `'error'` event is emitted if verification fails; `err.code` contains the OpenSSL error code. **Default:** `true`.", "name": "rejectUnauthorized", "type": "boolean", "default": "`true`", "desc": "If not `false`, the server certificate is verified against the list of supplied CAs. An `'error'` event is emitted if verification fails; `err.code` contains the OpenSSL error code." }, { "textRaw": "`requestCert`", "name": "requestCert" } ] }, { "textRaw": "`callback` {Function} If `renegotiate()` returned `true`, callback is attached once to the `'secure'` event. If `renegotiate()` returned `false`, `callback` will be called in the next tick with an error, unless the `tlsSocket` has been destroyed, in which case `callback` will not be called at all.", "name": "callback", "type": "Function", "desc": "If `renegotiate()` returned `true`, callback is attached once to the `'secure'` event. If `renegotiate()` returned `false`, `callback` will be called in the next tick with an error, unless the `tlsSocket` has been destroyed, in which case `callback` will not be called at all." } ] } ], "desc": "The tlsSocket.renegotiate() method initiates a TLS renegotiation process.\nUpon completion, the callback function will be passed a single argument\nthat is either an Error (if the request failed) or null.
This method can be used to request a peer's certificate after the secure\nconnection has been established.
\nWhen running as the server, the socket will be destroyed with an error after\nhandshakeTimeout timeout.
For TLSv1.3, renegotiation cannot be initiated, it is not supported by the\nprotocol.
" }, { "textRaw": "`tlsSocket.setMaxSendFragment(size)`", "type": "method", "name": "setMaxSendFragment", "meta": { "added": [ "v0.11.11" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {boolean}", "name": "return", "type": "boolean" }, "params": [ { "textRaw": "`size` {number} The maximum TLS fragment size. The maximum value is `16384`. **Default:** `16384`.", "name": "size", "type": "number", "default": "`16384`", "desc": "The maximum TLS fragment size. The maximum value is `16384`." } ] } ], "desc": "The tlsSocket.setMaxSendFragment() method sets the maximum TLS fragment size.\nReturns true if setting the limit succeeded; false otherwise.
Smaller fragment sizes decrease the buffering latency on the client: larger\nfragments are buffered by the TLS layer until the entire fragment is received\nand its integrity is verified; large fragments can span multiple roundtrips\nand their processing can be delayed due to packet loss or reordering. However,\nsmaller fragments add extra TLS framing bytes and CPU overhead, which may\ndecrease overall server throughput.
" } ], "properties": [ { "textRaw": "`tlsSocket.authorizationError`", "name": "authorizationError", "meta": { "added": [ "v0.11.4" ], "changes": [] }, "desc": "Returns the reason why the peer's certificate was not been verified. This\nproperty is set only when tlsSocket.authorized === false.
Returns true if the peer certificate was signed by one of the CAs specified\nwhen creating the tls.TLSSocket instance, otherwise false.
Always returns true. This may be used to distinguish TLS sockets from regular\nnet.Socket instances.
Returns the string representation of the local IP address.
" }, { "textRaw": "`localPort` {number}", "type": "number", "name": "localPort", "meta": { "added": [ "v0.11.4" ], "changes": [] }, "desc": "Returns the numeric representation of the local port.
" }, { "textRaw": "`remoteAddress` {string}", "type": "string", "name": "remoteAddress", "meta": { "added": [ "v0.11.4" ], "changes": [] }, "desc": "Returns the string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'.
Returns the string representation of the remote IP family. 'IPv4' or 'IPv6'.
Returns the numeric representation of the remote port. For example, 443.
Construct a new tls.TLSSocket object from an existing TCP socket.
Verifies the certificate cert is issued to hostname.
Returns <Error> object, populating it with reason, host, and cert on\nfailure. On success, returns <undefined>.
This function can be overwritten by providing alternative function as part of\nthe options.checkServerIdentity option passed to tls.connect(). The\noverwriting function can call tls.checkServerIdentity() of course, to augment\nthe checks done with additional verification.
This function is only called if the certificate passed all other checks, such as\nbeing issued by trusted CA (options.ca).
The callback function, if specified, will be added as a listener for the\n'secureConnect' event.
tls.connect() returns a tls.TLSSocket object.
Unlike the https API, tls.connect() does not enable the\nSNI (Server Name Indication) extension by default, which may cause some\nservers to return an incorrect certificate or reject the connection\naltogether. To enable SNI, set the servername option in addition\nto host.
The following illustrates a client for the echo server example from\ntls.createServer():
// Assumes an echo server that is listening on port 8000.\nconst tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n // Necessary only if the server requires client certificate authentication.\n key: fs.readFileSync('client-key.pem'),\n cert: fs.readFileSync('client-cert.pem'),\n\n // Necessary only if the server uses a self-signed certificate.\n ca: [ fs.readFileSync('server-cert.pem') ],\n\n // Necessary only if the server's cert isn't for \"localhost\".\n checkServerIdentity: () => { return null; },\n};\n\nconst socket = tls.connect(8000, options, () => {\n console.log('client connected',\n socket.authorized ? 'authorized' : 'unauthorized');\n process.stdin.pipe(socket);\n process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n console.log(data);\n});\nsocket.on('end', () => {\n console.log('server ends connection');\n});\nSame as tls.connect() except that path can be provided\nas an argument instead of an option.
A path option, if specified, will take precedence over the path argument.
" }, { "textRaw": "`tls.connect(port[, host][, options][, callback])`", "type": "method", "name": "connect", "meta": { "added": [ "v0.11.3" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {tls.TLSSocket}", "name": "return", "type": "tls.TLSSocket" }, "params": [ { "textRaw": "`port` {number} Default value for `options.port`.", "name": "port", "type": "number", "desc": "Default value for `options.port`." }, { "textRaw": "`host` {string} Default value for `options.host`.", "name": "host", "type": "string", "desc": "Default value for `options.host`." }, { "textRaw": "`options` {Object} See [`tls.connect()`][].", "name": "options", "type": "Object", "desc": "See [`tls.connect()`][]." }, { "textRaw": "`callback` {Function} See [`tls.connect()`][].", "name": "callback", "type": "Function", "desc": "See [`tls.connect()`][]." } ] } ], "desc": "Same as tls.connect() except that port and host can be provided\nas arguments instead of options.
A port or host option, if specified, will take precedence over any port or host\nargument.
" }, { "textRaw": "`tls.createSecureContext([options])`", "type": "method", "name": "createSecureContext", "meta": { "added": [ "v0.11.13" ], "changes": [ { "version": "v12.12.0", "pr-url": "https://github.com/nodejs/node/pull/28973", "description": "Added `privateKeyIdentifier` and `privateKeyEngine` options to get private key from an OpenSSL engine." }, { "version": "v12.11.0", "pr-url": "https://github.com/nodejs/node/pull/29598", "description": "Added `sigalgs` option to override supported signature algorithms." }, { "version": "v12.0.0", "pr-url": "https://github.com/nodejs/node/pull/26209", "description": "TLSv1.3 support added." }, { "version": "v11.5.0", "pr-url": "https://github.com/nodejs/node/pull/24733", "description": "The `ca:` option now supports `BEGIN TRUSTED CERTIFICATE`." }, { "version": [ "v11.4.0", "v10.16.0" ], "pr-url": "https://github.com/nodejs/node/pull/24405", "description": "The `minVersion` and `maxVersion` can be used to restrict the allowed TLS protocol versions." }, { "version": "v10.0.0", "pr-url": "https://github.com/nodejs/node/pull/19794", "description": "The `ecdhCurve` cannot be set to `false` anymore due to a change in OpenSSL." }, { "version": "v9.3.0", "pr-url": "https://github.com/nodejs/node/pull/14903", "description": "The `options` parameter can now include `clientCertEngine`." }, { "version": "v9.0.0", "pr-url": "https://github.com/nodejs/node/pull/15206", "description": "The `ecdhCurve` option can now be multiple `':'` separated curve names or `'auto'`." }, { "version": "v7.3.0", "pr-url": "https://github.com/nodejs/node/pull/10294", "description": "If the `key` option is an array, individual entries do not need a `passphrase` property anymore. `Array` entries can also just be `string`s or `Buffer`s now." }, { "version": "v5.2.0", "pr-url": "https://github.com/nodejs/node/pull/4099", "description": "The `ca` option can now be a single string containing multiple CA certificates." } ] }, "signatures": [ { "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`ca` {string|string[]|Buffer|Buffer[]} Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option. The value can be a string or `Buffer`, or an `Array` of strings and/or `Buffer`s. Any string or `Buffer` can contain multiple PEM CAs concatenated together. The peer's certificate must be chainable to a CA trusted by the server for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as a trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, use the `ca` option to provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided. For PEM encoded certificates, supported types are \"TRUSTED CERTIFICATE\", \"X509 CERTIFICATE\", and \"CERTIFICATE\". See also [`tls.rootCertificates`][].", "name": "ca", "type": "string|string[]|Buffer|Buffer[]", "desc": "Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option. The value can be a string or `Buffer`, or an `Array` of strings and/or `Buffer`s. Any string or `Buffer` can contain multiple PEM CAs concatenated together. The peer's certificate must be chainable to a CA trusted by the server for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as a trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, use the `ca` option to provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided. For PEM encoded certificates, supported types are \"TRUSTED CERTIFICATE\", \"X509 CERTIFICATE\", and \"CERTIFICATE\". See also [`tls.rootCertificates`][]." }, { "textRaw": "`cert` {string|string[]|Buffer|Buffer[]} Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private `key`, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see `ca`). When providing multiple cert chains, they do not have to be in the same order as their private keys in `key`. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.", "name": "cert", "type": "string|string[]|Buffer|Buffer[]", "desc": "Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private `key`, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see `ca`). When providing multiple cert chains, they do not have to be in the same order as their private keys in `key`. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail." }, { "textRaw": "`sigalgs` {string} Colon-separated list of supported signature algorithms. The list can contain digest algorithms (`SHA256`, `MD5` etc.), public key algorithms (`RSA-PSS`, `ECDSA` etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. `rsa_pss_pss_sha512`). See [OpenSSL man pages](https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set1_sigalgs_list.html) for more info.", "name": "sigalgs", "type": "string", "desc": "Colon-separated list of supported signature algorithms. The list can contain digest algorithms (`SHA256`, `MD5` etc.), public key algorithms (`RSA-PSS`, `ECDSA` etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. `rsa_pss_pss_sha512`). See [OpenSSL man pages](https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set1_sigalgs_list.html) for more info." }, { "textRaw": "`ciphers` {string} Cipher suite specification, replacing the default. For more information, see [modifying the default cipher suite][]. Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names must be uppercased in order for OpenSSL to accept them.", "name": "ciphers", "type": "string", "desc": "Cipher suite specification, replacing the default. For more information, see [modifying the default cipher suite][]. Permitted ciphers can be obtained via [`tls.getCiphers()`][]. Cipher names must be uppercased in order for OpenSSL to accept them." }, { "textRaw": "`clientCertEngine` {string} Name of an OpenSSL engine which can provide the client certificate.", "name": "clientCertEngine", "type": "string", "desc": "Name of an OpenSSL engine which can provide the client certificate." }, { "textRaw": "`crl` {string|string[]|Buffer|Buffer[]} PEM formatted CRLs (Certificate Revocation Lists).", "name": "crl", "type": "string|string[]|Buffer|Buffer[]", "desc": "PEM formatted CRLs (Certificate Revocation Lists)." }, { "textRaw": "`dhparam` {string|Buffer} Diffie-Hellman parameters, required for [perfect forward secrecy][]. Use `openssl dhparam` to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.", "name": "dhparam", "type": "string|Buffer", "desc": "Diffie-Hellman parameters, required for [perfect forward secrecy][]. Use `openssl dhparam` to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available." }, { "textRaw": "`ecdhCurve` {string} A string describing a named curve or a colon separated list of curve NIDs or names, for example `P-521:P-384:P-256`, to use for ECDH key agreement. Set to `auto` to select the curve automatically. Use [`crypto.getCurves()`][] to obtain a list of available curve names. On recent releases, `openssl ecparam -list_curves` will also display the name and description of each available elliptic curve. **Default:** [`tls.DEFAULT_ECDH_CURVE`][].", "name": "ecdhCurve", "type": "string", "default": "[`tls.DEFAULT_ECDH_CURVE`][]", "desc": "A string describing a named curve or a colon separated list of curve NIDs or names, for example `P-521:P-384:P-256`, to use for ECDH key agreement. Set to `auto` to select the curve automatically. Use [`crypto.getCurves()`][] to obtain a list of available curve names. On recent releases, `openssl ecparam -list_curves` will also display the name and description of each available elliptic curve." }, { "textRaw": "`honorCipherOrder` {boolean} Attempt to use the server's cipher suite preferences instead of the client's. When `true`, causes `SSL_OP_CIPHER_SERVER_PREFERENCE` to be set in `secureOptions`, see [OpenSSL Options][] for more information.", "name": "honorCipherOrder", "type": "boolean", "desc": "Attempt to use the server's cipher suite preferences instead of the client's. When `true`, causes `SSL_OP_CIPHER_SERVER_PREFERENCE` to be set in `secureOptions`, see [OpenSSL Options][] for more information." }, { "textRaw": "`key` {string|string[]|Buffer|Buffer[]|Object[]} Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with `options.passphrase`. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form `{pem:tls.createServer() sets the default value of the honorCipherOrder option\nto true, other APIs that create secure contexts leave it unset.
tls.createServer() uses a 128 bit truncated SHA1 hash value generated\nfrom process.argv as the default value of the sessionIdContext option, other\nAPIs that create secure contexts have no default value.
The tls.createSecureContext() method creates a SecureContext object. It is\nusable as an argument to several tls APIs, such as tls.createServer()\nand server.addContext(), but has no public methods.
A key is required for ciphers that make use of certificates. Either key or\npfx can be used to provide it.
If the ca option is not given, then Node.js will default to using\nMozilla's publicly trusted list of CAs.
Creates a new tls.Server. The secureConnectionListener, if provided, is\nautomatically set as a listener for the 'secureConnection' event.
The ticketKeys options is automatically shared between cluster module\nworkers.
The following illustrates a simple echo server:
\nconst tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n key: fs.readFileSync('server-key.pem'),\n cert: fs.readFileSync('server-cert.pem'),\n\n // This is necessary only if using client certificate authentication.\n requestCert: true,\n\n // This is necessary only if the client uses a self-signed certificate.\n ca: [ fs.readFileSync('client-cert.pem') ]\n};\n\nconst server = tls.createServer(options, (socket) => {\n console.log('server connected',\n socket.authorized ? 'authorized' : 'unauthorized');\n socket.write('welcome!\\n');\n socket.setEncoding('utf8');\n socket.pipe(socket);\n});\nserver.listen(8000, () => {\n console.log('server bound');\n});\nThe server can be tested by connecting to it using the example client from\ntls.connect().
Returns an array with the names of the supported TLS ciphers. The names are\nlower-case for historical reasons, but must be uppercased to be used in\nthe ciphers option of tls.createSecureContext().
Cipher names that start with 'tls_' are for TLSv1.3, all the others are for\nTLSv1.2 and below.
console.log(tls.getCiphers()); // ['aes128-gcm-sha256', 'aes128-sha', ...]\nAn immutable array of strings representing the root certificates (in PEM format)\nfrom the bundled Mozilla CA store as supplied by current Node.js version.
\nThe bundled CA store, as supplied by Node.js, is a snapshot of Mozilla CA store\nthat is fixed at release time. It is identical on all supported platforms.
" }, { "textRaw": "`tls.DEFAULT_ECDH_CURVE`", "name": "DEFAULT_ECDH_CURVE", "meta": { "added": [ "v0.11.13" ], "changes": [ { "version": "v10.0.0", "pr-url": "https://github.com/nodejs/node/pull/16853", "description": "Default value changed to `'auto'`." } ] }, "desc": "The default curve name to use for ECDH key agreement in a tls server. The\ndefault value is 'auto'. See tls.createSecureContext() for further\ninformation.