Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExtraTlsOptions

Additional options that can be passed to the connect function affecting the underlying TLS configuratio. These options are passed directly to tls.createSecureContext(). For more information, see the documentation for the tls.createSecureContext() function in the Node.js documentation.

Hierarchy

  • ExtraTlsOptions

Index

Properties

Optional ca

ca: string | Uint8Array | Array<string | Uint8Array> | undefined

Optionally override the trusted CA certificates.

Optional cert

cert: string | Uint8Array | Array<string | Uint8Array> | undefined

Cert chains in PEM format.

Optional ciphers

ciphers: string | undefined

Cipher suite specification, replacing the default.

Optional clientCertEngine

clientCertEngine: string | undefined

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

Optional crl

crl: string | Uint8Array | Array<string | Uint8Array> | undefined

PEM formatted CRLs (Certificate Revocation Lists).

Optional dhparam

dhparam: string | Uint8Array | undefined

Diffie Hellman parameters, required for Perfect Forward Secrecy.

Optional ecdhCurve

ecdhCurve: string | undefined

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.

Optional honorCipherOrder

honorCipherOrder: boolean | undefined

Attempt to use the server's cipher suite preferences instead of the client's.

Optional key

key: string | Uint8Array | Uint8Array[] | undefined

Private keys in PEM format.

Optional passphrase

passphrase: string | undefined

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

Optional pfx

pfx: string | Uint8Array | Array<string | Uint8Array> | undefined

PFX or PKCS12 encoded private key and certificate chain.

Optional rejectUnauthorized

rejectUnauthorized: boolean | undefined

If true the server will reject any connection which is not authorized with the list of supplied CAs.

Optional secureOptions

secureOptions: number | undefined

Optionally affect the OpenSSL protocol behavior, which is not usually necessary.

Optional secureProtocol

secureProtocol: string | undefined

Legacy mechanism to select the TLS protocol version to use.

Optional sessionIdContext

sessionIdContext: string | undefined

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