- Companion
- object
Value members
Inherited methods
Concrete fields
If true the TLS socket will be instantiated in server-mode. Defaults to false.
If true the TLS socket will be instantiated in server-mode. Defaults to false.
If true, specifies that the OCSP status request extension will be added to the client hello and an 'OCSPResponse' event will be emitted on the socket before establishing a secure communication
If true, specifies that the OCSP status request extension will be added to the client hello and an 'OCSPResponse' event will be emitted on the socket before establishing a secure communication
Inherited fields
An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
- Inherited from
- CommonConnectionOptions
SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).
SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).
- Inherited from
- CommonConnectionOptions
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.
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.
- Inherited from
- SecureContextOptions
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.
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.
- Inherited from
- SecureContextOptions
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.
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.
- Inherited from
- SecureContextOptions
Name of an OpenSSL engine which can provide the client certificate.
Name of an OpenSSL engine which can provide the client certificate.
- Inherited from
- SecureContextOptions
PEM formatted CRLs (Certificate Revocation Lists).
PEM formatted CRLs (Certificate Revocation Lists).
- Inherited from
- SecureContextOptions
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.
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.
- Inherited from
- SecureContextOptions
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.
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.
- Inherited from
- SecureContextOptions
When enabled, TLS packet trace information is written to stderr
. This can be
used to debug TLS connection problems.
When enabled, TLS packet trace information is written to stderr
. This can be
used to debug TLS connection problems.
- Inherited from
- CommonConnectionOptions
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
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
- Inherited from
- SecureContextOptions
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: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
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: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
- Inherited from
- SecureContextOptions
Optionally 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.
Optionally 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.
- Inherited from
- SecureContextOptions
Optionally 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.
Optionally 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.
- Inherited from
- SecureContextOptions
Shared passphrase used for a single private key and/or a PFX.
Shared passphrase used for a single private key and/or a PFX.
- Inherited from
- SecureContextOptions
PFX 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: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
PFX 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: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
- Inherited from
- SecureContextOptions
Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
- Inherited from
- SecureContextOptions
Identifier 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.
Identifier 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.
- Inherited from
- SecureContextOptions
If 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.
If 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.
- Inherited from
- CommonConnectionOptions
If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
- Inherited from
- CommonConnectionOptions
An optional TLS context object from tls.createSecureContext()
An optional TLS context object from tls.createSecureContext()
- Inherited from
- CommonConnectionOptions
Optionally 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
Optionally 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
- Inherited from
- SecureContextOptions
Legacy 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.
Legacy 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.
- Inherited from
- SecureContextOptions
Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
- Inherited from
- SecureContextOptions
The 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.
The 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.
- Inherited from
- SecureContextOptions
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).
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).
- Inherited from
- SecureContextOptions
48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
- Inherited from
- SecureContextOptions