All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jasypt.digest.config.SimpleDigesterConfig Maven / Gradle / Ivy

There is a newer version: 6.1.3
Show newest version
/*
 * =============================================================================
 * 
 *   Copyright (c) 2007-2010, The JASYPT team (http://www.jasypt.org)
 * 
 *   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.jasypt.digest.config;

import java.security.Provider;

import org.jasypt.exceptions.EncryptionInitializationException;
import org.jasypt.salt.SaltGenerator;

/**
 * 

* Bean implementation for {@link DigesterConfig}. This class allows * the values for the configuration parameters to be set * via "standard" setX methods. *

*

* For any of the configuration parameters, if its setX * method is not called, a null value will be returned by the * corresponding getX method. *

*

* Note that there is not an exact correspondence between setX() * and getX() methods, as sometimes two methods like * setProvider() and setProviderClassName() will affect the * same configuration parameter (getProvider()). This means that * several combinations of setX() methods collide, and * should not be called together (a call to setProviderClassName() * will override any previous call to setProvider()). *

* * @since 1.0 * * @author Daniel Fernández * */ public class SimpleDigesterConfig implements DigesterConfig { private String algorithm = null; private Integer iterations = null; private Integer saltSizeBytes = null; private SaltGenerator saltGenerator = null; private String providerName = null; private Provider provider = null; private Boolean invertPositionOfSaltInMessageBeforeDigesting = null; private Boolean invertPositionOfPlainSaltInEncryptionResults = null; private Boolean useLenientSaltSizeCheck = null; private Integer poolSize = null; /** *

* Creates a new SimpleDigesterConfig instance. *

*/ public SimpleDigesterConfig() { super(); } /** *

* Sets the name of the algorithm. *

*

* This algorithm has to be supported by your security infrastructure, and * it should be allowed as an algorithm for creating * java.security.MessageDigest instances. *

*

* If you are specifying a security provider with {@link #setProvider(Provider)} or * {@link #setProviderName(String)}, this algorithm should be * supported by your specified provider. *

*

* If you are not specifying a provider, you will be able to use those * algorithms provided by the default security provider of your JVM vendor. * For valid names in the Sun JVM, see Java * Cryptography Architecture API Specification & * Reference. *

*

* Determines the result of: {@link #getAlgorithm()} *

* * @param algorithm the name of the algorithm. */ public void setAlgorithm(final String algorithm) { this.algorithm = algorithm; } /** *

* Sets the number of hashing iterations. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getIterations()} *

* * @param iterations the number of iterations. */ public void setIterations(final Integer iterations) { this.iterations = iterations; } /** *

* Sets the number of hashing iterations. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getIterations()} *

* * @since 1.4 * * @param iterations the number of iterations. */ public void setIterations(final String iterations) { if (iterations != null) { try { this.iterations = new Integer(iterations); } catch (NumberFormatException e) { throw new EncryptionInitializationException(e); } } else { this.iterations = null; } } /** *

* Size in bytes of the salt to be used. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getSaltSizeBytes()} *

* * @param saltSizeBytes the size of the salt, in bytes. */ public void setSaltSizeBytes(final Integer saltSizeBytes) { this.saltSizeBytes = saltSizeBytes; } /** *

* Size in bytes of the salt to be used. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getSaltSizeBytes()} *

* * @since 1.4 * * @param saltSizeBytes the size of the salt, in bytes. */ public void setSaltSizeBytes(final String saltSizeBytes) { if (saltSizeBytes != null) { try { this.saltSizeBytes = new Integer(saltSizeBytes); } catch (NumberFormatException e) { throw new EncryptionInitializationException(e); } } else { this.saltSizeBytes = null; } } /** *

* Sets the salt generator. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getSaltGenerator()} *

* * @since 1.2 * * @param saltGenerator the salt generator. */ public void setSaltGenerator(final SaltGenerator saltGenerator) { this.saltGenerator = saltGenerator; } /** *

* Sets the class name of the salt generator. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getSaltGenerator()} *

* * @since 1.4 * * @param saltGeneratorClassName the name of the salt generator class. */ public void setSaltGeneratorClassName(final String saltGeneratorClassName) { if (saltGeneratorClassName != null) { try { final Class saltGeneratorClass = Thread.currentThread().getContextClassLoader().loadClass(saltGeneratorClassName); this.saltGenerator = (SaltGenerator) saltGeneratorClass.newInstance(); } catch (Exception e) { throw new EncryptionInitializationException(e); } } else { this.saltGenerator = null; } } /** *

* Sets the name of the security provider to be asked for the digest * algorithm. This provider should be already registered. *

*

* If both the providerName and provider properties * are set, only provider will be used, and providerName * will have no meaning for the digester object. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getProviderName()} *

* * @since 1.3 * * @param providerName the name of the security provider. */ public void setProviderName(final String providerName) { this.providerName = providerName; } /** *

* Sets the security provider to be used for obtaining the digest * algorithm. This method is an alternative to * both {@link #setProviderName(String)} and * {@link #setProviderClassName(String)} and they should not be used * altogether. * The provider specified with {@link #setProvider(Provider)} does not * have to be registered beforehand, and its use will not result in its * being registered. *

*

* If both the providerName and provider properties * are set, only provider will be used, and providerName * will have no meaning for the digester object. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getProvider()} *

* * @since 1.3 * * @param provider the security provider object. */ public void setProvider(final Provider provider) { this.provider = provider; } /** *

* Sets the class name for the security provider to be used for * obtaining the digest algorithm. This method is an alternative to * both {@link #setProviderName(String)} {@link #setProvider(Provider)} * and they should not be used altogether. * The provider specified with {@link #setProviderClassName(String)} does not * have to be registered beforehand, and its use will not result in its * being registered. *

*

* If both the providerName and provider properties * are set, only provider will be used, and providerName * will have no meaning for the digester object. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getProvider()} *

* * @since 1.4 * * @param providerClassName the name of the security provider class. */ public void setProviderClassName(final String providerClassName) { if (providerClassName != null) { try { final Class providerClass = Thread.currentThread().getContextClassLoader().loadClass(providerClassName); this.provider = (Provider) providerClass.newInstance(); } catch (Exception e) { throw new EncryptionInitializationException(e); } } else { this.provider = null; } } /** *

* Whether the salt bytes are to be appended after the * message ones before performing the digest operation on the whole. The * default behaviour is to insert those bytes before the message bytes, but * setting this configuration item to true allows compatibility * with some external systems and specifications (e.g. LDAP {SSHA}). *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getInvertPositionOfSaltInMessageBeforeDigesting()} *

* * @since 1.7 * * @param invertPositionOfSaltInMessageBeforeDigesting * whether salt will be appended after the message before applying * the digest operation on the whole, instead of inserted before it * (which is the default). */ public void setInvertPositionOfSaltInMessageBeforeDigesting( final Boolean invertPositionOfSaltInMessageBeforeDigesting) { this.invertPositionOfSaltInMessageBeforeDigesting = invertPositionOfSaltInMessageBeforeDigesting; } /** *

* Whether the plain (not hashed) salt bytes are to * be appended after the digest operation result bytes. The default behaviour is * to insert them before the digest result, but setting this configuration * item to true allows compatibility with some external systems * and specifications (e.g. LDAP {SSHA}). *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getInvertPositionOfPlainSaltInEncryptionResults()} *

* * @since 1.7 * * @param invertPositionOfPlainSaltInEncryptionResults * whether plain salt will be appended after the digest operation * result instead of inserted before it (which is the * default). */ public void setInvertPositionOfPlainSaltInEncryptionResults( final Boolean invertPositionOfPlainSaltInEncryptionResults) { this.invertPositionOfPlainSaltInEncryptionResults = invertPositionOfPlainSaltInEncryptionResults; } /** *

* Whether digest matching operations will allow matching * digests with a salt size different to the one configured in the "saltSizeBytes" * property. This is possible because digest algorithms will produce a fixed-size * result, so the remaining bytes from the hashed input will be considered salt. *

*

* This will allow the digester to match digests produced in environments which do not * establish a fixed salt size as standard (for example, SSHA password encryption * in LDAP systems). *

*

* The value of this property will not affect the creation of digests, * which will always have a salt of the size established by the "saltSizeBytes" * property. It will only affect digest matching. *

*

* Setting this property to true is not compatible with {@link SaltGenerator} * implementations which return false for their * {@link SaltGenerator#includePlainSaltInEncryptionResults()} property. *

*

* Also, be aware that some algorithms or algorithm providers might not support * knowing the size of the digests beforehand, which is also incompatible with * a lenient behaviour. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getUseLenientSaltSizeCheck()} *

* * @since 1.7 * * @param useLenientSaltSizeCheck whether the digester will allow matching of * digests with different salt sizes than established or not (default * is false). */ public void setUseLenientSaltSizeCheck(final Boolean useLenientSaltSizeCheck) { this.useLenientSaltSizeCheck = useLenientSaltSizeCheck; } /** *

* Sets the size of the pool of digesters to be created. *

*

* This parameter will be ignored if used with a non-pooled digester. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getPoolSize()} *

* * @since 1.7 * * @param poolSize the size of the pool to be used if this configuration is used with a * pooled digester */ public void setPoolSize(final Integer poolSize) { this.poolSize = poolSize; } /** *

* Sets the size of the pool of digesters to be created. *

*

* This parameter will be ignored if used with a non-pooled digester. *

*

* If not set, null will be returned. *

*

* Determines the result of: {@link #getPoolSize()} *

* * @since 1.7 * * @param poolSize the size of the pool to be used if this configuration is used with a * pooled digester */ public void setPoolSize(final String poolSize) { if (poolSize != null) { try { this.poolSize = new Integer(poolSize); } catch (NumberFormatException e) { throw new EncryptionInitializationException(e); } } else { this.poolSize = null; } } public String getAlgorithm() { return this.algorithm; } public Integer getIterations() { return this.iterations; } public Integer getSaltSizeBytes() { return this.saltSizeBytes; } public SaltGenerator getSaltGenerator() { return this.saltGenerator; } public String getProviderName() { return this.providerName; } public Provider getProvider() { return this.provider; } public Boolean getInvertPositionOfSaltInMessageBeforeDigesting() { return this.invertPositionOfSaltInMessageBeforeDigesting; } public Boolean getInvertPositionOfPlainSaltInEncryptionResults() { return this.invertPositionOfPlainSaltInEncryptionResults; } public Boolean getUseLenientSaltSizeCheck() { return this.useLenientSaltSizeCheck; } public Integer getPoolSize() { return this.poolSize; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy