com.entrust.toolkit.asn1.structures

Class FullCertTemplate

java.lang.Object

com.entrust.toolkit.asn1.structures.FullCertTemplate

public class FullCertTemplate
extends java.lang.Object

This class represents a PKIX full certificate template, which basically contains an (incomplete) X.509 certificate, and then a series of optional information related to it, such as archiving options and proof of possession of private keys. This class does not provide access to the full range of options in the full certificate template, but only to those which need to vary within Entrust profile creation requests. For a more complete specification of the full certificate template, see draft-ietf-pkix-ipki3cmp-04.txt by C. Adams and S. Farrell.

Constructor Summary

Constructors

Constructor and Description
FullCertTemplate() This constructor creates an empty full certificate template.
FullCertTemplate(ASN1Object template) This constructor decodes an ASN.1 representation of a full certificate template.

Method Summary

Methods

Modifier and Type	Method and Description
ASN1Object	getCertId() This method returns the old certificate identifier field, which is used in update requests to tie this certificate request to the user's request history.
int	getCertReqId() This method returns the certificate request identifier associated with this full certificate template.
boolean	getKeyEscrow() This method returns the key archive flag, which specifies whether the manager should perform key escrow upon generated keys.
BIT_STRING	getKeyUsage() This method returns the desired key usage for the certificate defined by the full certificate template.
ASN1Object	getPopoSigningKey()
boolean	getPublication() This method returns the certificate publication flag, which is true if this certificate should be published in the directory, and false otherwise.
java.security.PublicKey	getUserPublicKey() This method returns the public key associated with this template.
void	setCertId(ASN1Object certId) This method sets the old certificate identifier field.
void	setCertReqId(int certReqId) This method sets the certificate request identifier associated with the full certificate template.
void	setKeyEscrow(boolean keyEscrow) This method specifies whether or not key escrow should be performed on generated keys.
void	setKeyUsage(BIT_STRING keyUsage) This method sets the desired key usage for the certificate defined by the full certificate template.
void	setPopoSigningKey(ASN1Object popoSigningKey) This method sets an ASN.1 object as representing the proof of possession of the private key.
void	setPublication(boolean pub) This method sets the certificate publication flag, which determines whether or not the certificate should be published in the directory.
void	setUserPublicKey(java.security.PublicKey userPublicKey) This method sets the public key in the template.
ASN1Object	toASN1Object() This method converts the full certificate template to an ASN.1 object for transportation.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullCertTemplate

public FullCertTemplate()

This constructor creates an empty full certificate template. Any fields must be set manually.

FullCertTemplate

public FullCertTemplate(ASN1Object template)
                 throws CodingException

This constructor decodes an ASN.1 representation of a full certificate template.

Parameters:

template - The ASN.1 representation.

Throws:

CodingException - This exception is thrown if the ASN.1 object does not represent a full certificate template or cannot be decoded.

Method Detail

toASN1Object

public ASN1Object toASN1Object()
                        throws CodingException

This method converts the full certificate template to an ASN.1 object for transportation.

Returns:

The ASN.1 representation of the full certificate template.

Throws:

CodingException - This exception is thrown if there is an error encoding any of the necessary values.

getCertReqId

public int getCertReqId()

This method returns the certificate request identifier associated with this full certificate template. In the Entrust creation process, a certificate request ID of 1 implies an encryption certificate request and a certificate request ID of 2 implies a signing certificate request.

Returns:

The certificate request identifier.

setCertReqId

public void setCertReqId(int certReqId)

This method sets the certificate request identifier associated with the full certificate template. See above for the types.

getUserPublicKey

public java.security.PublicKey getUserPublicKey()

This method returns the public key associated with this template.

Returns:

The public key sent with the certificate template.

setUserPublicKey

public void setUserPublicKey(java.security.PublicKey userPublicKey)

This method sets the public key in the template.

Parameters:

userPublicKey - The public key to be associated with this certificate template.

getKeyUsage

public BIT_STRING getKeyUsage()

This method returns the desired key usage for the certificate defined by the full certificate template.

Returns:

The template's desired key usage.

setKeyUsage

public void setKeyUsage(BIT_STRING keyUsage)

This method sets the desired key usage for the certificate defined by the full certificate template.

Parameters:

keyUsage - The template's desired key usage.

getPopoSigningKey

public ASN1Object getPopoSigningKey()

setPopoSigningKey

public void setPopoSigningKey(ASN1Object popoSigningKey)

This method sets an ASN.1 object as representing the proof of possession of the private key. The exact data contained within the ASN.1 object differs upon the type of certificate template, and is not checked here.

Parameters:

popoSigningKey - The ASN.1 representation of the proof-of-possession of the signing key.

getCertId

public ASN1Object getCertId()

This method returns the old certificate identifier field, which is used in update requests to tie this certificate request to the user's request history. This field is a sequence containing the issuer name and serial number of the current certificate for which an update is being requested.

Returns:

The old certificate identifier field.

setCertId

public void setCertId(ASN1Object certId)

This method sets the old certificate identifier field. See above for a more complete description of the field.

Parameters:

certId - The old certificate identifier field.

getKeyEscrow

public boolean getKeyEscrow()

This method returns the key archive flag, which specifies whether the manager should perform key escrow upon generated keys.

Returns:

True if key escrow is to be performed, false otherwise.

setKeyEscrow

public void setKeyEscrow(boolean keyEscrow)

This method specifies whether or not key escrow should be performed on generated keys.

Parameters:

keyEscrow - True if key escrow is to be performed, false otherwise.

getPublication

public boolean getPublication()

This method returns the certificate publication flag, which is true if this certificate should be published in the directory, and false otherwise.

Returns:

True if the certificate is to be published; false otherwise.

setPublication

public void setPublication(boolean pub)

This method sets the certificate publication flag, which determines whether or not the certificate should be published in the directory.

Parameters:

pub - True if the certificate is to be published; false otherwise.