TlsSettings interface
Represents a certificate for TLS authentication.
Properties
| ca | 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 | 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. |
| key | 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 |
| passphrase | Shared passphrase used for a single private key and/or a PFX. |
| pfx | 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 |
Property Details
ca
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.
ca?: string | Buffer | (string | Buffer)[]Property Value
string | Buffer | (string | Buffer)[]
cert
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.
cert?: string | Buffer | (string | Buffer)[]Property Value
string | Buffer | (string | Buffer)[]
key
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.
key?: string | Buffer | (KeyObject | Buffer)[]Property Value
string | Buffer | (KeyObject | Buffer)[]
passphrase
Shared passphrase used for a single private key and/or a PFX.
passphrase?: stringProperty Value
string
pfx
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.
pfx?: string | Buffer | (string | Buffer | PxfObject)[]Property Value
string | Buffer | (string | Buffer | PxfObject)[]