GitHub

TlsUpgradeOptions

API reference for TlsUpgradeOptions.

How to upgrade a connection to TLS. key and cert (PEM) go together; a server needs both. servername is the client's SNI name and the name its certificate check expects; without it, a client checks the host name it connected to, else localhost (for an IP literal, a Unix or an adopted socket), as Node does.

Attributes

AttributeTypeDescription
servernamestr | None = None
keyRedacted[PemInput] | Sequence[Redacted[PemInput]] | None = None
certPemInput | Sequence[PemInput] | None = None
caPemInput | Sequence[PemInput] | None = None
passphraseRedacted[str] | None = None
alpn_protocolsSequence[str] | None = None
request_certbool | None = None
reject_unauthorizedbool | None = None

Functions

__init__

__init__(*, servername=None, key=None, cert=None, ca=None, passphrase=None, alpn_protocols=None, request_cert=None, reject_unauthorized=None) -> None
ParameterTypeDescription
servernamestr | None = None
keyRedacted[PemInput] | Sequence[Redacted[PemInput]] | None = None
certPemInput | Sequence[PemInput] | None = None
caPemInput | Sequence[PemInput] | None = None
passphraseRedacted[str] | None = None
alpn_protocolsSequence[str] | None = None
request_certbool | None = None
reject_unauthorizedbool | None = None