Class SaslAuthenticationContext

java.lang.Object

org.apache.kafka.common.security.auth.SaslAuthenticationContext

All Implemented Interfaces:

AuthenticationContext

public class SaslAuthenticationContext
extends Object
implements AuthenticationContext

Constructor Summary

Constructors

Constructor	Description
SaslAuthenticationContext(long sessionId, SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName)
SaslAuthenticationContext(long sessionId, SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName, Optional<SSLSession> sslSession, boolean isMTlsSession, boolean disableSwitchover)
SaslAuthenticationContext(long sessionId, SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName, Optional<SSLSession> sslSession, boolean isMTlsSession, boolean disableSwitchover, boolean enableIpFiltering)
SaslAuthenticationContext(long sessionId, SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName, Optional<SSLSession> sslSession, boolean isMTlsSession, boolean disableSwitchover, boolean enableIpFiltering, org.apache.kafka.common.security.authenticator.PathAwareSniHostName sniHostName)
SaslAuthenticationContext(long sessionId, SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName, Optional<SSLSession> sslSession, boolean isMTlsSession, boolean disableSwitchover, boolean enableIpFiltering, org.apache.kafka.common.security.authenticator.PathAwareSniHostName sniHostName, org.apache.kafka.common.network.ProxyTlvProvider proxyTlvProvider)
SaslAuthenticationContext(SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName)	Method used for tests.

Method Summary

Modifier and Type	Method	Description
InetAddress	clientAddress()	Address of the authenticated client
boolean	disableSwitchover()
boolean	enableIpFiltering()
org.apache.kafka.common.network.ProxyTlvProvider	getProxyTlvProvider()
org.apache.kafka.common.security.authenticator.PathAwareSniHostName	getSniHostName()
boolean	isMTlsSession()
String	listenerName()	Name of the listener used for the connection
SecurityProtocol	securityProtocol()	Underlying security protocol of the authentication session.
SaslServer	server()
long	sessionId()	Unique ID assigned to each connection
void	setProxyTlvProvider(org.apache.kafka.common.network.ProxyTlvProvider proxyTlvProvider)
void	setSniHostName(org.apache.kafka.common.security.authenticator.PathAwareSniHostName sniHostName)
Optional<SSLSession>	sslSession()	Returns SSL session for the connection if security protocol is SASL_SSL.

Methods inherited from class java.lang.Object

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

Constructor Details

SaslAuthenticationContext

public SaslAuthenticationContext(long sessionId,
 SaslServer server,
 SecurityProtocol securityProtocol,
 InetAddress clientAddress,
 String listenerName)

SaslAuthenticationContext

public SaslAuthenticationContext(SaslServer server,
 SecurityProtocol securityProtocol,
 InetAddress clientAddress,
 String listenerName)

Method used for tests. Session id is not required to be generated in case of tests.

SaslAuthenticationContext

public SaslAuthenticationContext(long sessionId,
 SaslServer server,
 SecurityProtocol securityProtocol,
 InetAddress clientAddress,
 String listenerName,
 Optional<SSLSession> sslSession,
 boolean isMTlsSession,
 boolean disableSwitchover)

SaslAuthenticationContext

public SaslAuthenticationContext(long sessionId,
 SaslServer server,
 SecurityProtocol securityProtocol,
 InetAddress clientAddress,
 String listenerName,
 Optional<SSLSession> sslSession,
 boolean isMTlsSession,
 boolean disableSwitchover,
 boolean enableIpFiltering)

SaslAuthenticationContext

public SaslAuthenticationContext(long sessionId,
 SaslServer server,
 SecurityProtocol securityProtocol,
 InetAddress clientAddress,
 String listenerName,
 Optional<SSLSession> sslSession,
 boolean isMTlsSession,
 boolean disableSwitchover,
 boolean enableIpFiltering,
 org.apache.kafka.common.security.authenticator.PathAwareSniHostName sniHostName)

SaslAuthenticationContext

public SaslAuthenticationContext(long sessionId,
 SaslServer server,
 SecurityProtocol securityProtocol,
 InetAddress clientAddress,
 String listenerName,
 Optional<SSLSession> sslSession,
 boolean isMTlsSession,
 boolean disableSwitchover,
 boolean enableIpFiltering,
 org.apache.kafka.common.security.authenticator.PathAwareSniHostName sniHostName,
 org.apache.kafka.common.network.ProxyTlvProvider proxyTlvProvider)

Method Details

server

public SaslServer server()

sslSession

public Optional<SSLSession> sslSession()

Returns SSL session for the connection if security protocol is SASL_SSL. If SSL mutual client authentication is enabled for the listener, peer principal can be determined using SSLSession.getPeerPrincipal().

securityProtocol

public SecurityProtocol securityProtocol()

Description copied from interface: AuthenticationContext

Underlying security protocol of the authentication session.

Specified by:

securityProtocol in interface AuthenticationContext

clientAddress

public InetAddress clientAddress()

Description copied from interface: AuthenticationContext

Address of the authenticated client

Specified by:

clientAddress in interface AuthenticationContext

listenerName

public String listenerName()

Description copied from interface: AuthenticationContext

Name of the listener used for the connection

Specified by:

listenerName in interface AuthenticationContext

sessionId

public long sessionId()

Description copied from interface: AuthenticationContext

Unique ID assigned to each connection

Specified by:

sessionId in interface AuthenticationContext

isMTlsSession

public boolean isMTlsSession()

disableSwitchover

public boolean disableSwitchover()

Specified by:

disableSwitchover in interface AuthenticationContext

enableIpFiltering

public boolean enableIpFiltering()

Specified by:

enableIpFiltering in interface AuthenticationContext

setSniHostName

public void setSniHostName(org.apache.kafka.common.security.authenticator.PathAwareSniHostName sniHostName)

getSniHostName

public org.apache.kafka.common.security.authenticator.PathAwareSniHostName getSniHostName()

setProxyTlvProvider

public void setProxyTlvProvider(org.apache.kafka.common.network.ProxyTlvProvider proxyTlvProvider)

getProxyTlvProvider

public org.apache.kafka.common.network.ProxyTlvProvider getProxyTlvProvider()