- java.lang.Object
-
- javax.crypto.SecretKeyFactory
-
public class SecretKeyFactory extends Object
This class represents a factory for secret keys.Key factories are used to convert keys (opaque cryptographic keys of type
Key
) into key specifications (transparent representations of the underlying key material), and vice versa. Secret key factories operate only on secret (symmetric) keys.Key factories are bi-directional, i.e., they allow to build an opaque key object from a given key specification (key material), or to retrieve the underlying key material of a key object in a suitable format.
Application developers should refer to their provider's documentation to find out which key specifications are supported by the
generateSecret
andgetKeySpec
methods. For example, the DES secret-key factory supplied by the "SunJCE" provider supportsDESKeySpec
as a transparent representation of DES keys, and that provider's secret-key factory for Triple DES keys supportsDESedeKeySpec
as a transparent representation of Triple DES keys.Every implementation of the Java platform is required to support the following standard
SecretKeyFactory
algorithms:- DES
- DESede
- Since:
- 1.4
- See Also:
SecretKey
,DESKeySpec
,DESedeKeySpec
,PBEKeySpec
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
SecretKeyFactory(SecretKeyFactorySpi keyFacSpi, Provider provider, String algorithm)
Creates a SecretKeyFactory object.
-
Method Summary
Methods Modifier and Type Method and Description SecretKey
generateSecret(KeySpec keySpec)
Generates aSecretKey
object from the provided key specification (key material).String
getAlgorithm()
Returns the algorithm name of thisSecretKeyFactory
object.static SecretKeyFactory
getInstance(String algorithm)
Returns aSecretKeyFactory
object that converts secret keys of the specified algorithm.static SecretKeyFactory
getInstance(String algorithm, Provider provider)
Returns aSecretKeyFactory
object that converts secret keys of the specified algorithm.static SecretKeyFactory
getInstance(String algorithm, String provider)
Returns aSecretKeyFactory
object that converts secret keys of the specified algorithm.KeySpec
getKeySpec(SecretKey key, Class keySpec)
Returns a specification (key material) of the given key object in the requested format.Provider
getProvider()
Returns the provider of thisSecretKeyFactory
object.SecretKey
translateKey(SecretKey key)
Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this secret-key factory.
-
-
-
Constructor Detail
-
SecretKeyFactory
protected SecretKeyFactory(SecretKeyFactorySpi keyFacSpi, Provider provider, String algorithm)
Creates a SecretKeyFactory object.- Parameters:
keyFacSpi
- the delegateprovider
- the provideralgorithm
- the secret-key algorithm
-
-
Method Detail
-
getInstance
public static final SecretKeyFactory getInstance(String algorithm) throws NoSuchAlgorithmException
Returns aSecretKeyFactory
object that converts secret keys of the specified algorithm.This method traverses the list of registered security Providers, starting with the most preferred Provider. A new SecretKeyFactory object encapsulating the SecretKeyFactorySpi implementation from the first Provider that supports the specified algorithm is returned.
Note that the list of registered providers may be retrieved via the
Security.getProviders()
method.- Parameters:
algorithm
- the standard name of the requested secret-key algorithm. See the SecretKeyFactory section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.- Returns:
- the new
SecretKeyFactory
object. - Throws:
NullPointerException
- if the specified algorithm is null.NoSuchAlgorithmException
- if no Provider supports a SecretKeyFactorySpi implementation for the specified algorithm.- See Also:
Provider
-
getInstance
public static final SecretKeyFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aSecretKeyFactory
object that converts secret keys of the specified algorithm.A new SecretKeyFactory object encapsulating the SecretKeyFactorySpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via the
Security.getProviders()
method.- Parameters:
algorithm
- the standard name of the requested secret-key algorithm. See the SecretKeyFactory section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the name of the provider.- Returns:
- the new
SecretKeyFactory
object. - Throws:
NoSuchAlgorithmException
- if a SecretKeyFactorySpi implementation for the specified algorithm is not available from the specified provider.NullPointerException
- if the specified algorithm is null.NoSuchProviderException
- if the specified provider is not registered in the security provider list.IllegalArgumentException
- if theprovider
is null or empty.- See Also:
Provider
-
getInstance
public static final SecretKeyFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aSecretKeyFactory
object that converts secret keys of the specified algorithm.A new SecretKeyFactory object encapsulating the SecretKeyFactorySpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
- Parameters:
algorithm
- the standard name of the requested secret-key algorithm. See the SecretKeyFactory section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the provider.- Returns:
- the new
SecretKeyFactory
object. - Throws:
NullPointerException
- if the specified algorithm is null.NoSuchAlgorithmException
- if a SecretKeyFactorySpi implementation for the specified algorithm is not available from the specified Provider object.IllegalArgumentException
- if theprovider
is null.- See Also:
Provider
-
getProvider
public final Provider getProvider()
Returns the provider of thisSecretKeyFactory
object.- Returns:
- the provider of this
SecretKeyFactory
object
-
getAlgorithm
public final String getAlgorithm()
Returns the algorithm name of thisSecretKeyFactory
object.This is the same name that was specified in one of the
getInstance
calls that created thisSecretKeyFactory
object.- Returns:
- the algorithm name of this
SecretKeyFactory
object.
-
generateSecret
public final SecretKey generateSecret(KeySpec keySpec) throws InvalidKeySpecException
Generates aSecretKey
object from the provided key specification (key material).- Parameters:
keySpec
- the specification (key material) of the secret key- Returns:
- the secret key
- Throws:
InvalidKeySpecException
- if the given key specification is inappropriate for this secret-key factory to produce a secret key.
-
getKeySpec
public final KeySpec getKeySpec(SecretKey key, Class keySpec) throws InvalidKeySpecException
Returns a specification (key material) of the given key object in the requested format.- Parameters:
key
- the keykeySpec
- the requested format in which the key material shall be returned- Returns:
- the underlying key specification (key material) in the requested format
- Throws:
InvalidKeySpecException
- if the requested key specification is inappropriate for the given key (e.g., the algorithms associated withkey
andkeySpec
do not match, orkey
references a key on a cryptographic hardware device whereaskeySpec
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).
-
translateKey
public final SecretKey translateKey(SecretKey key) throws 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:
InvalidKeyException
- if the given key cannot be processed by this secret-key factory.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
23/12/2024 20:59:45 Cette version de la page est en cache (à la date du 23/12/2024 20:59:45) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/crypto/SecretKeyFactory.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.