0N/A/*
2362N/A * Copyright (c) 1997, 2007, 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.security.*;
0N/Aimport java.security.spec.*;
0N/A
0N/A/**
0N/A * This class defines the <i>Service Provider Interface</i> (<b>SPI</b>)
0N/A * for the <code>SecretKeyFactory</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 secret-key factory for a particular algorithm.
0N/A *
0N/A * <P> A provider should document all the key specifications supported by its
0N/A * secret key factory.
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 *
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 * @since 1.4
0N/A */
0N/A
0N/Apublic abstract class SecretKeyFactorySpi {
0N/A
0N/A /**
0N/A * Generates a <code>SecretKey</code> object from the
0N/A * provided key 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 protected abstract SecretKey engineGenerateSecret(KeySpec keySpec)
0N/A throws InvalidKeySpecException;
0N/A
0N/A /**
0N/A * Returns a specification (key material) of the given key
0N/A * object in the requested format.
0N/A *
0N/A * @param key the key
0N/A *
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 protected abstract KeySpec engineGetKeySpec(SecretKey key, Class 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
0N/A * 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 protected abstract SecretKey engineTranslateKey(SecretKey key)
0N/A throws InvalidKeyException;
0N/A}