View Source KlifeProtocol.Messages.CreateDelegationToken (Klife Protocol v0.5.0)

Kafka protocol CreateDelegationToken message

Request versions summary:

  • Version 1 is the same as version 0.
  • Version 2 is the first flexible version.
  • Version 3 adds owner principal

Response versions summary:

  • Starting in version 1, on quota violation, brokers send out responses before throttling.
  • Version 2 is the first flexible version.
  • Version 3 adds token requester details

Link to this section Summary

Functions

Returns the message api key number.

Receive a binary in the kafka wire format and deserialize it into a map.

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Receives a map and serialize it to kafka wire format of the given version.

Link to this section Functions

Returns the message api key number.

Link to this function

deserialize_response(data, version, with_header? \\ true)

View Source

Receive a binary in the kafka wire format and deserialize it into a map.

Response content fields:

  • error_code: The top-level error, or zero if there was no error. (int16 | versions 0+)

  • principal_type: The principal type of the token owner. (string | versions 0+)

  • principal_name: The name of the token owner. (string | versions 0+)

  • token_requester_principal_type: The principal type of the requester of the token. (string | versions 3+)

  • token_requester_principal_name: The principal type of the requester of the token. (string | versions 3+)

  • issue_timestamp_ms: When this token was generated. (int64 | versions 0+)

  • expiry_timestamp_ms: When this token expires. (int64 | versions 0+)

  • max_timestamp_ms: The maximum lifetime of this token. (int64 | versions 0+)

  • token_id: The token UUID. (string | versions 0+)

  • hmac: HMAC of the delegation token. (bytes | versions 0+)

  • throttle_time_ms: The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota. (int32 | versions 0+)

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Link to this function

serialize_request(map, version)

View Source

Receives a map and serialize it to kafka wire format of the given version.

Input content fields:

  • owner_principal_type: The principal type of the owner of the token. If it's null it defaults to the token request principal. (string | versions 3+)

  • owner_principal_name: The principal name of the owner of the token. If it's null it defaults to the token request principal. (string | versions 3+)

  • renewers: A list of those who are allowed to renew this token before it expires. ([]CreatableRenewers | versions 0+)

    • principal_type: The type of the Kafka principal. (string | versions 0+)

    • principal_name: The name of the Kafka principal. (string | versions 0+)

  • max_lifetime_ms: The maximum lifetime of the token in milliseconds, or -1 to use the server side default. (int64 | versions 0+)