Added in API level 1

KeyStoreSpi

abstract class KeyStoreSpi

kotlin.Any
↳	java.security.KeyStoreSpi

This class defines the Service Provider Interface (SPI) for the KeyStore class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a keystore for a particular keystore type.

Summary

Public constructors
KeyStoreSpi()

Public methods
abstract Enumeration<String!>!	engineAliases() Lists all the alias names of this keystore.
abstract Boolean	engineContainsAlias(alias: String!) Checks if the given alias exists in this keystore.
abstract Unit	engineDeleteEntry(alias: String!) Deletes the entry identified by the given alias from this keystore.
open Boolean	engineEntryInstanceOf(alias: String!, entryClass: Class<out KeyStore.Entry!>!) Determines if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass.
abstract Certificate!	engineGetCertificate(alias: String!) Returns the certificate associated with the given alias.
abstract String!	engineGetCertificateAlias(cert: Certificate!) Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.
abstract Array<Certificate!>!	engineGetCertificateChain(alias: String!) Returns the certificate chain associated with the given alias.
abstract Date!	engineGetCreationDate(alias: String!) Returns the creation date of the entry identified by the given alias.
open KeyStore.Entry!	engineGetEntry(alias: String!, protParam: KeyStore.ProtectionParameter!) Gets a KeyStore.Entry for the specified alias with the specified protection parameter.
abstract Key!	engineGetKey(alias: String!, password: CharArray!) Returns the key associated with the given alias, using the given password to recover it.
abstract Boolean	engineIsCertificateEntry(alias: String!) Returns true if the entry identified by the given alias was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry.
abstract Boolean	engineIsKeyEntry(alias: String!) Returns true if the entry identified by the given alias was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry or a SecretKeyEntry.
abstract Unit	engineLoad(stream: InputStream!, password: CharArray!) Loads the keystore from the given input stream.
open Unit	engineLoad(param: KeyStore.LoadStoreParameter!) Loads the keystore using the given KeyStore.LoadStoreParameter.
open Boolean	engineProbe(stream: InputStream!) Probes the specified input stream to determine whether it contains a keystore that is supported by this implementation, or not.
abstract Unit	engineSetCertificateEntry(alias: String!, cert: Certificate!) Assigns the given certificate to the given alias.
open Unit	engineSetEntry(alias: String!, entry: KeyStore.Entry!, protParam: KeyStore.ProtectionParameter!) Saves a KeyStore.Entry under the specified alias.
abstract Unit	engineSetKeyEntry(alias: String!, key: Key!, password: CharArray!, chain: Array<Certificate!>!) Assigns the given key to the given alias, protecting it with the given password.
abstract Unit	engineSetKeyEntry(alias: String!, key: ByteArray!, chain: Array<Certificate!>!) Assigns the given key (that has already been protected) to the given alias.
abstract Int	engineSize() Retrieves the number of entries in this keystore.
abstract Unit	engineStore(stream: OutputStream!, password: CharArray!) Stores this keystore to the given output stream, and protects its integrity with the given password.
open Unit	engineStore(param: KeyStore.LoadStoreParameter!) Stores this keystore using the given KeyStore.LoadStoreParmeter.

Public constructors

KeyStoreSpi

Added in API level 1

KeyStoreSpi()

Public methods

engineAliases

Added in API level 1

abstract fun engineAliases(): Enumeration<String!>!

Lists all the alias names of this keystore.

Return
Enumeration<String!>!	enumeration of the alias names

engineContainsAlias

Added in API level 1

abstract fun engineContainsAlias(alias: String!): Boolean

Checks if the given alias exists in this keystore.

Parameters
alias	String!: the alias name

Return
Boolean	true if the alias exists, false otherwise

engineDeleteEntry

Added in API level 1

abstract fun engineDeleteEntry(alias: String!): Unit

Deletes the entry identified by the given alias from this keystore.

Parameters
alias	String!: the alias name

Exceptions
java.security.KeyStoreException	if the entry cannot be removed.

engineEntryInstanceOf

Added in API level 1

open fun engineEntryInstanceOf(
    alias: String!, 
    entryClass: Class<out KeyStore.Entry!>!
): Boolean

Determines if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass.

Parameters
alias	String!: the alias name
entryClass	Class<out KeyStore.Entry!>!: the entry class

Return
Boolean	true if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass, false otherwise

engineGetCertificate

Added in API level 1

abstract fun engineGetCertificate(alias: String!): Certificate!

Returns the certificate associated with the given alias.

If the given alias name identifies an entry created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, then the trusted certificate contained in that entry is returned.

If the given alias name identifies an entry created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry, then the first element of the certificate chain in that entry (if a chain exists) is returned.

Parameters
alias	String!: the alias name

Return
Certificate!	the certificate, or null if the given alias does not exist or does not contain a certificate.

engineGetCertificateAlias

Added in API level 1

abstract fun engineGetCertificateAlias(cert: Certificate!): String!

Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.

This method attempts to match the given certificate with each keystore entry. If the entry being considered was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, then the given certificate is compared to that entry's certificate.

If the entry being considered was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry, then the given certificate is compared to the first element of that entry's certificate chain.

Parameters
cert	Certificate!: the certificate to match with.

Return
String!	the alias name of the first entry with matching certificate, or null if no such entry exists in this keystore.

engineGetCertificateChain

Added in API level 1

abstract fun engineGetCertificateChain(alias: String!): Array<Certificate!>!

Returns the certificate chain associated with the given alias. The certificate chain must have been associated with the alias by a call to setKeyEntry, or by a call to setEntry with a PrivateKeyEntry.

Parameters
alias	String!: the alias name

Return
Array<Certificate!>!	the certificate chain (ordered with the user's certificate first and the root certificate authority last), or null if the given alias does not exist or does not contain a certificate chain

engineGetCreationDate

Added in API level 1

abstract fun engineGetCreationDate(alias: String!): Date!

Returns the creation date of the entry identified by the given alias.

Parameters
alias	String!: the alias name

Return
Date!	the creation date of this entry, or null if the given alias does not exist

engineGetEntry

Added in API level 1

open fun engineGetEntry(
    alias: String!, 
    protParam: KeyStore.ProtectionParameter!
): KeyStore.Entry!

Gets a KeyStore.Entry for the specified alias with the specified protection parameter.

Parameters
alias	String!: get the KeyStore.Entry for this alias
protParam	KeyStore.ProtectionParameter!: the ProtectionParameter used to protect the Entry, which may be null

Return
KeyStore.Entry!	the KeyStore.Entry for the specified alias, or null if there is no such entry

Exceptions
java.security.KeyStoreException	if the operation failed
java.security.NoSuchAlgorithmException	if the algorithm for recovering the entry cannot be found
java.security.UnrecoverableEntryException	if the specified protParam were insufficient or invalid
java.security.UnrecoverableKeyException	if the entry is a PrivateKeyEntry or SecretKeyEntry and the specified protParam does not contain the information needed to recover the key (e.g. wrong password)

engineGetKey

Added in API level 1

abstract fun engineGetKey(
    alias: String!, 
    password: CharArray!
): Key!

Returns the key associated with the given alias, using the given password to recover it. The key must have been associated with the alias by a call to setKeyEntry, or by a call to setEntry with a PrivateKeyEntry or SecretKeyEntry.

Parameters
alias	String!: the alias name
password	CharArray!: the password for recovering the key

Return
Key!	the requested key, or null if the given alias does not exist or does not identify a key-related entry.

Exceptions
java.security.NoSuchAlgorithmException	if the algorithm for recovering the key cannot be found
java.security.UnrecoverableKeyException	if the key cannot be recovered (e.g., the given password is wrong).

engineIsCertificateEntry

Added in API level 1

abstract fun engineIsCertificateEntry(alias: String!): Boolean

Returns true if the entry identified by the given alias was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry.

Parameters
alias	String!: the alias for the keystore entry to be checked

Return
Boolean	true if the entry identified by the given alias contains a trusted certificate, false otherwise.

engineIsKeyEntry

Added in API level 1

abstract fun engineIsKeyEntry(alias: String!): Boolean

Returns true if the entry identified by the given alias was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry or a SecretKeyEntry.

Parameters
alias	String!: the alias for the keystore entry to be checked

Return
Boolean	true if the entry identified by the given alias is a key-related, false otherwise.

engineLoad

Added in API level 1

abstract fun engineLoad(
    stream: InputStream!, 
    password: CharArray!
): Unit

Loads the keystore from the given input stream.

A password may be given to unlock the keystore (e.g. the keystore resides on a hardware token device), or to check the integrity of the keystore data. If a password is not given for integrity checking, then integrity checking is not performed.

Parameters
stream	InputStream!: the input stream from which the keystore is loaded, or null
password	CharArray!: the password used to check the integrity of the keystore, the password used to unlock the keystore, or null

Exceptions
java.io.IOException	if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect. If the error is due to a wrong password, the cause of the IOException should be an UnrecoverableKeyException
java.security.NoSuchAlgorithmException	if the algorithm used to check the integrity of the keystore cannot be found
java.security.cert.CertificateException	if any of the certificates in the keystore could not be loaded

engineLoad

Added in API level 1

open fun engineLoad(param: KeyStore.LoadStoreParameter!): Unit

Loads the keystore using the given KeyStore.LoadStoreParameter.

Note that if this KeyStore has already been loaded, it is reinitialized and loaded again from the given parameter.

Parameters
param	KeyStore.LoadStoreParameter!: the KeyStore.LoadStoreParameter that specifies how to load the keystore, which may be null

Exceptions
java.lang.IllegalArgumentException	if the given KeyStore.LoadStoreParameter input is not recognized
java.io.IOException	if there is an I/O or format problem with the keystore data. If the error is due to an incorrect ProtectionParameter (e.g. wrong password) the cause of the IOException should be an UnrecoverableKeyException
java.security.NoSuchAlgorithmException	if the algorithm used to check the integrity of the keystore cannot be found
java.security.cert.CertificateException	if any of the certificates in the keystore could not be loaded

engineProbe

Added in API level 33

open fun engineProbe(stream: InputStream!): Boolean

Probes the specified input stream to determine whether it contains a keystore that is supported by this implementation, or not.

Parameters
stream	InputStream!: the keystore data to be probed

Return
Boolean	true if the keystore data is supported, otherwise false

Exceptions
java.io.IOException	if there is an I/O problem with the keystore data.
java.lang.NullPointerException	if stream is null.

engineSetCertificateEntry

Added in API level 1

abstract fun engineSetCertificateEntry(
    alias: String!, 
    cert: Certificate!
): Unit

Assigns the given certificate to the given alias.

If the given alias identifies an existing entry created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, the trusted certificate in the existing entry is overridden by the given certificate.

Parameters
alias	String!: the alias name
cert	Certificate!: the certificate

Exceptions
java.security.KeyStoreException	if the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason.

engineSetEntry

Added in API level 1

open fun engineSetEntry(
    alias: String!, 
    entry: KeyStore.Entry!, 
    protParam: KeyStore.ProtectionParameter!
): Unit

Saves a KeyStore.Entry under the specified alias. The specified protection parameter is used to protect the Entry.

If an entry already exists for the specified alias, it is overridden.

Parameters
alias	String!: save the KeyStore.Entry under this alias
entry	KeyStore.Entry!: the Entry to save
protParam	KeyStore.ProtectionParameter!: the ProtectionParameter used to protect the Entry, which may be null

Exceptions
java.security.KeyStoreException	if this operation fails

engineSetKeyEntry

Added in API level 1

abstract fun engineSetKeyEntry(
    alias: String!, 
    key: Key!, 
    password: CharArray!, 
    chain: Array<Certificate!>!
): Unit

Assigns the given key to the given alias, protecting it with the given password.

If the given key is of type java.security.PrivateKey, it must be accompanied by a certificate chain certifying the corresponding public key.

If the given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).

Parameters
alias	String!: the alias name
key	Key!: the key to be associated with the alias
password	CharArray!: the password to protect the key
chain	Array<Certificate!>!: the certificate chain for the corresponding public key (only required if the given key is of type java.security.PrivateKey).

Exceptions
java.security.KeyStoreException	if the given key cannot be protected, or this operation fails for some other reason

engineSetKeyEntry

Added in API level 1

abstract fun engineSetKeyEntry(
    alias: String!, 
    key: ByteArray!, 
    chain: Array<Certificate!>!
): Unit

Assigns the given key (that has already been protected) to the given alias.

If the protected key is of type java.security.PrivateKey, it must be accompanied by a certificate chain certifying the corresponding public key.

If the given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).

Parameters
alias	String!: the alias name
key	ByteArray!: the key (in protected format) to be associated with the alias
chain	Array<Certificate!>!: the certificate chain for the corresponding public key (only useful if the protected key is of type java.security.PrivateKey).

Exceptions
java.security.KeyStoreException	if this operation fails.

engineSize

Added in API level 1

abstract fun engineSize(): Int

Retrieves the number of entries in this keystore.

Return
Int	the number of entries in this keystore

engineStore

Added in API level 1

abstract fun engineStore(
    stream: OutputStream!, 
    password: CharArray!
): Unit

Stores this keystore to the given output stream, and protects its integrity with the given password.

Parameters
stream	OutputStream!: the output stream to which this keystore is written.
password	CharArray!: the password to generate the keystore integrity check

Exceptions
java.io.IOException	if there was an I/O problem with data
java.security.NoSuchAlgorithmException	if the appropriate data integrity algorithm could not be found
java.security.cert.CertificateException	if any of the certificates included in the keystore data could not be stored

engineStore

Added in API level 1

open fun engineStore(param: KeyStore.LoadStoreParameter!): Unit

Stores this keystore using the given KeyStore.LoadStoreParmeter.

Parameters
param	KeyStore.LoadStoreParameter!: the KeyStore.LoadStoreParmeter that specifies how to store the keystore, which may be null

Exceptions
java.lang.IllegalArgumentException	if the given KeyStore.LoadStoreParmeter input is not recognized
java.io.IOException	if there was an I/O problem with data
java.security.NoSuchAlgorithmException	if the appropriate data integrity algorithm could not be found
java.security.cert.CertificateException	if any of the certificates included in the keystore data could not be stored