driver/io.github.octaviusframework.driver.ssl/SslMode

SslMode

How much protection the connection demands of its transport, in PostgreSQL's own vocabulary.

The modes form a ladder, and the rung that matters is between REQUIRE and VERIFY_CA: everything below VERIFY_CA encrypts the connection without establishing who is on the other end of it, which an intermediary can satisfy with a certificate of its own. ChannelBinding is what closes that gap without a certificate chain to check against.

Entries

DISABLE

Never encrypt. A server that demands TLS refuses the connection.

PREFER

Encrypt if the server offers it, connect in the clear if not. The default.

REQUIRE

Refuse to connect unencrypted. The certificate itself is not checked.

VERIFY_CA

Encrypt, and verify the server's certificate chains to a trusted CA. Needs sslrootcert.

VERIFY_FULL

As VERIFY_CA, and additionally require the certificate to name the host being connected to.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<SslMode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

value

val value: String

The spelling used in a JDBC URL and by libpq.

Functions

valueOf

fun valueOf(value: String): SslMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<SslMode>

Returns an array containing the constants of this enum type, in the order they're declared.