org.wildfly.security.password.PasswordFactory 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;
import static org.wildfly.security.credential._private.ElytronMessages.log;
import static org.wildfly.security.provider.util.ProviderUtil.INSTALLED_PROVIDERS;
import java.nio.charset.Charset;
import java.security.InvalidAlgorithmParameterException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.security.NoSuchProviderException;
import java.security.Provider;
import java.security.Security;
import java.security.spec.AlgorithmParameterSpec;
import java.security.spec.InvalidKeySpecException;
import java.security.spec.KeySpec;
import java.util.function.Supplier;
import org.wildfly.common.Assert;
/**
* A factory for passwords.
*
* Password factories are used to handle and manipulate password objects and their corresponding
* password specifications. Passwords are a kind of key which are used to store and compare against a
* string of text entered by a human. Passwords can be one-way ({@link OneWayPassword}) or two-way
* ({@link TwoWayPassword}).
*
* @author David M. Lloyd
*/
public final class PasswordFactory {
private final Provider provider;
private final String algorithm;
private final PasswordFactorySpi spi;
/**
* Construct a new instance.
*
* @param spi the password factory SPI (not {@code null})
* @param provider the provider (not {@code null})
* @param algorithm the algorithm name (not {@code null})
*/
public PasswordFactory(final PasswordFactorySpi spi, final Provider provider, final String algorithm) {
Assert.checkNotNullParam("spi", spi);
Assert.checkNotNullParam("provider", provider);
Assert.checkNotNullParam("algorithm", algorithm);
this.provider = provider;
this.algorithm = algorithm;
this.spi = spi;
}
/**
* Get a password factory instance. The returned password factory object will implement the given algorithm.
*
* @param algorithm the name of the algorithm
* @return a password factory instance
* @throws NoSuchAlgorithmException if the given algorithm has no available implementations
*/
public static PasswordFactory getInstance(String algorithm) throws NoSuchAlgorithmException {
return getInstance(algorithm, INSTALLED_PROVIDERS);
}
/**
* Get a password factory instance. The returned password factory object will implement the given algorithm.
*
* @param algorithm the name of the algorithm
* @param providerName the name of the provider to use
* @return a password factory instance
* @throws NoSuchAlgorithmException if the given algorithm has no available implementations
*/
public static PasswordFactory getInstance(String algorithm, String providerName) throws NoSuchAlgorithmException, NoSuchProviderException {
final Provider provider = Security.getProvider(providerName);
if (provider == null) throw new NoSuchProviderException(providerName);
return getInstance(algorithm, provider);
}
/**
* Get a password factory instance. The returned password factory object will implement the given algorithm.
*
* @param algorithm the name of the algorithm
* @param provider the provider to use
* @return a password factory instance
* @throws NoSuchAlgorithmException if the given algorithm has no available implementations
*/
public static PasswordFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException {
final Provider.Service service = provider.getService("PasswordFactory", algorithm);
if (service == null) throw log.noSuchAlgorithmInvalidAlgorithm(algorithm);
return new PasswordFactory((PasswordFactorySpi) service.newInstance(null), provider, algorithm);
}
/**
* Get a password factory instance. The returned password factory object will implement the given algorithm.
*
* @param algorithm the name of the algorithm
* @param providerSupplier the provider supplier to search
* @return a password factory instance
* @throws NoSuchAlgorithmException if the given algorithm has no available implementations
*/
public static PasswordFactory getInstance(String algorithm, Supplier providerSupplier) throws NoSuchAlgorithmException {
for (Provider provider : providerSupplier.get()) {
final Provider.Service service = provider.getService("PasswordFactory", algorithm);
if (service != null) {
return new PasswordFactory((PasswordFactorySpi) service.newInstance(null), provider, algorithm);
}
}
throw log.noSuchAlgorithmInvalidAlgorithm(algorithm);
}
/**
* Get the provider of this password factory.
*
* @return the provider
*/
public Provider getProvider() {
return provider;
}
/**
* Get the algorithm of this password factory.
*
* @return the algorithm
*/
public String getAlgorithm() {
return algorithm;
}
/**
* Generate a new {@link Password} object for the given specification.
*
* @param keySpec the specification
* @return the password object
* @throws InvalidKeySpecException if the key specification is not valid for this algorithm
*/
public Password generatePassword(KeySpec keySpec) throws InvalidKeySpecException {
return spi.engineGeneratePassword(algorithm, keySpec);
}
/**
* Generate a key specification of the given type from the given password object.
*
* @param password the password object
* @param specType the specification class
* @param the specification type
* @return the key specification
* @throws InvalidKeySpecException if the password cannot be translated to the given key specification type
*/
public T getKeySpec(Password password, Class specType) throws InvalidKeySpecException {
return spi.engineGetKeySpec(algorithm, password, specType);
}
/**
* Determine whether the given password can be converted to the given key specification type by this factory.
*
* @param password the password object
* @param specType the specification class
* @param the specification type
* @return {@code true} if the password can be converted, {@code false} otherwise
*/
public boolean convertibleToKeySpec(Password password, Class specType) {
return spi.engineConvertibleToKeySpec(algorithm, password, specType);
}
/**
* Determine whether the given password can be translated into one which is consumable by this factory. If this
* method returns {@code true}, then {@link #translate(Password)} will succeed.
*
* @param password the password object
* @return {@code true} if the given password is supported by this algorithm, {@code false} otherwise
*/
public boolean isTranslatable(Password password) {
return spi.engineIsTranslatablePassword(algorithm, password);
}
/**
* Translate the given password object to one which is consumable by this factory.
*
* @param password the password object
* @return the equivalent password object that this factory can work with
* @throws InvalidKeyException if the given password is not supported by this algorithm
*/
public Password translate(Password password) throws InvalidKeyException {
return spi.engineTranslatePassword(algorithm, password);
}
/**
* Verify a password guess.
*
* @param password the password object
* @param guess the guessed password characters
* @return {@code true} if the guess matches the password, {@code false} otherwise
* @throws InvalidKeyException if the given password is not supported by this factory
*/
public boolean verify(Password password, char[] guess) throws InvalidKeyException {
return spi.engineVerify(algorithm, password, guess);
}
/**
* Verify a password guess.
*
* @param password the password object
* @param guess the guessed password characters
* @param hashCharset the character set to use when converting the password string to a byte array (must not be {@code null})
* @return {@code true} if the guess matches the password, {@code false} otherwise
* @throws InvalidKeyException if the given password is not supported by this factory
*/
public boolean verify(Password password, char[] guess, Charset hashCharset) throws InvalidKeyException {
return spi.engineVerify(algorithm, password, guess, hashCharset);
}
/**
* Transform a password with new parameters. Not every transformation is allowed, but iterative password types
* generally should allow increasing the number of iterations.
*
* @param password the password
* @param parameterSpec the new parameters
* @return the transformed password
* @throws InvalidKeyException if the given password is invalid
* @throws InvalidAlgorithmParameterException if the transformation cannot be applied to the given parameters
*/
public Password transform(Password password, AlgorithmParameterSpec parameterSpec) throws InvalidKeyException, InvalidAlgorithmParameterException {
return spi.engineTransform(algorithm, password, parameterSpec);
}
}