Added in API level 1

KeyPairGeneratorSpi

abstract class KeyPairGeneratorSpi

kotlin.Any
↳	java.security.KeyPairGeneratorSpi

Known Direct Subclasses KeyPairGenerator KeyPairGenerator The KeyPairGenerator class is used to generate pairs of public and private keys.

This class defines the Service Provider Interface (SPI) for the KeyPairGenerator class, which is used to generate pairs of public and private keys.

All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a key pair generator for a particular algorithm.

In case the client does not explicitly initialize the KeyPairGenerator (via a call to an initialize method), each provider must supply (and document) a default initialization. For example, the Sun provider uses a default modulus size (keysize) of 1024 bits.

Summary

Public constructors
KeyPairGeneratorSpi()

Public methods
abstract KeyPair!	generateKeyPair() Generates a key pair.
abstract Unit	initialize(keysize: Int, random: SecureRandom!) Initializes the key pair generator for a certain keysize, using the default parameter set.
open Unit	initialize(params: AlgorithmParameterSpec!, random: SecureRandom!) Initializes the key pair generator using the specified parameter set and user-provided source of randomness.

Public constructors

KeyPairGeneratorSpi

Added in API level 1

KeyPairGeneratorSpi()

Public methods

generateKeyPair

Added in API level 1

abstract fun generateKeyPair(): KeyPair!

Generates a key pair. Unless an initialization method is called using a KeyPairGenerator interface, algorithm-specific defaults will be used. This will generate a new key pair every time it is called.

Return
KeyPair!	the newly generated KeyPair

initialize

Added in API level 1

abstract fun initialize(
    keysize: Int, 
    random: SecureRandom!
): Unit

Initializes the key pair generator for a certain keysize, using the default parameter set.

Parameters
keysize	Int: the keysize. This is an algorithm-specific metric, such as modulus length, specified in number of bits.
random	SecureRandom!: the source of randomness for this generator.

Exceptions
java.security.InvalidParameterException	if the keysize is not supported by this KeyPairGeneratorSpi object.

initialize

Added in API level 1

open fun initialize(
    params: AlgorithmParameterSpec!, 
    random: SecureRandom!
): Unit

Initializes the key pair generator using the specified parameter set and user-provided source of randomness.

This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.) It may be overridden by a provider to initialize the key pair generator. Such an override is expected to throw an InvalidAlgorithmParameterException if a parameter is inappropriate for this key pair generator. If this method is not overridden, it always throws an UnsupportedOperationException.

Parameters
params	AlgorithmParameterSpec!: the parameter set used to generate the keys.
random	SecureRandom!: the source of randomness for this generator.

Exceptions
java.security.InvalidAlgorithmParameterException	if the given parameters are inappropriate for this key pair generator.