com.entrust.toolkit.security.crypto.ec

Class EcAlgorithmParameters

java.lang.Object

java.security.AlgorithmParametersSpi

com.entrust.toolkit.security.crypto.ec.EcAlgorithmParameters

public class EcAlgorithmParameters
extends java.security.AlgorithmParametersSpi

An opaque representation of EC algorithm parameters.

This class provides the capability to convert EC algorithm parameters to/from transparent representation. Currently, the following transparent algorithm parameter representations are supported:

• java.security.spec.ECParameterSpec (this includes EcParameterSpecWithName)
• java.security.spec.ECGenParameterSpec

This class also provides the capability to convert EC algorithm parameters to/from encoded format. Currently, the following encoding/decoding formats are supported:

• ASN.1 - refer to EcParameterFactory for details on this encoding/decoding format

For a detailed description of the values contained in a set of EC algorithm parameters, refer to EcParameterSpecWithName.

Since:

7.2 SP2

See Also:

EcParameterSpecWithName, EcParameterFactory

Constructor Summary

Constructors

Constructor and Description
EcAlgorithmParameters() The constructor; creates a new instance of EC algorithm parameters.

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[]	engineGetEncoded() Returns the parameters in their primary encoding format.
protected byte[]	engineGetEncoded(java.lang.String format) Returns the parameters encoded in the specified format.
protected <T extends java.security.spec.AlgorithmParameterSpec> T	engineGetParameterSpec(java.lang.Class<T> paramSpec) Returns a (transparent) specification of this parameters object.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this parameters object using the parameters specified in paramSpec.
protected void	engineInit(byte[] params) Imports the specified parameters and decodes them according to the primary decoding format for parameters.
protected void	engineInit(byte[] params, java.lang.String format) Imports the parameters from params and decodes them according to the specified decoding format.
protected java.lang.String	engineToString() Returns a formatted string describing the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

EcAlgorithmParameters

public EcAlgorithmParameters()

The constructor; creates a new instance of EC algorithm parameters.

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

Method Detail

engineInit

protected void engineInit(java.security.spec.AlgorithmParameterSpec paramSpec)
                   throws java.security.spec.InvalidParameterSpecException

Initializes this parameters object using the parameters specified in paramSpec.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the parameter specification

Throws:

java.security.spec.InvalidParameterSpecException - if the given parameter specification is inappropriate for the initialization of this parameter object

engineInit

protected void engineInit(byte[] params)
                   throws java.io.IOException

Imports the specified parameters and decodes them according to the primary decoding format for parameters.

The primary decoding format for EC parameters is ASN.1; for details on this format refer to EcParameterFactory.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the encoded parameters.

Throws:

java.io.IOException - on decoding errors

engineInit

protected void engineInit(byte[] params,
              java.lang.String format)
                   throws java.io.IOException

Imports the parameters from params and decodes them according to the specified decoding format.

If format is null, the primary decoding format for parameters is used. The primary decoding format for EC parameters is ASN.1; for details on this format refer to EcParameterFactory. Currently, the following decoding formats are supported: 'ASN.1'.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the encoded parameters

format - the name of the decoding format

Throws:

java.io.IOException - if the decoding format is unsupported or a decoding error occurs

engineGetEncoded

protected byte[] engineGetEncoded()

Returns the parameters in their primary encoding format.

The primary encoding format for EC parameters is ASN.1; for details on this format refer to EcParameterFactory.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Returns:

the parameters encoded using the specified encoding scheme

engineGetEncoded

protected byte[] engineGetEncoded(java.lang.String format)
                           throws java.io.IOException

Returns the parameters encoded in the specified format.

If format is null, the primary encoding format for parameters is used. The primary encoding format for EC parameters is ASN.1; for details on this format refer to EcParameterFactory. Currently, the following encoding formats are supported: 'ASN.1'.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Parameters:

format - the name of the encoding format

Returns:

the parameters encoded using the specified encoding scheme

Throws:

java.io.IOException - if the encoding format is unsupported

engineGetParameterSpec

protected <T extends java.security.spec.AlgorithmParameterSpec> T engineGetParameterSpec(java.lang.Class<T> paramSpec)
                                                                              throws java.security.spec.InvalidParameterSpecException

Returns a (transparent) specification of this parameters object.

Specified by:

engineGetParameterSpec in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the specification class in which the parameters should be returned

Returns:

the parameter specification

Throws:

java.security.spec.InvalidParameterSpecException - if the requested parameter specification is inappropriate for this parameter object

engineToString

protected java.lang.String engineToString()

Returns a formatted string describing the parameters.

Specified by:

engineToString in class java.security.AlgorithmParametersSpi

Returns:

a formatted string describing the parameters