MasterKey

Artifact: androidx.security:security-crypto

Kotlin |Java

class MasterKey

Wrapper for a master key used in the library.

On Android M (API 23) and above, this is class references a key that's stored in the Android Keystore. On Android L (API 21, 22), there isn't a master key.

Summary

Nested types
`class MasterKey.Builder` This class is deprecated. Use `javax.crypto.KeyGenerator` with AndroidKeyStore instance instead.
`enum MasterKey.KeyScheme` This enum is deprecated. Use `javax.crypto.KeyGenerator` with AndroidKeyStore instance instead.

Nested types

class MasterKey.Builder

This class is deprecated.

Use javax.crypto.KeyGenerator with AndroidKeyStore instance instead.

enum MasterKey.KeyScheme

This enum is deprecated.

Use javax.crypto.KeyGenerator with AndroidKeyStore instance instead.

Constants
`const Int`	`DEFAULT_AES_GCM_MASTER_KEY_SIZE = 256` This property is deprecated. Use `javax.crypto.KeyGenerator` with AndroidKeyStore instance instead.
`const String!`	`DEFAULT_MASTER_KEY_ALIAS = "_androidx_security_master_key_"` This property is deprecated. Use `javax.crypto.KeyGenerator` with AndroidKeyStore instance instead.

Constants

const Int

DEFAULT_AES_GCM_MASTER_KEY_SIZE = 256

This property is deprecated.

Use javax.crypto.KeyGenerator with AndroidKeyStore instance instead.

const String!

DEFAULT_MASTER_KEY_ALIAS = "_androidx_security_master_key_"

This property is deprecated.

Use javax.crypto.KeyGenerator with AndroidKeyStore instance instead.

Public functions
`java-static Int`	`getDefaultAuthenticationValidityDurationSeconds()` The default validity period for authentication in seconds.
`Int`	`getUserAuthenticationValidityDurationSeconds()` Gets the duration in seconds that the key is unlocked for following user authentication.
`Boolean`	`isKeyStoreBacked()` Checks if this key is backed by the Android Keystore.
`Boolean`	`isStrongBoxBacked()` Gets whether the key is backed by strong box.
`Boolean`	`isUserAuthenticationRequired()` Gets whether user authentication is required to use this key.
`String`	`toString()`

Constants

DEFAULT_AES_GCM_MASTER_KEY_SIZE

Added in 1.1.0-beta01

Deprecated in 1.1.0-beta01

const val DEFAULT_AES_GCM_MASTER_KEY_SIZE = 256: Int

The default and recommended size for the master key.

DEFAULT_MASTER_KEY_ALIAS

Added in 1.1.0-beta01

Deprecated in 1.1.0-beta01

const val DEFAULT_MASTER_KEY_ALIAS = "_androidx_security_master_key_": String!

The default master key alias.

Public functions

getDefaultAuthenticationValidityDurationSeconds

Added in 1.1.0-beta01

Deprecated in 1.1.0-beta01

java-static fun getDefaultAuthenticationValidityDurationSeconds(): Int

The default validity period for authentication in seconds.

getUserAuthenticationValidityDurationSeconds

Added in 1.1.0-beta01

Deprecated in 1.1.0-beta01

fun getUserAuthenticationValidityDurationSeconds(): Int

Gets the duration in seconds that the key is unlocked for following user authentication.

The value returned for this method is only meaningful on Android M+ (API 23) when isUserAuthenticationRequired returns true.

Returns
`Int`	The duration the key is unlocked for in seconds.

isKeyStoreBacked

Added in 1.1.0-beta01

Deprecated in 1.1.0-beta01

fun isKeyStoreBacked(): Boolean

Checks if this key is backed by the Android Keystore.

Returns
`Boolean`	`true` if the key is in Android Keystore, `false` otherwise. This method always returns false when called on Android Lollipop (API 21 and 22).

isStrongBoxBacked

Added in 1.1.0-beta01

Deprecated in 1.1.0-beta01

fun isStrongBoxBacked(): Boolean

Gets whether the key is backed by strong box.

isUserAuthenticationRequired

Added in 1.1.0-beta01

Deprecated in 1.1.0-beta01

fun isUserAuthenticationRequired(): Boolean

Gets whether user authentication is required to use this key.

This method always returns false on Android L (API 21 + 22).

toString

fun toString(): String