Certificate
abstract class Certificate
| kotlin.Any | |
| ↳ | javax.security.cert.Certificate |
Abstract class for managing a variety of identity certificates. An identity certificate is a guarantee by a principal that a public key is that of another principal. (A principal represents an entity such as an individual user, a group, or a corporation.)
This class is an abstraction for certificates that have different formats but important common uses. For example, different types of certificates, such as X.509 and PGP, share general certificate functionality (like encoding and verifying) and some types of information (like a public key).
X.509, PGP, and SDSI certificates can all be implemented by subclassing the Certificate class, even though they contain different sets of information, and they store and retrieve the information in different ways.
Note: The classes in the package javax.security.cert exist for compatibility with earlier versions of the Java Secure Sockets Extension (JSSE). New applications should instead use the standard Java SE certificate classes located in java.security.cert.
Summary
| Public constructors | |
|---|---|
| Public methods | |
|---|---|
| open Boolean |
Compares this certificate for equality with the specified object. |
| abstract ByteArray! |
Returns the encoded form of this certificate. |
| abstract PublicKey! |
Gets the public key from this certificate. |
| open Int |
hashCode()Returns a hashcode value for this certificate from its encoded form. |
| abstract String |
toString()Returns a string representation of this certificate. |
| abstract Unit |
Verifies that this certificate was signed using the private key that corresponds to the specified public key. |
| abstract Unit |
Verifies that this certificate was signed using the private key that corresponds to the specified public key. |
Public constructors
Public methods
equals
open fun equals(other: Any?): Boolean
Compares this certificate for equality with the specified object. If the other object is an instanceof Certificate, then its encoded form is retrieved and compared with the encoded form of this certificate.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
other |
Any?: the object to test for equality with this certificate. |
| Return | |
|---|---|
Boolean |
true if the encoded forms of the two certificates match, false otherwise. |
getEncoded
abstract fun getEncoded(): ByteArray!
Returns the encoded form of this certificate. It is assumed that each certificate type would have only a single form of encoding; for example, X.509 certificates would be encoded as ASN.1 DER.
| Return | |
|---|---|
ByteArray! |
encoded form of this certificate |
| Exceptions | |
|---|---|
javax.security.cert.CertificateEncodingException |
on internal certificate encoding failure |
getPublicKey
abstract fun getPublicKey(): PublicKey!
Gets the public key from this certificate.
| Return | |
|---|---|
PublicKey! |
the public key. |
hashCode
open fun hashCode(): Int
Returns a hashcode value for this certificate from its encoded form.
| Return | |
|---|---|
Int |
the hashcode value. |
toString
abstract fun toString(): String
Returns a string representation of this certificate.
| Return | |
|---|---|
String |
a string representation of this certificate. |
verify
abstract fun verify(key: PublicKey!): Unit
Verifies that this certificate was signed using the private key that corresponds to the specified 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. |
javax.security.cert.CertificateException |
on encoding errors. |
verify
abstract fun verify(
key: PublicKey!,
sigProvider: String!
): Unit
Verifies that this certificate was signed using the private key that corresponds to the specified public key. This method uses the signature verification engine supplied by the specified 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. |
javax.security.cert.CertificateException |
on encoding errors. |