View Source KafkaEx.Auth.SASL.Codec behaviour (kafka_ex v0.15.0)

Behaviour defining the codec interface for SASL protocol messages.

Implementations must handle:

Building request frames (API versions, handshake, authenticate)
Parsing response frames with correlation ID validation
Selecting optimal protocol versions based on broker capabilities

This abstraction allows for different encoding strategies while maintaining a consistent interface for the SASL authentication flow.

Summary

Types

api_versions_map()

error()

Callbacks

api_versions_request(corr, version, client_id)

authenticate_request(auth_bytes, corr, version, client_id)

handshake_request(mechanism, corr, version, client_id)

parse_api_versions_response(data, expected_corr)

parse_authenticate_response(data, expected_corr, version)

parse_handshake_response(data, expected_corr, mechanism, version)

pick_authenticate_version(api_versions)

pick_handshake_version(api_versions)

Types

api_versions_map()

@type api_versions_map() :: %{required(integer()) => {integer(), integer()}}

error()

@type error() :: {:error, term()}

Callbacks

api_versions_request(corr, version, client_id)

@callback api_versions_request(
  corr :: integer(),
  version :: integer(),
  client_id :: binary()
) :: binary()

authenticate_request(auth_bytes, corr, version, client_id)

@callback authenticate_request(
  auth_bytes :: binary() | nil,
  corr :: integer(),
  version :: integer(),
  client_id :: binary()
) :: binary()

handshake_request(mechanism, corr, version, client_id)

@callback handshake_request(
  mechanism :: binary(),
  corr :: integer(),
  version :: integer(),
  client_id :: binary()
) :: binary()

parse_api_versions_response(data, expected_corr)

@callback parse_api_versions_response(data :: binary(), expected_corr :: integer()) ::
  api_versions_map() | error()

parse_authenticate_response(data, expected_corr, version)

@callback parse_authenticate_response(
  data :: binary(),
  expected_corr :: integer(),
  version :: integer()
) ::
  {:ok, binary() | nil} | error()

parse_handshake_response(data, expected_corr, mechanism, version)

@callback parse_handshake_response(
  data :: binary(),
  expected_corr :: integer(),
  mechanism :: binary(),
  version :: integer()
) :: :ok | error()

pick_authenticate_version(api_versions)

@callback pick_authenticate_version(api_versions :: api_versions_map() | error()) ::
  non_neg_integer()

pick_handshake_version(api_versions)

@callback pick_handshake_version(api_versions :: api_versions_map() | error()) ::
  non_neg_integer()