Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorOptions

Hierarchy继承层级

Index索引

Properties属性

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

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

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

Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. 可选地覆盖受信任的CA证书。默认设置是信任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. One cert chain should be provided per private key. PEM格式的证书链。每个私钥应提供一个证书链。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: string, cert: PeerCertificate) => Error | undefined

Type declaration类型声明

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

      Returns Error object, populating it with reason, host, and cert on failure. On success, returns 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选项结合使用,该选项可以传递给连接,因此可以在证书对象上运行。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(). The overwriting function can call tls.checkServerIdentity() of course, to augment the checks done with additional verification.

      This function is only called if the certificate passed all other checks, such as being issued by trusted 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). Applications that wish to acceptuniformResourceIdentifier subject alternative names can use a customoptions.checkServerIdentity function that implements the desired behavior.

      since

      v0.8.4

      Parameters参数

      • hostname: string

        The host name or IP address to verify the certificate against.

      • cert: PeerCertificate

        A certificate object representing the peer's certificate.

      Returns 返回 Error | undefined

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.

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

PEM formatted CRLs (Certificate Revocation Lists).

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.

family?: number
heartbeatFrequencyMS: number
hints?: number
keepAlive?: boolean
keepAliveInitialDelay?: number
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: ]}. 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.

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 is an alternative to providing key and cert individually. PFX或PKCS12编码的私钥和证书链。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. 对象形式只能出现在数组中。objectpassphrase是可选的。Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.加密的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,则服务器将拒绝未经授权的任何连接。This option only has an effect if requestCert is true.此选项仅在requestCert为true时有效。

default

true

secureContext?: SecureContext

An optional TLS context object from tls.createSecureContext()tls.createSecurityContext()中的可选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. 请改用minVersion和maxVersion。The possible values are listed as SSL_METHODS, use the function names as strings. 可能的值列为SSL_METHOD,使用函数名作为字符串。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_1_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版本,但为了实现互操作性,可能需要使用TLS版本。Default: none, see minVersion.默认值:无,请参阅minVersion。

serverApi?: ServerApi
servername?: string
session?: Buffer
socketTimeoutMS?: number
tls: boolean

Generated using TypeDoc