Package org.mozilla.jss.netscape.security.x509

Class X509CertInfo

java.lang.Object

org.mozilla.jss.netscape.security.x509.X509CertInfo

All Implemented Interfaces:

Serializable, CertAttrSet

Direct Known Subclasses:

CertInfo

public class X509CertInfo
extends Object
implements CertAttrSet, Serializable

The X509CertInfo class represents X.509 certificate information.

X.509 certificates have several base data elements, including:

• The Subject Name, an X.500 Distinguished Name for the entity (subject) for which the certificate was issued.
• The Subject Public Key, the public key of the subject. This is one of the most important parts of the certificate.
• The Validity Period, a time period (e.g. six months) within which the certificate is valid (unless revoked).
• The Issuer Name, an X.500 Distinguished Name for the Certificate Authority (CA) which issued the certificate.
• A Serial Number assigned by the CA, for use in certificate revocation and other applications.

Version:

1.16

See Also:

• CertAttrSet
• Serializable
• X509CertImpl
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CertificateAlgorithmId	algId
static final String	ALGORITHM_ID
private static final int	ATTR_ALGORITHM
private static final int	ATTR_EXTENSIONS
private static final int	ATTR_ISSUER
private static final int	ATTR_ISSUER_ID
private static final int	ATTR_KEY
private static final int	ATTR_SERIAL
private static final int	ATTR_SUBJECT
private static final int	ATTR_SUBJECT_ID
private static final int	ATTR_VALIDITY
private static final int	ATTR_VERSION
protected CertificateExtensions	extensions
static final String	EXTENSIONS
static final String	IDENT	Identifier for this attribute, to be used with the get, set, delete methods of Certificate, x509 type.
protected CertificateValidity	interval
protected CertificateIssuerName	issuer
static final String	ISSUER
static final String	ISSUER_ID
protected CertificateIssuerUniqueIdentity	issuerUniqueId
static final String	KEY
private static final org.slf4j.Logger	logger
private static final Hashtable<String,Integer>	map
static final String	NAME
protected CertificateX509Key	pubKey
private byte[]	rawCertInfo
static final String	SERIAL_NUMBER
protected CertificateSerialNumber	serialNum
private static final long	serialVersionUID
protected CertificateSubjectName	subject
static final String	SUBJECT
static final String	SUBJECT_ID
protected CertificateSubjectUniqueIdentity	subjectUniqueId
static final String	VALIDITY
protected CertificateVersion	version
static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
X509CertInfo()	Construct an uninitialized X509CertInfo on which decode must later be called (or which may be deserialized).
X509CertInfo(byte[] cert)	Unmarshals a certificate from its encoded form, parsing the encoded bytes.
X509CertInfo(DerValue derVal)	Unmarshal a certificate from its encoded form, parsing a DER value.

Method Summary

Modifier and Type	Method	Description
private int	attributeMap(String name)	Returns the integer attribute number for the passed attribute name.
void	decode(InputStream in)	Decode an X.509 certificate from an input stream.
void	delete(String name)	Delete the certificate attribute.
private void	emit(DerOutputStream out)
void	encode(OutputStream out)	Appends the certificate to an output stream.
void	encode(OutputStream out, boolean ignoreCache)	Appends the certificate to an output stream.
boolean	equals(Object other)	Compares two X509CertInfo objects.
boolean	equals(X509CertInfo other)	Compares two certificates, returning false if any data differs between the two.
Object	get(String name)	Get the certificate attribute.
Enumeration<String>	getAttributeNames()	Return an enumeration of names of attributes existing within this attribute.
byte[]	getEncodedInfo()	Returns the encoded certificate info.
byte[]	getEncodedInfo(boolean ignoreCache)
CertificateIssuerName	getIssuerObj()
String	getName()	Return the name of this attribute.
CertificateSubjectName	getSubjectObj()
int	hashCode()	Calculates a hash code value for the object.
private void	parse(DerValue val)
private void	readObject(ObjectInputStream stream)	Serialization read ...
void	set(String name, Object val)	Set the certificate attribute.
private void	setAlgorithmId(Object val)	Set the algorithm id of the certificate.
private void	setExtensions(Object val)	Set the extensions in the certificate.
private void	setIssuer(Object val)	Set the issuer name of the certificate.
private void	setIssuerUniqueId(Object val)	Set the Issuer Unique Identity in the certificate.
private void	setKey(Object val)	Set the public key in the certificate.
private void	setSerialNumber(Object val)	Set the serial number of the certificate.
private void	setSubject(Object val)	Set the subject name of the certificate.
private void	setSubjectUniqueId(Object val)	Set the Subject Unique Identity in the certificate.
private void	setValidity(Object val)	Set the validity interval of the certificate.
private void	setVersion(Object val)	Set the version number of the certificate.
String	toString()	Returns a printable representation of the certificate.
private void	writeObject(ObjectOutputStream stream)	Serialization write ...

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

logger

private static final org.slf4j.Logger logger

IDENT

public static final String IDENT

Identifier for this attribute, to be used with the get, set, delete methods of Certificate, x509 type.

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

SERIAL_NUMBER

public static final String SERIAL_NUMBER

See Also:

• Constant Field Values

ALGORITHM_ID

public static final String ALGORITHM_ID

See Also:

• Constant Field Values

ISSUER

public static final String ISSUER

See Also:

• Constant Field Values

VALIDITY

public static final String VALIDITY

See Also:

• Constant Field Values

SUBJECT

public static final String SUBJECT

See Also:

• Constant Field Values

KEY

public static final String KEY

See Also:

• Constant Field Values

ISSUER_ID

public static final String ISSUER_ID

See Also:

• Constant Field Values

SUBJECT_ID

public static final String SUBJECT_ID

See Also:

• Constant Field Values

EXTENSIONS

public static final String EXTENSIONS

See Also:

• Constant Field Values

version

protected CertificateVersion version

serialNum

protected CertificateSerialNumber serialNum

algId

protected CertificateAlgorithmId algId

issuer

protected CertificateIssuerName issuer

interval

protected CertificateValidity interval

subject

protected CertificateSubjectName subject

pubKey

protected CertificateX509Key pubKey

issuerUniqueId

protected CertificateIssuerUniqueIdentity issuerUniqueId

subjectUniqueId

protected CertificateSubjectUniqueIdentity subjectUniqueId

extensions

protected CertificateExtensions extensions

ATTR_VERSION

private static final int ATTR_VERSION

See Also:

• Constant Field Values

ATTR_SERIAL

private static final int ATTR_SERIAL

See Also:

• Constant Field Values

ATTR_ALGORITHM

private static final int ATTR_ALGORITHM

See Also:

• Constant Field Values

ATTR_ISSUER

private static final int ATTR_ISSUER

See Also:

• Constant Field Values

ATTR_VALIDITY

private static final int ATTR_VALIDITY

See Also:

• Constant Field Values

ATTR_SUBJECT

private static final int ATTR_SUBJECT

See Also:

• Constant Field Values

ATTR_KEY

private static final int ATTR_KEY

See Also:

• Constant Field Values

ATTR_ISSUER_ID

private static final int ATTR_ISSUER_ID

See Also:

• Constant Field Values

ATTR_SUBJECT_ID

private static final int ATTR_SUBJECT_ID

See Also:

• Constant Field Values

ATTR_EXTENSIONS

private static final int ATTR_EXTENSIONS

See Also:

• Constant Field Values

rawCertInfo

private byte[] rawCertInfo

map

private static final Hashtable<String,Integer> map

Constructor Details

X509CertInfo

public X509CertInfo()

Construct an uninitialized X509CertInfo on which decode must later be called (or which may be deserialized).

X509CertInfo

public X509CertInfo(byte[] cert)
             throws CertificateParsingException

Unmarshals a certificate from its encoded form, parsing the encoded bytes. This form of constructor is used by agents which need to examine and use certificate contents. That is, this is one of the more commonly used constructors. Note that the buffer must include only a certificate, and no "garbage" may be left at the end. If you need to ignore data at the end of a certificate, use another constructor.

Parameters:

cert - the encoded bytes, with no trailing data.

Throws:

CertificateParsingException - on parsing errors.

X509CertInfo

public X509CertInfo(DerValue derVal)
             throws CertificateParsingException

Unmarshal a certificate from its encoded form, parsing a DER value. This form of constructor is used by agents which need to examine and use certificate contents.

Parameters:

derVal - the der value containing the encoded cert.

Throws:

CertificateParsingException - on parsing errors.

Method Details

decode

public void decode(InputStream in)
            throws CertificateParsingException,
IOException

Decode an X.509 certificate from an input stream.

Specified by:

decode in interface CertAttrSet

Parameters:

in - an input stream holding at least one certificate

Throws:

CertificateParsingException - on decoding errors.

IOException - on other errors.

encode

public void encode(OutputStream out)
            throws CertificateException,
IOException

Appends the certificate to an output stream.

Specified by:

encode in interface CertAttrSet

Parameters:

out - an output stream to which the certificate is appended.

Throws:

CertificateException - on encoding errors.

IOException - on other errors.

encode

public void encode(OutputStream out,
 boolean ignoreCache)
            throws IOException,
CertificateException

Appends the certificate to an output stream.

Parameters:

out - An output stream to which the certificate is appended.

ignoreCache - Whether to ignore the internal cache when encoding. (the cache can easily become out of date).

Throws:

IOException

CertificateException

getAttributeNames

public Enumeration<String> getAttributeNames()

Return an enumeration of names of attributes existing within this attribute.

Specified by:

getAttributeNames in interface CertAttrSet

Returns:

an enumeration of the attribute names.

getName

public String getName()

Return the name of this attribute.

Specified by:

getName in interface CertAttrSet

Returns:

the name of this CertAttrSet.

getEncodedInfo

public byte[] getEncodedInfo()
                      throws CertificateEncodingException

Returns the encoded certificate info.

Throws:

CertificateEncodingException - on encoding information errors.

getEncodedInfo

public byte[] getEncodedInfo(boolean ignoreCache)
                      throws CertificateEncodingException

Throws:

CertificateEncodingException

equals

public boolean equals(Object other)

Compares two X509CertInfo objects. This is false if the certificates are not both X.509 certs, otherwise it compares them as binary data.

Overrides:

equals in class Object

Parameters:

other - the object being compared with this one

Returns:

true iff the certificates are equivalent

equals

public boolean equals(X509CertInfo other)

Compares two certificates, returning false if any data differs between the two.

Parameters:

other - the object being compared with this one

Returns:

true iff the certificates are equivalent

hashCode

public int hashCode()

Calculates a hash code value for the object. Objects which are equal will also have the same hashcode.

Overrides:

hashCode in class Object

toString

public String toString()

Returns a printable representation of the certificate.

Specified by:

toString in interface CertAttrSet

Overrides:

toString in class Object

Returns:

value of this certificate attribute in printable form.

set

public void set(String name,
 Object val)
         throws CertificateException,
IOException

Set the certificate attribute.

Specified by:

set in interface CertAttrSet

Parameters:

name - the name of the Certificate attribute.

val - the value of the Certificate attribute.

Throws:

CertificateException - on invalid attributes.

IOException - on other errors.

delete

public void delete(String name)
            throws CertificateException,
IOException

Delete the certificate attribute.

Specified by:

delete in interface CertAttrSet

Parameters:

name - the name of the Certificate attribute.

Throws:

CertificateException - on invalid attributes.

IOException - on other errors.

get

public Object get(String name)
           throws CertificateException,
IOException

Get the certificate attribute.

Specified by:

get in interface CertAttrSet

Parameters:

name - the name of the Certificate attribute.

Returns:

attribute value

Throws:

CertificateException - on invalid attributes.

IOException - on other errors.

parse

private void parse(DerValue val)
            throws CertificateParsingException,
IOException

Throws:

CertificateParsingException

IOException

emit

private void emit(DerOutputStream out)
           throws CertificateException,
IOException

Throws:

CertificateException

IOException

writeObject

private void writeObject(ObjectOutputStream stream)
                  throws CertificateException,
IOException

Serialization write ... X.509 certificates serialize as themselves, and they're parsed when they get read back. (Actually they serialize as some type data from the serialization subsystem, then the cert data.)

Throws:

CertificateException

IOException

readObject

private void readObject(ObjectInputStream stream)
                 throws CertificateException,
IOException

Serialization read ... X.509 certificates serialize as themselves, and they're parsed when they get read back.

Throws:

CertificateException

IOException

attributeMap

private int attributeMap(String name)

Returns the integer attribute number for the passed attribute name.

setVersion

private void setVersion(Object val)
                 throws CertificateException

Set the version number of the certificate.

Parameters:

val - the Object class value for the Extensions

Throws:

CertificateException - on invalid data.

setSerialNumber

private void setSerialNumber(Object val)
                      throws CertificateException

Set the serial number of the certificate.

Parameters:

val - the Object class value for the CertificateSerialNumber

Throws:

CertificateException - on invalid data.

setAlgorithmId

private void setAlgorithmId(Object val)
                     throws CertificateException

Set the algorithm id of the certificate.

Parameters:

val - the Object class value for the AlgorithmId

Throws:

CertificateException - on invalid data.

setIssuer

private void setIssuer(Object val)
                throws CertificateException

Set the issuer name of the certificate.

Parameters:

val - the Object class value for the issuer

Throws:

CertificateException - on invalid data.

getIssuerObj

public CertificateIssuerName getIssuerObj()

setValidity

private void setValidity(Object val)
                  throws CertificateException

Set the validity interval of the certificate.

Parameters:

val - the Object class value for the CertificateValidity

Throws:

CertificateException - on invalid data.

setSubject

private void setSubject(Object val)
                 throws CertificateException

Set the subject name of the certificate.

Parameters:

val - the Object class value for the Subject

Throws:

CertificateException - on invalid data.

getSubjectObj

public CertificateSubjectName getSubjectObj()

setKey

private void setKey(Object val)
             throws CertificateException

Set the public key in the certificate.

Parameters:

val - the Object class value for the PublicKey

Throws:

CertificateException - on invalid data.

setIssuerUniqueId

private void setIssuerUniqueId(Object val)
                        throws CertificateException

Set the Issuer Unique Identity in the certificate.

Parameters:

val - the Object class value for the IssuerUniqueId

Throws:

CertificateException

setSubjectUniqueId

private void setSubjectUniqueId(Object val)
                         throws CertificateException

Set the Subject Unique Identity in the certificate.

Parameters:

val - the Object class value for the SubjectUniqueId

Throws:

CertificateException

setExtensions

private void setExtensions(Object val)
                    throws CertificateException

Set the extensions in the certificate.

Parameters:

val - the Object class value for the Extensions

Throws:

CertificateException