Package org.apache.drill.exec.store.security.vault

Class VaultCredentialsProvider

java.lang.Object

org.apache.drill.exec.store.security.vault.VaultCredentialsProvider

All Implemented Interfaces:

CredentialsProvider

public class VaultCredentialsProvider
extends Object
implements CredentialsProvider

Implementation of CredentialsProvider that obtains credential values from Vault.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUERY_USER_VAR
static final String	VAULT_ADDRESS
static final String	VAULT_APP_ROLE_ID
static final String	VAULT_SECRET_ID

Constructor Summary

Constructors

Constructor	Description
VaultCredentialsProvider(String secretPath, Map<String,String> propertyNames, DrillConfig config)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,String>	getCredentials()	Returns map with authentication credentials.
Map<String,String>	getPropertyNames()
String	getSecretPath()
Map<String,String>	getUserCredentials(String queryUser)	This method returns the credentials associated with a specific user.
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.drill.common.logical.security.CredentialsProvider

setUserCredentials

Field Details

VAULT_ADDRESS

public static final String VAULT_ADDRESS

See Also:

• Constant Field Values

VAULT_APP_ROLE_ID

public static final String VAULT_APP_ROLE_ID

See Also:

• Constant Field Values

VAULT_SECRET_ID

public static final String VAULT_SECRET_ID

See Also:

• Constant Field Values

QUERY_USER_VAR

public static final String QUERY_USER_VAR

See Also:

• Constant Field Values

Constructor Details

VaultCredentialsProvider

public VaultCredentialsProvider(String secretPath,
 Map<String,String> propertyNames,
 DrillConfig config)
                         throws com.bettercloud.vault.VaultException

Parameters:

secretPath - The Vault key value from which to read

propertyNames - map with credential names as keys and vault keys as values.

config - drill config

Throws:

com.bettercloud.vault.VaultException - if exception happens when connecting to Vault.

Method Details

getCredentials

public Map<String,String> getCredentials()

Description copied from interface: CredentialsProvider

Returns map with authentication credentials. Key is the credential name, for example "username" and map value is corresponding credential value.

Specified by:

getCredentials in interface CredentialsProvider

getUserCredentials

public Map<String,String> getUserCredentials(String queryUser)

Description copied from interface: CredentialsProvider

This method returns the credentials associated with a specific user.

Specified by:

getUserCredentials in interface CredentialsProvider

Parameters:

queryUser - The logged in username

Returns:

A Map of the logged in user's credentials.

getSecretPath

public String getSecretPath()

getPropertyNames

public Map<String,String> getPropertyNames()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object