X509CRL
abstract class X509CRL : CRL, X509Extension
kotlin.Any | ||
↳ | java.security.cert.CRL | |
↳ | java.security.cert.X509CRL |
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 3280: Internet X.509 Public Key Infrastructure Certificate and CRL Profile.
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:
<code>try (InputStream inStream = new FileInputStream("fileName-of-crl")) { CertificateFactory cf = CertificateFactory.getInstance("X.509"); X509CRL crl = (X509CRL)cf.generateCRL(inStream); } </code>
Summary
Protected constructors | |
---|---|
X509CRL() Constructor for X. |
Public methods | |
---|---|
open Boolean |
Compares this CRL for equality with the given object. |
abstract ByteArray! |
Returns the ASN. |
abstract Principal! |
Denigrated, replaced by getIssuerX500Principal(). |
open X500Principal! |
Returns the issuer (issuer distinguished name) value from the CRL as an |
abstract Date! |
Gets the |
abstract X509CRLEntry! |
getRevokedCertificate(serialNumber: BigInteger!) Gets the CRL entry, if any, with the given certificate serialNumber. |
open X509CRLEntry! |
getRevokedCertificate(certificate: X509Certificate!) Get the CRL entry, if any, for the given certificate. |
abstract MutableSet<out X509CRLEntry!>! |
Gets all the entries from this CRL. |
abstract String! |
Gets the signature algorithm name for the CRL signature algorithm. |
abstract String! |
Gets the signature algorithm OID string from the CRL. |
abstract ByteArray! |
Gets the DER-encoded signature algorithm parameters from this CRL's signature algorithm. |
abstract ByteArray! |
Gets the |
abstract ByteArray! |
Gets the DER-encoded CRL information, the |
abstract Date! |
Gets the |
abstract Int |
Gets the |
open Int |
hashCode() Returns a hashcode value for this CRL from its encoded form. |
abstract Unit |
Verifies that this CRL was signed using the private key that corresponds to the given public key. |
abstract Unit |
Verifies that this CRL was signed using the private key that corresponds to the given public key. |
open Unit |
Verifies that this CRL was signed using the private key that corresponds to the given public key. |
Inherited functions | |
---|---|
Protected constructors
Public methods
equals
open fun equals(other: Any?): Boolean
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.
Parameters | |
---|---|
obj |
the reference object with which to compare. |
other |
Any?: the object to test for equality with this CRL. |
Return | |
---|---|
Boolean |
true iff the encoded forms of the two CRLs match, false otherwise. |
getEncoded
abstract fun getEncoded(): ByteArray!
Returns the ASN.1 DER-encoded form of this CRL.
Return | |
---|---|
ByteArray! |
the encoded form of this certificate |
Exceptions | |
---|---|
java.security.cert.CRLException |
if an encoding error occurs. |
getIssuerDN
abstract fun getIssuerDN(): Principal!
Denigrated, replaced by 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
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 | |
---|---|
Principal! |
a Principal whose name is the issuer distinguished name. |
getIssuerX500Principal
open fun getIssuerX500Principal(): X500Principal!
Returns the issuer (issuer distinguished name) value from the CRL as an X500Principal
.
It is recommended that subclasses override this method.
Return | |
---|---|
X500Principal! |
an X500Principal representing the issuer distinguished name |
getNextUpdate
abstract fun getNextUpdate(): Date!
Gets the nextUpdate
date from the CRL.
Return | |
---|---|
Date! |
the nextUpdate date from the CRL, or null if not present. |
getRevokedCertificate
abstract fun getRevokedCertificate(serialNumber: BigInteger!): X509CRLEntry!
Gets the CRL entry, if any, with the given certificate serialNumber.
Parameters | |
---|---|
serialNumber |
BigInteger!: the serial number of the certificate for which a CRL entry is to be looked up |
Return | |
---|---|
X509CRLEntry! |
the entry with the given serial number, or null if no such entry exists in this CRL. |
See Also
getRevokedCertificate
open fun getRevokedCertificate(certificate: X509Certificate!): X509CRLEntry!
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.
Parameters | |
---|---|
certificate |
X509Certificate!: the certificate for which a CRL entry is to be looked up |
Return | |
---|---|
X509CRLEntry! |
the entry for the given certificate, or null if no such entry exists in this CRL. |
Exceptions | |
---|---|
java.lang.NullPointerException |
if certificate is null |
getRevokedCertificates
abstract fun getRevokedCertificates(): MutableSet<out X509CRLEntry!>!
Gets all the entries from this CRL. This returns a Set of X509CRLEntry objects.
Return | |
---|---|
MutableSet<out X509CRLEntry!>! |
all the entries or null if there are none present. |
See Also
getSigAlgName
abstract fun getSigAlgName(): String!
Gets the signature algorithm name for the CRL signature algorithm. An example is the string "SHA256withRSA". 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 | |
---|---|
String! |
the signature algorithm name. |
getSigAlgOID
abstract fun getSigAlgOID(): String!
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 defined in RFC 3279: Algorithms and Identifiers for the Internet X.509 Public Key Infrastructure Certificate and CRL Profile.
See getSigAlgName
for relevant ASN.1 definitions.
Return | |
---|---|
String! |
the signature algorithm OID string. |
getSigAlgParams
abstract fun getSigAlgParams(): ByteArray!
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 AlgorithmParameters
and instantiate with the name returned by getSigAlgName
.
See getSigAlgName
for relevant ASN.1 definitions.
Return | |
---|---|
ByteArray! |
the DER-encoded signature algorithm parameters, or null if no parameters are present. |
getSignature
abstract fun getSignature(): ByteArray!
Gets the signature
value (the raw signature bits) from the CRL. The ASN.1 definition for this is:
signature BIT STRING
Return | |
---|---|
ByteArray! |
the signature. |
getTBSCertList
abstract fun getTBSCertList(): ByteArray!
Gets the DER-encoded CRL information, the tbsCertList
from this CRL. This can be used to verify the signature independently.
Return | |
---|---|
ByteArray! |
the DER-encoded CRL information. |
Exceptions | |
---|---|
java.security.cert.CRLException |
if an encoding error occurs. |
getThisUpdate
abstract fun getThisUpdate(): Date!
Gets the thisUpdate
date from the CRL. The ASN.1 definition for this is:
thisUpdate ChoiceOfTime ChoiceOfTime ::= CHOICE { utcTime UTCTime, generalTime GeneralizedTime }
Return | |
---|---|
Date! |
the thisUpdate date from the CRL. |
getVersion
abstract fun getVersion(): Int
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 | |
---|---|
Int |
the version number, i.e. 1 or 2. |
hashCode
open fun hashCode(): Int
Returns a hashcode value for this CRL from its encoded form.
Return | |
---|---|
Int |
the hashcode value. |
verify
abstract fun verify(key: PublicKey!): Unit
Verifies that this CRL was signed using the private key that corresponds to the given public key.
Parameters | |
---|---|
key |
PublicKey!: the PublicKey used to carry out the verification. |
Exceptions | |
---|---|
java.security.NoSuchAlgorithmException |
on unsupported signature algorithms. |
java.security.InvalidKeyException |
on incorrect key. |
java.security.NoSuchProviderException |
if there's no default provider. |
java.security.SignatureException |
on signature errors. |
java.security.cert.CRLException |
on encoding errors. |
verify
abstract fun verify(
key: PublicKey!,
sigProvider: String!
): Unit
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.
Parameters | |
---|---|
key |
PublicKey!: the PublicKey used to carry out the verification. |
sigProvider |
String!: the name of the signature provider. |
Exceptions | |
---|---|
java.security.NoSuchAlgorithmException |
on unsupported signature algorithms. |
java.security.InvalidKeyException |
on incorrect key. |
java.security.NoSuchProviderException |
on incorrect provider. |
java.security.SignatureException |
on signature errors. |
java.security.cert.CRLException |
on encoding errors. |
verify
open fun verify(
key: PublicKey!,
sigProvider: Provider!
): Unit
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. Note that the specified Provider object does not have to be registered in the provider list. This method was added to version 1.8 of the Java Platform Standard Edition. In order to maintain backwards compatibility with existing service providers, this method is not abstract
and it provides a default implementation.
Parameters | |
---|---|
key |
PublicKey!: the PublicKey used to carry out the verification. |
sigProvider |
Provider!: the signature provider. |
Exceptions | |
---|---|
java.security.NoSuchAlgorithmException |
on unsupported signature algorithms. |
java.security.InvalidKeyException |
on incorrect key. |
java.security.SignatureException |
on signature errors. |
java.security.cert.CRLException |
on encoding errors. |