Module: Rdkafka::Helpers::OAuth

Included in:
Admin, Consumer, Producer
Defined in:
lib/rdkafka/helpers/oauth.rb

Instance Method Summary collapse

Instance Method Details

#oauthbearer_set_token(token:, lifetime_ms:, principal_name:, extensions: nil) ⇒ Integer

Set the OAuthBearer token

Parameters:

  • token (String) —

    the mandatory token value to set, often (but not necessarily) a JWS compact serialization as per https://tools.ietf.org/html/rfc7515#section-3.1.

  • lifetime_ms (Integer) —

    when the token expires, in terms of the number of milliseconds since the epoch. See https://currentmillis.com/.

  • principal_name (String) —

    the mandatory Kafka principal name associated with the token.

  • extensions (Hash) (defaults to: nil) —

    optional SASL extensions key-value pairs to be communicated to the broker as additional key-value pairs during the initial client response as per https://tools.ietf.org/html/rfc7628#section-3.1.

Returns:

  • (Integer) —

    0 on success



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rdkafka/helpers/oauth.rb', line 13

def oauthbearer_set_token(token:, lifetime_ms:, principal_name:, extensions: nil)
  error_buffer = FFI::MemoryPointer.from_string(" " * 256)
  extensions_ptr, extensions_str_ptrs = map_extensions(extensions)

  begin
    response = @native_kafka.with_inner do |inner|
      Rdkafka::Bindings.rd_kafka_oauthbearer_set_token(
        inner, token, lifetime_ms, principal_name,
        extensions_ptr, extension_size(extensions), error_buffer, 256
      )
    end
  ensure
    extensions_str_ptrs&.each { |ptr| ptr.free }
    extensions_ptr&.free
  end

  return response if response == Rdkafka::Bindings::RD_KAFKA_RESP_ERR_NO_ERROR

  oauthbearer_set_token_failure("Failed to set token: #{error_buffer.read_string}")

  response
end

#oauthbearer_set_token_failure(reason) ⇒ Object

Marks failed oauth token acquire in librdkafka

Parameters:

  • reason (String) —

    human readable error reason for failing to acquire token



39
40
41
42
43
44
45
46
 
# File 'lib/rdkafka/helpers/oauth.rb', line 39

def oauthbearer_set_token_failure(reason)
  @native_kafka.with_inner do |inner|
    Rdkafka::Bindings.rd_kafka_oauthbearer_set_token_failure(
      inner,
      reason
    )
  end
end