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

Class HtpasswdFileUserAuthenticator

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, UserAuthenticator

public class HtpasswdFileUserAuthenticator
extends Object
implements UserAuthenticator

Implementation of UserAuthenticator that reads passwords from an htpasswd formatted file.

Currently supports MD5, SHA-1, and plaintext passwords.

Use the htpasswd command line tool to create and modify htpasswd files.

By default this loads the passwords from /opt/drill/conf/htpasswd. Users can change the path by putting the absolute file path as drill.exec.security.user.auth.htpasswd.path in drill-override.conf.

This is intended for situations where the list of users is relatively static, and you are running drill in a container so using pam is not convenient.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_HTPASSWD_AUTHENTICATOR_PATH

Constructor Summary

Constructors

Constructor	Description
HtpasswdFileUserAuthenticator()

Method Summary

Modifier and Type	Method	Description
void	authenticate(String username, String password)	Validate the given username and password against the password file
void	close()	Free resources associated with this authenticator
static boolean	isPasswordValid(String password, String hash)	Check password against hash read from the file
protected void	read()	Read the password file into the map, if the file has changed since we last read it
void	setup(DrillConfig drillConfig)	Setup for authenticating user credentials.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_HTPASSWD_AUTHENTICATOR_PATH

public static final String DEFAULT_HTPASSWD_AUTHENTICATOR_PATH

See Also:

• Constant Field Values

Constructor Details

HtpasswdFileUserAuthenticator

public HtpasswdFileUserAuthenticator()

Method Details

setup

public void setup(DrillConfig drillConfig)
           throws DrillbitStartupException

Description copied from interface: UserAuthenticator

Setup for authenticating user credentials.

Specified by:

setup in interface UserAuthenticator

Throws:

DrillbitStartupException

isPasswordValid

public static boolean isPasswordValid(String password,
 String hash)

Check password against hash read from the file

Parameters:

password - User provided password

hash - Hash stored in the htpasswd file

Returns:

true if the password matched the hash

authenticate

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

Validate the given username and password against the password file

Specified by:

authenticate in interface UserAuthenticator

Parameters:

username - Username provided

password - Password provided

Throws:

UserAuthenticationException - If the username and password could not be validated

read

protected void read()

Read the password file into the map, if the file has changed since we last read it

close

public void close()

Free resources associated with this authenticator

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface UserAuthenticator