org.jivesoftware.openfire.auth.AuthProvider Maven / Gradle / Ivy
/*
* Copyright (C) 2004-2008 Jive Software. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.openfire.auth;
import org.jivesoftware.openfire.user.UserNotFoundException;
/**
* 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
*/
public interface AuthProvider {
/**
* Returns if the username and password are valid; otherwise this
* method throws an UnauthorizedException.
*
* @param username the username or full JID.
* @param password the password
* @throws UnauthorizedException if the username and password do
* not match any existing user.
* @throws ConnectionException it there is a problem connecting to user and group system
* @throws InternalUnauthenticatedException if there is a problem authentication Openfire itself into the user and group system
*/
void authenticate(String username, String password) throws UnauthorizedException,
ConnectionException, InternalUnauthenticatedException;
/**
* Returns the user's password. This method should throw an UnsupportedOperationException
* if this operation is not supported by the backend user store.
*
* @param username the username of the user.
* @return the user's password.
* @throws UserNotFoundException if the given user's password could not be loaded.
* @throws UnsupportedOperationException if the provider does not
* support the operation (this is an optional operation).
*/
String getPassword( String username ) throws UserNotFoundException,
UnsupportedOperationException;
/**
* Sets the users's password. This method should throw an UnsupportedOperationException
* if this operation is not supported by the backend user store.
*
* @param username the username of the user.
* @param password the new plaintext password for the user.
* @throws UserNotFoundException if the given user could not be loaded.
* @throws UnsupportedOperationException if the provider does not
* support the operation (this is an optional operation).
*/
void setPassword( String username, String password )
throws UserNotFoundException, UnsupportedOperationException;
/**
* Returns true if this UserProvider is able to retrieve user passwords from
* the backend user store. If this operation is not supported then {@link #getPassword(String)}
* will throw an {@link UnsupportedOperationException} if invoked.
*
* @return true if this UserProvider is able to retrieve user passwords from the
* backend user store.
*/
boolean supportsPasswordRetrieval();
boolean isScramSupported();
String getSalt(String username) throws UnsupportedOperationException, UserNotFoundException;
int getIterations(String username) throws UnsupportedOperationException, UserNotFoundException;
String getServerKey(String username) throws UnsupportedOperationException, UserNotFoundException;
String getStoredKey(String username) throws UnsupportedOperationException, UserNotFoundException;
}