Properties

Link copied to clipboard
abstract var allowHalfOpen: Boolean?

Indicates whether half-opened TCP connections are allowed.

Link copied to clipboard

If 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.

Link copied to clipboard
abstract var ALPNProtocols: Any?

An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

Link copied to clipboard
abstract var ca: Any?

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.

Link copied to clipboard
abstract var cert: Any?

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.

Link copied to clipboard
abstract var 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.

Link copied to clipboard
abstract var clientCertEngine: String?

Name of an OpenSSL engine which can provide the client certificate.

Link copied to clipboard
abstract var crl: Any?

PEM formatted CRLs (Certificate Revocation Lists).

Link copied to clipboard
abstract var dhparam: Any?

'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.

Link copied to clipboard
abstract var 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.

Link copied to clipboard
abstract var enableTrace: Boolean?

When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

Link copied to clipboard
abstract var handshakeTimeout: Double?

Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds).

Link copied to clipboard
abstract var 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

Link copied to clipboard
abstract var keepAlive: Boolean?

If set to true, it enables keep-alive functionality on the socket immediately after a new incoming connection is received, similarly on what is done in socket.setKeepAlive([enable][, initialDelay]).

Link copied to clipboard

If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.

Link copied to clipboard
abstract var key: Any?

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: , passphrase: }. 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.

Link copied to clipboard
abstract var maxVersion: SecureVersion?

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.

Link copied to clipboard
abstract var minVersion: SecureVersion?

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.

Link copied to clipboard
abstract var noDelay: Boolean?

If set to true, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.

Link copied to clipboard
abstract var passphrase: String?

Shared passphrase used for a single private key and/or a PFX.

Link copied to clipboard
abstract var pauseOnConnect: Boolean?

Indicates whether the socket should be paused on incoming connections.

Link copied to clipboard
abstract var pfx: Any?

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: , passphrase: }. 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.

Link copied to clipboard
abstract var privateKeyEngine: String?

Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.

Link copied to clipboard

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.

Link copied to clipboard
abstract val pskCallback: (socket: TLSSocket, identity: String) -> Any??
Link copied to clipboard
abstract var pskIdentityHint: String?

hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint tlsClientError will be emitted with ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED code.

Link copied to clipboard

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.

Link copied to clipboard
abstract var requestCert: Boolean?

If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

Link copied to clipboard

An optional TLS context object from tls.createSecureContext()

Link copied to clipboard
abstract var secureOptions: Double?

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

Link copied to clipboard
abstract var secureProtocol: String?

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.

Link copied to clipboard
abstract var sessionIdContext: String?

Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.

Link copied to clipboard
abstract override var sessionTimeout: Double?

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.

Link copied to clipboard
abstract var 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).

Link copied to clipboard
abstract var SNICallback: (servername: String, cb: (JsError?, ctx: SecureContext?) -> Unit) -> Unit?

SNICallback(servername, cb) 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).

Link copied to clipboard
abstract override var ticketKeys: Buffer?

48-bytes of cryptographically strong pseudo-random data.