Added in API level 1

Certificate

abstract class Certificate : Serializable
kotlin.Any
   ↳ java.security.cert.Certificate

Abstract class for managing a variety of identity certificates. An identity certificate is a binding of a principal to a public key which is vouched for by 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.

Summary

Nested classes
open

Alternate Certificate class for serialization.

Protected constructors

Creates a certificate of the specified type.

Public methods
open Boolean
equals(other: Any?)

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.

String!

Returns the type of this certificate.

open Int

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

abstract String

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
verify(key: PublicKey!, sigProvider: String!)

Verifies that this certificate was signed using the private key that corresponds to the specified public key.

open Unit
verify(key: PublicKey!, sigProvider: Provider!)

Verifies that this certificate was signed using the private key that corresponds to the specified public key.

Protected methods
open Any!

Replace the Certificate to be serialized.

Protected constructors

Certificate

Added in API level 1
protected Certificate(type: String!)

Creates a certificate of the specified type.

Parameters
type String!: the standard name of the certificate type. See the CertificateFactory section in the Java Security Standard Algorithm Names Specification for information about standard certificate types.

Public methods

equals

Added in API level 1
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 iff the encoded forms of the two certificates match, false otherwise.

getEncoded

Added in API level 1
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! the encoded form of this certificate
Exceptions
java.security.cert.CertificateEncodingException if an encoding error occurs.

getPublicKey

Added in API level 1
abstract fun getPublicKey(): PublicKey!

Gets the public key from this certificate.

Return
PublicKey! the public key.

getType

Added in API level 1
fun getType(): String!

Returns the type of this certificate.

Return
String! the type of this certificate.

hashCode

Added in API level 1
open fun hashCode(): Int

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

Return
Int the hashcode value.

toString

Added in API level 1
abstract fun toString(): String

Returns a string representation of this certificate.

Return
String a string representation of this certificate.

verify

Added in API level 1
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.
java.security.cert.CertificateException on encoding errors.

verify

Added in API level 1
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.
java.security.cert.CertificateException on encoding errors.

verify

Added in API level 26
open fun verify(
    key: PublicKey!,
    sigProvider: Provider!
): 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. 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 cannot be abstract and by default throws an UnsupportedOperationException.

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.CertificateException on encoding errors.
java.lang.UnsupportedOperationException if the method is not supported

Protected methods

writeReplace

Added in API level 1
protected open fun writeReplace(): Any!

Replace the Certificate to be serialized.

Return
Any! the alternate Certificate object to be serialized
Exceptions
java.io.ObjectStreamException if a new object representing this Certificate could not be created