com.entrust.toolkit.x509.policies

Class EntrustSigConfig.SingleAlgSigConfig

java.lang.Object

com.entrust.toolkit.x509.policies.EntrustSigConfig

com.entrust.toolkit.x509.policies.EntrustSigConfig.SingleAlgSigConfig

Enclosing class:

EntrustSigConfig

public abstract static class EntrustSigConfig.SingleAlgSigConfig
extends EntrustSigConfig

A single algorithm signature algorithm configuration.

This configuration identifies a single signature algorithm; the algorithm it identifies is not dependent on the strength of the key it is being used with. It contains all the information (signature algorithm identifier, signature algorithm parameters, and hash algorithm identifier) necessary to initialize a signature generation operation.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class com.entrust.toolkit.x509.policies.EntrustSigConfig

EntrustSigConfig.MultipleAlgSigConfig, EntrustSigConfig.SingleAlgSigConfig

Field Summary

Fields inherited from class com.entrust.toolkit.x509.policies.EntrustSigConfig

DSA_RECOMMENDED, DSA_SHA1, DSA_SHA224, DSA_SHA256, ECDSA_RECOMMENDED, ECDSA_RECOMMENDED_NO_SHA224, ECDSA_SHA1, ECDSA_SHA224, ECDSA_SHA256, ECDSA_SHA384, ECDSA_SHA512, RSA_RECOMMENDED, RSA_RECOMMENDED_NO_SHA224, RSA_SHA1, RSA_SHA224, RSA_SHA256, RSA_SHA384, RSA_SHA512, RSAPSS_RECOMMENDED, RSAPSS_RECOMMENDED_NO_SHA224, RSAPSS_SHA1, RSAPSS_SHA224, RSAPSS_SHA256, RSAPSS_SHA384, RSAPSS_SHA512

Method Summary

Modifier and Type	Method and Description
ObjectID	getHashAlgorithmOid() Gets the hash algorithm object identifier associated with this signature algorithm configuration.
AlgorithmID	getSigAlgorithmId() Gets the signature algorithm identifier associated with this signature algorithm configuration.
ObjectID	getSigAlgorithmOid() Gets the signature algorithm object identifier associated with this signature algorithm configuration.
java.security.spec.AlgorithmParameterSpec	getSigAlgorithmParams() Gets the signature algorithm parameters associated with this signature algorithm configuration.
boolean	isSupportedWithKey(java.security.Key key) Indicates whether or not this signature algorithm configuration is supported for use with the provided key.
EntrustSigConfig.SingleAlgSigConfig	toSingleAlgSigConfig(EntrustAsymKeyType keyType) Converts this signature algorithm configuration to a single algorithm signature algorithm configuration based on the provided key type.

Methods inherited from class com.entrust.toolkit.x509.policies.EntrustSigConfig

getInstance, getInstance, getListInstance, getName, getSigAlgConfig, getSigConfigString, isKeyTypeSupported, toString

Methods inherited from class java.lang.Object

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

Method Detail

getSigAlgorithmOid

public final ObjectID getSigAlgorithmOid()

Gets the signature algorithm object identifier associated with this signature algorithm configuration.

Returns:

the signature algorithm object identifier

getSigAlgorithmParams

public final java.security.spec.AlgorithmParameterSpec getSigAlgorithmParams()

Gets the signature algorithm parameters associated with this signature algorithm configuration.

Algorithm parameters are optional; some signature algorithm configurations will not contain algorithm parameters

Returns:

the signature algorithm parameters; null if there are no algorithm parameters

getSigAlgorithmId

public final AlgorithmID getSigAlgorithmId()

Gets the signature algorithm identifier associated with this signature algorithm configuration.

The signature algorithm identifier is composed from the signature algorithm object identifier and signature algorithm parameters.

Returns:

the signature algorithm identifier

getHashAlgorithmOid

public final ObjectID getHashAlgorithmOid()

Gets the hash algorithm object identifier associated with this signature algorithm configuration.

Returns:

the hash algorithm object identifier

toSingleAlgSigConfig

public final EntrustSigConfig.SingleAlgSigConfig toSingleAlgSigConfig(EntrustAsymKeyType keyType)
                                                               throws java.security.KeyException

Description copied from class: EntrustSigConfig

Converts this signature algorithm configuration to a single algorithm signature algorithm configuration based on the provided key type.

There are two main classes of signature algorithm configuration objects; 'single algorithm' and 'multiple algorithm'. A single algorithm configuration identifies a single algorithm and is not dependent on the strength of the key it is being used with. A multiple algorithm configuration identifies a set of algorithms and the actual algorithm to be used depends on the strength of the key being used.

In order to perform a signature operation using the algorithm identified by a signature algorithm configuration it must be first converted to a single algorithm configuration; this API performs that task. When called on a multiple algorithm configuration, the appropriate algorithm is selected from the set by examining the key strength. When called on a single algorithm configuration, the same single algorithm configuration is simply returned (essentially a no-op).

Specified by:

toSingleAlgSigConfig in class EntrustSigConfig

Parameters:

keyType - the key type of the key that will be used to perform the signature operation

Returns:

a single algorithm signature configuration

Throws:

java.security.KeyException - if the key type is not supported by this signature algorithm configuration (e.g. the key type is EC-based, but the signature algorithm configuration is RSA-based)

isSupportedWithKey

public boolean isSupportedWithKey(java.security.Key key)

Indicates whether or not this signature algorithm configuration is supported for use with the provided key.

For example, RSA-based signature algorithms are only supported for use with RSA keys; they are not supported for use with EC keys.

Parameters:

key - an asymmetric key

Returns:

true if this signature algorithm configuration is supported for use with the provided key; false otherwise