driver/io.github.octaviusframework.driver.auth/ChannelBinding

ChannelBinding

enum ChannelBinding : Enum<ChannelBinding>

How hard the driver insists on binding the SCRAM exchange to the TLS channel underneath it.

Channel binding stops an intermediary from relaying an authentication exchange it cannot compute a proof for: the client proof covers a hash of the certificate the server presented, so a proxy that terminates TLS with a certificate of its own produces a proof the real server rejects. It earns its keep under sslmode=require, where the connection is encrypted but nothing checks who is on the other end of it.

Entries

DISABLE

Never offer channel binding; the exchange declares no support for it.

PREFER

Bind when the connection is encrypted and the server offers it, carry on when not. Default.

REQUIRE

Refuse to authenticate at all unless the exchange is bound to the TLS channel.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<ChannelBinding>

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

Functions

valueOf

fun valueOf(value: String): ChannelBinding

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<ChannelBinding>

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