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

org.apache.commons.crypto.cipher.CryptoCipherFactory Maven / Gradle / Ivy

Go to download

Apache Commons Crypto is a cryptographic library optimized with AES-NI (Advanced Encryption Standard New Instructions). It provides Java API for both cipher level and Java stream level. Developers can use it to implement high performance AES encryption/decryption with the minimum code and effort. Please note that Crypto doesn't implement the cryptographic algorithm such as AES directly. It wraps to Openssl or JCE which implement the algorithms. Features -------- 1. Cipher API for low level cryptographic operations. 2. Java stream API (CryptoInputStream/CryptoOutputStream) for high level stream encyrption/decryption. 3. Both optimized with high performance AES encryption/decryption. (1400 MB/s - 1700 MB/s throughput in modern Xeon processors). 4. JNI-based implementation to achieve comparable performance to the native C++ version based on OpenSsl. 5. Portable across various operating systems (currently only Linux/MacOSX/Windows); Apache Commons Crypto loads the library according to your machine environment (it checks system properties, `os.name` and `os.arch`). 6. Simple usage. Add the commons-crypto-(version).jar file to your classpath. Export restrictions ------------------- This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See <http://www.wassenaar.org/> for more information. The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. The following provides more details on the included cryptographic software: * Commons Crypto use [Java Cryptography Extension](http://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html) provided by Java * Commons Crypto link to and use [OpenSSL](https://www.openssl.org/) ciphers

There is a newer version: 1.2.0
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.commons.crypto.cipher;

import java.security.GeneralSecurityException;
import java.util.List;
import java.util.Properties;

import org.apache.commons.crypto.Crypto;
import org.apache.commons.crypto.utils.ReflectionUtils;
import org.apache.commons.crypto.utils.Utils;

/**
 * This is the factory class used for creating {@link CryptoCipher} instances.
 */
public class CryptoCipherFactory {

    /**
     * The configuration key of the provider class for JCE cipher.
     */
    public static final String JCE_PROVIDER_KEY = Crypto.CONF_PREFIX
            + "cipher.jce.provider";
    /**
     * The configuration key of the CryptoCipher implementation class.
     * 

* The value of CLASSES_KEY needs to be the full name of a * class that implements the * {@link org.apache.commons.crypto.cipher.CryptoCipher CryptoCipher} interface * The internal classes are listed in the enum * {@link CipherProvider CipherProvider} * which can be used to obtain the full class name. *

* The value can also be a comma-separated list of class names in * order of descending priority. */ public static final String CLASSES_KEY = Crypto.CONF_PREFIX + "cipher.classes"; /** * Defines the internal CryptoCipher implementations. *

* Usage: *

     * props.setProperty(CryptoCipherFactory.CLASSES_KEY, CipherProvider.OPENSSL.getClassName());
     * props.setProperty(...); // if required by the implementation
     * cipher = CryptoCipherFactory.getInstance(transformation, props);
     * 
*/ public enum CipherProvider { /** * The OpenSSL cipher implementation (using JNI) *

* This implementation does not use any properties */ // Please ensure the property description agrees with the implementation OPENSSL(OpenSslCipher.class), /** * The JCE cipher implementation from the JVM *

* uses the property {@link #JCE_PROVIDER_KEY} * to define the provider name, if present. */ // Please ensure the property description agrees with the implementation JCE(JceCipher.class); private final Class klass; private final String className; /** * The private constructor. * @param klass the Class of CryptoCipher */ private CipherProvider(Class klass) { this.klass = klass; this.className = klass.getName(); } /** * Gets the class name of the provider. * * @return the fully qualified name of the provider class */ public String getClassName() { return className; } /** * Gets the implementation class of the provider. * * @return the implementation class of the provider */ public Class getImplClass() { return klass; } } /** * For AES, the algorithm block is fixed size of 128 bits. * * @see * http://en.wikipedia.org/wiki/Advanced_Encryption_Standard */ public static final int AES_BLOCK_SIZE = 16; /** * The default value (OPENSSL,JCE) for crypto cipher. */ private static final String CLASSES_DEFAULT = CipherProvider.OPENSSL.getClassName() .concat(",") .concat(CipherProvider.JCE.getClassName()); /** * The private Constructor of {@link CryptoCipherFactory}. */ private CryptoCipherFactory() { } /** * Gets a cipher instance for specified algorithm/mode/padding. * * @param props the configuration properties - uses {@link #CLASSES_KEY} * @param transformation algorithm/mode/padding * @return CryptoCipher the cipher (defaults to OpenSslCipher) * @throws GeneralSecurityException if cipher initialize failed * @throws IllegalArgumentException if no classname(s) were provided */ public static CryptoCipher getCryptoCipher(String transformation, Properties props) throws GeneralSecurityException { final List names = Utils.splitClassNames(getCipherClassString(props), ","); if (names.size() == 0) { throw new IllegalArgumentException("No classname(s) provided"); } CryptoCipher cipher = null; Exception lastException = null; StringBuilder errorMessage = new StringBuilder("CryptoCipher "); for (String klass : names) { try { Class cls = ReflectionUtils.getClassByName(klass); cipher = ReflectionUtils.newInstance(cls.asSubclass (CryptoCipher.class), props, transformation); if (cipher != null) { break; } } catch (Exception e) { lastException = e; errorMessage.append("{" + klass + "}"); } } if (cipher != null) { return cipher; } errorMessage.append(" is not available or transformation " + transformation + " is not supported."); throw new GeneralSecurityException(errorMessage.toString(), lastException); } /** * Gets a cipher for algorithm/mode/padding in config value * commons.crypto.cipher.transformation * * @param transformation the name of the transformation, e.g., * AES/CBC/PKCS5Padding. * See the Java Cryptography Architecture Standard Algorithm Name Documentation * for information about standard transformation names. * @return CryptoCipher the cipher object (defaults to OpenSslCipher if available, else JceCipher) * @throws GeneralSecurityException if JCE cipher initialize failed */ public static CryptoCipher getCryptoCipher(String transformation) throws GeneralSecurityException { return getCryptoCipher(transformation, new Properties()); } /** * Gets the cipher class. * * @param props The Properties class represents a set of * properties. * @return the cipher class based on the props. */ private static String getCipherClassString(Properties props) { String cipherClassString = props.getProperty(CryptoCipherFactory.CLASSES_KEY, CLASSES_DEFAULT); if (cipherClassString.isEmpty()) { // TODO does it make sense to treat the empty string as the default? cipherClassString = CLASSES_DEFAULT; } return cipherClassString; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy