ServerTLSSettings class

Set of TLS related options that govern the server's behavior.

Constructors

ServerTLSSettings({String? caCertificates, List<String>? cipherSuites, String? credentialName, bool? httpsRedirect, TlsProtocol? minProtocolVersion, TlsProtocol? maxProtocolVersion, required TlsMode mode, String? privateKey, String? serverCertificate, List<String>? subjectAltNames, List<String>? verifyCertificateHash, List<String>? verifyCertificateSpki})

The main constructor.

const

ServerTLSSettings.fromJson(Map<String, dynamic> json)

Creates a ServerTLSSettings from JSON data.

Properties

caCertificates → String?

REQUIRED if mode is TlsMode.mutual.

final

cipherSuites → List<String>?

Optional: If specified, only support the specified cipher list.

final

credentialName → String?

For gateways running on Kubernetes, the name of the secret that holds the TLS certs including the CA certificates.

final

hashCode → int

The hash code for this object.

no setter, inherited

httpsRedirect → bool?

If set to true, the load balancer will send a 301 redirect for all http connections, asking the clients to use HTTPS.

final

maxProtocolVersion → TlsProtocol?

Optional: Maximum TLS protocol version.

final

minProtocolVersion → TlsProtocol?

Optional: Maximum TLS protocol version.

final

mode → TlsMode

Optional: Indicates whether connections to this port should be secured using TLS. The value of this field determines how TLS is enforced.

final

privateKey → String?

REQUIRED if mode is TlsMode.simple or TlsMode.mutual.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serverCertificate → String?

REQUIRED if mode is TlsMode.simple or TlsMode.mutual. The path to the file holding the server-side TLS certificate to use.

final

subjectAltNames → List<String>?

A list of alternate names to verify the subject identity in the certificate presented by the client.

final

verifyCertificateHash → List<String>?

An optional list of hex-encoded SHA-256 hashes of the authorized client certificates. Both simple and colon separated formats are acceptable.

final

verifyCertificateSpki → List<String>?

An optional list of base64-encoded SHA-256 hashes of the SKPIs of authorized client certificates.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited