X509CRL JDK 1.6)

Description

publicabstract abstract class X509CRL

Abstract class for an X.509 Certificate Revocation List (CRL).

Abstract class for an X.509 Certificate Revocation List (CRL). A CRL is a time-stamped list identifying revoked certificates. It is signed by a Certificate Authority (CA) and made freely available in a public repository.

Each revoked certificate is identified in a CRL by its certificate serial number. When a certificate-using system uses a certificate (e.g., for verifying a remote user's digital signature), that system not only checks the certificate signature and validity but also acquires a suitably- recent CRL and checks that the certificate serial number is not on that CRL. The meaning of "suitably-recent" may vary with local policy, but it usually means the most recently-issued CRL. A CA issues a new CRL on a regular periodic basis (e.g., hourly, daily, or weekly). Entries are added to CRLs as revocations occur, and an entry may be removed when the certificate expiration date is reached.

The X.509 v2 CRL format is described below in ASN.1:

 CertificateList  ::=  SEQUENCE  {
     tbsCertList          TBSCertList,
     signatureAlgorithm   AlgorithmIdentifier,
     signature            BIT STRING  }

More information can be found in RFC 2459, "Internet X.509 Public Key Infrastructure Certificate and CRL Profile" at http://www.ietf.org/rfc/rfc2459.txt .

The ASN.1 definition of tbsCertList is:

 TBSCertList  ::=  SEQUENCE  {
     version                 Version OPTIONAL,
                             -- if present, must be v2
     signature               AlgorithmIdentifier,
     issuer                  Name,
     thisUpdate              ChoiceOfTime,
     nextUpdate              ChoiceOfTime OPTIONAL,
     revokedCertificates     SEQUENCE OF SEQUENCE  {
         userCertificate         CertificateSerialNumber,
         revocationDate          ChoiceOfTime,
         crlEntryExtensions      Extensions OPTIONAL
                                 -- if present, must be v2
         }  OPTIONAL,
     crlExtensions           [0]  EXPLICIT Extensions OPTIONAL
                                  -- if present, must be v2
     }

CRLs are instantiated using a certificate factory. The following is an example of how to instantiate an X.509 CRL:

 
 InputStream inStream = new FileInputStream("fileName-of-crl");
 CertificateFactory cf = CertificateFactory.getInstance("X.509");
 X509CRL crl = (X509CRL)cf.generateCRL(inStream);
 inStream.close();

See also: CRL CertificateFactory X509Extension

Methods

Hide/Show inherited methods

public boolean equals (Object other)

Compares this CRL for equality with the given object.

Compares this CRL for equality with the given
object. If the other object is an
instanceof X509CRL, then
its encoded form is retrieved and compared with the
encoded form of this CRL.
Returns: true iff the encoded forms of the two CRLs match, false otherwise.
Parameters:
- other - the object to test for equality with this CRL.

publicabstract byte getEncoded () throws CRLException

Returns the ASN.1 DER-encoded form of this CRL.

publicabstract Principal getIssuerDN ()

Denigrated, replaced by X509CRL.getIssuerX500Principal().

Denigrated, replaced by X509CRL.getIssuerX500Principal(). This method returns the issuer as an implementation specific Principal object, which should not be relied upon by portable code.

Gets the issuer (issuer distinguished name) value from the CRL. The issuer name identifies the entity that signed (and issued) the CRL.

The issuer name field contains an X.500 distinguished name (DN). The ASN.1 definition for this is:

 issuer    Name

 Name ::= CHOICE { RDNSequence }
 RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
 RelativeDistinguishedName ::=
     SET OF AttributeValueAssertion

 AttributeValueAssertion ::= SEQUENCE {
                               AttributeType,
                               AttributeValue }
 AttributeType ::= OBJECT IDENTIFIER
 AttributeValue ::= ANY

The Name describes a hierarchical name composed of attributes, such as country name, and corresponding values, such as US. The type of the AttributeValue component is determined by the AttributeType; in general it will be a directoryString. A directoryString is usually one of PrintableString, TeletexString or UniversalString.
Returns: a Principal whose name is the issuer distinguished name.

public X500Principal getIssuerX500Principal ()

Returns the issuer (issuer distinguished name) value from the CRL as an X500Principal.

It is recommended that subclasses override this method.
Returns: an X500Principal representing the issuer distinguished name
Since: 1.4

publicabstract Date getNextUpdate ()

Gets the nextUpdate date from the CRL.

Gets the nextUpdate date from the CRL.
Returns: the nextUpdate date from the CRL, or null if not present.

publicabstract X509CRLEntry getRevokedCertificate (BigInteger serialNumber)

Gets the CRL entry, if any, with the given certificate serialNumber.

public X509CRLEntry getRevokedCertificate (X509Certificate certificate)

Get the CRL entry, if any, for the given certificate.

publicabstract Set<X509CRLEntry> getRevokedCertificates ()

Gets all the entries from this CRL.

publicabstract String getSigAlgName ()

Gets the signature algorithm name for the CRL signature algorithm.

Gets the signature algorithm name for the CRL signature algorithm. An example is the string "SHA-1/DSA". The ASN.1 definition for this is:

signatureAlgorithm AlgorithmIdentifier

AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL } -- contains a value of the type -- registered for use with the -- algorithm object identifier value

The algorithm name is determined from the algorithm OID string.
Returns: the signature algorithm name.

publicabstract String getSigAlgOID ()

Gets the signature algorithm OID string from the CRL.

publicabstract byte getSigAlgParams ()

Gets the DER-encoded signature algorithm parameters from this CRL's signature algorithm.

publicabstract byte getSignature ()

Gets the signature value (the raw signature bits) from the CRL.

Gets the signature value (the raw signature bits) from
the CRL.
The ASN.1 definition for this is:


 signature     BIT STRING

Returns: the signature.

publicabstract byte getTBSCertList () throws CRLException

Gets the DER-encoded CRL information, the tbsCertList from this CRL.

Gets the DER-encoded CRL information, the
tbsCertList from this CRL.
This can be used to verify the signature independently.
Returns: the DER-encoded CRL information.
Throws:
- CRLException - if an encoding error occurs.

publicabstract Date getThisUpdate ()

Gets the thisUpdate date from the CRL.

Gets the thisUpdate date from the CRL.
The ASN.1 definition for this is:


 thisUpdate   ChoiceOfTime
 ChoiceOfTime ::= CHOICE {
     utcTime        UTCTime,
     generalTime    GeneralizedTime }

Returns: the thisUpdate date from the CRL.

publicfinal String getType () [Inherited From CRL]

Returns the type of this CRL.

publicabstract int getVersion ()

Gets the version (version number) value from the CRL.

Gets the version (version number) value from the CRL. The ASN.1 definition for this is:

 version    Version OPTIONAL,
             -- if present, must be v2
 Version  ::=  INTEGER  {  v1(0), v2(1), v3(2)  }
             -- v3 does not apply to CRLs but appears for consistency
             -- with definition of Version for certs

Returns: the version number, i.e. 1 or 2.

public int hashCode ()

Returns a hashcode value for this CRL from its encoded form.

publicabstract boolean isRevoked (Certificate cert) [Inherited From CRL]

Checks whether the given certificate is on this CRL.

publicabstract String toString () [Inherited From CRL]

Returns a string representation of this CRL.

publicabstract void verify (PublicKey key) throws CRLException NoSuchAlgorithmException InvalidKeyException NoSuchProviderException SignatureException

Verifies that this CRL was signed using the private key that corresponds to the given public key.

publicabstract void verify (PublicKey key, String sigProvider) throws CRLException NoSuchAlgorithmException InvalidKeyException NoSuchProviderException SignatureException

Verifies that this CRL was signed using the private key that corresponds to the given public key.