iaik.x509.extensions

Class HoldInstructionCode

java.lang.Object

iaik.x509.V3Extension

iaik.x509.extensions.HoldInstructionCode

public class HoldInstructionCode
extends V3Extension

This class implements the HoldInstructionCode extension.

The HoldInstructionCode extension is a non-critical standard X509v2 CRL entry extension.

Each extension is associated with a specific certificateExtension object identifier, derived from:

 certificateExtension  OBJECT IDENTIFIER ::=
                            {joint-iso-ccitt(2) ds(5) 29}
 id-ce                 OBJECT IDENTIFIER ::=  certificateExtension
 

The object identifier for the HoldInstructionCode extension is defined as:

id-ce-HoldInstructionCode OBJECT IDENTIFIER ::= { id-ce 23 }

which corresponds to the OID string "2.5.29.23".

The X.509 Certificate and CRL profile presented in RFC 3280 specifies the HoldInstructionCode extension for providing a registered instruction identifier which indicates the action to be taken after encountering a certificate that has been placed on hold.

ASN.1 definition:

 holdInstructionCode ::= OBJECT IDENTIFER
 

Since in the IAIK-JCE environment revoked certificates are implementations of the iaik.x509.RevokedCertificate class, a holdInstructionCode CRL entry extension may be added to a revoked certificate by using the addExtension method of the iaik.x509.RevokedCertificate class. Any revoked certificate itself is added to a certificate revocation list by using a proper addCertificate method of the iaik.x509.X509CRL class, e.g.:

 //Create a revoked certificate from a X509Certificate and set the revocation date
 //to the current date; the X509Certificate is read in from a file:
 GregorianCalendar date = (GregorianCalendar)Calendar.getInstance();
 InputStream fis = new FileInputStream("cert.der");
 X509Certificate cert = new X509Certificate(fis);
 fis.close();
 RevokedCertificate rev_cert = new RevokedCertificate(cert, date.getTime());
 //add the holdInstructionCode code CRL entry extension to the revoked certificate:
 HoldInstructionCode holdInstructionCode =
   new HoldInstructionCode(HoldInstructionCode.holdInstructionCallIssuer);
 rev_cert.addExtension(holdInstructionCode);
 //add the revoked certificate to the crl
 X509CRL crl = new X509CRL();
  ...
 crl.addCertificate(rev_cert);
 

See Also:

X509CRL, X509Certificate, RevokedCertificate

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectID	holdInstruction The base OID for defined hold instructions (1.2.840.10040.2).
static ObjectID	holdInstructionCallIssuer The holdinstruction-callissuer oid (1.2.840.10040.2.2).
static ObjectID	holdInstructionNone The holdinstruction-none oid (1.2.840.10040.2.1).
static ObjectID	holdInstructionReject The holdinstruction-reject oid (1.2.840.10040.2.3).
static ObjectID	oid The object identifier of this HoldInstructionCode extension.

Fields inherited from class iaik.x509.V3Extension

critical

Constructor Summary

Constructors

Constructor and Description
HoldInstructionCode() Default constructor.
HoldInstructionCode(ObjectID instructionCode) Creates a new HoldInstructionCode from the given oid.

Method Summary

Modifier and Type	Method and Description
ObjectID	getHoldInstructionCode() Returns the hold instruction code.
ObjectID	getObjectID() Returns the object ID of this HoldInstructionCode extension.
int	hashCode() Returns a hashcode for this identity.
void	init(ASN1Object obj) Inits this HoldInstructionCode implementation with an ASN1object representing the value of this extension.
void	setInstructionCode(ObjectID instructionCode) Sets the hold instruction code.
ASN1Object	toASN1Object() Returns an ASN1Object representing the value of this HoldInstructionCode extension object.
java.lang.String	toString() Returns a string that represents the contents of this HoldInstructionCode extension.

Methods inherited from class iaik.x509.V3Extension

getName, isCritical, setCritical

Methods inherited from class java.lang.Object

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

Field Detail

oid

public static final ObjectID oid

The object identifier of this HoldInstructionCode extension. The corresponding OID string is "2.5.29.23".

holdInstruction

public static final ObjectID holdInstruction

The base OID for defined hold instructions (1.2.840.10040.2).

holdInstructionNone

public static final ObjectID holdInstructionNone

The holdinstruction-none oid (1.2.840.10040.2.1). Equivalent to the absence of a holdInstructionCode extension and therefore deprecated for the Internet PKI.

holdInstructionCallIssuer

public static final ObjectID holdInstructionCallIssuer

The holdinstruction-callissuer oid (1.2.840.10040.2.2). If present, the certificate issuer must be called or the certificate must be rejected.

holdInstructionReject

public static final ObjectID holdInstructionReject

The holdinstruction-reject oid (1.2.840.10040.2.3). If present, the certificate must be rejected.

Constructor Detail

HoldInstructionCode

public HoldInstructionCode()

Default constructor. Creates an empty HoldInstructionCode object. Use the setInstructionCode method for explicitly setting the instruction code.

HoldInstructionCode

public HoldInstructionCode(ObjectID instructionCode)

Creates a new HoldInstructionCode from the given oid.

For instance:

 HoldInstructionCode hic = new HoldInstructionCode(HoldInstrcutionCode.holdInstructionCodeReject));
 

Parameters:

instructionCode - the hold instruction code oid

Method Detail

getObjectID

public ObjectID getObjectID()

Returns the object ID of this HoldInstructionCode extension.

Specified by:

getObjectID in class V3Extension

Returns:

the object ID

init

public void init(ASN1Object obj)

Inits this HoldInstructionCode implementation with an ASN1object representing the value of this extension.

The given ASN1Object represents the hold instruction code oid.

The given ASN1Object is the one created by toASN1Object().

This method is used by the X509Extensions class when parsing the ASN.1 representation of a CRL for properly initializing an included HoldInstructionCode extension. This method initializes the extension only with its value, but not with its critical specification. For that reason, this method shall not be explicitly called by an application.

Specified by:

init in class V3Extension

Parameters:

obj - the HoldInstructionCode as ASN1Object

toASN1Object

public ASN1Object toASN1Object()

Returns an ASN1Object representing the value of this HoldInstructionCode extension object.

The returned ASN1Object represents the hold instruction code oid.

holdInstructionCode ::= OBJECT IDENTIFER

Specified by:

toASN1Object in class V3Extension

Returns:

the value of this HoldInstructionCode as ASN1Object

getHoldInstructionCode

public ObjectID getHoldInstructionCode()

Returns the hold instruction code.

Returns:

the hold instruction code

setInstructionCode

public void setInstructionCode(ObjectID instructionCode)

Sets the hold instruction code.

Parameters:

instructionCode - the instruction code

hashCode

public int hashCode()

Returns a hashcode for this identity.

Specified by:

hashCode in class V3Extension

Returns:

a hash code for this identity

toString

public java.lang.String toString()

Returns a string that represents the contents of this HoldInstructionCode extension.

Overrides:

toString in class java.lang.Object

Returns:

the string representation