Skip to content

Commit

Permalink
docs(review): edits to doc from review by MS (moves section)
Browse files Browse the repository at this point in the history
Signed-off-by: prmellor <[email protected]>
  • Loading branch information
PaulRMellor committed Aug 30, 2024
1 parent ce2bde0 commit 19ddb56
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions documentation/modules/oauth/con-oauth-authentication-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,6 @@ Specify SASL mechanisms in the client configuration:
* `OAUTHBEARER` for credentials exchange using a bearer token
* `PLAIN` to pass client credentials (clientId + secret) or an access token

.SASL extensions for custom `OAUTHBEARER` implementations

If your Kafka broker uses a custom `OAUTHBEARER` implementation, you may need to pass additional SASL extension options.
These extensions can include attributes or information required as client context by the authorization server.
The options are passed as key-value pairs and are sent to the Kafka broker when a new session is started.

Pass SASL extension values using `oauth.sasl.extension.` as a key prefix.

.Example configuration to pass SASL extension values
[source,properties]
----
oauth.sasl.extension.key1="value1"
oauth.sasl.extension.key2="value2"
----

.Configuring a JAAS module

Specify a JAAS module that implements the SASL authentication mechanism as a `sasl.jaas.config` property value:
Expand Down Expand Up @@ -238,3 +223,18 @@ sasl.login.callback.handler.class=io.strimzi.kafka.oauth.client.JaasClientOauthL
<2> (Optional) Client secret created when creating the _client_ in the authorization server.
<3> Long-lived refresh token for Kafka clients.

.SASL extensions for custom `OAUTHBEARER` implementations

If your Kafka broker uses a custom `OAUTHBEARER` implementation, you may need to pass additional SASL extension options.
These extensions can include attributes or information required as client context by the authorization server.
The options are passed as key-value pairs and are sent to the Kafka broker when a new session is started.

Pass SASL extension values using `oauth.sasl.extension.` as a key prefix.

.Example configuration to pass SASL extension values
[source,properties]
----
oauth.sasl.extension.key1="value1"
oauth.sasl.extension.key2="value2"
----

0 comments on commit 19ddb56

Please sign in to comment.