- java.lang.Object
-
- javax.crypto.KeyGenerator
-
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 akeysize
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 anAlgorithmParameterSpec
argument. One also has aSecureRandom
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
- Since:
- 1.4
- See Also:
SecretKey
- Algorithm-Independent Initialization
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
KeyGenerator(KeyGeneratorSpi keyGenSpi, Provider provider, String algorithm)
Creates a KeyGenerator object.
-
Method Summary
Methods Modifier and Type Method and Description SecretKey
generateKey()
Generates a secret key.String
getAlgorithm()
Returns the algorithm name of thisKeyGenerator
object.static KeyGenerator
getInstance(String algorithm)
Returns aKeyGenerator
object that generates secret keys for the specified algorithm.static KeyGenerator
getInstance(String algorithm, Provider provider)
Returns aKeyGenerator
object that generates secret keys for the specified algorithm.static KeyGenerator
getInstance(String algorithm, String provider)
Returns aKeyGenerator
object that generates secret keys for the specified algorithm.Provider
getProvider()
Returns the provider of thisKeyGenerator
object.void
init(AlgorithmParameterSpec params)
Initializes this key generator with the specified parameter set.void
init(AlgorithmParameterSpec params, SecureRandom random)
Initializes this key generator with the specified parameter set and a user-provided source of randomness.void
init(int keysize)
Initializes this key generator for a certain keysize.void
init(int keysize, SecureRandom random)
Initializes this key generator for a certain keysize, using a user-provided source of randomness.void
init(SecureRandom random)
Initializes this key generator.
-
-
-
Constructor Detail
-
KeyGenerator
protected KeyGenerator(KeyGeneratorSpi keyGenSpi, Provider provider, String algorithm)
Creates a KeyGenerator object.- Parameters:
keyGenSpi
- the delegateprovider
- the provideralgorithm
- the algorithm
-
-
Method Detail
-
getAlgorithm
public final String getAlgorithm()
Returns the algorithm name of thisKeyGenerator
object.This is the same name that was specified in one of the
getInstance
calls that created thisKeyGenerator
object.- Returns:
- the algorithm name of this
KeyGenerator
object.
-
getInstance
public static final KeyGenerator getInstance(String algorithm) throws NoSuchAlgorithmException
Returns aKeyGenerator
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, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aKeyGenerator
object that generates secret keys for the specified algorithm.A new KeyGenerator object encapsulating the KeyGeneratorSpi 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 key algorithm. See the KeyGenerator 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
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.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 KeyGenerator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aKeyGenerator
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 theprovider
is null.- See Also:
Provider
-
getProvider
public final Provider getProvider()
Returns the provider of thisKeyGenerator
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
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.)SecureRandom
- Parameters:
params
- the key generation parameters- Throws:
InvalidAlgorithmParameterException
- if the given parameters are inappropriate for this key generator
-
init
public final void init(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException
Initializes this key generator with the specified parameter set and a user-provided source of randomness.- Parameters:
params
- the key generation parametersrandom
- the source of randomness for this key generator- Throws:
InvalidAlgorithmParameterException
- ifparams
is 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
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.)SecureRandom
- 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
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/crypto/KeyGenerator.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.