io.fabric8.elasticsearch.plugin.auth

Class FileAuthenticationBackend

java.lang.Object

io.fabric8.elasticsearch.plugin.auth.FileAuthenticationBackend

All Implemented Interfaces:

com.floragunn.searchguard.auth.AuthenticationBackend, com.floragunn.searchguard.auth.HTTPAuthenticator

public class FileAuthenticationBackend
extends Object
implements com.floragunn.searchguard.auth.AuthenticationBackend, com.floragunn.searchguard.auth.HTTPAuthenticator

Provides 'basic' authorization using a file of usernames and passwords. The source is YAML based file of usernames and base64 encoded passwords: --- # username of 'foo' with password 'bar' foo: passwd: YmFyCg== This authorization assumes the header is also base64 encoded and the password contains no colons (e.g. :). This allows the username to be in an Openshift service account format (e.g. system:serviceaccount:logging:prometheus) and still be sent by the client with a parsable password. The backend is configured as follows in the sg_config.yml: searchguard: authc: my_domain: enabled: true order: 1 http_authenticator: challange: false type: io.fabric8.elasticsearch.plugin.auth.FileAuthenticationBackend config: file_path: /path/to/yamlfile authentication_backend: type: io.fabric8.elasticsearch.plugin.auth.FileAuthenticationBackend config: file_path: /path/to/yamlfile

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FILE

Constructor Summary

Constructors

Constructor and Description
FileAuthenticationBackend(org.elasticsearch.common.settings.Settings settings)
FileAuthenticationBackend(org.elasticsearch.common.settings.Settings settings, com.floragunn.searchguard.action.configupdate.TransportConfigUpdateAction tcua)

Method Summary

Modifier and Type	Method and Description
com.floragunn.searchguard.user.User	authenticate(com.floragunn.searchguard.user.AuthCredentials credentials)
boolean	exists(com.floragunn.searchguard.user.User user)
com.floragunn.searchguard.user.AuthCredentials	extractCredentials(org.elasticsearch.rest.RestRequest request, org.elasticsearch.common.util.concurrent.ThreadContext context)
String	getType()
boolean	reRequestAuthentication(org.elasticsearch.rest.RestChannel channel, com.floragunn.searchguard.user.AuthCredentials credentials)

Methods inherited from class java.lang.Object

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

Field Detail

FILE

protected static final String FILE

See Also:

Constant Field Values

Constructor Detail

FileAuthenticationBackend

public FileAuthenticationBackend(org.elasticsearch.common.settings.Settings settings)

FileAuthenticationBackend

public FileAuthenticationBackend(org.elasticsearch.common.settings.Settings settings,
                                 com.floragunn.searchguard.action.configupdate.TransportConfigUpdateAction tcua)

Method Detail

extractCredentials

public com.floragunn.searchguard.user.AuthCredentials extractCredentials(org.elasticsearch.rest.RestRequest request,
                                                                         org.elasticsearch.common.util.concurrent.ThreadContext context)
                                                                  throws org.elasticsearch.ElasticsearchSecurityException

Specified by:

extractCredentials in interface com.floragunn.searchguard.auth.HTTPAuthenticator

Throws:

org.elasticsearch.ElasticsearchSecurityException

reRequestAuthentication

public boolean reRequestAuthentication(org.elasticsearch.rest.RestChannel channel,
                                       com.floragunn.searchguard.user.AuthCredentials credentials)

Specified by:

reRequestAuthentication in interface com.floragunn.searchguard.auth.HTTPAuthenticator

getType

public String getType()

Specified by:

getType in interface com.floragunn.searchguard.auth.AuthenticationBackend

Specified by:

getType in interface com.floragunn.searchguard.auth.HTTPAuthenticator

authenticate

public com.floragunn.searchguard.user.User authenticate(com.floragunn.searchguard.user.AuthCredentials credentials)
                                                 throws org.elasticsearch.ElasticsearchSecurityException

Specified by:

authenticate in interface com.floragunn.searchguard.auth.AuthenticationBackend

Throws:

org.elasticsearch.ElasticsearchSecurityException

exists

public boolean exists(com.floragunn.searchguard.user.User user)

Specified by:

exists in interface com.floragunn.searchguard.auth.AuthenticationBackend