alluxio.security.authentication

Class ChannelAuthenticator

java.lang.Object

alluxio.security.authentication.ChannelAuthenticator

public class ChannelAuthenticator
extends Object

Used to authenticate with the target host. Used internally by GrpcChannelBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthType	mAuthType Authentication type to use with the target host.
protected GrpcChannelKey	mChannelKey Key for to-be-authenticated channel.
protected long	mGrpcAuthTimeoutMs gRPC Authentication timeout in milliseconds.
protected String	mImpersonationUser
protected Subject	mParentSubject Subject for authentication.
protected String	mPassword
protected String	mUserName
protected boolean	mUseSubject Whether to use mParentSubject as authentication user.

Constructor Summary

Constructors

Constructor and Description
ChannelAuthenticator(GrpcChannelKey channelKey, String userName, String password, String impersonationUser, AuthType authType, long grpcAuthTimeoutMs) Creates ChannelAuthenticator instance.
ChannelAuthenticator(GrpcChannelKey channelKey, Subject subject, AlluxioConfiguration conf) Creates ChannelAuthenticator instance.

Method Summary

Modifier and Type	Method and Description
AuthenticatedChannel	authenticate(io.grpc.ManagedChannel managedChannel) Authenticates given NettyChannelBuilder instance.

Methods inherited from class java.lang.Object

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

Field Detail

mUseSubject

protected boolean mUseSubject

Whether to use mParentSubject as authentication user.

mParentSubject

protected Subject mParentSubject

Subject for authentication.

mUserName

protected String mUserName

mPassword

protected String mPassword

mImpersonationUser

protected String mImpersonationUser

mAuthType

protected AuthType mAuthType

Authentication type to use with the target host.

mGrpcAuthTimeoutMs

protected final long mGrpcAuthTimeoutMs

gRPC Authentication timeout in milliseconds.

mChannelKey

protected final GrpcChannelKey mChannelKey

Key for to-be-authenticated channel.

Constructor Detail

ChannelAuthenticator

public ChannelAuthenticator(GrpcChannelKey channelKey,
                            Subject subject,
                            AlluxioConfiguration conf)

Creates ChannelAuthenticator instance.

Parameters:

channelKey - channel key

subject - javax subject to use for authentication

conf - Alluxio configuration

ChannelAuthenticator

public ChannelAuthenticator(GrpcChannelKey channelKey,
                            String userName,
                            String password,
                            String impersonationUser,
                            AuthType authType,
                            long grpcAuthTimeoutMs)

Creates ChannelAuthenticator instance.

Parameters:

channelKey - channel key

userName - user name

password - user password

impersonationUser - impersonation user

authType - authentication type

grpcAuthTimeoutMs - authentication timeout in milliseconds

Method Detail

authenticate

public AuthenticatedChannel authenticate(io.grpc.ManagedChannel managedChannel)
                                  throws AlluxioStatusException

Authenticates given NettyChannelBuilder instance. It attaches required interceptors to the channel based on authentication type.

Parameters:

managedChannel - the managed channel for which authentication is taking place

Returns:

channel that is augmented for authentication

Throws:

UnauthenticatedException

AlluxioStatusException