Package com.couchbase.lite

Class KeyStoreUtils

java.lang.Object

com.couchbase.lite.KeyStoreUtils

@Volatile
public final class KeyStoreUtils
extends Object

Key Store Utilities

Field Summary

Fields

Modifier and Type	Field	Description
static String	ANDROID_KEY_STORE

Method Summary

Modifier and Type	Method	Description
static void	importEntry(String storeType, InputStream storeStream, char[] storePassword, String extAlias, char[] extKeyPass, String newAlias)	Imports the key entry including public key, private key, and certificates from the given KeyStore input stream into the Android KeyStore.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANDROID_KEY_STORE

public static final String ANDROID_KEY_STORE

See Also:

Constant Field Values

Method Detail

importEntry

public static void importEntry(@NonNull
                               String storeType,
                               @NonNull
                               InputStream storeStream,
                               @Nullable
                               char[] storePassword,
                               @NonNull
                               String extAlias,
                               @Nullable
                               char[] extKeyPass,
                               @NonNull
                               String newAlias)
                        throws KeyStoreException,
                               CertificateException,
                               NoSuchAlgorithmException,
                               IOException,
                               UnrecoverableEntryException

Imports the key entry including public key, private key, and certificates from the given KeyStore input stream into the Android KeyStore. The imported key entry can be used as a TLSIdentity by calling TLSIdentity.get(String alias) method.

NOTE: The key data including the private key data will be in memory, temporarily, during the import operation! Android 9 (API 28) or higher has an alternative method that will import keys more securely. Check the documentation here: for more info.

Parameters:

storeType - KeyStore type, eg: "PKCS12"

storeStream - An InputStream from the keystore

storePassword - The keystore password

extAlias - The alias, in the external keystore, of the entry to be imported.

extKeyPass - The key password

newAlias - The alias for the imported key

Throws:

KeyStoreException - on failure to create keystore

CertificateException - on failure to load keystore

NoSuchAlgorithmException - on failure to load keystore

IOException - on failure to load keystore

UnrecoverableEntryException - on failure to load keystore entry