iaik.x509.ocsp

Class ResponderID

java.lang.Object

iaik.x509.ocsp.ResponderID

public class ResponderID
extends java.lang.Object

This class implements the OCSP type ResponderID.

Within a BasicOCSPResponse the ResponderID identifies the responder either by its name or by a SHA-1 hash calculated from the responder's public key (see RFC 2560, RFC 6960):

 ResponderID ::= CHOICE {
   byName   [1] Name,
   byKey    [2] KeyHash }
 

After having created a new ResponderID, add it to BasicOCSPResponse by calling the setResponderID method, e.g.:

 // the key of the responder:
 PublicKey responderKey = ...;
 ResponderID responderID = new ResponderID(responderKey);
 ...
 BasicOCSPResponse basicOCSPresponse = ...;
 ...
 basicOCSPResponse.setResponderID(responderID);
 

As you can see from the example above, you immediately may supply the responder's key to the corresponding constructor of this call to let it do the hash calculation for a keyHash responder id.

Version:

File Revision 10

See Also:

BasicOCSPResponse

Constructor Summary

Constructors

Constructor and Description
ResponderID(ASN1Object obj) Creates ResponderID from an ASN1Object.
ResponderID(byte[] keyHash) Creates a responder ID from a hash of its public key.
ResponderID(Name name) Creates a responder ID from its name.
ResponderID(java.security.PublicKey responderKey) Creates a responder ID from its public key.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	byName() Checks whether this ResponderID represents the byName choice.
boolean	equals(java.lang.Object obj) Compares this ResponderID with the given ResponderID.
byte[]	getKeyHash() Returns the hash of the responder's public key.
Name	getName() Returns the Name of the responder.
int	hashCode() Returns a hash code value for this object.
boolean	isResponderIdFor(X509Certificate responderCert) Checks if this is a responder id for the given certificate.
ASN1Object	toASN1Object() Returns this ResponderID as an ASN1Object.
java.lang.String	toString() Gives a String representation of this ResponderID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponderID

public ResponderID(Name name)

Creates a responder ID from its name.

Parameters:

name - the name of the responder

ResponderID

public ResponderID(byte[] keyHash)

Creates a responder ID from a hash of its public key.

Parameters:

keyHash - the hash of the responder's public key

ResponderID

public ResponderID(java.security.PublicKey responderKey)
            throws java.security.NoSuchAlgorithmException

Creates a responder ID from its public key. The SHA-1 hash of the key will be automatically calculated.

Parameters:

responderKey - the public key of the responder from which a SHA-1 hash has to be calculated for giving the value of this "byKey" responder ID

Throws:

java.security.NoSuchAlgorithmException - if SHA-1 is not supported by the installed providers

ResponderID

public ResponderID(ASN1Object obj)
            throws CodingException

Creates ResponderID from an ASN1Object.

Parameters:

obj - the ResponderID as ASN1Object

Throws:

CodingException - if the ASN1Object has the wrong format

Method Detail

isResponderIdFor

public boolean isResponderIdFor(X509Certificate responderCert)
                         throws java.security.NoSuchAlgorithmException

Checks if this is a responder id for the given certificate.

Parameters:

responderCert - the cert of the responder

Returns:

true if this responderID identifies the responder

Throws:

java.security.NoSuchAlgorithmException - if SHA-1 is not supported by the installed providers

getName

public Name getName()

Returns the Name of the responder.

Returns:

the Name of the responder if this ResponderID represents the byName choice

getKeyHash

public byte[] getKeyHash()

Returns the hash of the responder's public key.

Returns:

the hash of the responder's public key if this ResponderID represents the byKey choice

byName

public boolean byName()

Checks whether this ResponderID represents the byName choice.

Returns:

true if this ID identifies the responder by Name false if this ID identifies the responder by Key

toASN1Object

public ASN1Object toASN1Object()

Returns this ResponderID as an ASN1Object.

Returns:

this ResponderID as ASN1Object

equals

public boolean equals(java.lang.Object obj)

Compares this ResponderID with the given ResponderID.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the other ResponderID

Returns:

true, if the two ResponderID are equal, false otherwise

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object

toString

public java.lang.String toString()

Gives a String representation of this ResponderID.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this responder IS.