0N/A/*
3678N/A * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage javax.crypto;
0N/A
0N/Aimport java.util.*;
0N/A
0N/Aimport java.security.*;
0N/Aimport java.security.Provider.Service;
0N/Aimport java.security.spec.*;
0N/A
0N/Aimport sun.security.jca.*;
0N/Aimport sun.security.jca.GetInstance.Instance;
0N/A
0N/A/**
0N/A * This class represents a factory for secret keys.
0N/A *
0N/A * <P> Key factories are used to convert <I>keys</I> (opaque
0N/A * cryptographic keys of type <code>Key</code>) into <I>key specifications</I>
0N/A * (transparent representations of the underlying key material), and vice
0N/A * versa.
0N/A * Secret key factories operate only on secret (symmetric) keys.
0N/A *
0N/A * <P> Key factories are bi-directional, i.e., they allow to build an opaque
0N/A * key object from a given key specification (key material), or to retrieve
0N/A * the underlying key material of a key object in a suitable format.
0N/A *
0N/A * <P> Application developers should refer to their provider's documentation
0N/A * to find out which key specifications are supported by the
0N/A * {@link #generateSecret(java.security.spec.KeySpec) generateSecret} and
0N/A * {@link #getKeySpec(javax.crypto.SecretKey, java.lang.Class) getKeySpec}
0N/A * methods.
0N/A * For example, the DES secret-key factory supplied by the "SunJCE" provider
0N/A * supports <code>DESKeySpec</code> as a transparent representation of DES
0N/A * keys, and that provider's secret-key factory for Triple DES keys supports
0N/A * <code>DESedeKeySpec</code> as a transparent representation of Triple DES
0N/A * keys.
0N/A *
3465N/A * <p> Every implementation of the Java platform is required to support the
3465N/A * following standard <code>SecretKeyFactory</code> algorithms:
3465N/A * <ul>
3465N/A * <li><tt>DES</tt></li>
3465N/A * <li><tt>DESede</tt></li>
3465N/A * </ul>
3465N/A * These algorithms are described in the <a href=
3465N/A * "{@docRoot}/../technotes/guides/security/StandardNames.html#SecretKeyFactory">
3465N/A * SecretKeyFactory section</a> of the
3465N/A * Java Cryptography Architecture Standard Algorithm Name Documentation.
3465N/A * Consult the release documentation for your implementation to see if any
3465N/A * other algorithms are supported.
3465N/A *
0N/A * @author Jan Luehe
0N/A *
0N/A * @see SecretKey
0N/A * @see javax.crypto.spec.DESKeySpec
0N/A * @see javax.crypto.spec.DESedeKeySpec
0N/A * @see javax.crypto.spec.PBEKeySpec
0N/A * @since 1.4
0N/A */
0N/A
0N/Apublic class SecretKeyFactory {
0N/A
0N/A // The provider
0N/A private Provider provider;
0N/A
0N/A // The algorithm associated with this factory
0N/A private final String algorithm;
0N/A
0N/A // The provider implementation (delegate)
0N/A private volatile SecretKeyFactorySpi spi;
0N/A
0N/A // lock for mutex during provider selection
0N/A private final Object lock = new Object();
0N/A
0N/A // remaining services to try in provider selection
0N/A // null once provider is selected
0N/A private Iterator serviceIterator;
0N/A
0N/A /**
0N/A * Creates a SecretKeyFactory object.
0N/A *
0N/A * @param keyFacSpi the delegate
0N/A * @param provider the provider
0N/A * @param algorithm the secret-key algorithm
0N/A */
0N/A protected SecretKeyFactory(SecretKeyFactorySpi keyFacSpi,
0N/A Provider provider, String algorithm) {
0N/A this.spi = keyFacSpi;
0N/A this.provider = provider;
0N/A this.algorithm = algorithm;
0N/A }
0N/A
0N/A private SecretKeyFactory(String algorithm) throws NoSuchAlgorithmException {
0N/A this.algorithm = algorithm;
0N/A List list = GetInstance.getServices("SecretKeyFactory", algorithm);
0N/A serviceIterator = list.iterator();
0N/A // fetch and instantiate initial spi
0N/A if (nextSpi(null) == null) {
0N/A throw new NoSuchAlgorithmException
0N/A (algorithm + " SecretKeyFactory not available");
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Returns a <code>SecretKeyFactory</code> object that converts
0N/A * secret keys of the specified algorithm.
0N/A *
0N/A * <p> This method traverses the list of registered security Providers,
0N/A * starting with the most preferred Provider.
0N/A * A new SecretKeyFactory object encapsulating the
0N/A * SecretKeyFactorySpi implementation from the first
0N/A * Provider that supports the specified algorithm is returned.
0N/A *
0N/A * <p> Note that the list of registered providers may be retrieved via
0N/A * the {@link Security#getProviders() Security.getProviders()} method.
0N/A *
0N/A * @param algorithm the standard name of the requested secret-key
0N/A * algorithm.
3465N/A * See the SecretKeyFactory section in the <a href=
3465N/A * "{@docRoot}/../technotes/guides/security/StandardNames.html#SecretKeyFactory">
3465N/A * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
0N/A * for information about standard algorithm names.
0N/A *
0N/A * @return the new <code>SecretKeyFactory</code> object.
0N/A *
0N/A * @exception NullPointerException if the specified algorithm
0N/A * is null.
0N/A *
0N/A * @exception NoSuchAlgorithmException if no Provider supports a
0N/A * SecretKeyFactorySpi implementation for the
0N/A * specified algorithm.
0N/A *
0N/A * @see java.security.Provider
0N/A */
0N/A public static final SecretKeyFactory getInstance(String algorithm)
0N/A throws NoSuchAlgorithmException {
0N/A return new SecretKeyFactory(algorithm);
0N/A }
0N/A
0N/A /**
0N/A * Returns a <code>SecretKeyFactory</code> object that converts
0N/A * secret keys of the specified algorithm.
0N/A *
0N/A * <p> A new SecretKeyFactory object encapsulating the
0N/A * SecretKeyFactorySpi implementation from the specified provider
0N/A * is returned. The specified provider must be registered
0N/A * in the security provider list.
0N/A *
0N/A * <p> Note that the list of registered providers may be retrieved via
0N/A * the {@link Security#getProviders() Security.getProviders()} method.
0N/A *
0N/A * @param algorithm the standard name of the requested secret-key
0N/A * algorithm.
3465N/A * See the SecretKeyFactory section in the <a href=
3465N/A * "{@docRoot}/../technotes/guides/security/StandardNames.html#SecretKeyFactory">
3465N/A * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
0N/A * for information about standard algorithm names.
0N/A *
0N/A * @param provider the name of the provider.
0N/A *
0N/A * @return the new <code>SecretKeyFactory</code> object.
0N/A *
0N/A * @exception NoSuchAlgorithmException if a SecretKeyFactorySpi
0N/A * implementation for the specified algorithm is not
0N/A * available from the specified provider.
0N/A *
0N/A * @exception NullPointerException if the specified algorithm
0N/A * is null.
0N/A *
0N/A * @throws NoSuchProviderException if the specified provider is not
0N/A * registered in the security provider list.
0N/A *
0N/A * @exception IllegalArgumentException if the <code>provider</code>
0N/A * is null or empty.
0N/A *
0N/A * @see java.security.Provider
0N/A */
0N/A public static final SecretKeyFactory getInstance(String algorithm,
0N/A String provider) throws NoSuchAlgorithmException,
0N/A NoSuchProviderException {
0N/A Instance instance = JceSecurity.getInstance("SecretKeyFactory",
0N/A SecretKeyFactorySpi.class, algorithm, provider);
0N/A return new SecretKeyFactory((SecretKeyFactorySpi)instance.impl,
0N/A instance.provider, algorithm);
0N/A }
0N/A
0N/A /**
0N/A * Returns a <code>SecretKeyFactory</code> object that converts
0N/A * secret keys of the specified algorithm.
0N/A *
0N/A * <p> A new SecretKeyFactory object encapsulating the
0N/A * SecretKeyFactorySpi implementation from the specified Provider
0N/A * object is returned. Note that the specified Provider object
0N/A * does not have to be registered in the provider list.
0N/A *
0N/A * @param algorithm the standard name of the requested secret-key
0N/A * algorithm.
3465N/A * See the SecretKeyFactory section in the <a href=
3465N/A * "{@docRoot}/../technotes/guides/security/StandardNames.html#SecretKeyFactory">
3465N/A * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
0N/A * for information about standard algorithm names.
0N/A *
0N/A * @param provider the provider.
0N/A *
0N/A * @return the new <code>SecretKeyFactory</code> object.
0N/A *
0N/A * @exception NullPointerException if the specified algorithm
0N/A * is null.
0N/A *
0N/A * @exception NoSuchAlgorithmException if a SecretKeyFactorySpi
0N/A * implementation for the specified algorithm is not available
0N/A * from the specified Provider object.
0N/A *
0N/A * @exception IllegalArgumentException if the <code>provider</code>
0N/A * is null.
0N/A *
0N/A * @see java.security.Provider
0N/A */
0N/A public static final SecretKeyFactory getInstance(String algorithm,
0N/A Provider provider) throws NoSuchAlgorithmException {
0N/A Instance instance = JceSecurity.getInstance("SecretKeyFactory",
0N/A SecretKeyFactorySpi.class, algorithm, provider);
0N/A return new SecretKeyFactory((SecretKeyFactorySpi)instance.impl,
0N/A instance.provider, algorithm);
0N/A }
0N/A
0N/A /**
0N/A * Returns the provider of this <code>SecretKeyFactory</code> object.
0N/A *
0N/A * @return the provider of this <code>SecretKeyFactory</code> object
0N/A */
0N/A public final Provider getProvider() {
0N/A synchronized (lock) {
0N/A // disable further failover after this call
0N/A serviceIterator = null;
0N/A return provider;
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Returns the algorithm name of this <code>SecretKeyFactory</code> object.
0N/A *
0N/A * <p>This is the same name that was specified in one of the
0N/A * <code>getInstance</code> calls that created this
0N/A * <code>SecretKeyFactory</code> object.
0N/A *
0N/A * @return the algorithm name of this <code>SecretKeyFactory</code>
0N/A * object.
0N/A */
0N/A public final String getAlgorithm() {
0N/A return this.algorithm;
0N/A }
0N/A
0N/A /**
0N/A * Update the active spi of this class and return the next
0N/A * implementation for failover. If no more implemenations are
0N/A * available, this method returns null. However, the active spi of
0N/A * this class is never set to null.
0N/A */
0N/A private SecretKeyFactorySpi nextSpi(SecretKeyFactorySpi oldSpi) {
0N/A synchronized (lock) {
0N/A // somebody else did a failover concurrently
0N/A // try that spi now
0N/A if ((oldSpi != null) && (oldSpi != spi)) {
0N/A return spi;
0N/A }
0N/A if (serviceIterator == null) {
0N/A return null;
0N/A }
0N/A while (serviceIterator.hasNext()) {
0N/A Service s = (Service)serviceIterator.next();
0N/A if (JceSecurity.canUseProvider(s.getProvider()) == false) {
0N/A continue;
0N/A }
0N/A try {
0N/A Object obj = s.newInstance(null);
0N/A if (obj instanceof SecretKeyFactorySpi == false) {
0N/A continue;
0N/A }
0N/A SecretKeyFactorySpi spi = (SecretKeyFactorySpi)obj;
0N/A provider = s.getProvider();
0N/A this.spi = spi;
0N/A return spi;
0N/A } catch (NoSuchAlgorithmException e) {
0N/A // ignore
0N/A }
0N/A }
0N/A serviceIterator = null;
0N/A return null;
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Generates a <code>SecretKey</code> object from the provided key
0N/A * specification (key material).
0N/A *
0N/A * @param keySpec the specification (key material) of the secret key
0N/A *
0N/A * @return the secret key
0N/A *
0N/A * @exception InvalidKeySpecException if the given key specification
0N/A * is inappropriate for this secret-key factory to produce a secret key.
0N/A */
0N/A public final SecretKey generateSecret(KeySpec keySpec)
0N/A throws InvalidKeySpecException {
0N/A if (serviceIterator == null) {
0N/A return spi.engineGenerateSecret(keySpec);
0N/A }
0N/A Exception failure = null;
0N/A SecretKeyFactorySpi mySpi = spi;
0N/A do {
0N/A try {
0N/A return mySpi.engineGenerateSecret(keySpec);
0N/A } catch (Exception e) {
0N/A if (failure == null) {
0N/A failure = e;
0N/A }
0N/A mySpi = nextSpi(mySpi);
0N/A }
0N/A } while (mySpi != null);
0N/A if (failure instanceof InvalidKeySpecException) {
0N/A throw (InvalidKeySpecException)failure;
0N/A }
0N/A throw new InvalidKeySpecException
0N/A ("Could not generate secret key", failure);
0N/A }
0N/A
0N/A /**
0N/A * Returns a specification (key material) of the given key object
0N/A * in the requested format.
0N/A *
0N/A * @param key the key
0N/A * @param keySpec the requested format in which the key material shall be
0N/A * returned
0N/A *
0N/A * @return the underlying key specification (key material) in the
0N/A * requested format
0N/A *
0N/A * @exception InvalidKeySpecException if the requested key specification is
0N/A * inappropriate for the given key (e.g., the algorithms associated with
0N/A * <code>key</code> and <code>keySpec</code> do not match, or
0N/A * <code>key</code> references a key on a cryptographic hardware device
0N/A * whereas <code>keySpec</code> is the specification of a software-based
0N/A * key), or the given key cannot be dealt with
0N/A * (e.g., the given key has an algorithm or format not supported by this
0N/A * secret-key factory).
0N/A */
0N/A public final KeySpec getKeySpec(SecretKey key, Class keySpec)
0N/A throws InvalidKeySpecException {
0N/A if (serviceIterator == null) {
0N/A return spi.engineGetKeySpec(key, keySpec);
0N/A }
0N/A Exception failure = null;
0N/A SecretKeyFactorySpi mySpi = spi;
0N/A do {
0N/A try {
0N/A return mySpi.engineGetKeySpec(key, keySpec);
0N/A } catch (Exception e) {
0N/A if (failure == null) {
0N/A failure = e;
0N/A }
0N/A mySpi = nextSpi(mySpi);
0N/A }
0N/A } while (mySpi != null);
0N/A if (failure instanceof InvalidKeySpecException) {
0N/A throw (InvalidKeySpecException)failure;
0N/A }
0N/A throw new InvalidKeySpecException
0N/A ("Could not get key spec", failure);
0N/A }
0N/A
0N/A /**
0N/A * Translates a key object, whose provider may be unknown or potentially
0N/A * untrusted, into a corresponding key object of this secret-key factory.
0N/A *
0N/A * @param key the key whose provider is unknown or untrusted
0N/A *
0N/A * @return the translated key
0N/A *
0N/A * @exception InvalidKeyException if the given key cannot be processed
0N/A * by this secret-key factory.
0N/A */
0N/A public final SecretKey translateKey(SecretKey key)
0N/A throws InvalidKeyException {
0N/A if (serviceIterator == null) {
0N/A return spi.engineTranslateKey(key);
0N/A }
0N/A Exception failure = null;
0N/A SecretKeyFactorySpi mySpi = spi;
0N/A do {
0N/A try {
0N/A return mySpi.engineTranslateKey(key);
0N/A } catch (Exception e) {
0N/A if (failure == null) {
0N/A failure = e;
0N/A }
0N/A mySpi = nextSpi(mySpi);
0N/A }
0N/A } while (mySpi != null);
0N/A if (failure instanceof InvalidKeyException) {
0N/A throw (InvalidKeyException)failure;
0N/A }
0N/A throw new InvalidKeyException
0N/A ("Could not translate key", failure);
0N/A }
0N/A}