程序包 ohos.security.keystore

类 KeyGenAlgorithmParaSpec

java.lang.Object

ohos.security.keystore.KeyGenAlgorithmParaSpec

所有已实现的接口:

AlgorithmParameterSpec

public class KeyGenAlgorithmParaSpec
extends Object
implements AlgorithmParameterSpec

Sets algorithm parameters for key generation.

The following parameters can be set: key alias, length, usage(purposes), parameter set for key encryption, attribute set for key access control, and key accessibility period after user authentication.

从以下版本开始:

1

SystemCapability

SystemCapability.Security#KEYSTORE_PROVIDER

嵌套类概要

嵌套类

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

方法概要

限定符和类型	方法	说明
Date	getKeyInitiateTime()	Obtains the start date of the key.
Date	getPublicKeyExpireTime()	Obtains the expiry date of the public key.
AlgorithmParameterSpec	getSecKeyAlgorithmParameterSpec()	Obtains the algorithm parameter specification used for key generation.
String	getSecKeyAlias()	Obtains the key alias.
int	getSecKeyAuthDuration()	Obtains the validity period of user authentication for a key.
String[]	getSecKeyCryptoAttr(int type)	Obtains the cryptographic attribute set of a key.
int	getSecKeySizeInBits()	Obtains the key length.
int	getSecKeyUsagePurposes()	Obtains the purposes for using a key.
Date	getSecretKeyExpireTime()	Obtains the expiry date of the private key.
Date	getSelfSignedCertExpireTime()	Obtains the expiry date of the self-signed certificate.
Date	getSelfSignedCertInitiateTime()	Obtains the start date of the self-signed certificate.
BigInteger	getSelfSignedCertSerialNumber()	Obtains the serial number of the self-signed certificate.
X500Principal	getSelfSignedCertSubject()	Obtains the subject of the self-signed certificate.
boolean	isKeyAccessible(int flag)	Checks whether a key is accessible.

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

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

方法详细资料

getSecKeyAlgorithmParameterSpec

public AlgorithmParameterSpec getSecKeyAlgorithmParameterSpec()

Obtains the algorithm parameter specification used for key generation.

返回:

Returns AlgorithmParameterSpec, which is null by default.

从以下版本开始:

1

getSecKeySizeInBits

public int getSecKeySizeInBits()

Obtains the key length.

This method returns the default value if the key length is not specified during key generation.

返回:

Returns the key length in bits. For example, the default length of an AES key is 128 bits.

从以下版本开始:

1

getSecKeyAlias

public String getSecKeyAlias()

Obtains the key alias.

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

返回:

Returns the key alias.

从以下版本开始:

1

getSecKeyCryptoAttr

public String[] getSecKeyCryptoAttr(int type)

Obtains the cryptographic attribute set of a key.

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. The value ID 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

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

从以下版本开始:

1

getSecKeyUsagePurposes

public int getSecKeyUsagePurposes()

Obtains the purposes for using a key.

返回:

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

isKeyAccessible

public boolean isKeyAccessible(int flag)

Checks whether a key is accessible.

参数:

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

getSelfSignedCertExpireTime

public Date getSelfSignedCertExpireTime()

Obtains the expiry date of the self-signed certificate.

The default expiry date is Jan 1 2048.

返回:

Returns the expiry date of the self-signed certificate.

从以下版本开始:

6

getSelfSignedCertInitiateTime

public Date getSelfSignedCertInitiateTime()

Obtains the start date of the self-signed certificate.

The default start date is Jan 1 1970.

返回:

Returns the start date of the self-signed certificate.

从以下版本开始:

6

getSelfSignedCertSerialNumber

public BigInteger getSelfSignedCertSerialNumber()

Obtains the serial number of the self-signed certificate.

The default serial number is 1.

返回:

Returns the serial number of the self-signed certificate.

从以下版本开始:

6

getSelfSignedCertSubject

public X500Principal getSelfSignedCertSubject()

Obtains the subject of the self-signed certificate.

The default subject is CN=fake.

返回:

Returns the subject of the self-signed certificate.

从以下版本开始:

6

getSecretKeyExpireTime

public Date getSecretKeyExpireTime()

Obtains the expiry date of the private key.

After the expiry date, the private key cannot be used for encryption or signing.

返回:

Returns the expiry date of the private key.

从以下版本开始:

6

getPublicKeyExpireTime

public Date getPublicKeyExpireTime()

Obtains the expiry date of the public key.

After the expiry date, the public key cannot be used for decryption or signature verification.

返回:

Returns the expiry date of the public key.

从以下版本开始:

6

getKeyInitiateTime

public Date getKeyInitiateTime()

Obtains the start date of the key.

Before the start date, the key is invalid.

返回:

Returns the start date of the key.

从以下版本开始:

6