KeyFactory.java 9.2 KB
Newer Older
Tom Tromey committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/* KeyFactory.java --- Key Factory Class
   Copyright (C) 1999, 2003, 2004  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.security;

import gnu.java.security.Engine;

43
import java.lang.reflect.InvocationTargetException;
Tom Tromey committed
44 45 46 47
import java.security.spec.InvalidKeySpecException;
import java.security.spec.KeySpec;

/**
48
 * Key factories are used to convert keys (opaque cryptographic keys of type
Tom Tromey committed
49
 * {@link Key}) into key specifications (transparent representations of the
50 51 52 53 54 55 56
 * underlying key material).
 * 
 * <p>Key factories are bi-directional. They allow a key class to be converted
 * into a key specification (key material) and back again. For example DSA
 * public keys can be specified as <code>DSAPublicKeySpec</code> or
 * <code>X509EncodedKeySpec</code>. A key factory translates these key
 * specifications.</p>
Tom Tromey committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
 *
 * @since 1.2
 * @see Key
 * @see KeySpec
 * @see java.security.spec.DSAPublicKeySpec
 * @see java.security.spec.X509EncodedKeySpec
   @author Mark Benvenuto
 */
public class KeyFactory
{
  /** The service name for key factories. */
  private static final String KEY_FACTORY = "KeyFactory";

  private KeyFactorySpi keyFacSpi;
  private Provider provider;
  private String algorithm;

  /**
75 76 77 78 79 80 81 82 83
   * Constructs a new instance of <code>KeyFactory</code> with the specified
   * parameters.
   * 
   * @param keyFacSpi
   *          the key factory to use.
   * @param provider
   *          the provider to use.
   * @param algorithm
   *          the name of the key algorithm to use.
Tom Tromey committed
84 85 86 87 88 89 90 91 92 93
   */
  protected KeyFactory(KeyFactorySpi keyFacSpi, Provider provider,
		       String algorithm)
  {
    this.keyFacSpi = keyFacSpi;
    this.provider = provider;
    this.algorithm = algorithm;
  }

  /**
94 95 96
   * Returns a new instance of <code>KeyFactory</code> representing the
   * specified key factory.
   * 
97
   * @param algorithm the name of algorithm to use.
98
   * @return a new instance repesenting the desired algorithm.
99 100 101 102
   * @throws NoSuchAlgorithmException if the algorithm is not implemented by any
   *           provider.
   * @throws IllegalArgumentException if <code>algorithm</code> is
   *           <code>null</code> or is an empty string.
Tom Tromey committed
103 104
   */
  public static KeyFactory getInstance(String algorithm)
105
      throws NoSuchAlgorithmException
Tom Tromey committed
106 107
  {
    Provider[] p = Security.getProviders();
108
    NoSuchAlgorithmException lastException = null;
Tom Tromey committed
109 110 111 112 113
    for (int i = 0; i < p.length; i++)
      try
        {
          return getInstance(algorithm, p[i]);
        }
114 115 116 117 118 119
      catch (NoSuchAlgorithmException x)
        {
          lastException = x;
        }
    if (lastException != null)
      throw lastException;
Tom Tromey committed
120 121 122 123
    throw new NoSuchAlgorithmException(algorithm);
  }

  /**
124 125 126
   * Returns a new instance of <code>KeyFactory</code> representing the
   * specified key factory from the specified provider.
   * 
127 128
   * @param algorithm the name of algorithm to use.
   * @param provider the name of the provider to use.
129
   * @return a new instance repesenting the desired algorithm.
130 131 132 133 134
   * @throws NoSuchAlgorithmException if the algorithm is not implemented by the
   *           named provider.
   * @throws NoSuchProviderException if the named provider was not found.
   * @throws IllegalArgumentException if either <code>algorithm</code> or
   *           <code>provider</code> is <code>null</code> or empty.
Tom Tromey committed
135 136
   */
  public static KeyFactory getInstance(String algorithm, String provider)
137
      throws NoSuchAlgorithmException, NoSuchProviderException
Tom Tromey committed
138
  {
139 140 141 142 143
    if (provider == null)
      throw new IllegalArgumentException("provider MUST NOT be null");
    provider = provider.trim();
    if (provider.length() == 0)
      throw new IllegalArgumentException("provider MUST NOT be empty");
Tom Tromey committed
144 145 146 147 148 149 150
    Provider p = Security.getProvider(provider);
    if (p == null)
      throw new NoSuchProviderException(provider);
    return getInstance(algorithm, p);
  }

  /**
151 152 153
   * Returns a new instance of <code>KeyFactory</code> representing the
   * specified key factory from the designated {@link Provider}.
   * 
154 155
   * @param algorithm the name of algorithm to use.
   * @param provider the {@link Provider} to use.
156
   * @return a new instance repesenting the desired algorithm.
157 158 159 160 161
   * @throws NoSuchAlgorithmException if the algorithm is not implemented by
   *           {@link Provider}.
   * @throws IllegalArgumentException if either <code>algorithm</code> or
   *           <code>provider</code> is <code>null</code>, or if
   *           <code>algorithm</code> is an empty string.
Tom Tromey committed
162 163 164 165
   * @since 1.4
   * @see Provider
   */
  public static KeyFactory getInstance(String algorithm, Provider provider)
166
      throws NoSuchAlgorithmException
Tom Tromey committed
167
  {
168 169 170 171
    StringBuilder sb = new StringBuilder("KeyFactory for algorithm [")
        .append(algorithm).append("] from provider[")
        .append(provider).append("] could not be created");
    Throwable cause;
Tom Tromey committed
172 173
    try
      {
174 175
        Object spi = Engine.getInstance(KEY_FACTORY, algorithm, provider);
        return new KeyFactory((KeyFactorySpi) spi, provider, algorithm);
Tom Tromey committed
176
      }
177
    catch (InvocationTargetException x)
Tom Tromey committed
178
      {
179 180 181 182 183
        cause = x.getCause();
        if (cause instanceof NoSuchAlgorithmException)
          throw (NoSuchAlgorithmException) cause;
        if (cause == null)
          cause = x;
Tom Tromey committed
184
      }
185
    catch (ClassCastException x)
Tom Tromey committed
186
      {
187 188 189 190 191
        cause = x;
      }
    NoSuchAlgorithmException x = new NoSuchAlgorithmException(sb.toString());
    x.initCause(cause);
    throw x;
Tom Tromey committed
192 193 194
  }

  /**
195 196 197
   * Returns the {@link Provider} of this instance.
   * 
   * @return the {@link Provider} of this instance.
Tom Tromey committed
198 199 200 201 202 203 204
   */
  public final Provider getProvider()
  {
    return provider;
  }

  /**
205 206 207
   * Returns the name of the algorithm used.
   * 
   * @return the name of the algorithm used.
Tom Tromey committed
208 209 210 211 212 213 214
   */
  public final String getAlgorithm()
  {
    return algorithm;
  }

  /**
215 216 217 218
   * Generates a public key from the provided key specification.
   * 
   * @param keySpec
   *          the key specification.
Tom Tromey committed
219
   * @return the public key.
220 221
   * @throws InvalidKeySpecException
   *           if the key specification is invalid.
Tom Tromey committed
222 223 224 225 226 227 228 229
   */
  public final PublicKey generatePublic(KeySpec keySpec)
    throws InvalidKeySpecException
  {
    return keyFacSpi.engineGeneratePublic(keySpec);
  }

  /**
230 231 232 233
   * Generates a private key from the provided key specification.
   * 
   * @param keySpec
   *          the key specification.
Tom Tromey committed
234
   * @return the private key.
235 236
   * @throws InvalidKeySpecException
   *           if the key specification is invalid.
Tom Tromey committed
237 238 239 240 241 242 243 244
   */
  public final PrivateKey generatePrivate(KeySpec keySpec)
    throws InvalidKeySpecException
  {
    return keyFacSpi.engineGeneratePrivate(keySpec);
  }

  /**
245 246 247 248 249 250 251 252 253 254 255 256
   * Returns a key specification for the given key. <code>keySpec</code>
   * identifies the specification class to return the key material in.
   * 
   * @param key
   *          the key to use.
   * @param keySpec
   *          the specification class to use.
   * @return the key specification in an instance of the requested specification
   *         class.
   * @throws InvalidKeySpecException
   *           the requested key specification is inappropriate for this key or
   *           the key is unrecognized.
Tom Tromey committed
257
   */
258
  public final <T extends KeySpec> T getKeySpec(Key key, Class<T> keySpec)
Tom Tromey committed
259 260 261 262 263 264
    throws InvalidKeySpecException
  {
    return keyFacSpi.engineGetKeySpec(key, keySpec);
  }

  /**
265 266 267 268 269
   * Translates the key from an unknown or untrusted provider into a key from
   * this key factory.
   * 
   * @param key
   *          the key to translate from.
Tom Tromey committed
270
   * @return the translated key.
271 272
   * @throws InvalidKeyException
   *           if the key cannot be processed by this key factory.
Tom Tromey committed
273 274 275 276 277 278
   */
  public final Key translateKey(Key key) throws InvalidKeyException
  {
    return keyFacSpi.engineTranslateKey(key);
  }
}