com.google.crypto.tink.integration.android

Class AndroidKeystoreKmsClient

java.lang.Object

com.google.crypto.tink.integration.android.AndroidKeystoreKmsClient

All Implemented Interfaces:

KmsClient

public final class AndroidKeystoreKmsClient
extends Object
implements KmsClient

An implementation of KmsClient for Android Keystore.

This class requires Android M (API level 23) or newer.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX The prefix of all keys stored in Android Keystore.

Constructor Summary

Constructors

Constructor and Description
AndroidKeystoreKmsClient()
AndroidKeystoreKmsClient(String uri) Constructs an AndroidKeystoreKmsClient that is bound to a single key identified by uri.

Method Summary

Modifier and Type	Method and Description
boolean	doesSupport(String uri)
static void	generateNewAeadKey(String keyUri) Generates a new key in Android Keystore.
Aead	getAead(String uri) Gets an Aead backed by keyUri.
static Aead	getOrGenerateNewAeadKey(String keyUri) Generates a new key in Android Keystore, if it doesn't exist.
KmsClient	withCredentials(String unused) Initializes a KmsClient for Android Keystore.
KmsClient	withDefaultCredentials() Initializes a KmsClient for Android Keystore.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

The prefix of all keys stored in Android Keystore.

See Also:

Constant Field Values

Constructor Detail

AndroidKeystoreKmsClient

public AndroidKeystoreKmsClient()
                         throws GeneralSecurityException

Throws:

GeneralSecurityException

AndroidKeystoreKmsClient

public AndroidKeystoreKmsClient(String uri)

Constructs an AndroidKeystoreKmsClient that is bound to a single key identified by uri.

Method Detail

doesSupport

public boolean doesSupport(String uri)

Specified by:

doesSupport in interface KmsClient

Returns:

true either if keyUri is not null and equal to uri, or keyUri is null and uri starts with PREFIX.

withCredentials

public KmsClient withCredentials(String unused)
                          throws GeneralSecurityException

Initializes a KmsClient for Android Keystore.

Note that Android Keystore doesn't need credentials, thus the credential path is unused.

Specified by:

withCredentials in interface KmsClient

Throws:

GeneralSecurityException

withDefaultCredentials

public KmsClient withDefaultCredentials()
                                 throws GeneralSecurityException

Initializes a KmsClient for Android Keystore.

Note that Android Keystore does not use credentials.

Specified by:

withDefaultCredentials in interface KmsClient

Throws:

GeneralSecurityException

getAead

public Aead getAead(String uri)
             throws GeneralSecurityException

Description copied from interface: KmsClient

Gets an Aead backed by keyUri.

Specified by:

getAead in interface KmsClient

Throws:

GeneralSecurityException - if the URI is not supported or invalid

getOrGenerateNewAeadKey

public static Aead getOrGenerateNewAeadKey(String keyUri)
                                    throws GeneralSecurityException,
                                           IOException

Generates a new key in Android Keystore, if it doesn't exist.

At the moment it can generate only AES256-GCM keys.

Throws:

GeneralSecurityException

IOException

generateNewAeadKey

public static void generateNewAeadKey(String keyUri)
                               throws GeneralSecurityException

Generates a new key in Android Keystore.

At the moment it can generate only AES256-GCM keys.

Throws:

GeneralSecurityException