Android APIs
public abstract class

KeyProperties

extends Object
java.lang.Object
   ↳ android.security.keystore.KeyProperties

Class Overview

Properties of Android Keystore keys.

Summary

Constants
String BLOCK_MODE_CBC Cipher Block Chaining (CBC) block mode.
String BLOCK_MODE_CTR Counter (CTR) block mode.
String BLOCK_MODE_ECB Electronic Codebook (ECB) block mode.
String BLOCK_MODE_GCM Galois/Counter Mode (GCM) block mode.
String DIGEST_MD5 MD5 digest.
String DIGEST_NONE No digest: sign/authenticate the raw message.
String DIGEST_SHA1 SHA-1 digest.
String DIGEST_SHA224 SHA-2 224 (aka SHA-224) digest.
String DIGEST_SHA256 SHA-2 256 (aka SHA-256) digest.
String DIGEST_SHA384 SHA-2 384 (aka SHA-384) digest.
String DIGEST_SHA512 SHA-2 512 (aka SHA-512) digest.
String ENCRYPTION_PADDING_NONE No encryption padding.
String ENCRYPTION_PADDING_PKCS7 PKCS#7 encryption padding scheme.
String ENCRYPTION_PADDING_RSA_OAEP RSA Optimal Asymmetric Encryption Padding (OAEP) scheme.
String ENCRYPTION_PADDING_RSA_PKCS1 RSA PKCS#1 v1.5 padding scheme for encryption.
String KEY_ALGORITHM_AES Advanced Encryption Standard (AES) key.
String KEY_ALGORITHM_EC Elliptic Curve (EC) Cryptography key.
String KEY_ALGORITHM_HMAC_SHA1 Keyed-Hash Message Authentication Code (HMAC) key using SHA-1 as the hash.
String KEY_ALGORITHM_HMAC_SHA224 Keyed-Hash Message Authentication Code (HMAC) key using SHA-224 as the hash.
String KEY_ALGORITHM_HMAC_SHA256 Keyed-Hash Message Authentication Code (HMAC) key using SHA-256 as the hash.
String KEY_ALGORITHM_HMAC_SHA384 Keyed-Hash Message Authentication Code (HMAC) key using SHA-384 as the hash.
String KEY_ALGORITHM_HMAC_SHA512 Keyed-Hash Message Authentication Code (HMAC) key using SHA-512 as the hash.
String KEY_ALGORITHM_RSA Rivest Shamir Adleman (RSA) key.
int ORIGIN_GENERATED Key was generated inside AndroidKeyStore.
int ORIGIN_IMPORTED Key was imported into AndroidKeyStore.
int ORIGIN_UNKNOWN Origin of the key is unknown.
int PURPOSE_DECRYPT Purpose of key: decryption.
int PURPOSE_ENCRYPT Purpose of key: encryption.
int PURPOSE_SIGN Purpose of key: signing or generating a Message Authentication Code (MAC).
int PURPOSE_VERIFY Purpose of key: signature or Message Authentication Code (MAC) verification.
String SIGNATURE_PADDING_RSA_PKCS1 RSA PKCS#1 v1.5 padding for signatures.
String SIGNATURE_PADDING_RSA_PSS RSA PKCS#1 v2.1 Probabilistic Signature Scheme (PSS) padding.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String BLOCK_MODE_CBC

Added in API level 23

Cipher Block Chaining (CBC) block mode.

Constant Value: "CBC"

public static final String BLOCK_MODE_CTR

Added in API level 23

Counter (CTR) block mode.

Constant Value: "CTR"

public static final String BLOCK_MODE_ECB

Added in API level 23

Electronic Codebook (ECB) block mode.

Constant Value: "ECB"

public static final String BLOCK_MODE_GCM

Added in API level 23

Galois/Counter Mode (GCM) block mode.

Constant Value: "GCM"

public static final String DIGEST_MD5

Added in API level 23

MD5 digest.

Constant Value: "MD5"

public static final String DIGEST_NONE

Added in API level 23

No digest: sign/authenticate the raw message.

Constant Value: "NONE"

public static final String DIGEST_SHA1

Added in API level 23

SHA-1 digest.

Constant Value: "SHA-1"

public static final String DIGEST_SHA224

Added in API level 23

SHA-2 224 (aka SHA-224) digest.

Constant Value: "SHA-224"

public static final String DIGEST_SHA256

Added in API level 23

SHA-2 256 (aka SHA-256) digest.

Constant Value: "SHA-256"

public static final String DIGEST_SHA384

Added in API level 23

SHA-2 384 (aka SHA-384) digest.

Constant Value: "SHA-384"

public static final String DIGEST_SHA512

Added in API level 23

SHA-2 512 (aka SHA-512) digest.

Constant Value: "SHA-512"

public static final String ENCRYPTION_PADDING_NONE

Added in API level 23

No encryption padding.

Constant Value: "NoPadding"

public static final String ENCRYPTION_PADDING_PKCS7

Added in API level 23

PKCS#7 encryption padding scheme.

Constant Value: "PKCS7Padding"

public static final String ENCRYPTION_PADDING_RSA_OAEP

Added in API level 23

RSA Optimal Asymmetric Encryption Padding (OAEP) scheme.

Constant Value: "OAEPPadding"

public static final String ENCRYPTION_PADDING_RSA_PKCS1

Added in API level 23

RSA PKCS#1 v1.5 padding scheme for encryption.

Constant Value: "PKCS1Padding"

public static final String KEY_ALGORITHM_AES

Added in API level 23

Advanced Encryption Standard (AES) key.

Constant Value: "AES"

public static final String KEY_ALGORITHM_EC

Added in API level 23

Elliptic Curve (EC) Cryptography key.

Constant Value: "EC"

public static final String KEY_ALGORITHM_HMAC_SHA1

Added in API level 23

Keyed-Hash Message Authentication Code (HMAC) key using SHA-1 as the hash.

Constant Value: "HmacSHA1"

public static final String KEY_ALGORITHM_HMAC_SHA224

Added in API level 23

Keyed-Hash Message Authentication Code (HMAC) key using SHA-224 as the hash.

Constant Value: "HmacSHA224"

public static final String KEY_ALGORITHM_HMAC_SHA256

Added in API level 23

Keyed-Hash Message Authentication Code (HMAC) key using SHA-256 as the hash.

Constant Value: "HmacSHA256"

public static final String KEY_ALGORITHM_HMAC_SHA384

Added in API level 23

Keyed-Hash Message Authentication Code (HMAC) key using SHA-384 as the hash.

Constant Value: "HmacSHA384"

public static final String KEY_ALGORITHM_HMAC_SHA512

Added in API level 23

Keyed-Hash Message Authentication Code (HMAC) key using SHA-512 as the hash.

Constant Value: "HmacSHA512"

public static final String KEY_ALGORITHM_RSA

Added in API level 23

Rivest Shamir Adleman (RSA) key.

Constant Value: "RSA"

public static final int ORIGIN_GENERATED

Added in API level 23

Key was generated inside AndroidKeyStore.

Constant Value: 1 (0x00000001)

public static final int ORIGIN_IMPORTED

Added in API level 23

Key was imported into AndroidKeyStore.

Constant Value: 2 (0x00000002)

public static final int ORIGIN_UNKNOWN

Added in API level 23

Origin of the key is unknown. This can occur only for keys backed by an old TEE-backed implementation which does not record origin information.

Constant Value: 4 (0x00000004)

public static final int PURPOSE_DECRYPT

Added in API level 23

Purpose of key: decryption.

Constant Value: 2 (0x00000002)

public static final int PURPOSE_ENCRYPT

Added in API level 23

Purpose of key: encryption.

Constant Value: 1 (0x00000001)

public static final int PURPOSE_SIGN

Added in API level 23

Purpose of key: signing or generating a Message Authentication Code (MAC).

Constant Value: 4 (0x00000004)

public static final int PURPOSE_VERIFY

Added in API level 23

Purpose of key: signature or Message Authentication Code (MAC) verification.

Constant Value: 8 (0x00000008)

public static final String SIGNATURE_PADDING_RSA_PKCS1

Added in API level 23

RSA PKCS#1 v1.5 padding for signatures.

Constant Value: "PKCS1"

public static final String SIGNATURE_PADDING_RSA_PSS

Added in API level 23

RSA PKCS#1 v2.1 Probabilistic Signature Scheme (PSS) padding.

Constant Value: "PSS"