com.entrust.toolkit.security.provider

Class ECDSAPrivateKey

java.lang.Object

iaik.pkcs.pkcs8.PrivateKeyInfo

com.entrust.toolkit.security.provider.ECDSAPrivateKey

All Implemented Interfaces:

ASN1Type, java.io.Serializable, java.lang.Cloneable, java.security.Key, java.security.PrivateKey, java.security.spec.KeySpec, javax.security.auth.Destroyable

Deprecated.

since 7.2 SP2; use EcPrivateKey instead

public class ECDSAPrivateKey
extends PrivateKeyInfo
implements java.security.Key, java.security.spec.KeySpec, java.security.PrivateKey, java.io.Serializable, java.lang.Cloneable

Enables the storage of ECDSA private keys.

The user specific part of the private key is a large integer which is ASN1 encoded as an INTEGER value. However, this value is then wrapped as a PKCS#8 object, so that additional information (such as the algorithm IDs and the parameter) can be added.

The ASN1 structure is as follows:

 PrivateKeyInfo ::= SEQUENCE {
   version Version,
   privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
   privateKey PrivateKey
   attributes [0] IMPLICIT Attributes OPTIONAL }
 

where:

 Version ::= INTEGER   -- Syntax Version Number, must be 0.
 PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier
                                   private key algorithm, i.e.,
                                   must be a SEQUENCE containing the
                                   OID "1.2.840.10045.2.1" and the
                                   ECParameters value in ASN1 encoded form.
                                   See ANSI X9.62.
 PrivateKey ::= OCTET STRING       the value of the private key, i.e.,
                                   a BER encoded INTEGER value containing
                                   the ECDSA private key.
 Attributes ::= SET OF Attribute   additional information,
                                   will be ignored if there is any.
 

Note

The ASN1 encoding of the ECDSA private key is not defined in X9.62.

See Also:

Serialized Form

Field Summary

Fields inherited from class iaik.pkcs.pkcs8.PrivateKeyInfo

private_key_algorithm, private_key_info

Fields inherited from interface java.security.PrivateKey

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ECDSAPrivateKey(ASN1Object object) Deprecated. Initializes the ECDSA private key with an ASN1 structure.
ECDSAPrivateKey(byte[] array) Deprecated. Initializes the ECDSA private key with a DER encoded ASN1 structure.
ECDSAPrivateKey(ECParameters params, java.math.BigInteger privateExponent) Deprecated. Default public constructor that takes the parameter and the private exponent as arguments.
ECDSAPrivateKey(java.io.InputStream is) Deprecated. Initializes the ECDSA private key with a DER encoded ASN1 structure given as an input stream.

Method Summary

Modifier and Type	Method and Description
void	decode(byte[] key) Deprecated. Initializes the private exponent of the calling ECDSA private key with a DER encoded ASN1 structure.
byte[]	encode() Deprecated. Encodes the private exponent of the calling ECDSA private key as a DER encoded ASN1 structure (INTEGER).
java.lang.String	getAlgorithm() Deprecated. Returns the name of the calling algorithm — ECDSA.
ECParameters	getECParameters() Deprecated. Returns the parameter value.
java.lang.String	getFormat() Deprecated. Returns the name of the primary encoding format of this key — PKCS#8.
java.math.BigInteger	getPrivateExponent() Deprecated. Returns the private exponent.

Methods inherited from class iaik.pkcs.pkcs8.PrivateKeyInfo

createPrivateKeyInfo, decode, equals, getEncoded, getPrivateKey, getPrivateKey, toASN1Object, toString, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Key

getEncoded

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Constructor Detail

ECDSAPrivateKey

public ECDSAPrivateKey(ECParameters params,
                       java.math.BigInteger privateExponent)

Deprecated.

Default public constructor that takes the parameter and the private exponent as arguments.

Parameters:

params - the parameter set used for computing with the private key

privateExponent - the real private information

ECDSAPrivateKey

public ECDSAPrivateKey(ASN1Object object)
                throws java.security.InvalidKeyException

Deprecated.

Initializes the ECDSA private key with an ASN1 structure.

Parameters:

object - - the private key as an ASN1Object structure

Note

Precondition: ASN1 structure must be constructed as shown in the class description (PKCS 8).

Throws:

java.security.InvalidKeyException - if the object is malformed

ECDSAPrivateKey

public ECDSAPrivateKey(byte[] array)
                throws java.security.InvalidKeyException

Deprecated.

Initializes the ECDSA private key with a DER encoded ASN1 structure.

Parameters:

array - the private key as DER encoded ASN1 structure

Note

Precondition: ASN1 structure must be constructed as shown in the class description (PKCS 8).

Throws:

java.security.InvalidKeyException - if the object is malformed.

ECDSAPrivateKey

public ECDSAPrivateKey(java.io.InputStream is)
                throws java.security.InvalidKeyException,
                       java.io.IOException

Deprecated.

Initializes the ECDSA private key with a DER encoded ASN1 structure given as an input stream.

Parameters:

is - the private key as DER encoded ASN1 structure as an input stream

Note

Precondition: ASN1 structure must be constructed as shown in the class description (PKCS 8).

Throws:

InvalidKeyException, - IOException if the object is malformed.

java.security.InvalidKeyException

java.io.IOException

Method Detail

decode

public void decode(byte[] key)
            throws java.security.InvalidKeyException

Deprecated.

Initializes the private exponent of the calling ECDSA private key with a DER encoded ASN1 structure.

The private exponent must provided as a DER encoded INTEGER object.

Specified by:

decode in class PrivateKeyInfo

Parameters:

key - the private key as DER encoded ASN1 structure (INTEGER)

Throws:

java.security.InvalidKeyException - if the object is malformed.

encode

public byte[] encode()

Deprecated.

Encodes the private exponent of the calling ECDSA private key as a DER encoded ASN1 structure (INTEGER).

Specified by:

encode in class PrivateKeyInfo

Returns:

the private key as DER encoded ASN1 structure (INTEGER)

getAlgorithm

public java.lang.String getAlgorithm()

Deprecated.

Returns the name of the calling algorithm — ECDSA.

Specified by:

getAlgorithm in interface java.security.Key

Specified by:

getAlgorithm in class PrivateKeyInfo

Returns:

the String "ECDSA"

getECParameters

public ECParameters getECParameters()
                             throws CodingException

Deprecated.

Returns the parameter value.

Returns:

an ECParameters object

Throws:

CodingException

getPrivateExponent

public java.math.BigInteger getPrivateExponent()

Deprecated.

Returns the private exponent.

Returns:

the private exponent as a BigInteger object

getFormat

public java.lang.String getFormat()

Deprecated.

Returns the name of the primary encoding format of this key — PKCS#8.

Specified by:

getFormat in interface java.security.Key

Overrides:

getFormat in class PrivateKeyInfo

Returns:

the String "PKCS#8"