io.strimzi.kafka.oauth.server

Class OAuthKafkaPrincipalBuilder

java.lang.Object

org.apache.kafka.common.security.authenticator.DefaultKafkaPrincipalBuilder

io.strimzi.kafka.oauth.server.OAuthKafkaPrincipalBuilder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.kafka.common.Configurable, org.apache.kafka.common.security.auth.KafkaPrincipalBuilder, org.apache.kafka.common.security.auth.KafkaPrincipalSerde

public class OAuthKafkaPrincipalBuilder
extends org.apache.kafka.common.security.authenticator.DefaultKafkaPrincipalBuilder
implements org.apache.kafka.common.Configurable

This class needs to be enabled as the PrincipalBuilder on Kafka Broker.

It ensures that additional session info is associated with the current session to allow enforcing access token lifetime, for re-authentication to operate properly, and for custom authorizers to have access to additional session state - i.e. the parsed access token. The extra information is in the form of SessionInfo object containing the OAuthBearerToken token produced by io.strimzi.kafka.oauth.server.JaasServerOauthValidatorCallbackHandler.

It is also required for OAuth over PLAIN to operate properly.

Use 'principal.builder.class=io.strimzi.kafka.oauth.server.OAuthKafkaPrincipalBuilder' property definition in server.properties to install it.

Constructor Summary

Constructors

Constructor and Description
OAuthKafkaPrincipalBuilder()

Method Summary

Modifier and Type	Method and Description
org.apache.kafka.common.security.auth.KafkaPrincipal	build(org.apache.kafka.common.security.auth.AuthenticationContext context)
void	configure(java.util.Map<java.lang.String,?> configs)

Methods inherited from class org.apache.kafka.common.security.authenticator.DefaultKafkaPrincipalBuilder

close, deserialize, fromOldPrincipalBuilder, serialize

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthKafkaPrincipalBuilder

public OAuthKafkaPrincipalBuilder()

Method Detail

configure

public void configure(java.util.Map<java.lang.String,?> configs)

Specified by:

configure in interface org.apache.kafka.common.Configurable

build

public org.apache.kafka.common.security.auth.KafkaPrincipal build(org.apache.kafka.common.security.auth.AuthenticationContext context)

Specified by:

build in interface org.apache.kafka.common.security.auth.KafkaPrincipalBuilder

Overrides:

build in class org.apache.kafka.common.security.authenticator.DefaultKafkaPrincipalBuilder