程序包 ohos.security.keystore

类 KeyStoreKeySpec

java.lang.Object

ohos.security.keystore.KeyStoreKeySpec

所有已实现的接口:

KeySpec

public class KeyStoreKeySpec
extends Object
implements KeySpec

Stores key specifications.

A key specification contains the key alias, source, purposes, length, validity period, and block cipher mode.

从以下版本开始:

1

SystemCapability

SystemCapability.Security#KEYSTORE_PROVIDER

方法概要

限定符和类型	方法	说明
String[]	getKeyCryptoAttr(int type)	Obtains the cryptographic attribute set of a key, depending on the input parameter.
String	getSecKeyAlias()	Obtains the alias of a key.
int	getSecKeyAuthDuration()	Obtains the validity period of user authentication for a key.
int	getSecKeySizeInBits()	Obtains the key length.
int	getSecKeySource()	Obtains the source of a key.
int	getSecKeyUsagePurposes()	Obtains the purposes for using a key.
boolean	isInMobileSecureProcessor()	Checks whether the key is stored in a secure mobile processor.
boolean	isKeyAccessible(int flag)	Checks the accessibility of a key based on the input parameter.
boolean	isUsedAfterAuthenticatedWithMobileSecureProcessor()	Checks whether the key can be used only after it is user-authenticated through a secure mobile processor.

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

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

方法详细资料

getSecKeyAlias

public String getSecKeyAlias()

Obtains the alias of a key.

This alias can be used to retrieve the key entry in the KeyStore.

返回:

Returns the key alias.

从以下版本开始:

1

getSecKeySource

public int getSecKeySource()

Obtains the source of a key.

The source of a key can be generated by the KeyStore, imported to the KeyStore from outside, or unknown.

返回:

Returns the source of the key, which can be KeyStoreConstants#SEC_KEY_SOURCE_GENERATED, KeyStoreConstants#SEC_KEY_SOURCE_IMPORTED, or unknown.

从以下版本开始:

1

getSecKeyUsagePurposes

public int getSecKeyUsagePurposes()

Obtains the purposes for using a key.

Examples include encryption, decryption, signing, and signature verification.

返回:

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

getSecKeySizeInBits

public int getSecKeySizeInBits()

Obtains the key length.

返回:

Returns the key length in bits; returns the default value (for example, 128 bits for an AES key) if the length is not specified when the key is generated.

从以下版本开始:

1

getKeyCryptoAttr

public String[] getKeyCryptoAttr(int type)

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

参数:

type - Indicates the cryptographic attribute of the key, 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 attributes of the key and their values.

从以下版本开始:

1

getSecKeyAuthDuration

public int getSecKeyAuthDuration()

Obtains the validity period of user authentication for 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 (in seconds) of user authentication; returns -1 if user authentication is required every time the key is used.

从以下版本开始:

1

isKeyAccessible

public boolean isKeyAccessible(int flag)

Checks the accessibility of a key 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

isInMobileSecureProcessor

public boolean isInMobileSecureProcessor()

Checks whether the key is stored in a secure mobile processor.

返回:

Returns true if the key is stored in a secure mobile processor; returns false otherwise.

从以下版本开始:

6

isUsedAfterAuthenticatedWithMobileSecureProcessor

public boolean isUsedAfterAuthenticatedWithMobileSecureProcessor()

Checks whether the key can be used only after it is user-authenticated through a secure mobile processor.

返回:

Returns true if the key can be used only after it is user-authenticated through a secure mobile processor; returns false otherwise.

从以下版本开始:

6