http2.SecureClientSessionOptions

interface SecureClientSessionOptions

• allowPartialTrustChain?: boolean

  Treat intermediate (non-self-signed) certificates in the trust CA certificate list as trusted.

• ALPNCallback?: (arg: { protocols: string[]; servername: string }) => undefined | string

  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.

• ALPNProtocols?: Uint8Array<ArrayBufferLike> | string[] | Uint8Array<ArrayBufferLike>[]

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

• ca?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike>[]

  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.

• cert?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike>[]

  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.

• checkServerIdentity?: (hostname: string, cert: PeerCertificate) => undefined | Error
• 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.

• createConnection?: (authority: URL, option: SessionOptions) => Duplex

  An optional callback that receives the URL instance passed to connect and the options object, and returns any Duplex stream that is to be used as the connection for this session.

• crl?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike>[]

  PEM formatted CRLs (Certificate Revocation Lists).

• dhparam?: string | Buffer<ArrayBufferLike>

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

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

• enableTrace?: boolean

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

• 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

• host?: string
• key?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike> | KeyObject[]

  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.

• lookup?: LookupFunction
• maxDeflateDynamicTableSize?: number

  Sets the maximum dynamic table size for deflating header fields.

• maxHeaderListPairs?: number

  Sets the maximum number of header entries. This is similar to server.maxHeadersCount or request.maxHeadersCount in the node:http module. The minimum value is 1.

• maxOutstandingPings?: number

  Sets the maximum number of outstanding, unacknowledged pings.

• maxReservedRemoteStreams?: number

  Sets the maximum number of reserved push streams the client will accept at any given time. Once the current number of currently reserved push streams exceeds reaches this limit, new push streams sent by the server will be automatically rejected. The minimum allowed value is 0. The maximum allowed value is 2³²-1. A negative value sets this option to the maximum allowed value.

• maxSendHeaderBlockLength?: number

  Sets the maximum allowed size for a serialized, compressed block of headers. Attempts to send headers that exceed this limit will result in a 'frameError' event being emitted and the stream being closed and destroyed.

• maxSessionMemory?: number

  Sets the maximum memory that the Http2Session is permitted to use. The value is expressed in terms of number of megabytes, e.g. 1 equal 1 megabyte. The minimum value allowed is 1. This is a credit based limit, existing Http2Streams may cause this limit to be exceeded, but new Http2Stream instances will be rejected while this limit is exceeded. The current number of Http2Stream sessions, the current memory use of the header compression tables, current data queued to be sent, and unacknowledged PING and SETTINGS frames are all counted towards the current limit.

• maxSettings?: number

  Sets the maximum number of settings entries per SETTINGS frame. The minimum value allowed is 1.

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

• minDHSize?: number
• 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.

• paddingStrategy?: number

  Strategy used for determining the amount of padding to use for HEADERS and DATA frames.

• passphrase?: string

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

• path?: string
• peerMaxConcurrentStreams?: number

  Sets the maximum number of concurrent streams for the remote peer as if a SETTINGS frame had been received. Will be overridden if the remote peer sets its own value for maxConcurrentStreams.

• pfx?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike> | PxfObject[]

  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.

• port?: number
• protocol?: 'http:' | 'https:'

  The protocol to connect with, if not set in the authority. Value may be either 'http:' or 'https:'.

• rejectUnauthorized?: boolean

  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.

• remoteCustomSettings?: number[]

  The array of integer values determines the settings types, which are included in the CustomSettings-property of the received remoteSettings. Please see the CustomSettings-property of the Http2Settings object for more information, on the allowed setting types.

• requestCert?: boolean

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

• secureContext?: SecureContext

  An optional TLS context object from tls.createSecureContext()

• secureOptions?: number

  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

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

• servername?: string
• session?: Buffer<ArrayBufferLike>
• sessionIdContext?: string

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

• sessionTimeout?: number

  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.

• settings?: Settings

  The initial settings to send to the remote peer upon connection.

• 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).

• SNICallback?: (servername: string, cb: (err: null | Error, ctx?: SecureContext) => void) => void

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

• socket?: Duplex
• ticketKeys?: Buffer<ArrayBufferLike>

  48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.

• timeout?: number
• unknownProtocolTimeout?: number

  Specifies a timeout in milliseconds that a server should wait when an ['unknownProtocol'][] is emitted. If the socket has not been destroyed by that time the server will destroy it.

• pskCallback(

  hint: null | string

  ): null | PSKCallbackNegotation;

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

  @param hint

  message sent from the server to help client decide which identity to use during negotiation. Always null if TLS 1.3 is used.

  @returns

  Return null to stop the negotiation process. psk must be compatible with the selected cipher's digest. identity must use UTF-8 encoding.