98 lines
3.0 KiB
Java
98 lines
3.0 KiB
Java
package fr.xephi.authme.security.pbkdf2;
|
|
|
|
/**
|
|
* <p>
|
|
* A free Java implementation of Password Based Key Derivation Function 2 as
|
|
* defined by RFC 2898. Copyright (c) 2007 Matthias Gärtner
|
|
* </p>
|
|
* <p>
|
|
* This library is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU Lesser General Public License as published by the Free
|
|
* Software Foundation; either version 2.1 of the License, or (at your option)
|
|
* any later version.
|
|
* </p>
|
|
* <p>
|
|
* This library is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
|
|
* details.
|
|
* </p>
|
|
* <p>
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this library; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
* </p>
|
|
* <p>
|
|
* For Details, see <a
|
|
* href="http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html"
|
|
* >http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html</a>.
|
|
* </p>
|
|
*
|
|
* @author Matthias Gärtner
|
|
* @version 1.0
|
|
*/
|
|
public interface PBKDF2 {
|
|
|
|
/**
|
|
* Convert String-based input to internal byte array, then invoke PBKDF2.
|
|
* Desired key length defaults to Pseudo Random Function block size.
|
|
*
|
|
* @param inputPassword Candidate password to compute the derived key for.
|
|
*
|
|
* @return internal byte array
|
|
*/
|
|
byte[] deriveKey(String inputPassword);
|
|
|
|
/**
|
|
* Convert String-based input to internal byte array, then invoke PBKDF2.
|
|
*
|
|
* @param inputPassword Candidate password to compute the derived key for.
|
|
* @param dkLen Specify desired key length
|
|
*
|
|
* @return internal byte array
|
|
*/
|
|
byte[] deriveKey(String inputPassword, int dkLen);
|
|
|
|
/**
|
|
* Convert String-based input to internal byte arrays, then invoke PBKDF2
|
|
* and verify result against the reference data that is supplied in the
|
|
* PBKDF2Parameters.
|
|
*
|
|
* @param inputPassword Candidate password to compute the derived key for.
|
|
*
|
|
* @return <code>true</code> password match; <code>false</code> incorrect
|
|
* password
|
|
*/
|
|
boolean verifyKey(String inputPassword);
|
|
|
|
/**
|
|
* Allow reading of configured parameters.
|
|
*
|
|
* @return Currently set parameters.
|
|
*/
|
|
PBKDF2Parameters getParameters();
|
|
|
|
/**
|
|
* Allow setting of configured parameters.
|
|
*
|
|
* @param parameters PBKDF2Parameters
|
|
*/
|
|
void setParameters(PBKDF2Parameters parameters);
|
|
|
|
/**
|
|
* Get currently set Pseudo Random Function.
|
|
*
|
|
* @return Currently set Pseudo Random Function
|
|
*/
|
|
PRF getPseudoRandomFunction();
|
|
|
|
/**
|
|
* Set the Pseudo Random Function to use. Note that deriveKeys/getPRF does
|
|
* init this object using the supplied candidate password. If this is
|
|
* undesired, one has to override getPRF.
|
|
*
|
|
* @param prf Pseudo Random Function to set.
|
|
*/
|
|
void setPseudoRandomFunction(PRF prf);
|
|
}
|