com.google.crypto.tink.integration.android

Class AndroidKeysetManager.Builder

java.lang.Object

com.google.crypto.tink.integration.android.AndroidKeysetManager.Builder

Enclosing class:

AndroidKeysetManager

public static final class AndroidKeysetManager.Builder
extends Object

A builder for AndroidKeysetManager.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AndroidKeysetManager	build() Builds and returns a new AndroidKeysetManager with the specified options.
AndroidKeysetManager.Builder	doNotUseKeystore() Deprecated. Please do not use this function. Instead, do not call {#code withMasterKeyUri} which has the same effect.
AndroidKeysetManager.Builder	withKeyTemplate(KeyTemplate val) If the keyset is not found or valid, generates a new one using val.
AndroidKeysetManager.Builder	withKeyTemplate(KeyTemplate val) If the keyset is not found or valid, generates a new one using val.
AndroidKeysetManager.Builder	withMasterKeyUri(String val) Sets the master key URI that references the key in Android Keystore with which the keyset gets encrypted.
AndroidKeysetManager.Builder	withSharedPref(android.content.Context context, String keysetName, String prefFileName) Reads and writes the keyset from shared preferences.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withSharedPref

@CanIgnoreReturnValue
public AndroidKeysetManager.Builder withSharedPref(android.content.Context context,
                                                                         String keysetName,
                                                                         String prefFileName)
                                                                  throws IOException

Reads and writes the keyset from shared preferences.

Throws:

IOException

withMasterKeyUri

@CanIgnoreReturnValue
public AndroidKeysetManager.Builder withMasterKeyUri(String val)

Sets the master key URI that references the key in Android Keystore with which the keyset gets encrypted.

Only master keys stored in Android Keystore is supported. The URI must start with android-keystore://.

Android Keystore is only supported on Android M (API level 23) and later. On older version, calling this method works but doesn't do anything.

withKeyTemplate

@CanIgnoreReturnValue
public AndroidKeysetManager.Builder withKeyTemplate(KeyTemplate val)

If the keyset is not found or valid, generates a new one using val.

withKeyTemplate

@CanIgnoreReturnValue
public AndroidKeysetManager.Builder withKeyTemplate(KeyTemplate val)

If the keyset is not found or valid, generates a new one using val.

doNotUseKeystore

@CanIgnoreReturnValue
 @Deprecated
public AndroidKeysetManager.Builder doNotUseKeystore()

Deprecated. Please do not use this function. Instead, do not call {#code withMasterKeyUri} which has the same effect.

Does not use Android Keystore which might not work well in some phones.

Warning: When Android Keystore is disabled, keys are stored in cleartext. This should be safe because they are stored in private preferences.

build

public AndroidKeysetManager build()
                           throws GeneralSecurityException,
                                  IOException

Builds and returns a new AndroidKeysetManager with the specified options.

Throws:

IOException - If a keyset is found but unusable.

KeystoreException - If a master key is found but unusable.

GeneralSecurityException - If cannot read an existing keyset or generate a new one.