com.entrust.toolkit.security.crypto.ec

Class EcKeyFactory

java.lang.Object

java.security.KeyFactorySpi

com.entrust.toolkit.security.crypto.ec.EcKeyFactory

public class EcKeyFactory
extends java.security.KeyFactorySpi

An Elliptic Curve (EC) key factory.

An EC key factory is used to convert EC keys between opaque (java.security.Key) and transparent (java.security.spec.KeySpec) representation. This EC key factory is capable to converting to and from the following key specifications:

Public Key:

• java.security.spec.ECPublicKeySpec
• java.security.spec.X509EncodedKeySpec

Private Key:

• java.security.spec.ECPrivateKeySpec
• java.security.spec.PKCS8EncodedKeySpec

When converting to key representation, the key is always returned as one of the following:

Public Key:

• EcPublicKey

Private Key:

• EcPrivateKey

When converting from key representation, the following key input formats are supported:

Public Key:

• java.security.interfaces.ECPublicKey (this includes EcPublicKey)
• java.security.PublicKey with algorithm 'EC' and format 'X.509' (this includes ECDSAPublicKey)

Private Key:

• java.security.interfaces.ECPrivateKey (this includes EcPrivateKey)
• java.security.PrivateKey with algorithm 'EC' and format 'PKCS#8' (this includes ECDSAPrivateKey)

Since:

7.2 SP2

See Also:

EcKeyPairGenerator, EcdsaSignature

Constructor Summary

Constructors

Constructor and Description
EcKeyFactory() The constructor; creates a new instance of an EC key factory.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.security.PrivateKey	engineGeneratePrivate(java.security.spec.KeySpec keySpec) Generates a private key object from the provided key specification (key material).
protected java.security.PublicKey	engineGeneratePublic(java.security.spec.KeySpec keySpec) Generates a public key object from the provided key specification (key material).
protected <T extends java.security.spec.KeySpec> T	engineGetKeySpec(java.security.Key key, java.lang.Class<T> keySpec) Returns a specification (key material) of the given key object
protected java.security.Key	engineTranslateKey(java.security.Key key) Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this key factory.

Methods inherited from class java.lang.Object

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

Constructor Detail

EcKeyFactory

public EcKeyFactory()

The constructor; creates a new instance of an EC key factory.

Applications should never use this constructor, instead the key factory should be requested from the appropriate JCA/JCE cryptographic service provider as follows: KeyFactory.getInstance("EC", "Entrust").

Method Detail

engineGeneratePublic

protected java.security.PublicKey engineGeneratePublic(java.security.spec.KeySpec keySpec)
                                                throws java.security.spec.InvalidKeySpecException

Generates a public key object from the provided key specification (key material).

Specified by:

engineGeneratePublic in class java.security.KeyFactorySpi

Parameters:

keySpec - the specification (key material) of the public key

Returns:

the public key

Throws:

java.security.spec.InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a public key

engineGeneratePrivate

protected java.security.PrivateKey engineGeneratePrivate(java.security.spec.KeySpec keySpec)
                                                  throws java.security.spec.InvalidKeySpecException

Generates a private key object from the provided key specification (key material).

Specified by:

engineGeneratePrivate in class java.security.KeyFactorySpi

Parameters:

keySpec - the specification (key material) of the private key

Returns:

the private key

Throws:

java.security.spec.InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a private key

engineGetKeySpec

protected <T extends java.security.spec.KeySpec> T engineGetKeySpec(java.security.Key key,
                                                        java.lang.Class<T> keySpec)
                                                         throws java.security.spec.InvalidKeySpecException

Returns a specification (key material) of the given key object

keySpec identifies the specification class in which the key material should be returned. It could, for example, be ECPublicKeySpec.class, to indicate that the key material should be returned in an instance of the ECPublicKeySpec class.

Specified by:

engineGetKeySpec in class java.security.KeyFactorySpi

Parameters:

key - the key

keySpec - the specification class in which the key material should be returned

Returns:

the underlying key specification (key material) in an instance of the requested specification class

Throws:

java.security.spec.InvalidKeySpecException - if the requested key specification is inappropriate for the given key, or the given key cannot be dealt with (e.g., the given key has an unrecognized format)

engineTranslateKey

protected java.security.Key engineTranslateKey(java.security.Key key)
                                        throws java.security.InvalidKeyException

Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this key factory.

Specified by:

engineTranslateKey in class java.security.KeyFactorySpi

Parameters:

key - the key whose provider is unknown or untrusted

Returns:

the translated key

Throws:

java.security.InvalidKeyException - if the given key cannot be processed by this key factory