KeyGenAlgorithmParaSpec.Builder

java.lang.Object
- ohos.security.keystore.KeyGenAlgorithmParaSpec.Builder

封闭类:

KeyGenAlgorithmParaSpec
```
public static class KeyGenAlgorithmParaSpec.Builder
extends Object
```
A static inner class of KeyGenAlgorithmParaSpec.
This class provides methods used to set key parameters and finally create a KeyGenAlgorithmParaSpec object.

从以下版本开始:

1

构造器概要

构造器
构造器说明

Builder(String secKeyAlias)
A constructor that uses the key alias to create a Builder object.

构造器
构造器	说明
`Builder(String secKeyAlias)`	A constructor that uses the key alias to create a `Builder` object.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`KeyGenAlgorithmParaSpec.Builder`	`addSecKeyCryptoAttr(int secKeyCryptoAttrType, String... attrs)`	Sets the values for the cryptographic attributes of a key, including the block cipher mode, padding mode, and digest algorithm.
`KeyGenAlgorithmParaSpec`	`createKeyGenAlgorithmParaSpec()`	Creates a `KeyGenAlgorithmParaSpec` object.
`KeyGenAlgorithmParaSpec.Builder`	`setKeyExpireTime(Date expireTime)`	Sets the expiry date for the key.
`KeyGenAlgorithmParaSpec.Builder`	`setKeyInitiateTime(Date initiateTime)`	Sets the start date for the key.
`KeyGenAlgorithmParaSpec.Builder`	`setPublicKeyExpireTime(Date expireTime)`	Sets the expiry date for the public key.
`KeyGenAlgorithmParaSpec.Builder`	`setSecKeyAccessibleAttr(int secKeyAccessibleAttr)`	Sets the accessibility attribute set for a key, depending on how the key is meant to be used.
`KeyGenAlgorithmParaSpec.Builder`	`setSecKeyAlgorithmParameterSpec(AlgorithmParameterSpec spec)`	Sets algorithm parameters during key generation.
`KeyGenAlgorithmParaSpec.Builder`	`setSecKeyAuthDuration(int secKeyAuthDuration)`	Sets the validity period of user authentication for a key.
`KeyGenAlgorithmParaSpec.Builder`	`setSecKeySizeInBits(int secKeySizeInBits)`	Sets the length of the generated key.
`KeyGenAlgorithmParaSpec.Builder`	`setSecKeyUsagePurposes(int secKeyUsagePurposes)`	Sets the purposes for using a key.
`KeyGenAlgorithmParaSpec.Builder`	`setSecretKeyExpireTime(Date expireTime)`	Sets the expiry date for the private key.
`KeyGenAlgorithmParaSpec.Builder`	`setSelfSignedCertAttrs(Date expireTime, Date initiateTime, BigInteger serialNumber, X500Principal subject)`	Sets the attributes for the self-signed certificate, including the start date, expiry date, serial number, and subject.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Builder
```
public Builder(String secKeyAlias)
```
    A constructor that uses the key alias to create a Builder object.
    
    参数:
    
    secKeyAlias - Indicates the key alias to set.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - addSecKeyCryptoAttr
```
public KeyGenAlgorithmParaSpec.Builder addSecKeyCryptoAttr(int secKeyCryptoAttrType,
                                                           String... attrs)
```
    Sets the values for the cryptographic attributes of a key, including the block cipher mode, padding mode, and digest algorithm.
    
    参数:
    
    secKeyCryptoAttrType - Indicates the cryptographic attribute type, which can be KeyStoreConstants#CRYPTO_PARAMETER_DIGEST, KeyStoreConstants#CRYPTO_PARAMETER_ENCRYPT_PADDING, KeyStoreConstants#CRYPTO_PARAMETER_BLOCK_MODE, or KeyStoreConstants#CRYPTO_PARAMETER_SIGNATURE_PADDING.
    
    attrs - Indicates the attribute set.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    1
  - setSecKeyAuthDuration
```
public KeyGenAlgorithmParaSpec.Builder setSecKeyAuthDuration(int secKeyAuthDuration)
```
    Sets the validity period of user authentication for a key.
    This method is valid only for keys that require user authentication to become accessible.
    
    参数:
    
    secKeyAuthDuration - Indicates the validity period of user authentication. By default, do not set it to -1.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    1
  - setSecKeySizeInBits
```
public KeyGenAlgorithmParaSpec.Builder setSecKeySizeInBits(int secKeySizeInBits)
```
    Sets the length of the generated key.
    The default key length will be used if secKeySizeInBits is not set.
    
    参数:
    
    secKeySizeInBits - Indicates the length of the generated key in bits. For example, the default length of an AES key is 128 bits.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    1
  - setSecKeyUsagePurposes
```
public KeyGenAlgorithmParaSpec.Builder setSecKeyUsagePurposes(int secKeyUsagePurposes)
```
    Sets the purposes for using a key.
    Examples include encryption, decryption, signing, and signature verification.
    
    参数:
    
    secKeyUsagePurposes - Indicates 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.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    1
  - setSecKeyAlgorithmParameterSpec
```
public KeyGenAlgorithmParaSpec.Builder setSecKeyAlgorithmParameterSpec(AlgorithmParameterSpec spec)
```
    Sets algorithm parameters during key generation.
    The algorithm parameters depend on the key type.
    
    参数:
    
    spec - Indicates the AlgorithmParameterSpec object, which can be RSAKeyGenParameterSpec or ECGenParameterSpec.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    1
  - setSecKeyAccessibleAttr
```
public KeyGenAlgorithmParaSpec.Builder setSecKeyAccessibleAttr(int secKeyAccessibleAttr)
```
    Sets the accessibility attribute set for a key, depending on how the key is meant to be used.
    
    参数:
    
    secKeyAccessibleAttr - Indicates the accessibility attribute set for 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 the Builder object.
    
    从以下版本开始:
    
    1
  - setSelfSignedCertAttrs
```
public KeyGenAlgorithmParaSpec.Builder setSelfSignedCertAttrs(Date expireTime,
                                                              Date initiateTime,
                                                              BigInteger serialNumber,
                                                              X500Principal subject)
```
    Sets the attributes for the self-signed certificate, including the start date, expiry date, serial number, and subject.
    
    参数:
    
    expireTime - Indicates the expiry date, after which the certificate will become invalid. The default date is Jan 1 2048.
    
    InitiateTime - Indicates the start date, before which the certificate is invalid. The default date is Jan 1 1970.
    
    serialNumber - Indicates the serial number of the certificate. The default serial number is 1.
    
    subject - Indicates the subject of the certificate. The default subject is CN=fake.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    6
  - setKeyExpireTime
```
public KeyGenAlgorithmParaSpec.Builder setKeyExpireTime(Date expireTime)
```
    Sets the expiry date for the key.
    
    参数:
    
    expireTime - Indicates the expiry date to set. After the expiry date, the key will become invalid.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    6
    
    另请参阅:
    
    setSecretKeyExpireTime(Date), setPublicKeyExpireTime(Date)
  - setSecretKeyExpireTime
```
public KeyGenAlgorithmParaSpec.Builder setSecretKeyExpireTime(Date expireTime)
```
    Sets the expiry date for the private key.
    
    参数:
    
    expireTime - Indicates the expiry date to set. After the expiry date, the private key cannot be used for encryption or signing.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    6
  - setPublicKeyExpireTime
```
public KeyGenAlgorithmParaSpec.Builder setPublicKeyExpireTime(Date expireTime)
```
    Sets the expiry date for the public key.
    
    参数:
    
    expireTime - Indicates the expiry date to set. After the expiry date, the public key cannot be used for decryption or signature verification.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    6
  - setKeyInitiateTime
```
public KeyGenAlgorithmParaSpec.Builder setKeyInitiateTime(Date initiateTime)
```
    Sets the start date for the key.
    
    参数:
    
    initiateTime - Indicates the start date to set. Before the start date, the key is invalid.
    
    返回:
    
    Returns the Builder object.
    
    从以下版本开始:
    
    6
  - createKeyGenAlgorithmParaSpec
```
public KeyGenAlgorithmParaSpec createKeyGenAlgorithmParaSpec()
```
    Creates a KeyGenAlgorithmParaSpec object.
    This method passes the parameters set in Builder to the constructor used to create a KeyGenAlgorithmParaSpec object.
    
    返回:
    
    Returns the KeyGenAlgorithmParaSpec object created.
    
    从以下版本开始:
    
    1

类 KeyGenAlgorithmParaSpec.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

addSecKeyCryptoAttr

setSecKeyAuthDuration

setSecKeySizeInBits

setSecKeyUsagePurposes

setSecKeyAlgorithmParameterSpec

setSecKeyAccessibleAttr

setSelfSignedCertAttrs

setKeyExpireTime

setSecretKeyExpireTime

setPublicKeyExpireTime

setKeyInitiateTime

createKeyGenAlgorithmParaSpec