com.entrust.toolkit.credentials

Class KeyGenerationParams

java.lang.Object

com.entrust.toolkit.credentials.KeyGenerationParams

public class KeyGenerationParams
extends java.lang.Object

Key generation parameters for a key pair generation utility that is used during digital identity management operations.

Provides the configuration information that is necessary when generating an asymmetric key pair, for example, the key type (key algorithm, key strength, and key parameters).

Since:

8.0

See Also:

KeyGenerationUtil

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKeyAlgorithm() Gets the key algorithm of the key pair being generated.
java.security.spec.AlgorithmParameterSpec	getKeyParams() Gets the key parameters of the key pair being generated.
int	getKeySizeBits() Gets the key size (in bits) of the key pair being generated.
EntrustAsymKeyType	getKeyType() Gets the key type of the key pair being generated.
java.lang.String	getKeyUsage() Gets the key usage of the key pair being generated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKeyAlgorithm

public java.lang.String getKeyAlgorithm()

Gets the key algorithm of the key pair being generated.

Returns:

the key algorithm (e.g. 'RSA')

getKeySizeBits

public int getKeySizeBits()

Gets the key size (in bits) of the key pair being generated.

Returns:

the key size in bits (e.g. 2048-bits)

getKeyParams

public java.security.spec.AlgorithmParameterSpec getKeyParams()

Gets the key parameters of the key pair being generated.

Note: Only certain asymmetric key types support key parameters; for example RSA-based and DSA-based key types do not contain key parameters, but EC-based key types do contain key parameters

Returns:

the key parameters (e.g. EC domain parameters); null for asymmetric key types that do not contain key parameters

getKeyType

public EntrustAsymKeyType getKeyType()

Gets the key type of the key pair being generated.

The key type contains the key algorithm, key size (in bits) and key parameters in a single identifier.

Returns:

the key type

getKeyUsage

public java.lang.String getKeyUsage()

Gets the key usage of the key pair being generated.

The key usage indicates what type of cryptographic operations the key pair can be used for. Currently supported key usage values are:

verification

Can be used only for digital signature generation/verification

encryption

Can be used only for encryption/decryption (key encipherment or key agreement, depending the on key algorithm)

both

Can be used for digital signature generation/verification and encryption/decryption

Returns:

the key usage