Optional ALPNProtocolsOptional autoOptional caOptionally 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.
Optional cancellationOptional certCert 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.
Optional checkVerifies 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 theoptions.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 customoptions.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.
v0.8.4
Optional ciphersCipher 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.
Optional compressorsOptional connectOptional credentialsOptional crlPEM formatted CRLs (Certificate Revocation Lists).
Optional ecdhA 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.
Optional familyOptional hintsOptional keepOptional keepOptional keyPrivate 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:
If we are in load balancer mode.
Optional localOptional localOptional logicalOptional lookupThe maximum number of connections that may be in the process of being established concurrently by the connection pool.
The maximum amount of time a connection should remain idle in the connection pool before being marked idle.
The maximum number of connections that may be associated with a pool at a given time. This includes in use and available connections.
Optional minDHSizeThe minimum number of connections that MUST exist at any moment in a single connection pool.
Optional noOptional passphraseShared passphrase used for a single private key and/or a PFX.
Optional pfxPFX 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:
Optional proxyOptional proxyOptional proxyOptional proxyOptional rejectIf 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.
true
Optional secureAn optional TLS context object from tls.createSecureContext()
Optional secureLegacy 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.
Optional serverOptional servernameOptional sessionAn optional Buffer instance containing a TLS session.
Optional socketThe maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit.
Generated using TypeDoc
An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)