MasterKey.Builder

Builder(context: Context)

Creates a builder for a MasterKey using the default alias of DEFAULT_MASTER_KEY_ALIAS.

Builder(context: Context, keyAlias: String)

Creates a builder for a MasterKey.

fun build(): MasterKey

Builds a MasterKey from this builder.

@RequiresApi(value = Build.VERSION_CODES.M)
fun setKeyGenParameterSpec(keyGenParameterSpec: KeyGenParameterSpec): MasterKey.Builder

Sets a custom KeyGenParameterSpec to use as the basis of the master key. NOTE: Either this method OR setKeyScheme should be used to set the parameters to use for building the master key. Calling either function after the other will throw an IllegalArgumentException.

fun setKeyScheme(keyScheme: MasterKey.KeyScheme): MasterKey.Builder

Sets a KeyScheme to be used for the master key.

This uses a default KeyGenParameterSpec associated with the provided KeyScheme.

NOTE: Either this method OR setKeyGenParameterSpec should be used to set the parameters to use for building the master key. Calling either function after the other will throw an IllegalArgumentException.

fun setRequestStrongBoxBacked(requestStrongBoxBacked: Boolean): MasterKey.Builder

Sets whether or not to request this key is strong box backed. This setting is only applicable on P and above, and only on devices that support Strongbox.

fun setUserAuthenticationRequired(authenticationRequired: Boolean): MasterKey.Builder

When used with setKeyScheme, sets that the built master key should require the user to authenticate before it's unlocked, probably using the androidx.biometric library.

This method sets the validity duration of the key to getDefaultAuthenticationValidityDurationSeconds.

fun setUserAuthenticationRequired(
    authenticationRequired: Boolean,
    userAuthenticationValidityDurationSeconds: @IntRange(from = 1) Int
): MasterKey.Builder

When used with setKeyScheme, sets that the built master key should require the user to authenticate before it's unlocked, probably using the androidx.biometric library, and that the key should remain unlocked for the provided duration.