Class SaslAuthenticationContext
java.lang.Object
org.apache.kafka.common.security.auth.SaslAuthenticationContext
- All Implemented Interfaces:
AuthenticationContext
Constructor Summary
ConstructorsConstructorDescriptionSaslAuthenticationContext(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 TypeMethodDescriptionAddress of the authenticated clientbooleanbooleanorg.apache.kafka.common.network.ProxyTlvProviderorg.apache.kafka.common.security.authenticator.PathAwareSniHostNamebooleanName of the listener used for the connectionUnderlying security protocol of the authentication session.server()longUnique ID assigned to each connectionvoidsetProxyTlvProvider(org.apache.kafka.common.network.ProxyTlvProvider proxyTlvProvider) voidsetSniHostName(org.apache.kafka.common.security.authenticator.PathAwareSniHostName sniHostName) Returns SSL session for the connection if security protocol is SASL_SSL.
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
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 usingSSLSession.getPeerPrincipal().securityProtocol
Description copied from interface:AuthenticationContextUnderlying security protocol of the authentication session.- Specified by:
securityProtocolin interfaceAuthenticationContext
clientAddress
Description copied from interface:AuthenticationContextAddress of the authenticated client- Specified by:
clientAddressin interfaceAuthenticationContext
listenerName
Description copied from interface:AuthenticationContextName of the listener used for the connection- Specified by:
listenerNamein interfaceAuthenticationContext
sessionId
public long sessionId()Description copied from interface:AuthenticationContextUnique ID assigned to each connection- Specified by:
sessionIdin interfaceAuthenticationContext
isMTlsSession
public boolean isMTlsSession()disableSwitchover
public boolean disableSwitchover()- Specified by:
disableSwitchoverin interfaceAuthenticationContext
enableIpFiltering
public boolean enableIpFiltering()- Specified by:
enableIpFilteringin interfaceAuthenticationContext
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()