Added in API level 1

KeyStore

open class KeyStore

kotlin.Any
↳	java.security.KeyStore

This class represents a storage facility for cryptographic keys and certificates.

A KeyStore manages different types of entries. Each type of entry implements the KeyStore.Entry interface. Three basic KeyStore.Entry implementations are provided:

• KeyStore.PrivateKeyEntry

  This type of entry holds a cryptographic PrivateKey, which is optionally stored in a protected format to prevent unauthorized access. It is also accompanied by a certificate chain for the corresponding public key.

  Private keys and certificate chains are used by a given entity for self-authentication. Applications for this authentication include software distribution organizations which sign JAR files as part of releasing and/or licensing software.

• KeyStore.SecretKeyEntry

  This type of entry holds a cryptographic SecretKey, which is optionally stored in a protected format to prevent unauthorized access.

• KeyStore.TrustedCertificateEntry

  This type of entry contains a single public key Certificate belonging to another party. It is called a trusted certificate because the keystore owner trusts that the public key in the certificate indeed belongs to the identity identified by the subject (owner) of the certificate.

  This type of entry can be used to authenticate other parties.

Each entry in a keystore is identified by an "alias" string. In the case of private keys and their associated certificate chains, these strings distinguish among the different ways in which the entity may authenticate itself. For example, the entity may authenticate itself using different certificate authorities, or using different public key algorithms.

Whether aliases are case sensitive is implementation dependent. In order to avoid problems, it is recommended not to use aliases in a KeyStore that only differ in case.

Whether keystores are persistent, and the mechanisms used by the keystore if it is persistent, are not specified here. This allows use of a variety of techniques for protecting sensitive (e.g., private or secret) keys. Smart cards or other integrated cryptographic engines (SafeKeyper) are one option, and simpler mechanisms such as files may also be used (in a variety of formats).

Typical ways to request a KeyStore object include specifying an existing keystore file, relying on the default type and providing a specific keystore type.

• To specify an existing keystore file:

  // get keystore password
       char[] password = getPassword();
   
       // probe the keystore file and load the keystore entries
       KeyStore ks = KeyStore.getInstance(new File("keyStoreName"), password);
   

  The system will probe the specified file to determine its keystore type and return a keystore implementation with its entries already loaded. When this approach is used there is no need to call the keystore's load method.
• To rely on the default type:

  KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());
    

  The system will return a keystore implementation for the default type.
• To provide a specific keystore type:

  KeyStore ks = KeyStore.getInstance("JKS");
    

  The system will return the most preferred implementation of the specified keystore type available in the environment.

Before a keystore can be accessed, it must be loaded.

KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());
 
     // get user password and file input stream
     char[] password = getPassword();
 
     try (FileInputStream fis = new FileInputStream("keyStoreName")) {
         ks.load(fis, password);
     }
  

To create an empty keystore using the above load method, pass null as the InputStream argument.

Once the keystore has been loaded, it is possible to read existing entries from the keystore, or to write new entries into the keystore:

KeyStore.ProtectionParameter protParam =
         new KeyStore.PasswordProtection(password);
 
     // get my private key
     KeyStore.PrivateKeyEntry pkEntry = (KeyStore.PrivateKeyEntry)
         ks.getEntry("privateKeyAlias", protParam);
     PrivateKey myPrivateKey = pkEntry.getPrivateKey();
 
     // save my secret key
     javax.crypto.SecretKey mySecretKey;
     KeyStore.SecretKeyEntry skEntry =
         new KeyStore.SecretKeyEntry(mySecretKey);
     ks.setEntry("secretKeyAlias", skEntry, protParam);
 
     // store away the keystore
     try (FileOutputStream fos = new FileOutputStream("newKeyStoreName")) {
         ks.store(fos, password);
     }
  

Note that although the same password may be used to load the keystore, to protect the private key entry, to protect the secret key entry, and to store the keystore (as is shown in the sample code above), different passwords or other protection parameters may also be used.

Android provides the following KeyStore types:

Algorithm	Supported API Levels
AndroidCAStore	14+
AndroidKeyStore	18+
BCPKCS12	1-8
BKS	1+
BouncyCastle	1+
PKCS12	1+
PKCS12-DEF	1-8

These types are described in the KeyStore section of the Java Cryptography Architecture Standard Algorithm Name Documentation.

Summary

Nested classes
abstract	Builder A description of a to-be-instantiated KeyStore object.
open	CallbackHandlerProtection A ProtectionParameter encapsulating a CallbackHandler.
abstract	Entry A marker interface for KeyStore entry types.
abstract	LoadStoreParameter A marker interface for KeyStore load and store parameters.
open	PasswordProtection A password-based implementation of ProtectionParameter.
	PrivateKeyEntry A KeyStore entry that holds a PrivateKey and corresponding certificate chain.
abstract	ProtectionParameter A marker interface for keystore protection parameters.
	SecretKeyEntry A KeyStore entry that holds a SecretKey.
	TrustedCertificateEntry A KeyStore entry that holds a trusted Certificate.

Protected constructors
KeyStore(keyStoreSpi: KeyStoreSpi!, provider: Provider!, type: String!) Creates a KeyStore object of the given type, and encapsulates the given provider implementation (SPI object) in it.

Public methods
Enumeration<String!>!	aliases() Lists all the alias names of this keystore.
Boolean	containsAlias(alias: String!) Checks if the given alias exists in this keystore.
Unit	deleteEntry(alias: String!) Deletes the entry identified by the given alias from this keystore.
Boolean	entryInstanceOf(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.
Certificate!	getCertificate(alias: String!) Returns the certificate associated with the given alias.
String!	getCertificateAlias(cert: Certificate!) Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.
Array<Certificate!>!	getCertificateChain(alias: String!) Returns the certificate chain associated with the given alias.
Date!	getCreationDate(alias: String!) Returns the creation date of the entry identified by the given alias.
static String!	getDefaultType() Returns the default keystore type as specified by the keystore.type security property, or the string "jks" (acronym for "Java keystore") if no such property exists.
KeyStore.Entry!	getEntry(alias: String!, protParam: KeyStore.ProtectionParameter!) Gets a keystore Entry for the specified alias with the specified protection parameter.
static KeyStore!	getInstance(file: File!, password: CharArray!) Returns a loaded keystore object of the appropriate keystore type.
static KeyStore!	getInstance(file: File!, param: KeyStore.LoadStoreParameter!) Returns a loaded keystore object of the appropriate keystore type.
open static KeyStore!	getInstance(type: String!) Returns a keystore object of the specified type.
open static KeyStore!	getInstance(type: String!, provider: String!) Returns a keystore object of the specified type.
open static KeyStore!	getInstance(type: String!, provider: Provider!) Returns a keystore object of the specified type.
Key!	getKey(alias: String!, password: CharArray!) Returns the key associated with the given alias, using the given password to recover it.
Provider!	getProvider() Returns the provider of this keystore.
String!	getType() Returns the type of this keystore.
Boolean	isCertificateEntry(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.
Boolean	isKeyEntry(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.
Unit	load(stream: InputStream!, password: CharArray!) Loads this KeyStore from the given input stream.
Unit	load(param: KeyStore.LoadStoreParameter!) Loads this keystore using the given LoadStoreParameter.
Unit	setCertificateEntry(alias: String!, cert: Certificate!) Assigns the given trusted certificate to the given alias.
Unit	setEntry(alias: String!, entry: KeyStore.Entry!, protParam: KeyStore.ProtectionParameter!) Saves a keystore Entry under the specified alias.
Unit	setKeyEntry(alias: String!, key: ByteArray!, chain: Array<Certificate!>!) Assigns the given key (that has already been protected) to the given alias.
Unit	setKeyEntry(alias: String!, key: Key!, password: CharArray!, chain: Array<Certificate!>!) Assigns the given key to the given alias, protecting it with the given password.
Int	size() Retrieves the number of entries in this keystore.
Unit	store(stream: OutputStream!, password: CharArray!) Stores this keystore to the given output stream, and protects its integrity with the given password.
Unit	store(param: KeyStore.LoadStoreParameter!) Stores this keystore using the given LoadStoreParameter.

Protected constructors

KeyStore

Added in API level 1

protected KeyStore(
    keyStoreSpi: KeyStoreSpi!, 
    provider: Provider!, 
    type: String!)

Creates a KeyStore object of the given type, and encapsulates the given provider implementation (SPI object) in it.

Parameters
keyStoreSpi	KeyStoreSpi!: the provider implementation.
provider	Provider!: the provider.
type	String!: the keystore type.

Public methods

aliases

Added in API level 1

fun aliases(): Enumeration<String!>!

Lists all the alias names of this keystore.

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

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

containsAlias

Added in API level 1

fun containsAlias(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

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

deleteEntry

Added in API level 1

fun deleteEntry(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 keystore has not been initialized, or if the entry cannot be removed.

entryInstanceOf

Added in API level 1

fun entryInstanceOf(
    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

Exceptions
java.lang.NullPointerException	if alias or entryClass is null
java.security.KeyStoreException	if the keystore has not been initialized (loaded)

getCertificate

Added in API level 1

fun getCertificate(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 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.

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

getCertificateAlias

Added in API level 1

fun getCertificateAlias(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 a matching certificate, or null if no such entry exists in this keystore.

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

getCertificateChain

Added in API level 1

fun getCertificateChain(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 followed by zero or more certificate authorities), or null if the given alias does not exist or does not contain a certificate chain

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

getCreationDate

Added in API level 1

fun getCreationDate(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

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

getDefaultType

Added in API level 1

static fun getDefaultType(): String!

Returns the default keystore type as specified by the keystore.type security property, or the string "jks" (acronym for "Java keystore") if no such property exists.

The default keystore type can be used by applications that do not want to use a hard-coded keystore type when calling one of the getInstance methods, and want to provide a default keystore type in case a user does not specify its own.

The default keystore type can be changed by setting the value of the keystore.type security property to the desired keystore type.

Return
String!	the default keystore type as specified by the keystore.type security property, or the string "jks" if no such property exists.

See Also

• java.security.Security

getEntry

Added in API level 1

fun getEntry(
    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.lang.NullPointerException	if alias is null
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)
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

See Also

• #setEntry(String, KeyStore.Entry, KeyStore.ProtectionParameter)

getInstance

Added in API level 33

static fun getInstance(
    file: File!, 
    password: CharArray!
): KeyStore!

Returns a loaded keystore object of the appropriate keystore type. First the keystore type is determined by probing the specified file. Then a keystore object is instantiated and loaded using the data from that file.

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.

This method traverses the list of registered security providers, starting with the most preferred Provider. For each KeyStoreSpi implementation supported by a Provider, it invokes the engineProbe method to determine if it supports the specified keystore. A new KeyStore object is returned that encapsulates the KeyStoreSpi implementation from the first Provider that supports the specified file.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters
file	File!: the keystore file
password	CharArray!: the keystore password, which may be null

Return
KeyStore!	a keystore object loaded with keystore data

Exceptions
java.security.KeyStoreException	if no Provider supports a KeyStoreSpi implementation for the specified keystore file.
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.
java.lang.IllegalArgumentException	if file does not exist or does not refer to a normal file.
java.lang.NullPointerException	if file is null.
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkRead method denies read access to the specified file.

See Also

• java.security.Provider

getInstance

Added in API level 33

static fun getInstance(
    file: File!, 
    param: KeyStore.LoadStoreParameter!
): KeyStore!

Returns a loaded keystore object of the appropriate keystore type. First the keystore type is determined by probing the specified file. Then a keystore object is instantiated and loaded using the data from that file. A LoadStoreParameter may be supplied which specifies how to unlock the keystore data or perform an integrity check.

This method traverses the list of registered security providers, starting with the most preferred Provider. For each KeyStoreSpi implementation supported by a Provider, it invokes the engineProbe method to determine if it supports the specified keystore. A new KeyStore object is returned that encapsulates the KeyStoreSpi implementation from the first Provider that supports the specified file.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

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

Return
KeyStore!	a keystore object loaded with keystore data

Exceptions
java.security.KeyStoreException	if no Provider supports a KeyStoreSpi implementation for the specified keystore file.
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.
java.lang.IllegalArgumentException	if file does not exist or does not refer to a normal file, or if param is not recognized.
java.lang.NullPointerException	if file is null.
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkRead method denies read access to the specified file.

See Also

• java.security.Provider

getInstance

Added in API level 1

open static fun getInstance(type: String!): KeyStore!

Returns a keystore object of the specified type.

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyStore object encapsulating the KeyStoreSpi implementation from the first Provider that supports the specified type is returned.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

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

Return
KeyStore!	a keystore object of the specified type

Exceptions
java.security.KeyStoreException	if no Provider supports a KeyStoreSpi implementation for the specified type.

See Also

• java.security.Provider

getInstance

Added in API level 1

open static fun getInstance(
    type: String!, 
    provider: String!
): KeyStore!

Returns a keystore object of the specified type.

A new KeyStore object encapsulating the KeyStoreSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

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

Return
KeyStore!	a keystore object of the specified type

Exceptions
java.security.KeyStoreException	if a KeyStoreSpi implementation for the specified type is not available from the specified provider.
java.security.NoSuchProviderException	if the specified provider is not registered in the security provider list.
java.lang.IllegalArgumentException	if the provider name is null or empty.

See Also

• java.security.Provider

getInstance

Added in API level 1

open static fun getInstance(
    type: String!, 
    provider: Provider!
): KeyStore!

Returns a keystore object of the specified type.

A new KeyStore object encapsulating the KeyStoreSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.

Parameters
type	String!: the type of keystore. See the KeyStore section in the Java Security Standard Algorithm Names Specification for information about standard keystore types.
provider	Provider!: the provider.

Return
KeyStore!	a keystore object of the specified type

Exceptions
java.lang.IllegalArgumentException	if the specified provider is null
java.security.KeyStoreException	if KeyStoreSpi implementation for the specified type is not available from the specified Provider object
java.lang.NullPointerException	if type is null

See Also

• java.security.Provider

getKey

Added in API level 1

fun getKey(
    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.KeyStoreException	if the keystore has not been initialized (loaded).
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).

getProvider

Added in API level 1

fun getProvider(): Provider!

Returns the provider of this keystore.

Return
Provider!	the provider of this keystore.

getType

Added in API level 1

fun getType(): String!

Returns the type of this keystore.

Return
String!	the type of this keystore.

isCertificateEntry

Added in API level 1

fun isCertificateEntry(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.

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

isKeyEntry

Added in API level 1

fun isKeyEntry(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 entry, false otherwise.

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

load

Added in API level 1

fun load(
    stream: InputStream!, 
    password: CharArray!
): Unit

Loads this 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.

In order to create an empty keystore, or if the keystore cannot be initialized from a stream, pass null as the stream argument.

Note that if this keystore has already been loaded, it is reinitialized and loaded again from the given input stream.

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

load

Added in API level 1

fun load(param: KeyStore.LoadStoreParameter!): Unit

Loads this keystore using the given 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 LoadStoreParameter that specifies how to load the keystore, which may be null

Exceptions
java.lang.IllegalArgumentException	if the given 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

setCertificateEntry

Added in API level 1

fun setCertificateEntry(
    alias: String!, 
    cert: Certificate!
): Unit

Assigns the given trusted 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 keystore has not been initialized, or the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason.

setEntry

Added in API level 1

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

Saves a keystore Entry under the specified alias. The 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.lang.NullPointerException	if alias or entry is null
java.security.KeyStoreException	if the keystore has not been initialized (loaded), or if this operation fails for some other reason

See Also

• #getEntry(String, KeyStore.ProtectionParameter)

setKeyEntry

Added in API level 1

fun setKeyEntry(
    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 underlying keystore implementation is of type jks, key must be encoded as an EncryptedPrivateKeyInfo as defined in the PKCS #8 standard.

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 the keystore has not been initialized (loaded), or if this operation fails for some other reason.

setKeyEntry

Added in API level 1

fun setKeyEntry(
    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 keystore has not been initialized (loaded), the given key cannot be protected, or this operation fails for some other reason

size

Added in API level 1

fun size(): Int

Retrieves the number of entries in this keystore.

Return
Int	the number of entries in this keystore

Exceptions
java.security.KeyStoreException	if the keystore has not been initialized (loaded).

store

Added in API level 1

fun store(
    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.security.KeyStoreException	if the keystore has not been initialized (loaded).
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

store

Added in API level 1

fun store(param: KeyStore.LoadStoreParameter!): Unit

Stores this keystore using the given LoadStoreParameter.

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

Exceptions
java.lang.IllegalArgumentException	if the given LoadStoreParameter input is not recognized
java.security.KeyStoreException	if the keystore has not been initialized (loaded)
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