View Source KafkaEx.Auth.SASL.VersionSupport (kafka_ex v1.0.0-rc.1)
Version compatibility checker for SASL authentication.
With the Kayrock-based client, API version negotiation is handled automatically. This module provides SASL validation to ensure proper configuration.
Support Matrix
| Feature | Support |
|---|---|
| SASL/PLAIN | ✅ |
| API Versions | ✅ |
| SCRAM-SHA | ✅ |
Note: SASL/PLAIN requires SSL/TLS for security.
Summary
Functions
Returns whether to check API versions during SASL handshake.
Returns the SASL support level.
Validates SASL configuration against server capabilities. Returns :ok or an error tuple with a descriptive message.
Types
@type support_level() :: :full
Functions
@spec check_api_versions?() :: boolean()
Returns whether to check API versions during SASL handshake.
Always returns true with the Kayrock-based client.
@spec sasl_support_level() :: support_level()
Returns the SASL support level.
With the Kayrock-based client, full SASL support is available. API version negotiation is handled automatically by the client.
@spec validate_config(KafkaEx.Auth.Config.t(), KafkaEx.Network.Socket.t()) :: :ok | {:error, term()}
Validates SASL configuration against server capabilities. Returns :ok or an error tuple with a descriptive message.
Currently validates:
- PLAIN mechanism requires TLS for security