iaik.x509.ocsp

Class OCSPExtensions

java.lang.Object

iaik.x509.X509Extensions

iaik.x509.ocsp.OCSPExtensions

public class OCSPExtensions
extends X509Extensions

Extends class X509Extensions for handling OCSP extensions.

This class can be used in the same way as the parent X509Extensions class for managing extensions that may be included in OCSP requests or responses. An application wishing to implement some private OCSP extension has to write a class by extending the abstract class V3Extension and statically registering the implementation by its object id:

This class consists of two parts:

• a static part: is responsible for registering implementations of extensions
• a dynamic part: manages the extensions

Every class which implements a specific extension must first register itself, e.g.:

 MyPrivateExtension extends V3Extension {
   ...
   public static final ObjectID oid = ...;
 
 }
 
 OCSPExtensions.register(MyPrivateExtension.oid, MyPrivateExtension.class);
 

Per default all OCSP ( RFC 2560), RFC 6960) extensions specified by RFC 2560 are implemented and registered by this class:

• AcceptableResponses
• ArchiveCutoff
• CrlID
• Nonce
• ServiceLocator

Additionally the Common PKI CertHash extension is registered.

Version:

File Revision 10

See Also:

V3Extension, X509Extensions

Field Summary

Fields inherited from class iaik.x509.X509Extensions

critical_extensions, noncritical_extensions

Constructor Summary

Constructors

Constructor and Description
OCSPExtensions() Default Constructor.
OCSPExtensions(ASN1Object extensions) Creates a new OCSPExtensions object from an ASN1Object.
OCSPExtensions(int initialCriticalExtensionsCapacity, int initialNoncriticalExtensionCapacity) Creates an OCSPExtensions object with the given initial capacities for the critical_extensions and noncritical_extensions hashtables.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addExtension(V3Extension e) Adds an extension to this OCSPExtensions object.
V3Extension	getExtension(ObjectID oid) Returns a particular extension, specified by its object ID.

Methods inherited from class iaik.x509.X509Extensions

countExtensions, create, createExtensionsTable, decode, getCriticalExtensionOIDs, getExtensionValue, getNonCriticalExtensionOIDs, getRawExtensionValue, hasExtensions, hasUnsupportedCriticalExtension, listExtensions, parseExtensions, register, removeAllExtensions, removeExtension, toASN1Object, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OCSPExtensions

public OCSPExtensions()

Default Constructor. Creates a new OCSPExtensions object to be supplied with V3Extensions.

OCSPExtensions

public OCSPExtensions(int initialCriticalExtensionsCapacity,
              int initialNoncriticalExtensionCapacity)

Creates an OCSPExtensions object with the given initial capacities for the critical_extensions and noncritical_extensions hashtables.

Parameters:

initialCriticalExtensionsCapacity - the initial capacity of the critical_extensions table

initialNoncriticalExtensionsCapacity - the initial capacity of the noncritical_extensions table

OCSPExtensions

public OCSPExtensions(ASN1Object extensions)
               throws X509ExtensionException

Creates a new OCSPExtensions object from an ASN1Object.

The given ASN1Object has the ASN.1 type "SEQUENCE of Extensions", and may have been created by calling the toASN1Objetct method.

Parameters:

extensions - the extensions as ASN1Object

Throws:

X509ExtensionException - if the extensions cannot be parsed

Method Detail

getExtension

public V3Extension getExtension(ObjectID oid)
                         throws X509ExtensionInitException

Returns a particular extension, specified by its object ID.

This method creates a new implementation of the class registered for this ObjectID and initializes it with its extension value. If the extension is an unknown extension, an UnknownExtension is returned. If the extension cannot be initialized properly because of some error, an X509ExtensionInitException is thrown.

Overrides:

getExtension in class X509Extensions

Parameters:

oid - the object ID of the extension

Returns:

the desired extension if it is available, or null if not

Throws:

X509ExtensionInitException - if the extension can not be initialized

addExtension

public boolean addExtension(V3Extension e)
                     throws X509ExtensionException

Adds an extension to this OCSPExtensions object.

Overrides:

addExtension in class X509Extensions

Parameters:

e - the X509v3 extension to add to the list of extensions

Returns:

true, if an extension with the same object id has been replaced, or false if there has yet not been included any extension with the same ObjectID

Throws:

X509ExtensionException - if an error occurs while DER encoding the extension