0N/A/*
2362N/A * Copyright (c) 1997, 2004, 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 java.security;
0N/A
0N/Aimport java.security.spec.KeySpec;
0N/Aimport java.security.spec.InvalidKeySpecException;
0N/A
0N/A/**
0N/A * This class defines the <i>Service Provider Interface</i> (<b>SPI</b>)
0N/A * for the <code>KeyFactory</code> class.
0N/A * All the abstract methods in this class must be implemented by each
0N/A * cryptographic service provider who wishes to supply the implementation
0N/A * of a key factory for a particular algorithm.
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 *
0N/A * <P> Key factories are bi-directional. That is, they allow you to build an
0N/A * opaque key object from a given key specification (key material), or to
0N/A * retrieve the underlying key material of a key object in a suitable format.
0N/A *
0N/A * <P> Multiple compatible key specifications may exist for the same key.
0N/A * For example, a DSA public key may be specified using
0N/A * <code>DSAPublicKeySpec</code> or
0N/A * <code>X509EncodedKeySpec</code>. A key factory can be used to translate
0N/A * between compatible key specifications.
0N/A *
0N/A * <P> A provider should document all the key specifications supported by its
0N/A * key factory.
0N/A *
0N/A * @author Jan Luehe
0N/A *
0N/A *
0N/A * @see KeyFactory
0N/A * @see Key
0N/A * @see PublicKey
0N/A * @see PrivateKey
0N/A * @see java.security.spec.KeySpec
0N/A * @see java.security.spec.DSAPublicKeySpec
0N/A * @see java.security.spec.X509EncodedKeySpec
0N/A *
0N/A * @since 1.2
0N/A */
0N/A
0N/Apublic abstract class KeyFactorySpi {
0N/A
0N/A /**
0N/A * Generates a public key object from the provided key
0N/A * specification (key material).
0N/A *
0N/A * @param keySpec the specification (key material) of the public key.
0N/A *
0N/A * @return the public key.
0N/A *
0N/A * @exception InvalidKeySpecException if the given key specification
0N/A * is inappropriate for this key factory to produce a public key.
0N/A */
0N/A protected abstract PublicKey engineGeneratePublic(KeySpec keySpec)
0N/A throws InvalidKeySpecException;
0N/A
0N/A /**
0N/A * Generates a private key object from the provided key
0N/A * specification (key material).
0N/A *
0N/A * @param keySpec the specification (key material) of the private key.
0N/A *
0N/A * @return the private key.
0N/A *
0N/A * @exception InvalidKeySpecException if the given key specification
0N/A * is inappropriate for this key factory to produce a private key.
0N/A */
0N/A protected abstract PrivateKey engineGeneratePrivate(KeySpec keySpec)
0N/A throws InvalidKeySpecException;
0N/A
0N/A /**
0N/A * Returns a specification (key material) of the given key
0N/A * object.
0N/A * <code>keySpec</code> identifies the specification class in which
0N/A * the key material should be returned. It could, for example, be
0N/A * <code>DSAPublicKeySpec.class</code>, to indicate that the
0N/A * key material should be returned in an instance of the
0N/A * <code>DSAPublicKeySpec</code> class.
0N/A *
0N/A * @param key the key.
0N/A *
0N/A * @param keySpec the specification class in which
0N/A * the key material should be returned.
0N/A *
0N/A * @return the underlying key specification (key material) in an instance
0N/A * of the requested specification class.
0N/A
0N/A * @exception InvalidKeySpecException if the requested key specification is
0N/A * inappropriate for the given key, or the given key cannot be dealt with
0N/A * (e.g., the given key has an unrecognized format).
0N/A */
0N/A protected abstract <T extends KeySpec>
0N/A T engineGetKeySpec(Key key, Class<T> keySpec)
0N/A throws InvalidKeySpecException;
0N/A
0N/A /**
0N/A * Translates a key object, whose provider may be unknown or
0N/A * potentially untrusted, into a corresponding key object of this key
0N/A * 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 key factory.
0N/A */
0N/A protected abstract Key engineTranslateKey(Key key)
0N/A throws InvalidKeyException;
0N/A
0N/A}