Package org.jivesoftware.openfire.auth
Class DefaultAuthProvider
java.lang.Object
org.jivesoftware.openfire.auth.DefaultAuthProvider
- All Implemented Interfaces:
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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) getPassword
(String username) Returns the user's password.getServerKey
(String username) getStoredKey
(String username) boolean
void
setPassword
(String username, String password) Sets the user's password.boolean
Returns true if this UserProvider is able to retrieve user passwords from the backend user store.
-
Constructor Details
-
DefaultAuthProvider
public DefaultAuthProvider()Constructs a new DefaultAuthProvider.
-
-
Method Details
-
getSalt
- Specified by:
getSalt
in interfaceAuthProvider
- Throws:
UserNotFoundException
-
getIterations
- Specified by:
getIterations
in interfaceAuthProvider
- Throws:
UserNotFoundException
-
getStoredKey
- Specified by:
getStoredKey
in interfaceAuthProvider
- Throws:
UserNotFoundException
-
getServerKey
- Specified by:
getServerKey
in interfaceAuthProvider
- Throws:
UserNotFoundException
-
authenticate
Description copied from interface:AuthProvider
Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.- Specified by:
authenticate
in interfaceAuthProvider
- Parameters:
username
- the username or full JID.password
- the password- Throws:
UnauthorizedException
- if the username and password do not match any existing user.
-
getPassword
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 interfaceAuthProvider
- 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
- Throws:
UserNotFoundException
-
setPassword
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 interfaceAuthProvider
- 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 thenAuthProvider.getPassword(String)
will throw anUnsupportedOperationException
if invoked.- Specified by:
supportsPasswordRetrieval
in interfaceAuthProvider
- Returns:
- true if this UserProvider is able to retrieve user passwords from the backend user store.
-
isScramSupported
public boolean isScramSupported()- Specified by:
isScramSupported
in interfaceAuthProvider
-