javax.crypto

Class KeyGenerator

Table des matières

  • public class KeyGenerator
extends Object
    This class provides the functionality of a secret (symmetric) key generator.

    Key generators are constructed using one of the getInstance class methods of this class.

    KeyGenerator objects are reusable, i.e., after a key has been generated, the same KeyGenerator object can be re-used to generate further keys.

    There are two ways to generate a key: in an algorithm-independent manner, and in an algorithm-specific manner. The only difference between the two is the initialization of the object:

    • Algorithm-Independent Initialization

      All key generators share the concepts of a keysize and a source of randomness. There is an init method in this KeyGenerator class that takes these two universally shared types of arguments. There is also one that takes just a keysize argument, and uses the SecureRandom implementation of the highest-priority installed provider as the source of randomness (or a system-provided source of randomness if none of the installed providers supply a SecureRandom implementation), and one that takes just a source of randomness.

      Since no other parameters are specified when you call the above algorithm-independent init methods, it is up to the provider what to do about the algorithm-specific parameters (if any) to be associated with each of the keys.

    • Algorithm-Specific Initialization

      For situations where a set of algorithm-specific parameters already exists, there are two init methods that have an AlgorithmParameterSpec argument. One also has a SecureRandom argument, while the other uses the SecureRandom implementation of the highest-priority installed provider as the source of randomness (or a system-provided source of randomness if none of the installed providers supply a SecureRandom implementation).

    In case the client does not explicitly initialize the KeyGenerator (via a call to an init method), each provider must supply (and document) a default initialization.

    Every implementation of the Java platform is required to support the following standard KeyGenerator algorithms with the keysizes in parentheses:

    • AES (128)
    • DES (56)
    • DESede (168)
    • HmacSHA1
    • HmacSHA256
    These algorithms are described in the KeyGenerator section of the Java Cryptography Architecture Standard Algorithm Name Documentation. Consult the release documentation for your implementation to see if any other algorithms are supported.
    Since:
    1.4
    See Also:
    SecretKey

    • Constructor Detail

      • KeyGenerator

        protected KeyGenerator(KeyGeneratorSpi keyGenSpi,
            Provider provider,
            String algorithm)
        Creates a KeyGenerator object.
        Parameters:
        keyGenSpi - the delegate
        provider - the provider
        algorithm - the algorithm

    • Method Detail

      • getAlgorithm

        public final String getAlgorithm()
        Returns the algorithm name of this KeyGenerator object.

        This is the same name that was specified in one of the getInstance calls that created this KeyGenerator object.

        Returns:
        the algorithm name of this KeyGenerator object.

      • getInstance

        public static final KeyGenerator getInstance(String algorithm)
                                      throws NoSuchAlgorithmException
        Returns a KeyGenerator object that generates secret keys for the specified algorithm.

        This method traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyGenerator object encapsulating the KeyGeneratorSpi 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 key algorithm. See the KeyGenerator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
        Returns:
        the new KeyGenerator object.
        Throws:
        NullPointerException - if the specified algorithm is null.
        NoSuchAlgorithmException - if no Provider supports a KeyGeneratorSpi implementation for the specified algorithm.
        See Also:
        Provider

      • getInstance

        public static final KeyGenerator getInstance(String algorithm,
                       Provider provider)
                                      throws NoSuchAlgorithmException
        Returns a KeyGenerator object that generates secret keys for the specified algorithm.

        A new KeyGenerator object encapsulating the KeyGeneratorSpi 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 key algorithm. See the KeyGenerator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
        provider - the provider.
        Returns:
        the new KeyGenerator object.
        Throws:
        NullPointerException - if the specified algorithm is null.
        NoSuchAlgorithmException - if a KeyGeneratorSpi implementation for the specified algorithm is not available from the specified Provider object.
        IllegalArgumentException - if the provider is null.
        See Also:
        Provider

      • getProvider

        public final Provider getProvider()
        Returns the provider of this KeyGenerator object.
        Returns:
        the provider of this KeyGenerator object

      • init

        public final void init(SecureRandom random)
        Initializes this key generator.
        Parameters:
        random - the source of randomness for this generator

      • init

        public final void init(AlgorithmParameterSpec params)
                throws InvalidAlgorithmParameterException
        Initializes this key generator with the specified parameter set.

        If this key generator requires any random bytes, it will get them using the SecureRandom implementation of the highest-priority installed provider as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness will be used.)

        Parameters:
        params - the key generation parameters
        Throws:
        InvalidAlgorithmParameterException - if the given parameters are inappropriate for this key generator

      • init

        public final void init(int keysize)
        Initializes this key generator for a certain keysize.

        If this key generator requires any random bytes, it will get them using the SecureRandom implementation of the highest-priority installed provider as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness will be used.)

        Parameters:
        keysize - the keysize. This is an algorithm-specific metric, specified in number of bits.
        Throws:
        InvalidParameterException - if the keysize is wrong or not supported.

      • init

        public final void init(int keysize,
        SecureRandom random)
        Initializes this key generator for a certain keysize, using a user-provided source of randomness.
        Parameters:
        keysize - the keysize. This is an algorithm-specific metric, specified in number of bits.
        random - the source of randomness for this key generator
        Throws:
        InvalidParameterException - if the keysize is wrong or not supported.

      • generateKey

        public final SecretKey generateKey()
        Generates a secret key.
        Returns:
        the new key

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

05/11/2024 22:00:37 Cette version de la page est en cache (à la date du 05/11/2024 22:00:37) 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 29/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/crypto/KeyGenerator.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

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com, KeyGenerator

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.

Table des matières Haut