OptionalALPNCallbackIf set, this will be called when a client opens a connection using the ALPN extension.
One argument will be passed to the callback: an object containing servername and protocols fields,
respectively containing the server name from the SNI extension (if any) and an array of
ALPN protocol name strings. The callback must return either one of the strings listed in protocols,
which will be returned to the client as the selected ALPN protocol, or undefined,
to reject the connection with a fatal alert. If a string is returned that does not match one of
the client's ALPN protocols, an error will be thrown.
This option cannot be used with the ALPNProtocols option, and setting both options will throw an error.
OptionalALPNProtocolsAn array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
OptionalSNICallbackSNICallback(servername, cb)
OptionalautoOptionalautoOptionalcaOptionally 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.
OptionalcertCert 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.
OptionalcheckVerifies the certificate cert is issued to hostname.
Returns Error object, populating it with reason, host, and cert on
failure. On success, returns undefined.
This function is intended to be used in combination with thecheckServerIdentity option that can be passed to connect and as
such operates on a certificate object. For other purposes, consider using x509.checkHost() instead.
This function can be overwritten by providing an alternative function as the options.checkServerIdentity option that is passed to tls.connect(). The
overwriting function can call tls.checkServerIdentity() of course, to augment
the checks done with additional verification.
This function is only called if the certificate passed all other checks, such as
being issued by trusted CA (options.ca).
Earlier versions of Node.js incorrectly accepted certificates for a givenhostname if a matching uniformResourceIdentifier subject alternative name
was present (see CVE-2021-44531). Applications that wish to acceptuniformResourceIdentifier subject alternative names can use
a custom options.checkServerIdentity function that implements the desired behavior.
The host name or IP address to verify the certificate against.
A certificate object representing the peer's certificate.
OptionalciphersCipher 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.
OptionalclientName of an OpenSSL engine which can provide the client certificate.
OptionalcrlPEM formatted CRLs (Certificate Revocation Lists).
Optionaldhparam'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy.
If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
ECDHE-based perfect forward secrecy will still be available.
OptionalecdhA 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.
OptionalenableWhen enabled, TLS packet trace information is written to stderr. This can be
used to debug TLS connection problems.
OptionalfamilyOptionalhintsOptionalhonorAttempt 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
OptionalhostOptionalkeepKeep sockets around in a pool to be used by other requests in the future. Default = false
OptionalkeepOptionalkeepWhen using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.
OptionalkeyPrivate 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: <string|buffer>[,
passphrase:
OptionallocalOptionallocalOptionallookupOptionalmaxOptionalmaxMaximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.
OptionalmaxMaximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity
OptionalmaxMaximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.
OptionalmaxOptionally set the maximum TLS version to allow. One
of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the
secureProtocol option, use one or the other.
Default: 'TLSv1.3', unless changed using CLI options. Using
--tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to
'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.
OptionalminDHSizeOptionalminOptionally set the minimum TLS version to allow. One
of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the
secureProtocol option, use one or the other. It is not recommended to use
less than TLSv1.2, but it may be required for interoperability.
Default: 'TLSv1.2', unless changed using CLI options. Using
--tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to
'TLSv1.1'. Using --tls-min-v1.3 sets the default to
'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
OptionalnoOptionalonreadIf specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.
OptionalpassphraseShared passphrase used for a single private key and/or a PFX.
OptionalpathOptionalpfxPFX or PKCS12 encoded private key and certificate chain. pfx is an
alternative to providing key and cert individually. PFX is usually
encrypted, if it is, passphrase will be used to decrypt it. Multiple
PFX can be provided either as an array of unencrypted PFX buffers,
or an array of objects in the form {buf: <string|buffer>[,
passphrase:
OptionalportOptionalprivateName of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
OptionalprivateIdentifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
OptionalrejectIf true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
OptionalrequestIf true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
OptionalschedulingScheduling strategy to apply when picking the next free socket to use.
OptionalsecureAn optional TLS context object from tls.createSecureContext()
OptionalsecureOptionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
OptionalsecureLegacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
OptionalservernameOptionalsessionOptionalsessionOpaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
OptionalsessionThe number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
OptionalsigalgsColon-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).
OptionalsocketOptionalticket48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
OptionaltimeoutSocket timeout in milliseconds. This will set the timeout after the socket is connected.
OptionalpskWhen negotiating TLS-PSK (pre-shared keys), this function is called
with optional identity hint provided by the server or null
in case of TLS 1.3 where hint was removed.
It will be necessary to provide a custom tls.checkServerIdentity()
for the connection as the default one will try to check hostname/IP
of the server against the certificate but that's not applicable for PSK
because there won't be a certificate present.
More information can be found in the RFC 4279.
message sent from the server to help client
decide which identity to use during negotiation.
Always null if TLS 1.3 is used.
Return null to stop the negotiation process. psk must be
compatible with the selected cipher's digest.
identity must use UTF-8 encoding.
Make all properties in T optional