Interface MonitorOptions

Hierarchy

Properties

ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

An array of strings or a Buffer naming possible ALPN protocols.字符串数组或缓冲区,命名可能的ALPN协议。 (Protocols should be ordered by their priority.)(协议应按优先级排序。)

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

Optionally override the trusted CA certificates. (可选)覆盖受信任的CA证书。Default is to trust the well-known CAs curated by Mozilla. 默认情况是信任Mozilla策划的知名CA。Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.当使用此选项显式指定CA时,Mozilla的CA将被完全替换。

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

Cert chains in PEM format. PEM格式的证书链。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). 每个证书链应按顺序由所提供私钥的PEM格式证书组成,然后是PEM格式的中间证书(如果有的话),不包括根CA(根CA必须是对等方已知的,请参阅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, cert) => Error | undefined)

Type declaration

    • (hostname, cert): Error | undefined
    • Verifies the certificate cert is issued to hostname.验证证书cert是否颁发给hostname

      Returns Error object, populating it with reason, host, and cert on failure. 返回Error对象,在失败时用reasonhostcert填充该对象。On success, returns undefined.成功时,返回undefined

      This function is intended to be used in combination with thecheckServerIdentity option that can be passed to connect and as such operates on a certificate object. 此函数旨在与checkServerIdentity选项结合使用,该选项可传递给连接,因此可对certificate object进行操作。For other purposes, consider using x509.checkHost() instead.出于其他目的,请考虑使用x509.checkHost()

      This function can be overwritten by providing an alternative function as theoptions.checkServerIdentity option that is passed to tls.connect(). 通过提供一个替代函数作为传递给tls.connect()options.checkServerIdentity选项,可以覆盖此函数。The overwriting function can call tls.checkServerIdentity() of course, to augment the checks done with additional verification.覆盖函数当然可以调用tls.checkServerIdentity(),以通过额外的验证来增强所做的检查。

      This function is only called if the certificate passed all other checks, such as being issued by trusted CA (options.ca).只有当证书通过了所有其他检查(例如由受信任的CA(options.ca)颁发)时,才会调用此函数。

      Earlier versions of Node.js incorrectly accepted certificates for a givenhostname if a matching uniformResourceIdentifier subject alternative name was present (see CVE-2021-44531). 如果存在匹配的uniformResourceIdentifier使用者替代名称,早期版本的Node.js错误地接受了给定hostname的证书(请参阅CVE-2021-44531)。Applications that wish to acceptuniformResourceIdentifier subject alternative names can use a customoptions.checkServerIdentity function that implements the desired behavior.希望接受uniformResourceIdentifier主题替代名称的应用程序可以使用实现所需行为的自定义options.checkServerIdentity函数。

      Parameters

      • hostname: string

        The host name or IP address to verify the certificate against.用于验证证书的主机名或IP地址。

      • cert: PeerCertificate

        A certificate object representing the peer's certificate.表示对等方证书的certificate object

      Returns Error | undefined

      Since

      v0.8.4

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(). 允许的密码可以通过tls.getCiphers()获得。Cipher names must be uppercased in order for OpenSSL to accept them.密码名称必须大写,OpenSSL才能接受它们。

compressors?: ("none" | "snappy" | "zlib" | "zstd")[]
connectTimeoutMS: number
credentials?: MongoCredentials
crl?: string | Buffer | (string | Buffer)[]

PEM formatted CRLs (Certificate Revocation Lists).PEM格式的CRL(证书吊销列表)。

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. 描述命名曲线或曲线NID或名称的冒号分隔列表的字符串,例如P-521:P-384:P-256,用于ECDH键协商。Set to auto to select the curve automatically. 设置为“自动”可自动选择曲线。Use crypto.getCurves() to obtain a list of available curve names. 使用crypto.getCurves()获取可用曲线名称的列表。On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. 在最近的版本中,openssl ecparam-list_curves还将显示每个可用椭圆曲线的名称和描述。Default: tls.DEFAULT_ECDH_CURVE.默认值:tls.DEFAULT_ECDH_CURVE

family?: number
heartbeatFrequencyMS: number
hints?: number
key?: string | Buffer | (string | Buffer | KeyObject)[]

Private keys in PEM format. PEM格式的私钥。PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. PEM允许选择加密私钥。加密的键将使用可选的密码进行解密。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>]}. 使用不同算法的多个键可以作为未加密键字符串或缓冲区的数组提供,也可以作为对象的数组提供形式为 {pem: <string|buffer>[, passphrase: <string>]}The object form can only occur in an array. object.passphrase is optional. 对象形式只能出现在数组中。object.passphrase是可选的。Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.加密的键将使用object.passphrase(如果提供)进行解密,或者如果没有,则使用options.passphrase进行解密。

loadBalanced: boolean
localAddress?: string
localPort?: number
logicalSessionTimeoutMinutes?: number
lookup?: LookupFunction
metadata: ClientMetadata
minDHSize?: number
minHeartbeatFrequencyMS: number
monitorCommands: boolean
noDelay?: boolean
passphrase?: string

Shared passphrase used for a single private key and/or a PFX.用于单个私钥和/或PFX的共享密码短语。

pfx?: string | Buffer | (string | Buffer | PxfObject)[]

PFX or PKCS12 encoded private key and certificate chain. PFX或PKCS12编码的私钥和证书链。pfx is an alternative to providing key and cert individually. pfx是单独提供键和证书的替代方案。PFX is usually encrypted, if it is, passphrase will be used to decrypt it. PFX通常是加密的,如果是,密码短语将用于解密。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>]}. 多个PFX可以作为未加密PFX缓冲区的数组提供,也可以作为对象数组提供,格式为{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.object.passphrase是可选的。加密的PFX将使用object.passphrase(如果提供)进行解密,或者如果没有,则使用options.passphrase进行解密。

proxyHost?: string
proxyPassword?: string
proxyPort?: number
proxyUsername?: string
rejectUnauthorized?: boolean

If true the server will reject any connection which is not authorized with the list of supplied CAs. 如果为true,则服务器将拒绝未经所提供CA列表授权的任何连接。This option only has an effect if requestCert is true.只有当requestCerttrue时,此选项才有效。

Default

true
secureContext?: SecureContext

An optional TLS context object from tls.createSecureContext()tls.creatSecureContext()中的可选TLS上下文对象

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. 传统机制选择TLS协议版本使用,它不支持独立控制最低和最高版本,也不支持将协议限制为TLSv1.3。Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. 请改用minVersion和maxVersion。可能的值列为SSL_METHODS,将函数名用作字符串。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. 例如,使用“TLSv1_method”强制TLS版本1.1,或使用“TLS_method”允许TLSv1.3以下的任何TLS协议版本。It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. 不建议使用低于1.2的TLS版本,但可能需要使用该版本才能实现互操作性。Default: none, see minVersion.默认值:none,请参阅minVersion。

serverApi?: ServerApi
servername?: string
session?: Buffer

An optional Buffer instance containing a TLS session.包含TLS会话的可选缓冲区实例。

socketTimeoutMS?: number
tls: boolean

Generated using TypeDoc