Package org.apache.solr.security

Class Sha256AuthenticationProvider

java.lang.Object

org.apache.solr.security.Sha256AuthenticationProvider

All Implemented Interfaces:

org.apache.solr.common.SpecProvider, BasicAuthPlugin.AuthenticationProvider, ConfigEditablePlugin

public class Sha256AuthenticationProvider
extends Object
implements ConfigEditablePlugin, BasicAuthPlugin.AuthenticationProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_USER_AS_PASSWORD_PROP	System property (or SOLR_SECURITY_AUTH_BASICAUTH_ALLOWUSERASPASSWORD environment variable) that, when explicitly set to true, disables the check that rejects a password equal to its username, both at login time and when creating or editing a user via the set-user command (UI, API or CLI).

Constructor Summary

Constructors

Constructor	Description
Sha256AuthenticationProvider()

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(String username, String password)
Map<String,Object>	edit(Map<String,Object> latestConf, List<org.apache.solr.common.util.CommandOperation> commands)	Operate the commands on the latest conf and return a new conf object If there are errors in the commands , throw a SolrException.
Map<String,String>	getPromptHeaders()
static String	getSaltedHashedValue(String pwd)
org.apache.solr.common.util.ValidatingJsonMap	getSpec()
void	init(Map<String,Object> pluginConfig)
static String	sha256(String password, String saltKey)

Methods inherited from class java.lang.Object

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

Field Details

ALLOW_USER_AS_PASSWORD_PROP

public static final String ALLOW_USER_AS_PASSWORD_PROP

System property (or SOLR_SECURITY_AUTH_BASICAUTH_ALLOWUSERASPASSWORD environment variable) that, when explicitly set to true, disables the check that rejects a password equal to its username, both at login time and when creating or editing a user via the set-user command (UI, API or CLI). This is an escape hatch for users upgrading to 9.11.0 or 10.1.0 who still have Basic Auth users with weak passwords equal to the username; it lets them keep logging in (and managing those accounts) while they migrate to stronger passwords. Defaults to false.

See Also:

• Constant Field Values

Constructor Details

Sha256AuthenticationProvider

public Sha256AuthenticationProvider()

Method Details

getSaltedHashedValue

public static String getSaltedHashedValue(String pwd)

init

public void init(Map<String,Object> pluginConfig)

Specified by:

init in interface BasicAuthPlugin.AuthenticationProvider

authenticate

public boolean authenticate(String username,
 String password)

Specified by:

authenticate in interface BasicAuthPlugin.AuthenticationProvider

getPromptHeaders

public Map<String,String> getPromptHeaders()

Specified by:

getPromptHeaders in interface BasicAuthPlugin.AuthenticationProvider

sha256

public static String sha256(String password,
 String saltKey)

edit

public Map<String,Object> edit(Map<String,Object> latestConf,
 List<org.apache.solr.common.util.CommandOperation> commands)

Description copied from interface: ConfigEditablePlugin

Operate the commands on the latest conf and return a new conf object If there are errors in the commands , throw a SolrException. return a null if no changes are to be made as a result of this edit. It is the responsibility of the implementation to ensure that the returned config is valid . The framework does no validation of the data

Specified by:

edit in interface ConfigEditablePlugin

getSpec

public org.apache.solr.common.util.ValidatingJsonMap getSpec()

Specified by:

getSpec in interface org.apache.solr.common.SpecProvider