Package org.jivesoftware.openfire.auth

Interface AuthProvider

All Known Implementing Classes:
AuthMultiProvider, CrowdAuthProvider, DefaultAuthProvider, HybridAuthProvider, JDBCAuthProvider, LdapAuthProvider, MappedAuthProvider, NativeAuthProvider, POP3AuthProvider
public interface AuthProvider
Provider interface for authentication. Users that wish to integrate with their own authentication system must implement this class and then register the implementation with Openfire in the openfire.xml file. An entry in that file would look like the following: 
   <provider>
     <auth>
       <className>com.foo.auth.CustomAuthProvider</className>
     </auth>
   </provider>
Author:
Matt Tucker

  • 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.
    default Set<String>
    getFallbackScramMechanisms()
    Returns the names of the SCRAM mechanisms that can be assumed to be usable by any user, for use when the user that is going to authenticate cannot be identified.
    int
    getIterations(String username)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use getIterations(String, String) with the mechanism name.
    default int
    getIterations(String username, String mechanism)
    Returns a SCRAM iteration count for a user and mechanism.
    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.
    Use getSalt(String, String) with the mechanism name.
    default String
    getSalt(String username, String mechanism)
    Returns a SCRAM salt for a user and mechanism.
    default ScramCredentialData
    getScramCredential(String username, String mechanism)
    Returns SCRAM credentials for a user and mechanism.
    default Set<String>
    getScramMechanisms(String username)
    Returns the names of the SCRAM mechanisms for which credentials are available for a user.
    String
    getServerKey(String username)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use getServerKey(String, String) with the mechanism name.
    default String
    getServerKey(String username, String mechanism)
    Returns a SCRAM server key for a user and mechanism.
    String
    getStoredKey(String username)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use getStoredKey(String, String) with the mechanism name.
    default String
    getStoredKey(String username, String mechanism)
    Returns a SCRAM stored key for a user and mechanism.
    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.