Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> java >> security >> [ cert overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of java.security.cert.X509CRL JAVADOC | Sourc code of java.security.cert.X509CRL SOURCE | Download java.security.cert.X509CRL DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.security.cert
Class X509CRL  view X509CRL download X509CRL.java

java.lang.Object
  extended byjava.security.cert.CRL
      extended byjava.security.cert.X509CRL
All Implemented Interfaces:
X509Extension
public abstract class X509CRL
extends CRL
implements X509Extension

The X509CRL class is the abstract class used to manage X.509 Certificate Revocation Lists. The CRL is a list of time stamped entries which indicate which lists have been revoked. The list is signed by a Certificate Authority (CA) and made publically available in a repository. Each revoked certificate in the CRL is identified by its certificate serial number. When a piece of code uses a certificate, the certificates validity is checked by validating its signature and determing that it is not only a recently acquired CRL. The recently aquired CRL is depends on the local policy in affect. The CA issues a new CRL periodically and entries are removed as the certificate expiration date is reached A description of the X.509 v2 CRL follows below from rfc2459. "The X.509 v2 CRL syntax is as follows. For signature calculation, the data that is to be signed is ASN.1 DER encoded. ASN.1 DER encoding is a tag, length, value encoding system for each element. CertificateList ::= SEQUENCE { tbsCertList TBSCertList, signatureAlgorithm AlgorithmIdentifier, signatureValue BIT STRING } TBSCertList ::= SEQUENCE { version Version OPTIONAL, -- if present, shall be v2 signature AlgorithmIdentifier, issuer Name, thisUpdate Time, nextUpdate Time OPTIONAL, revokedCertificates SEQUENCE OF SEQUENCE { userCertificate CertificateSerialNumber, revocationDate Time, crlEntryExtensions Extensions OPTIONAL -- if present, shall be v2 } OPTIONAL, crlExtensions [0] EXPLICIT Extensions OPTIONAL -- if present, shall be v2 }"

Since:
JDK 1.2

Field Summary
 
Fields inherited from class java.security.cert.CRL
 
Constructor Summary
protected X509CRL()
          Constructs a new X509CRL.
 
Method Summary
 boolean equals(java.lang.Object other)
          Compares this X509CRL to other.
abstract  byte[] getEncoded()
          Gets the DER ASN.1 encoded format for this X.509 CRL.
abstract  java.security.Principal getIssuerDN()
          Returns the issuer (issuer distinguished name) of the CRL.
 javax.security.auth.x500.X500Principal getIssuerX500Principal()
          Returns the X.500 distinguished name of this CRL's issuer.
abstract  java.util.Date getNextUpdate()
           
abstract  X509CRLEntry getRevokedCertificate(java.math.BigInteger serialNumber)
          Gets the requeste dX509Entry for the specified certificate serial number.
abstract  java.util.Set getRevokedCertificates()
          Returns a Set of revoked certificates.
abstract  java.lang.String getSigAlgName()
          Returns the signature algorithm used to sign the CRL.
abstract  java.lang.String getSigAlgOID()
          Returns the OID for the signature algorithm used.
abstract  byte[] getSigAlgParams()
          Returns the AlgorithmParameters in the encoded form for the signature algorithm used.
abstract  byte[] getSignature()
          Returns the signature for the CRL.
abstract  byte[] getTBSCertList()
          Returns the DER ASN.1 encoded tbsCertList which is the basic information of the list and associated certificates in the encoded state.
abstract  java.util.Date getThisUpdate()
          Returns the thisUpdate date of the CRL.
abstract  int getVersion()
          Gets the version of this CRL.
 int hashCode()
          Returns a hash code for this X509CRL in its encoded form.
abstract  void verify(java.security.PublicKey key)
          Verifies that this CRL was properly signed with the PublicKey that corresponds to its private key.
abstract  void verify(java.security.PublicKey key, java.lang.String sigProvider)
          Verifies that this CRL was properly signed with the PublicKey that corresponds to its private key and uses the signature engine provided by the provider.
 
Methods inherited from class java.security.cert.CRL
getType, isRevoked, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.security.cert.X509Extension
getCriticalExtensionOIDs, getExtensionValue, getNonCriticalExtensionOIDs, hasUnsupportedCriticalExtension
 

Constructor Detail

X509CRL

protected X509CRL()
Constructs a new X509CRL.

Method Detail

equals

public boolean equals(java.lang.Object other)
Compares this X509CRL to other. It checks if the object if instanceOf X509CRL and then checks if the encoded form matches.

hashCode

public int hashCode()
Returns a hash code for this X509CRL in its encoded form.

getEncoded

public abstract byte[] getEncoded()
                           throws CRLException
Gets the DER ASN.1 encoded format for this X.509 CRL.

verify

public abstract void verify(java.security.PublicKey key)
                     throws CRLException,
                            java.security.NoSuchAlgorithmException,
                            java.security.InvalidKeyException,
                            java.security.NoSuchProviderException,
                            java.security.SignatureException
Verifies that this CRL was properly signed with the PublicKey that corresponds to its private key.

verify

public abstract void verify(java.security.PublicKey key,
                            java.lang.String sigProvider)
                     throws CRLException,
                            java.security.NoSuchAlgorithmException,
                            java.security.InvalidKeyException,
                            java.security.NoSuchProviderException,
                            java.security.SignatureException
Verifies that this CRL was properly signed with the PublicKey that corresponds to its private key and uses the signature engine provided by the provider.

getVersion

public abstract int getVersion()
Gets the version of this CRL. The ASN.1 encoding is: version Version OPTIONAL, -- if present, shall be v2 Version ::= INTEGER { v1(0), v2(1), v3(2) } Consult rfc2459 for more information.

getIssuerDN

public abstract java.security.Principal getIssuerDN()
Returns the issuer (issuer distinguished name) of the CRL. The issuer is the entity who signed and issued the Certificate Revocation List. The ASN.1 DER encoding is: issuer Name, Name ::= CHOICE { RDNSequence } RDNSequence ::= SEQUENCE OF RelativeDistinguishedName RelativeDistinguishedName ::= SET OF AttributeTypeAndValue AttributeTypeAndValue ::= SEQUENCE { type AttributeType, value AttributeValue } AttributeType ::= OBJECT IDENTIFIER AttributeValue ::= ANY DEFINED BY AttributeType DirectoryString ::= CHOICE { teletexString TeletexString (SIZE (1..MAX)), printableString PrintableString (SIZE (1..MAX)), universalString UniversalString (SIZE (1..MAX)), utf8String UTF8String (SIZE (1.. MAX)), bmpString BMPString (SIZE (1..MAX)) } Consult rfc2459 for more information.

getThisUpdate

public abstract java.util.Date getThisUpdate()
Returns the thisUpdate date of the CRL. The ASN.1 DER encoding is: thisUpdate Time, Time ::= CHOICE { utcTime UTCTime, generalTime GeneralizedTime } Consult rfc2459 for more information.

getNextUpdate

public abstract java.util.Date getNextUpdate()

getRevokedCertificate

public abstract X509CRLEntry getRevokedCertificate(java.math.BigInteger serialNumber)
Gets the requeste dX509Entry for the specified certificate serial number.

getRevokedCertificates

public abstract java.util.Set getRevokedCertificates()
Returns a Set of revoked certificates.

getTBSCertList

public abstract byte[] getTBSCertList()
                               throws CRLException
Returns the DER ASN.1 encoded tbsCertList which is the basic information of the list and associated certificates in the encoded state. See top for more information. The ASN.1 DER encoding is: tbsCertList TBSCertList, Consult rfc2459 for more information.

getSignature

public abstract byte[] getSignature()
Returns the signature for the CRL. The ASN.1 DER encoding is: signatureValue BIT STRING Consult rfc2459 for more information.

getSigAlgName

public abstract java.lang.String getSigAlgName()
Returns the signature algorithm used to sign the CRL. An examples is "SHA-1/DSA". The ASN.1 DER encoding is: signatureAlgorithm AlgorithmIdentifier, AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL } Consult rfc2459 for more information. The algorithm name is determined from the OID.

getSigAlgOID

public abstract java.lang.String getSigAlgOID()
Returns the OID for the signature algorithm used. Example "1.2.840.10040.4.3" is return for SHA-1 with DSA.\ The ASN.1 DER encoding for the example is: id-dsa-with-sha1 ID ::= { iso(1) member-body(2) us(840) x9-57 (10040) x9cm(4) 3 } Consult rfc2459 for more information.

getSigAlgParams

public abstract byte[] getSigAlgParams()
Returns the AlgorithmParameters in the encoded form for the signature algorithm used. If access to the parameters is need, create an instance of AlgorithmParameters.

getIssuerX500Principal

public javax.security.auth.x500.X500Principal getIssuerX500Principal()
Returns the X.500 distinguished name of this CRL's issuer.

Since:
JDK 1.4
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> java >> security >> [ cert overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of java.security.cert.X509CRL JAVADOC | Sourc code of java.security.cert.X509CRL SOURCE | Download java.security.cert.X509CRL DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD