org.jasypt.encryption.pbe.config.PBEConfig Maven / Gradle / Ivy
Show all versions of activemq-osgi Show documentation
/*
* =============================================================================
*
* 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.encryption.pbe.config;
import java.security.Provider;
import org.jasypt.salt.SaltGenerator;
/**
*
* Common interface for config classes applicable to
* {@link org.jasypt.encryption.pbe.StandardPBEByteEncryptor},
* {@link org.jasypt.encryption.pbe.StandardPBEStringEncryptor},
* {@link org.jasypt.encryption.pbe.StandardPBEBigIntegerEncryptor} or
* {@link org.jasypt.encryption.pbe.StandardPBEBigDecimalEncryptor} objects.
*
*
* This interface lets the user create new PBEConfig
* classes which retrieve values for this parameters from different
* (and maybe more secure) sources (remote servers, LDAP, other databases...),
* and do this transparently for the encryptor object.
*
*
* The config objects passed to an encryptor will only be queried once
* for each configuration parameter, and this will happen
* during the initialization of the encryptor object.
*
*
* For a default implementation, see {@link SimplePBEConfig}.
*
*
* @since 1.0
*
* @author Daniel Fernández
*
*/
public interface PBEConfig {
/**
*
* Returns the algorithm to be used for encryption, like
* PBEWithMD5AndDES.
*
*
*
* This algorithm has to be supported by the specified JCE provider
* (or the default one if no provider has been specified) and, if the
* provider supports it, you can also specify mode and
* padding for it, like ALGORITHM/MODE/PADDING.
*
*
* @return the name of the algorithm to be used.
*/
public String getAlgorithm();
/**
*
* Returns the password to be used.
*
*
* There is no default value for password, so not setting
* this parameter either from a
* {@link org.jasypt.encryption.pbe.config.PBEConfig} object or from
* a call to setPassword will result in an
* EncryptionInitializationException being thrown during initialization.
*
*
* @return the password to be used.
*/
public String getPassword();
/**
*
* Returns the number of hashing iterations applied to obtain the
* encryption key.
*
*
* This mechanism is explained in
* PKCS #5: Password-Based Cryptography Standard.
*
*
* @return the number of iterations
*/
public Integer getKeyObtentionIterations();
/**
*
* Returns a {@link SaltGenerator} implementation to be used by the
* encryptor.
*
*
* If this method returns null, the encryptor will ignore the config object
* when deciding the salt generator to be used.
*
*
* @return the salt generator, or null if this object will not want to set
* a specific SaltGenerator implementation.
*/
public SaltGenerator getSaltGenerator();
/**
*
* Returns the name of the java.security.Provider implementation
* to be used by the encryptor for obtaining the encryption algorithm. This
* provider must have been registered beforehand.
*
*
* If this method returns null, the encryptor will ignore this parameter
* when deciding the name of the security provider to be used.
*
*
* If this method does not return null, and neither does {@link #getProvider()},
* providerName will be ignored, and the provider object returned
* by getProvider() will be used.
*
*
* @since 1.3
*
* @return the name of the security provider to be used.
*/
public String getProviderName();
/**
*
* Returns the java.security.Provider implementation object
* to be used by the encryptor for obtaining the encryption algorithm.
*
*
* If this method returns null, the encryptor will ignore this parameter
* when deciding the security provider object to be used.
*
*
* If this method does not return null, and neither does {@link #getProviderName()},
* providerName will be ignored, and the provider object returned
* by getProvider() will be used.
*
*
* The provider returned by this method does not need to be
* registered beforehand, and its use will not result in its
* being registered.
*
*
* @since 1.3
*
* @return the security provider object to be asked for the digest
* algorithm.
*/
public Provider getProvider();
/**
*
* Get the size of the pool of encryptors to be created.
*
*
* This parameter will be ignored if used with a non-pooled encryptor.
*
*
* @since 1.7
*
* @return the size of the pool to be used if this configuration is used with a
* pooled encryptor
*/
public Integer getPoolSize();
}