alluxio.security.authentication

Class DefaultAuthenticationServer

java.lang.Object

alluxio.grpc.SaslAuthenticationServiceGrpc.SaslAuthenticationServiceImplBase

alluxio.security.authentication.DefaultAuthenticationServer

All Implemented Interfaces:

AuthenticationServer, io.grpc.BindableService, Closeable, AutoCloseable

@ThreadSafe
public class DefaultAuthenticationServer
extends SaslAuthenticationServiceGrpc.SaslAuthenticationServiceImplBase
implements AuthenticationServer

Default implementation of AuthenticationServer. Its functions include: -> Authentication server against which client channels could get authenticated -> Registry of identities for known channels during RPC calls.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentHashMap<UUID,alluxio.security.authentication.DefaultAuthenticationServer.AuthenticatedChannelInfo>	mChannels List of channels authenticated against this server.
protected long	mCleanupIntervalMs Interval for clean-up task to fire.
protected AlluxioConfiguration	mConfiguration Alluxio client configuration.
protected String	mHostName Address of the authentication host.
protected ScheduledExecutorService	mScheduler Scheduler for periodic cleaning of channels registry.

Constructor Summary

Constructors

Constructor and Description
DefaultAuthenticationServer(String hostName, AlluxioConfiguration conf) Creates DefaultAuthenticationServer instance.

Method Summary

Modifier and Type	Method and Description
io.grpc.stub.StreamObserver<SaslMessage>	authenticate(io.grpc.stub.StreamObserver<SaslMessage> responseObserver) Used to drive Sasl negotiation with clients.
protected void	checkSupported(AuthType authType) Used to check if given authentication is supported by the server.
void	close() Closes the server, releases all authentication sessions.
SaslServerHandler	createSaslHandler(ChannelAuthenticationScheme authScheme) Creates server-side Sasl handler for given scheme.
AuthenticatedUserInfo	getUserInfoForChannel(UUID channelId)
void	registerChannel(UUID channelId, AuthenticatedUserInfo userInfo, AuthenticatedChannelServerDriver serverDriver) Registers new user against given channel.
void	unregisterChannel(UUID channelId) Unregisters given channel.

Methods inherited from class alluxio.grpc.SaslAuthenticationServiceGrpc.SaslAuthenticationServiceImplBase

bindService

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.grpc.BindableService

bindService

Field Detail

mChannels

protected final ConcurrentHashMap<UUID,alluxio.security.authentication.DefaultAuthenticationServer.AuthenticatedChannelInfo> mChannels

List of channels authenticated against this server.

mScheduler

protected final ScheduledExecutorService mScheduler

Scheduler for periodic cleaning of channels registry.

mHostName

protected final String mHostName

Address of the authentication host.

mCleanupIntervalMs

protected final long mCleanupIntervalMs

Interval for clean-up task to fire.

mConfiguration

protected final AlluxioConfiguration mConfiguration

Alluxio client configuration.

Constructor Detail

DefaultAuthenticationServer

public DefaultAuthenticationServer(String hostName,
                                   AlluxioConfiguration conf)

Creates DefaultAuthenticationServer instance.

Parameters:

hostName - host name of the server

conf - Alluxio client configuration

Method Detail

authenticate

public io.grpc.stub.StreamObserver<SaslMessage> authenticate(io.grpc.stub.StreamObserver<SaslMessage> responseObserver)

Description copied from class: SaslAuthenticationServiceGrpc.SaslAuthenticationServiceImplBase

 Used to drive Sasl negotiation with clients.
 

Overrides:

authenticate in class SaslAuthenticationServiceGrpc.SaslAuthenticationServiceImplBase

registerChannel

public void registerChannel(UUID channelId,
                            AuthenticatedUserInfo userInfo,
                            AuthenticatedChannelServerDriver serverDriver)

Description copied from interface: AuthenticationServer

Registers new user against given channel.

Specified by:

registerChannel in interface AuthenticationServer

Parameters:

channelId - channel id

userInfo - authanticated user info

serverDriver - sasl server driver

getUserInfoForChannel

public AuthenticatedUserInfo getUserInfoForChannel(UUID channelId)
                                            throws UnauthenticatedException

Specified by:

getUserInfoForChannel in interface AuthenticationServer

Parameters:

channelId - channel id

Returns:

info of user that is authenticated with the given channel

Throws:

UnauthenticatedException - if given channel is not registered

unregisterChannel

public void unregisterChannel(UUID channelId)

Description copied from interface: AuthenticationServer

Unregisters given channel.

Specified by:

unregisterChannel in interface AuthenticationServer

Parameters:

channelId - channel id

createSaslHandler

public SaslServerHandler createSaslHandler(ChannelAuthenticationScheme authScheme)
                                    throws SaslException

Description copied from interface: AuthenticationServer

Creates server-side Sasl handler for given scheme.

Specified by:

createSaslHandler in interface AuthenticationServer

Parameters:

authScheme - the authentication scheme

Returns:

the created SaslServerHandler instance

Throws:

SaslException

close

public void close()

Description copied from interface: AuthenticationServer

Closes the server, releases all authentication sessions.

Specified by:

close in interface AuthenticationServer

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

checkSupported

protected void checkSupported(AuthType authType)

Used to check if given authentication is supported by the server.

Parameters:

authType - authentication type

Throws:

RuntimeException - if not supported