org.apache.drill.exec.rpc.user.security

Class VaultUserAuthenticator

java.lang.Object

org.apache.drill.exec.rpc.user.security.VaultUserAuthenticator

All Implemented Interfaces:

Closeable, AutoCloseable, UserAuthenticator

public class VaultUserAuthenticator
extends Object
implements UserAuthenticator

Implement UserAuthenticator based on HashiCorp Vault. Configure the Vault client using the Drill BOOT options that appear below.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultUserAuthenticator.VaultAuthMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	VAULT_ADDRESS
static String	VAULT_AUTH_METHOD

Constructor Summary

Constructors

Constructor and Description
VaultUserAuthenticator()

Method Summary

Modifier and Type	Method and Description
void	authenticate(String user, String password) Attempts to authenticate a Drill user with the provided password and the configured Vault auth method.
void	close() Close the authenticator.
boolean	equals(Object o)
int	hashCode()
void	setup(DrillConfig config) Reads Drill BOOT options and uses them to set up a Vault client.

Methods inherited from class java.lang.Object

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

Field Detail

VAULT_ADDRESS

public static final String VAULT_ADDRESS

See Also:

Constant Field Values

VAULT_AUTH_METHOD

public static final String VAULT_AUTH_METHOD

See Also:

Constant Field Values

Constructor Detail

VaultUserAuthenticator

public VaultUserAuthenticator()

Method Detail

setup

public void setup(DrillConfig config)
           throws DrillbitStartupException

Reads Drill BOOT options and uses them to set up a Vault client.

Specified by:

setup in interface UserAuthenticator

Parameters:

config - object providing Drill config settings for Vault

Throws:

DrillbitStartupException - if the provided Vault configuration is invalid

authenticate

public void authenticate(String user,
                         String password)
                  throws UserAuthenticationException

Attempts to authenticate a Drill user with the provided password and the configured Vault auth method. Only auth methods that have a natural mapping to PLAIN authentication's user and password strings are supported.

Specified by:

authenticate in interface UserAuthenticator

Parameters:

user - username

password - password

Throws:

UserAuthenticationException - if the authentication attempt fails

close

public void close()
           throws IOException

Description copied from interface: UserAuthenticator

Close the authenticator. Used to release resources. Ex. LDAP authenticator opens connections to LDAP server, such connections resources are released in a safe manner as part of close.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface UserAuthenticator

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object