javax.crypto

Class SecretKeyFactorySpi

  1. java.lang.Object
  2. extended byjavax.crypto.SecretKeyFactorySpi

  1. public abstract class SecretKeyFactorySpi
  2. extends java.lang.Object
This class defines the Service Provider Interface (SPI) for the SecretKeyFactory class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a secret-key factory for a particular algorithm.

A provider should document all the key specifications supported by its secret key factory. For example, the DES secret-key factory supplied by the "SunJCE" provider supports DESKeySpec as a transparent representation of DES keys, and that provider's secret-key factory for Triple DES keys supports DESedeKeySpec as a transparent representation of Triple DES keys.

Since:
1.4
Version:
1.9, 01/06/04
Author:
Jan Luehe
See Also:
SecretKey, DESKeySpec, DESedeKeySpec

Constructor Summary

Constructor and Description
SecretKeyFactorySpi()

Method Summary

Modifier and Type Method and Description
  1. protected abstract
  2. SecretKey
engineGenerateSecret(java.security.spec.KeySpec keySpec)
Generates a SecretKey object from the provided key specification (key material).
  1. protected abstract
  2. java.security.spec.KeySpec
engineGetKeySpec(SecretKey key,java.lang.Class keySpec)
Returns a specification (key material) of the given key object in the requested format.
  1. protected abstract
  2. SecretKey
engineTranslateKey(SecretKey key)
Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this secret-key factory.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecretKeyFactorySpi

  1. public SecretKeyFactorySpi()

Method Detail

engineGenerateSecret

  1. protected abstract SecretKey engineGenerateSecret( java.security.spec.KeySpec keySpec)
  2. throws java.security.spec.InvalidKeySpecException
Generates a SecretKey object from the provided key specification (key material).
Parameters:
keySpec - the specification (key material) of the secret key
Returns:
the secret key
Throws:
java.security.spec.InvalidKeySpecException - if the given key specification is inappropriate for this secret-key factory to produce a secret key.

engineGetKeySpec

  1. protected abstract java.security.spec.KeySpec engineGetKeySpec( SecretKey key,
  2. java.lang.Class keySpec)
  3. throws java.security.spec.InvalidKeySpecException
Returns a specification (key material) of the given key object in the requested format.
Parameters:
key - the key
keySpec - the requested format in which the key material shall be returned
Returns:
the underlying key specification (key material) in the requested format
Throws:
java.security.spec.InvalidKeySpecException - if the requested key specification is inappropriate for the given key (e.g., the algorithms associated with key and keySpec do not match, or key references a key on a cryptographic hardware device whereas keySpec is the specification of a software-based key), or the given key cannot be dealt with (e.g., the given key has an algorithm or format not supported by this secret-key factory).

engineTranslateKey

  1. protected abstract SecretKey engineTranslateKey( SecretKey key)
  2. throws java.security.InvalidKeyException
Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this secret-key factory.
Parameters:
key - the key whose provider is unknown or untrusted
Returns:
the translated key
Throws:
java.security.InvalidKeyException - if the given key cannot be processed by this secret-key factory.