/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.wildfly.security.password.interfaces;
import java.security.spec.AlgorithmParameterSpec;
import java.util.Arrays;
import org.wildfly.common.Assert;
import org.wildfly.security.password.OneWayPassword;
import org.wildfly.security.password.Password;
import org.wildfly.security.password.PasswordFactory;
import org.wildfly.security.password.spec.IteratedPasswordAlgorithmSpec;
import org.wildfly.security.password.spec.IteratedSaltedPasswordAlgorithmSpec;
import org.wildfly.security.password.spec.SaltedPasswordAlgorithmSpec;
/**
* A password using the "bcrypt" Blowfish-based one-way password encryption algorithm.
*
* @author <a href="mailto:david.lloyd@redhat.com">David M. Lloyd</a>
*/
public interface BCryptPassword extends OneWayPassword {
/**
* The algorithm name.
*/
String ALGORITHM_BCRYPT = "bcrypt";
/**
* A constant representing the bcrypt salt size, in bytes.
*/
int BCRYPT_SALT_SIZE = 16;
/**
* A constant representing the bcrypt hash size, in bytes.
*/
int BCRYPT_HASH_SIZE = 23;
/**
* A constant representing the default iteration count for bcrypt passwords.
*/
int DEFAULT_ITERATION_COUNT = 10;
/**
* Get the hash segment of this password.
*
* @return the hash segment
*/
byte[] getHash();
/**
* Get the salt segment of this password.
*
* @return the salt segment
*/
byte[] getSalt();
/**
* Get the iteration count of this password.
*
* @return the iteration count
*/
int getIterationCount();
/**
* Creates and returns a copy of this {@link Password}.
*
* @return a copy of this {@link Password}.
*/
BCryptPassword clone();
default IteratedSaltedPasswordAlgorithmSpec getParameterSpec() {
return new IteratedSaltedPasswordAlgorithmSpec(getIterationCount(), getSalt());
}
default boolean impliesParameters(AlgorithmParameterSpec parameterSpec) {
Assert.checkNotNullParam("parameterSpec", parameterSpec);
if (parameterSpec instanceof IteratedSaltedPasswordAlgorithmSpec) {
final IteratedSaltedPasswordAlgorithmSpec spec = (IteratedSaltedPasswordAlgorithmSpec) parameterSpec;
return getIterationCount() <= spec.getIterationCount() && Arrays.equals(getSalt(), spec.getSalt());
} else if (parameterSpec instanceof SaltedPasswordAlgorithmSpec) {
return Arrays.equals(getSalt(), ((SaltedPasswordAlgorithmSpec) parameterSpec).getSalt());
} else if (parameterSpec instanceof IteratedPasswordAlgorithmSpec) {
return getIterationCount() <= ((IteratedPasswordAlgorithmSpec) parameterSpec).getIterationCount();
} else {
return false;
}
}
/**
* Create a raw implementation of this password type. No validation of the content is performed, and the password
* must be "adopted" in to a {@link PasswordFactory} (via the {@link PasswordFactory#translate(Password)} method)
* before it can be validated and used to verify guesses.
*
* @param algorithm the algorithm name
* @param hash the hash
* @param salt the salt
* @param iterationCount the iteration count
* @return the raw password implementation
*/
static BCryptPassword createRaw(String algorithm, byte[] hash, byte[] salt, int iterationCount) {
Assert.checkNotNullParam("hash", hash);
Assert.checkNotNullParam("salt", salt);
Assert.checkNotNullParam("algorithm", algorithm);
return new RawBCryptPassword(algorithm, hash.clone(), salt.clone(), iterationCount);
}
}