MasterKey.Builder

public Builder(@NonNull Context context)

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

public Builder(@NonNull Context context, @NonNull String keyAlias)

Creates a builder for a MasterKey.

public @NonNull MasterKey build()

Builds a MasterKey from this builder.

@RequiresApi(value = Build.VERSION_CODES.M)
public @NonNull MasterKey.Builder setKeyGenParameterSpec(@NonNull KeyGenParameterSpec keyGenParameterSpec)

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.

public @NonNull MasterKey.Builder setKeyScheme(@NonNull MasterKey.KeyScheme keyScheme)

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.

public @NonNull MasterKey.Builder setRequestStrongBoxBacked(boolean requestStrongBoxBacked)

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.

public @NonNull MasterKey.Builder setUserAuthenticationRequired(boolean authenticationRequired)

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.

public @NonNull MasterKey.Builder setUserAuthenticationRequired(
    boolean authenticationRequired,
    @IntRange(from = 1) int userAuthenticationValidityDurationSeconds
)

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.