Package org.jivesoftware.openfire.auth

Class DefaultAuthProvider

java.lang.Object

org.jivesoftware.openfire.auth.DefaultAuthProvider

All Implemented Interfaces:

AuthProvider

public class DefaultAuthProvider
extends Object
implements AuthProvider

Default AuthProvider implementation. It authenticates against the ofUser database table and supports plain text and digest authentication. Because each call to authenticate() makes a database connection, the results of authentication should be cached whenever possible.

Author:

Matt Tucker

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SALT_LENGTH	The length of the salt used to generate salted passwords.

Constructor Summary

Constructors

Constructor	Description
DefaultAuthProvider()	Constructs a new DefaultAuthProvider.

Method Summary

Modifier and Type	Method	Description
void	authenticate(String username, String password)	Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.
boolean	checkPassword(String username, String testPassword)
int	getIterations(String username)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getPassword(String username)	Returns the user's password.
String	getSalt(String username)	Deprecated, for removal: This API element is subject to removal in a future version.
ScramCredentialData	getScramCredential(String username, String mechanism)	Returns SCRAM credentials for a user and mechanism.
String	getServerKey(String username)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getStoredKey(String username)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isScramSupported()
void	setPassword(String username, String password)	Sets the user's password.
boolean	supportsPasswordRetrieval()	Returns true if this UserProvider is able to retrieve user passwords from the backend user store.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.openfire.auth.AuthProvider

getIterations, getSalt, getServerKey, getStoredKey

Field Details

SALT_LENGTH

public static final int SALT_LENGTH

The length of the salt used to generate salted passwords.

See Also:

• Constant Field Values

Constructor Details

DefaultAuthProvider

public DefaultAuthProvider()

Constructs a new DefaultAuthProvider.

Method Details

getSalt

@Deprecated(forRemoval=true)
public String getSalt(String username)
               throws UserNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AuthProvider

Returns a SCRAM-SHA-1 salt for a user.

Specified by:

getSalt in interface AuthProvider

Throws:

UserNotFoundException

getIterations

@Deprecated(forRemoval=true)
public int getIterations(String username)
                  throws UserNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AuthProvider

Returns a SCRAM-SHA-1 iteration count for a user.

Specified by:

getIterations in interface AuthProvider

Throws:

UserNotFoundException

getStoredKey

@Deprecated(forRemoval=true)
public String getStoredKey(String username)
                    throws UserNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AuthProvider

Returns a SCRAM-SHA-1 stored key for a user.

Specified by:

getStoredKey in interface AuthProvider

Throws:

UserNotFoundException

getServerKey

@Deprecated(forRemoval=true)
public String getServerKey(String username)
                    throws UserNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AuthProvider

Returns a SCRAM-SHA-1 server key for a user.

Specified by:

getServerKey in interface AuthProvider

Throws:

UserNotFoundException

getScramCredential

public ScramCredentialData getScramCredential(String username,
 String mechanism)
                                       throws UnsupportedOperationException,
UserNotFoundException

Returns SCRAM credentials for a user and mechanism. Only SCRAM-SHA-1 is supported. When SHA-1 credentials are missing but a plaintext (or decryptable) password is available, the credentials are regenerated (preserving the historical behavior of this provider).

Specified by:

getScramCredential in interface AuthProvider

Parameters:

username - the username of the user.

mechanism - the SCRAM mechanism name.

Returns:

the SCRAM credentials for the user under the (normalized) mechanism.

Throws:

UnsupportedOperationException - if the mechanism is not SCRAM-SHA-1.

UserNotFoundException - if the user's credentials could not be loaded.

authenticate

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

Description copied from interface: AuthProvider

Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.

Specified by:

authenticate in interface AuthProvider

Parameters:

username - the username or full JID.

password - the password

Throws:

UnauthorizedException - if the username and password do not match any existing user.

getPassword

public String getPassword(String username)
                   throws UserNotFoundException

Description copied from interface: AuthProvider

Returns the user's password. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Specified by:

getPassword in interface AuthProvider

Parameters:

username - the username of the user.

Returns:

the user's password.

Throws:

UserNotFoundException - if the given user's password could not be loaded.

checkPassword

public boolean checkPassword(String username,
 String testPassword)
                      throws UserNotFoundException

Throws:

UserNotFoundException

setPassword

public void setPassword(String username,
 String password)
                 throws UserNotFoundException

Description copied from interface: AuthProvider

Sets the user's password. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Specified by:

setPassword in interface AuthProvider

Parameters:

username - the username of the user.

password - the new plaintext password for the user.

Throws:

UserNotFoundException - if the given user could not be loaded.

supportsPasswordRetrieval

public boolean supportsPasswordRetrieval()

Description copied from interface: AuthProvider

Returns true if this UserProvider is able to retrieve user passwords from the backend user store. If this operation is not supported then AuthProvider.getPassword(String) will throw an UnsupportedOperationException if invoked.

Specified by:

supportsPasswordRetrieval in interface AuthProvider

Returns:

true if this UserProvider is able to retrieve user passwords from the backend user store.

isScramSupported

public boolean isScramSupported()

Specified by:

isScramSupported in interface AuthProvider