# Interface ClientOptions

#### Hierarchy

- SecureContextOptions
  - ClientOptions

#####
Index

### Properties

ALPNCallback?
agent?
ca?
cert?
ciphers?
clientCertEngine?
crl?
dhparam?
ecdhCurve?
family?
followRedirects?
handshakeTimeout?
headers?
honorCipherOrder?
host?
key?
localAddress?
maxPayload?
maxRedirects?
maxVersion?
minVersion?
origin?
passphrase?
perMessageDeflate?
pfx?
privateKeyEngine?
privateKeyIdentifier?
protocol?
protocolVersion?
rejectUnauthorized?
secureOptions?
secureProtocol?
sessionIdContext?
sessionTimeout?
sigalgs?
skipUTF8Validation?
ticketKeys?

### Methods

checkServerIdentity?
generateMask?

## Properties

### `Optional` ALPNCallback

ALPNCallback?: ((arg) => undefined | string)

#### Type declaration

- - (arg): 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.

    #### Parameters

    - ##### arg: {
      protocols: string[];
      servername: string;
      }

      - ##### protocols: string[]

      - ##### servername: string

    #### Returns undefined | string

Inherited from SecureContextOptions.ALPNCallback

### `Optional` agent

agent?: Agent

### `Optional` ca

ca?: string | Buffer | (string | Buffer)[]

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

### `Optional` cert

cert?: string | Buffer | (string | Buffer)[]

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

### `Optional` ciphers

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.

Inherited from SecureContextOptions.ciphers

### `Optional` clientCertEngine

clientCertEngine?: string

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

Inherited from SecureContextOptions.clientCertEngine

### `Optional` crl

crl?: string | Buffer | (string | Buffer)[]

PEM formatted CRLs (Certificate Revocation Lists).

Inherited from SecureContextOptions.crl

### `Optional` dhparam

dhparam?: string | Buffer

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

Inherited from SecureContextOptions.dhparam

### `Optional` ecdhCurve

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.

Inherited from SecureContextOptions.ecdhCurve

### `Optional` family

family?: number

### `Optional` followRedirects

followRedirects?: boolean

### `Optional` handshakeTimeout

handshakeTimeout?: number

### `Optional` headers

headers?: {
[key: string]: string;
}

#### Type declaration

- ##### [key: string]: string

### `Optional` honorCipherOrder

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

Inherited from SecureContextOptions.honorCipherOrder

### `Optional` host

host?: string

### `Optional` key

key?: string | Buffer | (string | Buffer | 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.

Inherited from SecureContextOptions.key

### `Optional` localAddress

localAddress?: string

### `Optional` maxPayload

maxPayload?: number

### `Optional` maxRedirects

maxRedirects?: number

### `Optional` maxVersion

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.

Inherited from SecureContextOptions.maxVersion

### `Optional` minVersion

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.

Inherited from SecureContextOptions.minVersion

### `Optional` origin

origin?: string

### `Optional` passphrase

passphrase?: string

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

Inherited from SecureContextOptions.passphrase

### `Optional` perMessageDeflate

perMessageDeflate?: boolean | PerMessageDeflateOptions

### `Optional` pfx

pfx?: string | Buffer | (string | Buffer | 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.

Inherited from SecureContextOptions.pfx

### `Optional` privateKeyEngine

privateKeyEngine?: string

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

Inherited from SecureContextOptions.privateKeyEngine

### `Optional` privateKeyIdentifier

privateKeyIdentifier?: string

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

### `Optional` protocol

protocol?: string

### `Optional` protocolVersion

protocolVersion?: number

### `Optional` rejectUnauthorized

rejectUnauthorized?: boolean

### `Optional` secureOptions

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

Inherited from SecureContextOptions.secureOptions

### `Optional` secureProtocol

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.

Inherited from SecureContextOptions.secureProtocol

### `Optional` sessionIdContext

sessionIdContext?: string

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

Inherited from SecureContextOptions.sessionIdContext

### `Optional` sessionTimeout

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.

Inherited from SecureContextOptions.sessionTimeout

### `Optional` sigalgs

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

Inherited from SecureContextOptions.sigalgs

### `Optional` skipUTF8Validation

skipUTF8Validation?: boolean

### `Optional` ticketKeys

ticketKeys?: Buffer

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

Inherited from SecureContextOptions.ticketKeys

## Methods

### `Optional` checkServerIdentity

- checkServerIdentity(servername, cert): boolean

- #### Parameters

  - ##### servername: string

  - ##### cert: CertMeta

  #### Returns boolean

### `Optional` generateMask

- generateMask(mask): void

- #### Parameters

  - ##### mask: Buffer

  #### Returns void

Generated using TypeDoc