com.entrust.toolkit.security.crypto.ec

Class EcParameterSpecWithName

java.lang.Object

java.security.spec.ECParameterSpec

com.entrust.toolkit.security.crypto.ec.EcParameterSpecWithName

All Implemented Interfaces:

java.security.spec.AlgorithmParameterSpec

public class EcParameterSpecWithName
extends java.security.spec.ECParameterSpec

This class represents a set of Elliptic Curve (EC) domain parameters, with a domain name and parameter format indicator.

The domain name and parameter format indicator, together with the EC domain parameter values, allow three different EC domain parameter formats to be supported. Each supported format is described in detail in EcParameterFormat.

The domain name and parameter format indicator provided by this class are supported by the Entrust EcParameterFactory, which is responsible for the creation, conversion, and encoding/decoding of EC domain parameters. This class is leveraged by the EC cryptographic algorithms provided by Entrust. For example, it can be used with the Entrust EC KeyPairGenerator to generate keys that contain EC domain parameters in any required format ('specified', 'named', or 'implicitCA').

Sun has already defined the class java.security.spec.ECParameterSpec to represent a set of EC domain parameters. This class is also supported by the Entrust EC cryptographic algorithms; it is treated as EC domain parameters in 'specified' format.

Instantiation of EcParameterSpecWithName objects and conversion to and from ASN.1 can be done using the EcParameterFactory class; refer to this class for more details on EC domain parameters.

Since:

7.2 SP2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EcParameterSpecWithName.SpecifiedECDomainVersion Specifies the version number of elliptic curve domain parameters in specified format.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines whether or not one EcDomainParamsWithName object is equal to another.
ObjectID	getDomainName() Returns the domain name associated with the EC domain parameters.
EcParameterFormat	getFormat() Returns the parameter format indicator.
AlgorithmID	getHash() Returns the hash algorithm identifier.
EcParameterSpecWithName.SpecifiedECDomainVersion	getVersion() Returns the parameter version indicator.
int	hashCode() Returns a hash code for a EcDomainParamsWithName object.

Methods inherited from class java.security.spec.ECParameterSpec

getCofactor, getCurve, getGenerator, getOrder

Methods inherited from class java.lang.Object

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

Method Detail

getDomainName

public ObjectID getDomainName()

Returns the domain name associated with the EC domain parameters.

The domain name is available for EC domain parameters in 'named' format; EC domain parameters in 'specified' or 'implicitCA' do not have a domain name.

Note: The domain name is an optional component; null is used to represent an absent domain name.

Returns:

the domain name

getFormat

public EcParameterFormat getFormat()

Returns the parameter format indicator.

For additional details on the parameter format indicator, refer to EcParameterFormat.

Returns:

the parameter format indicator

Since:

8.0

getVersion

public EcParameterSpecWithName.SpecifiedECDomainVersion getVersion()

Returns the parameter version indicator.

For additional details on the parameter version indicator, refer to #SpecifiedECDomainVersion.

Returns:

the parameter version indicator

Since:

8.0

getHash

public AlgorithmID getHash()

Returns the hash algorithm identifier.

This component identifies the hash algorithm used to generate the elliptic curve E and/or base point G verifiably at random. If not present, the hash algorithm shall be SHA-1.

Note: The hash algorithm identifier is an optional component; null is used to represent an absent hash algorithm identifier.

Returns:

the hash algorithm identifier

equals

public boolean equals(java.lang.Object obj)

Determines whether or not one EcDomainParamsWithName object is equal to another.

The comparison is done using only the EC domain parameter values (the domain name, if present, and parameter format indicator are not included in the comparison).

Overrides:

equals in class java.lang.Object

Parameters:

obj - an object being compared for equality

Returns:

true if the two EcDomainParamsWithName objects are equal; false otherwise.

hashCode

public int hashCode()

Returns a hash code for a EcDomainParamsWithName object.

The hash code calculation is done using only the EC domain parameter values (the domain name, if present, and parameter format indicator are not included in the calculation).

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code