org.wildfly.security.password.interfaces.BSDUnixDESCryptPassword Maven / Gradle / Ivy
/*
* 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 BSD-style DES "crypt" password.
*
* @author David M. Lloyd
*/
public interface BSDUnixDESCryptPassword extends OneWayPassword {
/**
* The algorithm name.
*/
String ALGORITHM_BSD_CRYPT_DES = "bsd-crypt-des";
/**
* The constant size of the hash, in bytes.
*/
int BSD_CRYPT_DES_HASH_SIZE = 8;
/**
* The constant size of the salt, in bytes.
*/
int BSD_CRYPT_DES_SALT_SIZE = 3;
/**
* The default iteration count.
*/
int DEFAULT_ITERATION_COUNT = 5001;
/**
* Get the iteration count of this password.
*
* @return the iteration count
*/
int getIterationCount();
/**
* Get the salt segment of this password as an {@code int} value.
*
* @return the salt segment
*/
int getSalt();
/**
* Get the hash segment of this password.
*
* @return the hash segment
*/
byte[] getHash();
default IteratedSaltedPasswordAlgorithmSpec getParameterSpec() {
final int salt = getSalt();
byte[] saltBytes = new byte[4];
// Big-endian format
saltBytes[0] = (byte) (salt >>> 24 & 0xff);
saltBytes[1] = (byte) (salt >>> 16 & 0xff);
saltBytes[2] = (byte) (salt >>> 8 & 0xff);
saltBytes[3] = (byte) (salt & 0xff);
return new IteratedSaltedPasswordAlgorithmSpec(getIterationCount(), saltBytes);
}
default boolean impliesParameters(AlgorithmParameterSpec parameterSpec) {
Assert.checkNotNullParam("parameterSpec", parameterSpec);
if (parameterSpec instanceof IteratedSaltedPasswordAlgorithmSpec) {
final IteratedSaltedPasswordAlgorithmSpec spec = (IteratedSaltedPasswordAlgorithmSpec) parameterSpec;
return getIterationCount() <= spec.getIterationCount() && Arrays.equals(getParameterSpec().getSalt(), spec.getSalt());
} else if (parameterSpec instanceof SaltedPasswordAlgorithmSpec) {
return Arrays.equals(getParameterSpec().getSalt(), ((SaltedPasswordAlgorithmSpec) parameterSpec).getSalt());
} else if (parameterSpec instanceof IteratedPasswordAlgorithmSpec) {
return getIterationCount() <= ((IteratedPasswordAlgorithmSpec) parameterSpec).getIterationCount();
} else {
return false;
}
}
/**
* Creates and returns a copy of this {@link Password}.
*
* @return a copy of this {@link Password}.
*/
BSDUnixDESCryptPassword clone();
/**
* 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 BSDUnixDESCryptPassword createRaw(String algorithm, byte[] hash, int salt, int iterationCount) {
Assert.checkNotNullParam("hash", hash);
Assert.checkNotNullParam("algorithm", algorithm);
return new RawBSDUnixDESCryptPassword(algorithm, iterationCount, salt, hash.clone());
}
}