File	Doc	Category	Size	Date	Package
X509CRL.java	API Doc	Java SE 5 API	14765	Fri Aug 26 14:57:18 BST 2005	java.security.cert

X509CRL

• java.lang.Object
  • java.security.cert.CRL

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

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
}

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

Fields Summary
private transient X500Principal	issuerPrincipal

Constructors Summary
protected X509CRL() Constructor for X.509 CRLs. super("X.509");

Methods Summary
public boolean	equals(java.lang.Object other) 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. param other the object to test for equality with this CRL. return true iff the encoded forms of the two CRLs match, false otherwise. if (this == other) { return true; } if (!(other instanceof X509CRL)) { return false; } try { byte[] thisCRL = X509CRLImpl.getEncodedInternal(this); byte[] otherCRL = X509CRLImpl.getEncodedInternal((X509CRL)other); return Arrays.equals(thisCRL, otherCRL); } catch (CRLException e) { return false; }
public abstract byte[]	getEncoded() Returns the ASN.1 DER-encoded form of this CRL. return the encoded form of this certificate exception CRLException if an encoding error occurs.
public abstract java.security.Principal	getIssuerDN() Denigrated, replaced by {@linkplain #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. return a Principal whose name is the issuer distinguished name.
public javax.security.auth.x500.X500Principal	getIssuerX500Principal() Returns the issuer (issuer distinguished name) value from the CRL as an X500Principal. It is recommended that subclasses override this method. return an X500Principal representing the issuer distinguished name since 1.4 if (issuerPrincipal == null) { issuerPrincipal = X509CRLImpl.getIssuerX500Principal(this); } return issuerPrincipal;
public abstract java.util.Date	getNextUpdate() Gets the nextUpdate date from the CRL. return the nextUpdate date from the CRL, or null if not present.
public abstract java.security.cert.X509CRLEntry	getRevokedCertificate(java.math.BigInteger serialNumber) Gets the CRL entry, if any, with the given certificate serialNumber. param serialNumber the serial number of the certificate for which a CRL entry is to be looked up return the entry with the given serial number, or null if no such entry exists in this CRL. see X509CRLEntry
public java.security.cert.X509CRLEntry	getRevokedCertificate(java.security.cert.X509Certificate certificate) Get the CRL entry, if any, for the given certificate. This method can be used to lookup CRL entries in indirect CRLs, that means CRLs that contain entries from issuers other than the CRL issuer. The default implementation will only return entries for certificates issued by the CRL issuer. Subclasses that wish to support indirect CRLs should override this method. param certificate the certificate for which a CRL entry is to be looked up return the entry for the given certificate, or null if no such entry exists in this CRL. exception NullPointerException if certificate is null since 1.5 X500Principal certIssuer = certificate.getIssuerX500Principal(); X500Principal crlIssuer = getIssuerX500Principal(); if (certIssuer.equals(crlIssuer) == false) { return null; } return getRevokedCertificate(certificate.getSerialNumber());
public abstract java.util.Set	getRevokedCertificates() Gets all the entries from this CRL. This returns a Set of X509CRLEntry objects. return all the entries or null if there are none present. see X509CRLEntry
public abstract java.lang.String	getSigAlgName() 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. return the signature algorithm name.
public abstract java.lang.String	getSigAlgOID() Gets the signature algorithm OID string from the CRL. An OID is represented by a set of nonnegative whole numbers separated by periods. For example, the string "1.2.840.10040.4.3" identifies the SHA-1 with DSA signature algorithm, as per RFC 2459. See {@link #getSigAlgName() getSigAlgName} for relevant ASN.1 definitions. return the signature algorithm OID string.
public abstract byte[]	getSigAlgParams() Gets the DER-encoded signature algorithm parameters from this CRL's signature algorithm. In most cases, the signature algorithm parameters are null; the parameters are usually supplied with the public key. If access to individual parameter values is needed then use {@link java.security.AlgorithmParameters AlgorithmParameters} and instantiate with the name returned by {@link #getSigAlgName() getSigAlgName}. See {@link #getSigAlgName() getSigAlgName} for relevant ASN.1 definitions. return the DER-encoded signature algorithm parameters, or null if no parameters are present.
public abstract byte[]	getSignature() Gets the signature value (the raw signature bits) from the CRL. The ASN.1 definition for this is: signature BIT STRING return the signature.
public abstract byte[]	getTBSCertList() Gets the DER-encoded CRL information, the tbsCertList from this CRL. This can be used to verify the signature independently. return the DER-encoded CRL information. exception CRLException if an encoding error occurs.
public abstract java.util.Date	getThisUpdate() Gets the thisUpdate date from the CRL. The ASN.1 definition for this is: thisUpdate ChoiceOfTime ChoiceOfTime ::= CHOICE { utcTime UTCTime, generalTime GeneralizedTime } return the thisUpdate date from the CRL.
public abstract int	getVersion() 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 return the version number, i.e. 1 or 2.
public int	hashCode() Returns a hashcode value for this CRL from its encoded form. return the hashcode value. int retval = 0; try { byte[] crlData = X509CRLImpl.getEncodedInternal(this); for (int i = 1; i < crlData.length; i++) { retval += crlData[i] * i; } return retval; } catch (CRLException e) { return retval; }
public abstract void	verify(java.security.PublicKey key) Verifies that this CRL was signed using the private key that corresponds to the given public key. param key the PublicKey used to carry out the verification. exception NoSuchAlgorithmException on unsupported signature algorithms. exception InvalidKeyException on incorrect key. exception NoSuchProviderException if there's no default provider. exception SignatureException on signature errors. exception CRLException on encoding errors.
public abstract void	verify(java.security.PublicKey key, java.lang.String sigProvider) Verifies that this CRL was signed using the private key that corresponds to the given public key. This method uses the signature verification engine supplied by the given provider. param key the PublicKey used to carry out the verification. param sigProvider the name of the signature provider. exception NoSuchAlgorithmException on unsupported signature algorithms. exception InvalidKeyException on incorrect key. exception NoSuchProviderException on incorrect provider. exception SignatureException on signature errors. exception CRLException on encoding errors.