com.sun.faces.renderkit.ByteArrayGuard Maven / Gradle / Ivy
/*
* $Id: ByteArrayGuard.java,v 1.16 2007/07/19 15:32:45 rlubke Exp $
*/
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.renderkit;
import javax.crypto.Cipher;
import javax.crypto.NullCipher;
import javax.crypto.SecretKeyFactory;
import javax.crypto.spec.DESedeKeySpec;
import javax.crypto.spec.IvParameterSpec;
import javax.faces.FacesException;
import java.security.Key;
import java.security.MessageDigest;
import java.security.SecureRandom;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.sun.faces.util.FacesLogger;
/**
* This utility class is to provide both encryption and
* decryption Ciphers to ResponseStateManager
* implementations wishing to provide encryption support.
*
* The algorithm used to encrypt byte array is 3DES with CBC.
*
* Original author Inderjeet Singh, J2EE Blue Prints Team. Modified to suit JSF
* needs.
*/
public final class ByteArrayGuard {
// Log instance for this class
private static final Logger LOGGER = FacesLogger.RENDERKIT.getLogger();
private static final int IV_LENGTH = 8;
private static final int KEY_LENGTH = 24;
private static Cipher NULL_CIPHER = new NullCipher();
private Cipher decryptCipher = NULL_CIPHER;
private Cipher encryptCipher = NULL_CIPHER;
// ------------------------------------------------------------ Constructors
/**
* Constructs a new ByteArrayGuard using the specified
* keyLength, macLength, ivLength.
* @param password the password to seed the encryption
*/
public ByteArrayGuard(String password) {
if (password != null) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
"Client state saving encryption enabled.");
}
byte[] passwordKey = convertPasswordToKey(password.getBytes());
try {
SecureRandom prng = SecureRandom.getInstance("SHA1PRNG");
SecretKeyFactory keygen = SecretKeyFactory.getInstance("DESede");
encryptCipher =
getBlockCipherForEncryption(keygen, prng, passwordKey);
byte[] iVector = encryptCipher.getIV();
decryptCipher =
getBlockCipherForDecryption(keygen,
prng,
passwordKey,
iVector);
} catch (Exception e) {
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE,
"Unexpected exception initializing encryption."
+ " No encryption will be performed.",
e);
}
encryptCipher = NULL_CIPHER;
decryptCipher = NULL_CIPHER;
}
}
}
// ---------------------------------------------------------- Public Methods
public Cipher getEncryptionCipher() {
return encryptCipher;
}
public Cipher getDecryptionCipher() {
return decryptCipher;
}
// --------------------------------------------------------- Private Methods
/**
* This method converts the specified password into a key in a
* deterministic manner. The key is then usable for creating ciphers
* and MACs.
*
* @param password plain text password
*
* @return a byte array containing a key based on the specified
* password. The length of the returned byte array is KEY_LENGTH.
*/
private byte[] convertPasswordToKey(byte[] password) {
try {
MessageDigest md = MessageDigest.getInstance("SHA");
byte[] seed = md.digest(password);
SecureRandom random = SecureRandom.getInstance("SHA1PRNG");
random.setSeed(seed);
byte[] rawkey = new byte[KEY_LENGTH];
random.nextBytes(rawkey);
return rawkey;
} catch (Exception e) {
throw new FacesException(e);
}
}
/**
* Obtain a Cipher for decrypting data.
* @param keyGen the key factory
* @param random secure random
* @param rawKey must be 24 bytes in length.
* @param iv initialization vector @return a 3DES block cipher to be used for decryption based on the
* specified key
* @return an initialized Cipher for decryption
*/
private Cipher getBlockCipherForDecryption(SecretKeyFactory keyGen,
SecureRandom random,
byte[] rawKey,
byte[] iv) {
try {
DESedeKeySpec keyspec = new DESedeKeySpec(rawKey);
Key key = keyGen.generateSecret(keyspec);
Cipher cipher = Cipher.getInstance("DESede/CBC/PKCS5Padding");
IvParameterSpec ivspec = new IvParameterSpec(iv);
cipher.init(Cipher.DECRYPT_MODE, key, ivspec, random);
return cipher;
} catch (Exception e) {
throw new FacesException(e);
}
}
/**
* Obtain a Cipher for encrypting data.
* @param keyGen the key factory
* @param random secure random
* @param rawKey must be 24 bytes in length. @return a 3DES block cipher to be used for encryption based on the
* specified key
* @return an initialized Cipher for decryption
*/
private Cipher getBlockCipherForEncryption(SecretKeyFactory keyGen,
SecureRandom random,
byte[] rawKey) {
try {
DESedeKeySpec keyspec = new DESedeKeySpec(rawKey);
Key key = keyGen.generateSecret(keyspec);
Cipher cipher = Cipher.getInstance("DESede/CBC/PKCS5Padding");
byte[] iv = new byte[IV_LENGTH];
random.nextBytes(iv);
IvParameterSpec ivspec = new IvParameterSpec(iv);
cipher.init(Cipher.ENCRYPT_MODE, key, ivspec, random);
return cipher;
} catch (Exception e) {
throw new FacesException(e);
}
}
}