iaik.smime.ess

Class ESSCertIDv2

java.lang.Object

iaik.smime.ess.ESSCertID

iaik.smime.ess.ESSCertIDv2

All Implemented Interfaces:

ASN1Type

public class ESSCertIDv2
extends ESSCertID

This class implements the S/MIMEv3 ESSCertIDv2 type.

The ESSCertID Update defines the structure ESSCertIDv2 along with a new attribute SigningCertificateV2, which uses the updated structure.

 ESSCertIDv2 ::=  SEQUENCE {
   hashAlgorithm           AlgorithmIdentifier
          DEFAULT {algorithm id-sha256},
   certHash     Hash,
   issuerSerial IssuerSerial OPTIONAL   }
 

 Hash ::= OCTET STRING -- SHA1 hash of entire certificate
 

 IssuerSerial ::= SEQUENCE {        
   issuer       GeneralNames,
   serialNumber CertificateSerialNumber   }
 

The ESSCertIDv2 type is used for identifying a certificate in a SigningCertificateV2 object to be included as signed attribute into CMS SignerInfo object.

See Also:

ESSIssuerSerial, SigningCertificateV2, X509Certificate, AttributeCertificate

Field Summary

Fields inherited from class iaik.smime.ess.ESSCertID

certHash_, issuerSerial_

Constructor Summary

Constructors

Constructor and Description
ESSCertIDv2() Default Constructor.
ESSCertIDv2(AlgorithmID hashAlgorithm, java.security.cert.Certificate cert, boolean includeIssuerSerial)
ESSCertIDv2(ASN1Object obj) Creates a new ESSCertIDv2 from an ASN1Object.
ESSCertIDv2(java.security.cert.Certificate cert, boolean includeIssuerSerial) Creates an ESSCertIDv2 for the given X.509 public key or X.509 attribute certificate.

Method Summary

Modifier and Type	Method and Description
void	calculateCertHash(byte[] encodedCert) Calculates and set cert hash value for the given encoded certificate.
void	decode(ASN1Object obj) Decodes the given ASN.1 ESSCertIDv2 object for parsing the internal structure.
boolean	equals(java.lang.Object obj) Compares this ESSCertID to the specified object.
byte[]	getCertHash() Returns the cert hash.
AlgorithmID	getHashAlgorithm() Returns the identifier of the algorithm used in computing certHash.
ESSIssuerSerial	getIssuerSerial() Returns issuer and serial number.
int	hashCode() Returns a hashcode for this ESSCertIDv2.
boolean	identifiesCert(java.security.cert.Certificate certificate) Checks whether the given certificate is identified by this ESSCertIDv2.
void	setCertHash(byte[] certHash) Sets the cert hash value.
void	setHashAlgorithm(AlgorithmID hashAlgorithm) Sets the hashAlgorithm value, identifying the algorithm used in computing the certHash
ASN1Object	toASN1Object() Returns this ESSCertID as ASN1Object.
java.lang.String	toString() Returns a string giving some information about this ESSCertIDv2 object.

Methods inherited from class iaik.smime.ess.ESSCertID

setIssuerSerial

Methods inherited from class java.lang.Object

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

Constructor Detail

ESSCertIDv2

public ESSCertIDv2()

Default Constructor. Creates an empty ESSCertID object.

ESSCertIDv2

public ESSCertIDv2(java.security.cert.Certificate cert,
                   boolean includeIssuerSerial)
            throws java.security.NoSuchAlgorithmException,
                   java.security.cert.CertificateException

Creates an ESSCertIDv2 for the given X.509 public key or X.509 attribute certificate.

Attention! Only X.509 public key certificates (instances of iaik.x509.X509Certificate) or X.509 attribute certificates (instances of iaik.x409.attr.AttributeCertificate) can be handled by this constructor; PKCS#6 ExtendedCertificates are obsolete and therefore not supported.

Parameters:

cert - the certificate for which to create an ESSCertID (either an instance of iaik.x509.X509Certificate or an instance of iaik.x509.attr.AttributeCertificate

includeIssuerSerial - if the IssuerSerial component should be set

Throws:

java.lang.IllegalArgumentException - if the supplied certificate is not an iaik.x509.X509Certificate or iaik.x509.attr.AttributeCertificate

java.security.NoSuchAlgorithmException - if the requested hashing algorithm (required for hash computation) is not supported by the installed providers. SHA-256 is used by default, and if an alternate hasher is desired, the setHashHalgorithm() method or an alternate constructor needs to be used

java.security.cert.CertificateException - if an error occurs while encoding the certificate for computing the hash, or the given certificate is an attribute certificate, but the issuer information included is not sufficient to construct an IssuerSerial (if V2Form is used for indicating the issuer, but not the issuerName option)

ESSCertIDv2

public ESSCertIDv2(AlgorithmID hashAlgorithm,
                   java.security.cert.Certificate cert,
                   boolean includeIssuerSerial)
            throws java.security.NoSuchAlgorithmException,
                   java.security.cert.CertificateException

Throws:

java.security.NoSuchAlgorithmException

java.security.cert.CertificateException

ESSCertIDv2

public ESSCertIDv2(ASN1Object obj)
            throws CodingException

Creates a new ESSCertIDv2 from an ASN1Object.

The ASN1Object supplied to this constructor represents an already existing ESSCertIDv2 object that may have been created by calling toASN1Object.

Parameters:

obj - the ESSCertID as ASN1Object

Throws:

CodingException - if the ASN1Object could not be parsed

Method Detail

setHashAlgorithm

public void setHashAlgorithm(AlgorithmID hashAlgorithm)

Sets the hashAlgorithm value, identifying the algorithm used in computing the certHash

setCertHash

public void setCertHash(byte[] certHash)

Sets the cert hash value.

Overrides:

setCertHash in class ESSCertID

Parameters:

certHash - the -- already calculated hash of the cert

calculateCertHash

public void calculateCertHash(byte[] encodedCert)
                       throws java.security.NoSuchAlgorithmException

Calculates and set cert hash value for the given encoded certificate.

Overrides:

calculateCertHash in class ESSCertID

Parameters:

encodedCert - the DER encoded cert for which the hash shall be calculated and set

Throws:

java.security.NoSuchAlgorithmException - if the hashAlgorithm is not supported by the installed cryptography providers

identifiesCert

public boolean identifiesCert(java.security.cert.Certificate certificate)
                       throws java.security.NoSuchAlgorithmException

Checks whether the given certificate is identified by this ESSCertIDv2.

Overrides:

identifiesCert in class ESSCertID

Parameters:

certificate - the certificate to be checked (either an instance of iaik.x509.X509Certificate or an instance of iaik.x509.attr.AttributeCertificate

Returns:

true if the given certificate is identified by this ESSCertIDv2, false if not

Throws:

java.lang.IllegalArgumentException - if the supplied certificate is not an iaik.x509.X509Certificate or iaik.x509.attr.AttributeCertificate

java.security.NoSuchAlgorithmException - if the check cannot be performed because the specified hashing algorithm is not supported by the installed cryptographic providers

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes the given ASN.1 ESSCertIDv2 object for parsing the internal structure.

This method internally is called when creating a ESSCertIDv2 object from an already existing ESSCertIDv2 object, supplied as ASN1Object.

Specified by:

decode in interface ASN1Type

Overrides:

decode in class ESSCertID

Parameters:

obj - the ESSCertIDv2 as ASN1Object

Throws:

CodingException - if the object can not be parsed

toASN1Object

public ASN1Object toASN1Object()

Returns this ESSCertID as ASN1Object.

The ASN1Object returned by this method may be used as parameter value when creating an ESSCertID object using the ESSCertIDv2(ASN1Object) constructor.

Specified by:

toASN1Object in interface ASN1Type

Overrides:

toASN1Object in class ESSCertID

Returns:

this ESSCertIDv2 as ASN1Object

equals

public boolean equals(java.lang.Object obj)

Compares this ESSCertID to the specified object.

Overrides:

equals in class ESSCertID

Parameters:

obj - the object to compare this ESSCertID against.

Returns:

true, if the given object is equal to this ESSCertID, false otherwise

hashCode

public int hashCode()

Returns a hashcode for this ESSCertIDv2.

Overrides:

hashCode in class ESSCertID

Returns:

a hashcode for this ESSCertIDv2

getHashAlgorithm

public AlgorithmID getHashAlgorithm()

Returns the identifier of the algorithm used in computing certHash.

Returns:

AlgorithmID containing the identifier of the algorithm used in computing the certHash of this ESSCertIDv2

getIssuerSerial

public ESSIssuerSerial getIssuerSerial()

Returns issuer and serial number.

Overrides:

getIssuerSerial in class ESSCertID

Returns:

the IssuerSerial of this ESSCertID

getCertHash

public byte[] getCertHash()

Returns the cert hash.

Overrides:

getCertHash in class ESSCertID

Returns:

cert hash of this ESSCertID

toString

public java.lang.String toString()

Returns a string giving some information about this ESSCertIDv2 object.

Overrides:

toString in class ESSCertID

Returns:

the string representation