程序包 ohos.security.keystore

类 KeyStoreProtectionParameter

java.lang.Object

ohos.security.keystore.KeyStoreProtectionParameter

所有已实现的接口:

KeyStore.ProtectionParameter

public class KeyStoreProtectionParameter
extends Object
implements KeyStore.ProtectionParameter

Sets security protection parameters during key importing.

One example of such parameters is KeyStoreConstants#FLAG_KEY_ACCESSIBLE_NEEDED_USER_AUTH, a constant indicating whether a key becomes accessible only after user authentication.

从以下版本开始:

1

SystemCapability

SystemCapability.Security#KEYSTORE_PROVIDER

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	KeyStoreProtectionParameter.Builder	A static inner class of KeyGenAlgorithmParaSpec.

方法概要

限定符和类型	方法	说明
int	getSecKeyAuthDuration()	Obtains the validity period for user authentication with a key.
String[]	getSecKeyCryptoAttrs(int type)	Obtains the cryptographic attribute set of a key, depending on the input parameters.
int	getSecKeyUsagePurposes()	Obtains the purposes for using a key.
boolean	isKeyAccessible(int flag)	Checks whether a key is accessible based on the input parameter.

从类继承的方法 java.lang.Object

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

方法详细资料

getSecKeyUsagePurposes

public int getSecKeyUsagePurposes()

Obtains the purposes for using a key. For details, see the declaration in KeyStoreConstants.

返回:

Returns the purposes for using the key, which can be KeyStoreConstants#PURPOSE_CAN_ENCRYPT, KeyStoreConstants#PURPOSE_CAN_DECRYPT, KeyStoreConstants#PURPOSE_CAN_SIGN, or KeyStoreConstants#PURPOSE_CAN_VERIFY.

从以下版本开始:

1

getSecKeyCryptoAttrs

public String[] getSecKeyCryptoAttrs(int type)

Obtains the cryptographic attribute set of a key, depending on the input parameters.

A key-value set is used. The specific parameters depend on the value of type.

参数:

type - Indicates the attribute value ID, which can be KeyStoreConstants#CRYPTO_PARAMETER_DIGEST, KeyStoreConstants#CRYPTO_PARAMETER_ENCRYPT_PADDING, KeyStoreConstants#CRYPTO_PARAMETER_BLOCK_MODE, or KeyStoreConstants#CRYPTO_PARAMETER_SIGNATURE_PADDING.

返回:

Returns the cryptographic attribute set in a string array, for example, supported block cipher modes ECB, CBC, and GCM.

从以下版本开始:

1

isKeyAccessible

public boolean isKeyAccessible(int flag)

Checks whether a key is accessible based on the input parameter.

参数:

flag - Indicates the purposes for using the key, which can be KeyStoreConstants#FLAG_KEY_ACCESSIBLE_NEEDED_USER_AUTH, KeyStoreConstants#FLAG_KEY_ACCESSIBLE_NEED_DEVICE_UNLOCK, or KeyStoreConstants#FLAG_KEY_ACCESSIBLE_NEED_RANDOMIZED_ENCRYPTION.

返回:

Returns true if the key is accessible; returns false otherwise.

从以下版本开始:

1

getSecKeyAuthDuration

public int getSecKeyAuthDuration()

Obtains the validity period for user authentication with a key.

If a key requires user authentication (see KeyStoreConstants#FLAG_KEY_ACCESSIBLE_NEEDED_USER_AUTH), this method can be used to obtain the validity period of user authentication.

返回:

Returns the validity period for user authentication in seconds; returns -1 if user authentication is required every time the key is used.

从以下版本开始:

1