harmony 鸿蒙@ohos.security.cryptoFramework (Crypto Framework)
@ohos.security.cryptoFramework (Crypto Framework)
The cryptoFramework module shields underlying hardware and algorithm libraries and provides unified APIs for cryptographic operations.
NOTE
- The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
- The following code snippets apply only to JavaScript development.
Modules to Import
import cryptoFramework from "@ohos.security.cryptoFramework";
Result
Enumerates the operation results.
System capability: SystemCapability.Security.CryptoFramework
Name | Value | Description |
---|---|---|
INVALID_PARAMS | 401 | Invalid parameter. |
NOT_SUPPORT | 801 | Unsupported operation. |
ERR_OUT_OF_MEMORY | 17620001 | Memory error. |
ERR_RUNTIME_ERROR | 17620002 | Runtime error. |
ERR_CRYPTO_OPERATION | 17630001 | Failed to invoke the third-party cryptographic API. |
DataBlob
Defines a binary data array.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
data | Uint8Array | Yes | Yes | Binary data array. |
ParamsSpec
Defines the parameters used for encryption and decryption.
For the symmetric encryption and decryption modes that require parameters such as the initialization vector (IV), you need to construct a child class object and pass it to init(). If the IV is not required (for example, the ECB mode), pass in null in init().
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | Yes | Symmetric encryption and decryption parameters. Options: - IvParamsSpec: applicable to the CBC, CTR, OFB, and CFB modes. - GcmParamsSpec: applicable to the GCM mode. - CcmParamsSpec: applicable to the CCM mode. |
NOTE
The params parameter in init() is of the ParamsSpec type (parent class). However, a specific child class object (such as IvParamsSpec) needs to be passed in. When constructing the child class object, you need to set algName for the parent class ParamsSpec to specify the child class object in init().
IvParamsSpec
Defines the child class of ParamsSpec. It is used as the parameters of init() during symmetric encryption and decryption.
IvParamsSpec applies to the encryption and decryption modes such as CBC, CTR, OFB, and CFB, which use only the IV.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
iv | DataBlob | Yes | Yes | IV for encryption and decryption. Options: - AES CBC, CTR, OFB, or CFB mode: 16-byte IV - 3DES CBC, OFB, or CFB mode: 8-byte IV - SM410+CBC, CTR, OFB, or CFB mode: 16-byte IV |
NOTE
Before passing init(), specify algName for its parent class ParamsSpec.
GcmParamsSpec
Defines the child class of ParamsSpec. It is used as the parameters of init() during symmetric encryption and decryption.
GcmParamsSpec applies to the GCM mode.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
iv | DataBlob | Yes | Yes | IV, which is of 1 to 16 bytes. A 12-byte IV is commonly used. |
aad | DataBlob | Yes | Yes | Additional authentication data (AAD), which is of 0 to INT_MAX bytes. A 16-byte AAD is commonly used. |
authTag | DataBlob | Yes | Yes | Authentication tag, which is of 16 bytes. When the GCM mode is used for encryption, the last 16 bytes of the DataBlob output by doFinal() are used as the authTag in GcmParamsSpec of init(). |
NOTE
- Before passing init(), specify algName for its parent class ParamsSpec.
- The Crypto framework has no requirements on the length of the IV. However, the operation result depends on whether the underlying OpenSSL supports the IV.
- If aad is not required or the length of aad is 0, you can set the data attribute of aad to an empty Uint8Array, that is, aad: { data: new Uint8Array() }.
CcmParamsSpec
Defines the child class of ParamsSpec. It is used as the parameters of init() during symmetric encryption and decryption.
CcmParamsSpec applies to the CCM mode.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
iv | DataBlob | Yes | Yes | IV, which is of 7 bytes. |
aad | DataBlob | Yes | Yes | AAD, which is of 8 bytes. |
authTag | DataBlob | Yes | Yes | Authentication tag, which is of 12 bytes. When the CCM mode is used for encryption, the last 12 bytes of the DataBlob output by doFinal() are used as the authTag in CcmParamsSpec of init(). |
NOTE
Before passing init(), specify algName for its parent class ParamsSpec.
CryptoMode
Enumerates the cryptographic operations.
System capability: SystemCapability.Security.CryptoFramework
Name | Value | Description |
---|---|---|
ENCRYPT_MODE | 0 | Encryption. |
DECRYPT_MODE | 1 | Decryption. |
AsyKeySpecItem10+
Enumerates the key parameters.
System capability: SystemCapability.Security.CryptoFramework
Name | Value | Description |
---|---|---|
DSA_P_BN | 101 | Prime modulus p in the DSA algorithm. |
DSA_Q_BN | 102 | Parameter q (prime factor of p – 1) in the DSA algorithm. |
DSA_G_BN | 103 | Parameter g in the DSA algorithm. |
DSA_SK_BN | 104 | Private key sk in the DSA algorithm. |
DSA_PK_BN | 105 | Public key pk in the DSA algorithm. |
ECC_FP_P_BN | 201 | Prime number p in the Fp fields of the elliptic curve in the DSA algorithm. |
ECC_A_BN | 202 | First coefficient a of the elliptic curve in the DSA algorithm. |
ECC_B_BN | 203 | Second coefficient b of the elliptic curve in the DSA algorithm. |
ECC_G_X_BN | 204 | X coordinate of the base point g in the ECC algorithm. |
ECC_G_Y_BN | 205 | Y coordinate of the base point g in the ECC algorithm. |
ECC_N_BN | 206 | Order n of the base point g in the ECC algorithm. |
ECC_H_NUM | 207 | Cofactor h in the ECC algorithm. |
ECC_SK_BN | 208 | Private key sk in the ECC algorithm. |
ECC_PK_X_BN | 209 | X coordinate of the public key pk (a point on the elliptic curve) in the ECC algorithm. |
ECC_PK_Y_BN | 210 | Y coordinate of the public key pk (a point on the elliptic curve) in the ECC algorithm. |
ECC_FIELD_TYPE_STR | 211 | Elliptic curve field type in the ECC algorithm. Currently, only the Fp field is supported. |
ECC_FIELD_SIZE_NUM | 212 | Size of the field in the ECC algorithm, in bits. NOTE For the Fp field, the size of the field is the length of the prime p, in bits. |
ECC_CURVE_NAME_STR | 213 | SECG curve name in the ECC algorithm. |
RSA_N_BN | 301 | Modulus n in the RSA algorithm. |
RSA_SK_BN | 302 | Private key sk (private key exponent d) in the RSA algorithm. |
RSA_PK_BN | 303 | Public key pk (public key exponent e) in the RSA algorithm. |
AsyKeySpecType10+
Enumerates the key parameter types.
System capability: SystemCapability.Security.CryptoFramework
Name | Value | Description |
---|---|---|
COMMON_PARAMS_SPEC | 0 | Common parameters contained in the public and private keys. You can use generateKeyPair() to randomly generate a key pair based on the parameters of this type. |
PRIVATE_KEY_SPEC | 1 | Parameter contained in the private key. You can use generatePriKey() to generate a private key based on the parameters of this type. |
PUBLIC_KEY_SPEC | 2 | Parameter contained in the public key. You can use generatePubKey() to generate a public key based on the parameters of this type. |
KEY_PAIR_SPEC | 3 | All parameters contained in the public and private keys. You can use generateKeyPair to generate a key pair based on the parameters of this type. |
CipherSpecItem10+
Enumerates the cipher parameters. You can use setCipherSpec to set cipher parameters, and use getCipherSpec to obtain cipher parameters.
Currently, only the RSA algorithm is supported. For details, see Encryption and Decryption Specifications.
System capability: SystemCapability.Security.CryptoFramework
Name | Value | Description |
---|---|---|
OAEP_MD_NAME_STR | 100 | Name of the message digest algorithm when the PKCS1_OAEP padding mode is used in the RSA. |
OAEP_MGF_NAME_STR | 101 | Mask generation algorithm when the PKCS1_OAEP padding mode is used in the RSA. Currently, only MGF1 is supported. |
OAEP_MGF1_MD_STR | 102 | Message digest algorithm for the MGF1 mask generation when the PKCS1_OAEP padding mode is used in the RSA. |
OAEP_MGF1_PSRC_UINT8ARR | 103 | pSource byte stream when the PKCS1_OAEP padding mode is used in the RSA. |
SignSpecItem10+
Enumerates the parameters for signing and signature verification. You can use setSignSpec and setVerifySpec to set these parameters, and use getSignSpec and getVerifySpec to obtain the parameters.
Currently, only the RSA algorithm is supported. For details, see Encryption and Decryption Specifications.
System capability: SystemCapability.Security.CryptoFramework
Name | Value | Description |
---|---|---|
PSS_MD_NAME_STR | 100 | Name of the message digest algorithm when the PSS padding mode is used in the RSA. |
PSS_MGF_NAME_STR | 101 | Mask generation algorithm when the PSS padding mode is used in the RSA. Currently, only MGF1 is supported. |
PSS_MGF1_MD_STR | 102 | Message digest parameters for the MGF1 mask generation when the PSS padding mode is used in the RSA. |
PSS_SALT_LEN_NUM | 103 | Length of the salt in bytes when the PSS padding mode is used in the RSA. |
PSS_TRAILER_FIELD_NUM | 104 | Integer used for encoding when the PSS padding mode is used in the RSA. The value is 1. |
AsyKeySpec10+
Defines the asymmetric key parameters for creating a key generator. You need to construct a child class object and pass it to createAsyKeyGeneratorBySpec() to create a key generator. All the parameters of the bigint type in the child class object must be integers in big-endian format.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | Yes | Algorithm of the asymmetric key pair, for example, RSA, DSA, or ECC. |
specType | AsyKeySpecType | Yes | Yes | Key parameter type, which is used to distinguish public and private key parameters. |
DSACommonParamsSpec10+
Defines the common parameters contained in the public and private keys in the DSA algorithm. It is a child class of AsyKeySpec and can be used to randomly generate public or private keys.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
p | bigint | Yes | Yes | Prime modulus p in the DSA algorithm. |
q | bigint | Yes | Yes | Parameter q (prime factor of p – 1) in the DSA algorithm. |
g | bigint | Yes | Yes | Parameter g in the DSA algorithm. |
DSAPubKeySpec10+
Defines the parameters contained in the public key in the DSA algorithm. It is a child class of AsyKeySpec.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
params | DSACommonParamsSpec | Yes | Yes | Common parameters contained in both public and private keys in the DSA algorithm. |
pk | bigint | Yes | Yes | Public key of the DSA algorithm. |
DSAKeyPairSpec10+
Defines full parameters contained in the public and private keys in the DSA algorithm. It is a child class of AsyKeySpec.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
params | DSACommonParamsSpec | Yes | Yes | Common parameters contained in both public and private keys in the DSA algorithm. |
sk | bigint | Yes | Yes | Private key sk in the DSA algorithm. |
pk | bigint | Yes | Yes | Public key pk in the DSA algorithm. |
ECField10+
Defines the elliptic curve field. Currently, only the Fp field is supported.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
fieldType | string | Yes | Yes | Type of the elliptic curve field. Currently, only Fp is supported. |
ECFieldFp10+
Defines the prime field of the elliptic curve. It is a child class of ECField.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
p | bigint | Yes | Yes | Prime p. |
Point10+
Defines a point on the elliptic curve.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
x | bigint | Yes | Yes | X coordinate of the point on an elliptic curve. |
y | bigint | Yes | Yes | Y coordinate of the point on an elliptic curve. |
ECCCommonParamsSpec10+
Defines the common parameters contained in the public and private keys in the ECC algorithm. It is a child class of AsyKeySpec and can be used to randomly generate public or private keys.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
field | ECField | Yes | Yes | Field of the elliptic curve. Currently, only the Fp field is supported. |
a | bigint | Yes | Yes | First coefficient a of the elliptic curve. |
b | bigint | Yes | Yes | Second coefficient b of the elliptic curve. |
g | Point | Yes | Yes | Base point g. |
n | bigint | Yes | Yes | Order n of the base point g. |
h | number | Yes | Yes | Cofactor h. |
ECCPriKeySpec10+
Defines the parameters contained in the private key in the ECC algorithm. It is a child class of AsyKeySpec.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
params | ECCCommonParamsSpec | Yes | Yes | Common parameters contained in both public and private keys in the ECC algorithm. |
sk | bigint | Yes | Yes | Private key sk in the ECC algorithm. |
ECCPubKeySpec10+
Defines the parameters contained in the public key in the ECC algorithm. It is a child class of AsyKeySpec.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
params | ECCCommonParamsSpec | Yes | Yes | Common parameters contained in both public and private keys in the ECC algorithm. |
pk | Point | Yes | Yes | Public key pk in the ECC algorithm. |
ECCKeyPairSpec10+
Defines full parameters contained in the public and private keys in the ECC algorithm. It is a child class of AsyKeySpec.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
params | ECCCommonParamsSpec | Yes | Yes | Common parameters contained in both public and private keys in the ECC algorithm. |
sk | bigint | Yes | Yes | Private key sk in the ECC algorithm. |
pk | Point | Yes | Yes | Public key pk in the ECC algorithm. |
RSACommonParamsSpec10+
Defines the common parameters contained in the public and private keys in the RSA algorithm. It is a child class of AsyKeySpec and can be used to randomly generate public or private keys.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
n | bigint | Yes | Yes | Modulus n. |
RSAPubKeySpec10+
Defines the parameters contained in the public key in the RSA algorithm. It is a child class of AsyKeySpec.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
params | RSACommonParamsSpec | Yes | Yes | Common parameters contained in both public and private keys in the RSA algorithm. |
pk | bigint | Yes | Yes | Public key pk in the RSA algorithm. |
RSAKeyPairSpec10+
Defines full parameters contained in the public and private keys in the RSA algorithm. It is a child class of AsyKeySpec.
When key parameters are used to generate a key, you can pass it to createAsyKeyGeneratorBySpec() to create a key generator.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
params | RSACommonParamsSpec | Yes | Yes | Common parameters contained in both public and private keys in the RSA algorithm. |
sk | bigint | Yes | Yes | Private key sk in the RSA algorithm. |
pk | bigint | Yes | Yes | Public key pk in the RSA algorithm. |
Key
Provides APIs for key operations. Before performing cryptographic operations (such as encryption and decryption), you need to construct a child class object of Key and pass it to init() of the Cipher instance.
Keys can be generated by a key generator.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
format | string | Yes | No | Format of the key. |
algName | string | Yes | No | Algorithm name (including the key length). |
getEncoded
getEncoded(): DataBlob
Obtains the byte stream of the key data. This API returns the result synchronously. The key can be a symmetric key, public key, or private key. The public key must be in DER encoding format and comply with the ASN.1 syntax and X.509 specifications. The private key must be in DER encoding format and comply with the ASN.1 syntax and PKCS#8 specifications.
NOTE
When key parameters are used to generate an RSA private key, the private key object does not support getEncoded().
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
DataBlob | Key obtained. |
Error codes
ID | Error Message |
---|---|
801 | this operation is not supported. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let key: cryptoFramework.SymKey; // The key is generated by a key generator. The generation process is omitted here.
let encodedKey = key.getEncoded();
console.info("key blob:" + encodedKey.data);
SymKey
Provides APIs for symmetric key operations. It is a child class of Key. Its objects need to be passed to init() of the Cipher instance in symmetric encryption and decryption.
Symmetric keys can be generated by a SymKeyGenerator.
clearMem
clearMem(): void
Clears the keys in the memory. This API returns the result synchronously. You are advised to use this API when symmetric key instances are no longer used.
System capability: SystemCapability.Security.CryptoFramework
Example
let key: cryptoFramework.SymKey; // The key is generated by a symKeyGenerator. The generation process is omitted here.
let encodedKey = key.getEncoded();
console.info("key blob: "+ encodedKey.data); // Display key content.
key.clearMem();
encodedKey = key.getEncoded();
console.info("key blob:" + encodedKey.data); // Display all 0s.
PubKey
Provides APIs for public key operations. It is a child class of Key. Its objects need to be passed in during asymmetric encryption and decryption, signature verification, and key agreement.
The public key can be generated by using the asymmetric key generator AsyKeyGenerator or AsyKeyGeneratorBySpec.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
format | string | Yes | No | Format of the key. |
algName | string | Yes | No | Algorithm name (including the key length). |
getAsyKeySpec10+
getAsyKeySpec(itemType: AsyKeySpecItem): bigint|string|number
Obtains a key parameter. This API returns the result synchronously.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
item | AsyKeySpecItem | Yes | Key parameter to obtain. |
Return value
Type | Description |
---|---|
bigint|string|number | Content of the key parameter obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let key: cryptoFramework.PubKey; // key is a public key object. The generation process is omitted here.
let p = key.getAsyKeySpec(cryptoFramework.AsyKeySpecItem.ECC_FP_P_BN);
console.info("ecc item --- p: " + p.toString(16));
PriKey
Provides APIs for private key operations. It is a child class of Key. Its objects need to be passed in during asymmetric encryption and decryption, signing, and key agreement.
The private key can be generated by using the asymmetric key generator AsyKeyGenerator or AsyKeyGeneratorBySpec.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
format | string | Yes | No | Format of the key. |
algName | string | Yes | No | Algorithm name (including the key length). |
clearMem
clearMem(): void
Clears the keys in the memory. This API returns the result synchronously.
System capability: SystemCapability.Security.CryptoFramework
Example
let key: cryptoFramework.PriKey; // The key is a private key generated by the asymmetric key generator. The generation process is omitted here.
key.clearMem(); // For the asymmetric private key, clearMem() releases the internal key struct. After clearMem is executed, getEncoded() is not supported. }
getAsyKeySpec10+
getAsyKeySpec(itemType: AsyKeySpecItem): bigint|string|number
Obtains a key parameter. This API returns the result synchronously.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
item | AsyKeySpecItem | Yes | Key parameter to obtain. |
Return value
Type | Description |
---|---|
bigint|string|number | Content of the key parameter obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let key: cryptoFramework.PriKey; // key is a private key object. The generation process is omitted here.
let p = key.getAsyKeySpec(cryptoFramework.AsyKeySpecItem.ECC_FP_P_BN);
console.info("ecc item --- p: " + p.toString(16));
KeyPair
Defines an asymmetric key pair, which includes a public key and a private key.
The asymmetric key pair can be generated by using the asymmetric key generator AsyKeyGenerator or AsyKeyGeneratorBySpec.
NOTE
The pubKey and priKey objects in the KeyPair object exist as one parameter in the KeyPair object. When KeyPair leaves the scope, its internal objects can be destructed.
The service must reference the KeyPair object instead of the internal pubKey or priKey object.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
priKey | PriKey | Yes | No | Private key. |
pubKey | PubKey | Yes | No | Public key. |
cryptoFramework.createSymKeyGenerator
createSymKeyGenerator(algName: string): SymKeyGenerator
Creates a symKeyGenerator instance based on the specified algorithm.
For details about the supported specifications, see Key Generation Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
algName | string | Yes | Algorithm used to create the symKeyGenerator instance. For details, see “String Parameter” in Key Generation Specifications. |
Return value
Type | Description |
---|---|
SymKeyGenerator | symKeyGenerator instance created. |
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
Example
let symKeyGenerator = cryptoFramework.createSymKeyGenerator('3DES192');
SymKeyGenerator
Provides APIs for using the symKeyGenerator.
Before using any API of the SymKeyGenerator class, you must create a symKeyGenerator instance by using createSymKeyGenerator.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Algorithm used by the symKeyGenerator. |
generateSymKey
generateSymKey(callback: AsyncCallback<SymKey>): void
Generates a key randomly. This API uses an asynchronous callback to return the result.
This API can be used only after a symKeyGenerator instance is created by using createSymKeyGenerator.
RAND_priv_bytes() of OpenSSL can be used to generate random keys.
NOTE
For the symmetric key used in the hash-based message authentication code (HMAC) algorithm, if the hash algorithm (for example, HMAC|SHA256) is specified when the symmetric key generator is created, a binary key with the same length as the hash value will be randomly generated. For example, if HMAC|SHA256 is specified, a 256-bit key will be randomly generated.
If no hash algorithm is specified when the symmetric key generator is created (for example, only HMAC is specified), symmetric key data cannot be randomly generated. In this case, you can use convertKey to generate symmetric key data.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<SymKey> | Yes | Callback invoked to return the result. If the operation is successful, err is undefined and data is the symmetric key generated. Otherwise, err is an error object. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
let symAlgName = '3DES192';
let symKeyGenerator = cryptoFramework.createSymKeyGenerator(symAlgName);
symKeyGenerator.generateSymKey((err, symKey) => {
if (err) {
console.error(`Generate symKey failed, ${err.code}, ${err.message}`);
} else {
console.info(`Generate symKey success, algName: ${symKey.algName}`);
}
})
generateSymKey
generateSymKey(): Promise<SymKey>
Generates a key randomly. This API uses a promise to return the result.
This API can be used only after a symKeyGenerator instance is created by using createSymKeyGenerator.
RAND_priv_bytes() of OpenSSL can be used to generate random keys.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Promise<SymKey> | Promise used to return the symmetric key generated. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
let symAlgName = 'AES128';
let symKeyGenerator = cryptoFramework.createSymKeyGenerator(symAlgName);
symKeyGenerator.generateSymKey()
.then(symKey => {
console.info(`Generate symKey success, algName: ${symKey.algName}`);
}, (error: BusinessError) => {
console.error(`Generate symKey failed, ${error.code}, ${error.message}`);
})
convertKey
convertKey(key: DataBlob, callback: AsyncCallback<SymKey>): void
Converts data into a symmetric key. This API uses an asynchronous callback to return the result.
This API can be used only after a symKeyGenerator instance is created by using createSymKeyGenerator.
NOTE
For the symmetric key used in the HMAC algorithm, if the hash algorithm (for example, HMAC|SHA256) is specified when the symmetric key generator is created, the binary key data to be passed in must be of the same length as the hash. For example, if HMAC|SHA256 is specified, a 256-bit key must be passed in.
If no hash algorithm is specified when the symmetric key generator is created (for example, only HMAC is specified), the length of the binary key data is in the range of [1,4096], in bytes.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | DataBlob | Yes | Data to convert. |
callback | AsyncCallback<SymKey> | Yes | Callback invoked to return the result. If the operation is successful, err is undefined and data is the symmetric key generated. Otherwise, err is an error object. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
function genKeyMaterialBlob(): cryptoFramework.DataBlob {
let arr = [
0xba, 0x3d, 0xc2, 0x71, 0x21, 0x1e, 0x30, 0x56,
0xad, 0x47, 0xfc, 0x5a, 0x46, 0x39, 0xee, 0x7c,
0xba, 0x3b, 0xc2, 0x71, 0xab, 0xa0, 0x30, 0x72]; // keyLen = 192 (24 bytes)
let keyMaterial = new Uint8Array(arr);
return { data: keyMaterial };
}
let symAlgName = '3DES192';
let symKeyGenerator = cryptoFramework.createSymKeyGenerator(symAlgName);
let keyMaterialBlob = genKeyMaterialBlob();
symKeyGenerator.convertKey(keyMaterialBlob, (err, symKey) => {
if (err) {
console.error(`Convert symKey failed, ${err.code}, ${err.message}`);
} else {
console.info(`Convert symKey success, algName: ${symKey.algName}`);
}
})
convertKey
convertKey(key: DataBlob): Promise<SymKey>
Converts data into a symmetric key. This API uses a promise to return the result.
This API can be used only after a symKeyGenerator instance is created by using createSymKeyGenerator.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | DataBlob | Yes | Data to convert. |
Return value
Type | Description |
---|---|
Promise<SymKey> | Promise used to return the symmetric key generated. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
function genKeyMaterialBlob(): cryptoFramework.DataBlob {
let arr = [
0xba, 0x3d, 0xc2, 0x71, 0x21, 0x1e, 0x30, 0x56,
0xad, 0x47, 0xfc, 0x5a, 0x46, 0x39, 0xee, 0x7c,
0xba, 0x3b, 0xc2, 0x71, 0xab, 0xa0, 0x30, 0x72]; // keyLen = 192 (24 bytes)
let keyMaterial = new Uint8Array(arr);
return { data: keyMaterial };
}
let symAlgName = '3DES192';
let symKeyGenerator = cryptoFramework.createSymKeyGenerator(symAlgName);
let keyMaterialBlob = genKeyMaterialBlob();
symKeyGenerator.convertKey(keyMaterialBlob)
.then(symKey => {
console.info(`Convert symKey success, algName: ${symKey.algName}`);
}, (error: BusinessError) => {
console.error(`Convert symKey failed, ${error.code}, ${error.message}`);
})
cryptoFramework.createAsyKeyGenerator
createAsyKeyGenerator(algName: string): AsyKeyGenerator
Creates an AsyKeyGenerator instance based on the specified algorithm.
For details about the supported specifications, see Key Generation Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
algName | string | Yes | Algorithm used to create the symkeyGenerator. |
Return value
Type | Description |
---|---|
AsyKeyGenerator | AsyKeyGenerator instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
Example
let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator("ECC256");
AsyKeyGenerator
Provides APIs for using the AsKeyGenerator. Before using any API of the AsKeyGenerator class, you must create an AsyKeyGenerator instance by using createAsyKeyGenerator().
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Algorithm used by the AsKeyGenerator. |
generateKeyPair
generateKeyPair(callback: AsyncCallback<KeyPair>): void
Generates a key pair randomly. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<KeyPair> | Yes | Callback invoked to return the key pair obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator("ECC256");
asyKeyGenerator.generateKeyPair((err, keyPair) => {
if (err) {
console.error("generateKeyPair: error.");
return;
}
console.info("generateKeyPair: success.");
})
generateKeyPair
generateKeyPair(): Promise<KeyPair>
Generates a key pair randomly. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Promise<KeyPair> | Promise used to return the key pair generated. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator("ECC256");
let keyGenPromise = asyKeyGenerator.generateKeyPair();
keyGenPromise.then( keyPair => {
console.info("generateKeyPair success.");
}).catch((error: BusinessError) => {
console.error("generateKeyPair error.");
});
convertKey
convertKey(pubKey: DataBlob|null, priKey: DataBlob|null, callback: AsyncCallback<KeyPair>): void
Converts data into an asymmetric key. This API uses an asynchronous callback to return the result. For details, see Key Conversion.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
pubKey | DataBlob |null10+ | Yes | Public key material to convert. If no public key is required, set this parameter to null. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
priKey | DataBlob |null10+ | Yes | Private key material to convert. If no private key is required, set this parameter to null. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
callback | AsyncCallback<KeyPair> | Yes | Callback invoked to return the key pair obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let pubKeyArray = new Uint8Array([48, 89, 48, 19, 6, 7, 42, 134, 72, 206, 61, 2, 1, 6, 8, 42, 134, 72, 206, 61, 3, 1, 7, 3, 66, 0, 4, 83, 96, 142, 9, 86, 214, 126, 106, 247, 233, 92, 125, 4, 128, 138, 105, 246, 162, 215, 71, 81, 58, 202, 121, 26, 105, 211, 55, 130, 45, 236, 143, 55, 16, 248, 75, 167, 160, 167, 106, 2, 152, 243, 44, 68, 66, 0, 167, 99, 92, 235, 215, 159, 239, 28, 106, 124, 171, 34, 145, 124, 174, 57, 92]);
let priKeyArray = new Uint8Array([48, 49, 2, 1, 1, 4, 32, 115, 56, 137, 35, 207, 0, 60, 191, 90, 61, 136, 105, 210, 16, 27, 4, 171, 57, 10, 61, 123, 40, 189, 28, 34, 207, 236, 22, 45, 223, 10, 189, 160, 10, 6, 8, 42, 134, 72, 206, 61, 3, 1, 7]);
let pubKeyBlob: cryptoFramework.DataBlob = {data: pubKeyArray}; // Data of the public key.
let priKeyBlob: cryptoFramework.DataBlob = {data: priKeyArray}; // Data of the private key.
let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator("ECC256");
asyKeyGenerator.convertKey(pubKeyBlob, priKeyBlob, (err, keyPair) => {
if (err) {
console.error("convertKey: error.");
return;
}
console.info("convertKey: success.");
})
convertKey
convertKey(pubKey: DataBlob|null, priKey: DataBlob|null): Promise<KeyPair>
Converts data into an asymmetric key. This API uses a promise to return the result. For details, see Key Conversion.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
pubKey | DataBlob |null10+ | Yes | Public key material to convert. If no public key is required, set this parameter to null. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
priKey | DataBlob |null10+ | Yes | Private key material to convert. If no private key is required, set this parameter to null. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
Return value
Type | Description |
---|---|
Promise<KeyPair> | Promise used to return the key pair generated. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let pubKeyArray = new Uint8Array([48, 89, 48, 19, 6, 7, 42, 134, 72, 206, 61, 2, 1, 6, 8, 42, 134, 72, 206, 61, 3, 1, 7, 3, 66, 0, 4, 83, 96, 142, 9, 86, 214, 126, 106, 247, 233, 92, 125, 4, 128, 138, 105, 246, 162, 215, 71, 81, 58, 202, 121, 26, 105, 211, 55, 130, 45, 236, 143, 55, 16, 248, 75, 167, 160, 167, 106, 2, 152, 243, 44, 68, 66, 0, 167, 99, 92, 235, 215, 159, 239, 28, 106, 124, 171, 34, 145, 124, 174, 57, 92]);
let priKeyArray = new Uint8Array([48, 49, 2, 1, 1, 4, 32, 115, 56, 137, 35, 207, 0, 60, 191, 90, 61, 136, 105, 210, 16, 27, 4, 171, 57, 10, 61, 123, 40, 189, 28, 34, 207, 236, 22, 45, 223, 10, 189, 160, 10, 6, 8, 42, 134, 72, 206, 61, 3, 1, 7]);
let pubKeyBlob: cryptoFramework.DataBlob = {data: pubKeyArray}; // Data of the public key.
let priKeyBlob: cryptoFramework.DataBlob = {data: priKeyArray}; // Data of the private key.
let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator("ECC256");
let keyGenPromise = asyKeyGenerator.convertKey(pubKeyBlob, priKeyBlob);
keyGenPromise.then( keyPair => {
console.info("convertKey success.");
}).catch((error: BusinessError) => {
console.error("convertKey error.");
});
Key Conversion
- After getEncoded() is called for the asymmetric (RSA, ECC, or DSA) public and private keys, binary data in X.509 format and binary data in PKCS #8 format are returned, respectively. The binary data can be used for cross-application transfer or persistent storage.
- The public key returned by convertKey() must comply with the ASN.1 syntax, X.509 specifications, and DER encoding format, and the private key must comply with the ASN.1 syntax, PKCS #8 specifications, and DER encoding format.
- In convertKey(), you can pass in either pubKey or priKey, or both of them. If one of them is passed in, the returned KeyPair instance contains only the key converted from the data you passed in.
cryptoFramework.createAsyKeyGeneratorBySpec10+
createAsyKeyGeneratorBySpec(asyKeySpec: AsyKeySpec): AsyKeyGeneratorBySpec
Creates an AsyKeyGenerator instance based on the key parameters.
For details about the supported specifications, see Key Generation Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
asyKeySpec | AsyKeySpec | Yes | Key parameters. The AsyKeyGenerator generates the public/private key based on the specified parameters. |
Return value
Type | Description |
---|---|
AsyKeyGeneratorBySpec | Returns the AsyKeyGenerator instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
Example
// Set the common parameters contained in both the DSA1024 public and private keys.
function genDsa1024CommonSpecBigE() {
let dsaCommonSpec: cryptoFramework.DSACommonParamsSpec = {
algName : "DSA",
specType : cryptoFramework.AsyKeySpecType.COMMON_PARAMS_SPEC,
p : BigInt("0xed1501551b8ab3547f6355ffdc2913856ddeca198833dbd04f020e5f25e47c50e0b3894f7690a0d2ea5ed3a7be25c54292a698e1f086eb3a97deb4dbf04fcad2dafd94a9f35c3ae338ab35477e16981ded6a5b13d5ff20bf55f1b262303ad3a80af71aa6aa2354d20e9c82647664bdb6b333b7bea0a5f49d55ca40bc312a1729"),
q : BigInt("0xd23304044019d5d382cfeabf351636c7ab219694ac845051f60b047b"),
g : BigInt("0x2cc266d8bd33c3009bd67f285a257ba74f0c3a7e12b722864632a0ac3f2c17c91c2f3f67eb2d57071ef47aaa8f8e17a21ad2c1072ee1ce281362aad01dcbcd3876455cd17e1dd55d4ed36fa011db40f0bbb8cba01d066f392b5eaa9404bfcb775f2196a6bc20eeec3db32d54e94d87ecdb7a0310a5a017c5cdb8ac78597778bd"),
}
return dsaCommonSpec;
}
// Set full parameters contained in the DSA1024 public and private keys.
function genDsa1024KeyPairSpecBigE() {
let dsaCommonSpec = genDsa1024CommonSpecBigE();
let dsaKeyPairSpec: cryptoFramework.DSAKeyPairSpec = {
algName : "DSA",
specType : cryptoFramework.AsyKeySpecType.KEY_PAIR_SPEC,
params : dsaCommonSpec,
sk : BigInt("0xa2dd2adb2d11392c2541930f61f1165c370aabd2d78d00342e0a2fd9"),
pk : BigInt("0xae6b5d5042e758f3fc9a02d009d896df115811a75b5f7b382d8526270dbb3c029403fafb8573ba4ef0314ea86f09d01e82a14d1ebb67b0c331f41049bd6b1842658b0592e706a5e4d20c14b67977e17df7bdd464cce14b5f13bae6607760fcdf394e0b73ac70aaf141fa4dafd736bd0364b1d6e6c0d7683a5de6b9221e7f2d6b"),
}
return dsaKeyPairSpec;
}
let asyKeyPairSpec = genDsa1024KeyPairSpecBigE(); // The JS input must be a positive number in big-endian format.
let asyKeyGeneratorBySpec = cryptoFramework.createAsyKeyGeneratorBySpec(asyKeyPairSpec);
AsyKeyGeneratorBySpec10+
Provides APIs for using the AsKeyGenerator. Before using the APIs of this class, you need to use createAsyKeyGeneratorBySpec() to create an AsyKeyGeneratorBySpec instance.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Algorithm used by the asymmetric key generator. |
generateKeyPair
generateKeyPair(callback: AsyncCallback<KeyPair>): void
Generates an asymmetric key pair. This API uses an asynchronous callback to return the result.
If key parameters of the COMMON_PARAMS_SPEC type are used to create the key generator, a key pair will be randomly generated. If key parameters of the KEY_PAIR_SPEC type are used to create the key generator, you can obtain a key pair that is consistent with the specified key parameters.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<KeyPair> | Yes | Callback invoked to return the key pair obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyPairSpec: cryptoFramework.DSAKeyPairSpec; // DSA is used as an example. asyKeyPairSpec specifies full parameters contained in the private and public keys. The generation process is omitted here.
let asyKeyGeneratorBySpec = cryptoFramework.createAsyKeyGeneratorBySpec(asyKeyPairSpec);
asyKeyGeneratorBySpec.generateKeyPair((err, keyPair) => {
if (err) {
console.error("generateKeyPair: error.");
return;
}
console.info("generateKeyPair: success.");
})
generateKeyPair
generateKeyPair(): Promise<KeyPair>
Generates an asymmetric key pair. This API uses a promise to return the result.
If key parameters of the COMMON_PARAMS_SPEC type are used to create the key generator, a key pair will be randomly generated. If key parameters of the KEY_PAIR_SPEC type are used to create the key generator, you can obtain a key pair that is consistent with the specified key parameters.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Promise<KeyPair> | Promise used to return the key pair generated. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyPairSpec: cryptoFramework.DSAKeyPairSpec; // DSA is used as an example. asyKeyPairSpec specifies full parameters contained in the private and public keys. The generation process is omitted here.
let asyKeyGeneratorBySpec = cryptoFramework.createAsyKeyGeneratorBySpec(asyKeyPairSpec);
let keyGenPromise = asyKeyGeneratorBySpec.generateKeyPair();
keyGenPromise.then( keyPair => {
console.info("generateKeyPair success.");
}).catch((error: BusinessError) => {
console.error("generateKeyPair error.");
});
generatePriKey
generatePriKey(callback: AsyncCallback<PriKey>): void
Generates an asymmetric key pair. This API uses an asynchronous callback to return the result.
If key parameters of the PRIVATE_KEY_SPEC type are used to create the key generator, the specified private key can be obtained. If key parameters of the KEY_PAIR_SPEC type are used to create the key generator, you can obtain the specified private key from the key pair generated.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<PriKey> | Yes | Callback invoked to return the key pair obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyPairSpec: cryptoFramework.DSAKeyPairSpec; // DSA is used as an example. asyKeyPairSpec specifies full parameters contained in the private and public keys.
let asyKeyGeneratorBySpec = cryptoFramework.createAsyKeyGeneratorBySpec(asyKeyPairSpec);
asyKeyGeneratorBySpec.generatePriKey((err, prikey) => {
if (err) {
console.error("generatePriKey: error.");
return;
}
console.info("generatePriKey: success.");
})
generatePriKey
generatePriKey(): Promise<PriKey>
Generates an asymmetric key pair. This API uses a promise to return the result.
If key parameters of the PRIVATE_KEY_SPEC type are used to create the key generator, the specified private key can be obtained. If key parameters of the KEY_PAIR_SPEC type are used to create the key generator, you can obtain the specified private key from the key pair generated.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Promise<PriKey> | Promise used to return the key generated. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyPairSpec: cryptoFramework.DSAKeyPairSpec; // DSA is used as an example. asyKeyPairSpec specifies full parameters contained in the private and public keys.
let asyKeyGeneratorBySpec = cryptoFramework.createAsyKeyGeneratorBySpec(asyKeyPairSpec);
let keyGenPromise = asyKeyGeneratorBySpec.generatePriKey();
keyGenPromise.then( priKey => {
console.info("generatePriKey success.");
}).catch((error: BusinessError) => {
console.error("generatePriKey error.");
});
generatePubKey
generatePubKey(callback: AsyncCallback<PubKey>): void
Generates an asymmetric key pair. This API uses an asynchronous callback to return the result.
If key parameters of the PUBLIC_KEY_SPEC type are used to create the key generator, the specified public key can be obtained. If key parameters of the KEY_PAIR_SPEC type are used to create the key generator, you can obtain the specified public key from the key pair generated.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<PubKey> | Yes | Callback invoked to return the key pair obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyPairSpec: cryptoFramework.DSAKeyPairSpec; // DSA is used as an example. asyKeyPairSpec specifies full parameters contained in the private and public keys. The generation process is omitted here.
let asyKeyGeneratorBySpec = cryptoFramework.createAsyKeyGeneratorBySpec(asyKeyPairSpec);
asyKeyGeneratorBySpec.generateKeyPair((err, pubKey) => {
if (err) {
console.error("generatePubKey: error.");
return;
}
console.info("generatePubKey: success.");
})
generatePubKey
generatePubKey(): Promise<PubKey>
Generates an asymmetric key pair. This API uses a promise to return the result.
If key parameters of the PUBLIC_KEY_SPEC type are used to create the key generator, the specified public key can be obtained. If key parameters of the KEY_PAIR_SPEC type are used to create the key generator, you can obtain the specified public key from the key pair generated.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Promise<PubKey> | Promise used to return the key generated. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let asyKeyPairSpec: cryptoFramework.DSAKeyPairSpec; // DSA is used as an example. asyKeyPairSpec specifies full parameters contained in the private and public keys. The generation process is omitted here.
let asyKeyGeneratorBySpec = cryptoFramework.createAsyKeyGeneratorBySpec(asyKeyPairSpec);
let keyGenPromise = asyKeyGeneratorBySpec.generatePubKey();
keyGenPromise.then( pubKey => {
console.info("generatePubKey success.");
}).catch((error: BusinessError) => {
console.error("generatePubKey error.");
});
cryptoFramework.createCipher
createCipher(transformation: string): Cipher
Creates a Cipher instance based on the specified algorithm.
For details about the supported specifications, see Encryption and Decryption Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
transformation | string | Yes | Combination of the algorithm name (including the key length), encryption mode, and padding algorithm of the Cipher instance to create. For details, see String Parameter in Encryption and Decryption Specifications. |
NOTE
- In symmetric encryption and decryption, the implementation of PKCS #5 is the same as that of PKCS #7. PKCS #5 and PKCS #7 use the same padding length and block length. That is, data is padded with 8 bytes in 3DES and 16 bytes in AES. noPadding indicates that no padding is performed.
You need to understand the differences between different block cipher modes and use the correct parameter specifications. For example, padding is required for ECB and CBC. Otherwise, ensure that the plaintext length is an integer multiple of the block size. No padding is recommended for other modes. In this case, the ciphertext length is the same as the plaintext length.- When RSA or SM2 is used for asymmetric encryption and decryption, create a Cipher instance for encryption and decryption respectively. Do not use the same Cipher instance for encryption and decryption. For symmetric encryption and decryption, one Cipher object can be used to perform both encryption and decryption as long as the algorithm specifications are the same.
Return value
Type | Description |
---|---|
Cipher | Cipher instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
let cipherAlgName = '3DES192|ECB|PKCS7';
try {
let cipher = cryptoFramework.createCipher(cipherAlgName);
console.info(`cipher algName: ${cipher.algName}`);
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`sync error, ${e.code}, ${e.message}`);
}
Cipher
Provides APIs for cipher operations. The init(), update(), and doFinal() APIs in this class are called in sequence to implement symmetric encryption or decryption and asymmetric encryption or decryption.
For details about the complete encryption and decryption process, see Encryption and Decryption.
A complete symmetric encryption/decryption process is slightly different from the asymmetric encryption/decryption process.
- Symmetric encryption and decryption: init() and doFinal() are mandatory. update() is optional and can be called multiple times to encrypt or decrypt big data. After doFinal() is called to complete an encryption or decryption operation, init() can be called to start a new encryption or decryption operation.
- RSA or SM2 asymmetric encryption and decryption: init() and doFinal() are mandatory, and update() is not supported. doFinal() can be called multiple times to encrypt or decrypt big data. init() cannot be called repeatedly. If the encryption/decryption mode or padding mode is changed, a new Cipher object must be created.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Algorithm. |
init
init(opMode: CryptoMode, key: Key, params: ParamsSpec|null, callback: AsyncCallback<void>): void
Initializes a Cipher instance. This API uses an asynchronous callback to return the result.
This API can be used only after a Cipher instance is created by using createCipher.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
opMode | CryptoMode | Yes | Operation (encryption or decryption) to perform. |
key | Key | Yes | Key for encryption or decryption. |
params | ParamsSpec |null10+ | Yes | Parameters for encryption or decryption. For algorithm modes without parameters (such as ECB), null can be passed in. In versions earlier than API version 10, only ParamsSpec is supported. Since API version 10, null is also supported. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. If the initialization is successful, err is undefined. Otherwise, err is an error object. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let symKey: cryptoFramework.SymKey; // The process of generating the symmetric key is omitted here.
let cipher: cryptoFramework.Cipher; // The process of creating a Cipher instance is omitted here.
cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, symKey, null, (err, ) => {
if (err) {
console.error(`Failed to init cipher, ${err.code}, ${err.message}`);
} else {
console.info(`Init cipher success`);
// Perform subsequent operations such as update.
}
})
init
init(opMode: CryptoMode, key: Key, params: ParamsSpec|null): Promise<void>
Initializes a Cipher instance. This API uses a promise to return the result.
This API can be used only after a Cipher instance is created by using createCipher.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
opMode | CryptoMode | Yes | Operation (encryption or decryption) to perform. |
key | Key | Yes | Key for encryption or decryption. |
params | ParamsSpec |null10+ | Yes | Parameters for encryption or decryption. For algorithm modes without parameters (such as ECB), null can be passed in. In versions earlier than API version 10, only ParamsSpec is supported. Since API version 10, null is also supported. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let symKey: cryptoFramework.SymKey; // The process of generating the symmetric key is omitted here.
let cipher: cryptoFramework.Cipher; // The process of creating a Cipher instance is omitted here.
cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, symKey, null)
.then(() => {
console.info(`Init cipher success`);
// Perform subsequent operations such as update.
}, (error: BusinessError) => {
console.error(`Failed to init cipher, ${error.code}, ${error.message}`);
})
update
update(data: DataBlob, callback: AsyncCallback<DataBlob>): void
Updates the data to encrypt or decrypt by segment. This API uses an asynchronous callback to return the encrypted or decrypted data.
This API can be called only after the Cipher instance is initialized by using init().
NOTE
- The update() and doFinal() operation results vary with the block mode used. If you are not familiar with the block modes for symmetric encryption and decryption, add a judgment to determine whether the result of each update() and doFinal() is null. If the result is not null, obtain the data to concatenate the complete ciphertext or plaintext.
For example, in ECB and CBC modes, data is encrypted or decrypted by block no matter whether the data passed in by update() is an integer multiple of the block length, and the encrypted/decrypted block data generated by this update() is output.
That is, encrypted/decrypted data is returned as long as the data passed in by update() reaches the size of a block. Otherwise, null is returned and the data will be retained until a block is formed in the next update()/doFinal().
When doFinal() is called, the data that has not been encrypted or decrypted will be padded based on the padding mode set in createCipher to an integer multiple of the block length, and then encrypted or decrypted.For a mode in which a block cipher can be converted into a stream cipher, the length of the ciphertext may be the same as that of the plaintext.
- You can use update() multiple times or do not use it (use doFinal() after init()), depending on the size of the data.
The algorithm library does not set a limit on the amount of data that can be passed in by updated() (once or accumulatively). For symmetric encryption and decryption of a large amount of data, you are advised to call update() multiple times to pass in the data by segment.
For details about the sample code for calling update() multiple times in AES, see Encryption and Decryption.
- RSA or SM2 asymmetric encryption and decryption do not support update().
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob | Yes | Data to encrypt or decrypt. It cannot be null or {data:Uint8Array (empty)}. |
callback | AsyncCallback<DataBlob> | Yes | Callback invoked to return the result. If the operation is successful, err is undefined, and data is DataBlob (containing the encrypted or decrypted data). Otherwise, err is an error object. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
function stringToUint8Array(str: string) {
let arr = new Uint8Array(str.length);
for (let i = 0, j = str.length; i < j; ++i) {
arr[i] = str.charCodeAt(i);
}
return arr;
}
let cipher: cryptoFramework.Cipher; // The process of creating a Cipher instance is omitted here.
// The init() process is omitted here.
let plainText: cryptoFramework.DataBlob = {data: stringToUint8Array('this is test!')};
cipher.update(plainText, (err, output) => { // Example of the encryption process.
if (err) {
console.error(`Failed to update cipher`);
} else {
console.info(`Update cipher success`);
if (output != null) {
// Concatenate output.data to the ciphertext.
}
// Perform subsequent operations such as doFinal().
}
})
update
update(data: DataBlob): Promise<DataBlob>
Updates the data to encrypt or decrypt by segment. This API uses a promise to return the encrypted or decrypted data.
This API can be called only after the Cipher instance is initialized by using init().
NOTE
- The update() and doFinal() operation results vary with the block mode used. If you are not familiar with the block modes for symmetric encryption and decryption, add a judgment to determine whether the result of each update() and doFinal() is null. If the result is not null, obtain the data to concatenate the complete ciphertext or plaintext.
For example, in ECB and CBC modes, data is encrypted or decrypted by block no matter whether the data passed in by update() is an integer multiple of the block length, and the encrypted/decrypted block data generated by this update() is output.
That is, encrypted/decrypted data is returned as long as the data passed in by update() reaches the size of a block. Otherwise, null is returned and the data will be retained until a block is formed in the next update()/doFinal().
When doFinal() is called, the data that has not been encrypted or decrypted will be padded based on the padding mode set in createCipher to an integer multiple of the block length, and then encrypted or decrypted.
For a mode in which a block cipher can be converted into a stream cipher, the length of the ciphertext may be the same as that of the plaintext.- You can use update() multiple times or do not use it (use doFinal() after init()), depending on the size of the data.
The algorithm library does not set a limit on the amount of data that can be passed in by updated() (once or accumulatively). For symmetric encryption and decryption of a large amount of data, you are advised to call update() multiple times to pass in the data by segment. For details about the sample code for calling update() multiple times in AES, see Encryption and Decryption.
- RSA or SM2 asymmetric encryption and decryption do not support update().
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob | Yes | Data to encrypt or decrypt. It cannot be null or {data:Uint8Array (empty)}. |
Return value
Type | Description |
---|---|
Promise<DataBlob> | Promise used to return the DataBlob (containing the encrypted or decrypted data). |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
function stringToUint8Array(str: string) {
let arr = new Uint8Array(str.length);
for (let i = 0, j = str.length; i < j; ++i) {
arr[i] = str.charCodeAt(i);
}
return arr;
}
let cipher: cryptoFramework.Cipher; // The process of creating a Cipher instance is omitted here.
// The init() process is omitted here.
let plainText: cryptoFramework.DataBlob = {data: stringToUint8Array('this is test!')};
cipher.update(plainText)
.then((output) => {
console.info(`Update cipher success.`);
if (output != null) {
// Concatenate output.data to the ciphertext.
}
// Perform subsequent operations such as doFinal().
}, (error: BusinessError) => {
console.info(`Update cipher failed.`);
})
doFinal
doFinal(data: DataBlob|null, callback: AsyncCallback<DataBlob>): void
(1) Encrypts or decrypts the remaining data (generated by the block cipher mode) and the data passed in by doFinal() to finish the symmetric encryption or decryption. This API uses an asynchronous callback to return the encrypted or decrypted data.
If a small amount of data needs to be encrypted or decrypted, you can use doFinal() to pass in data without using update(). If all the data has been passed in by update(), you can pass in null in data of doFinal().
The output of doFinal() varies with the symmetric encryption/decryption mode in use.
- Symmetric encryption in GCM and CCM mode: The result consists of the ciphertext and authTag (the last 16 bytes for GCM and the last 12 bytes for CCM). If null is passed in by data of doFinal(), the result of doFinal() is authTag.
authTag must be GcmParamsSpec or CcmParamsSpec used for decryption. The ciphertext is the data passed in for decryption. - Symmetric encryption and decryption in other modes and symmetric decryption in GCM and CCM modes: The result is the complete plaintext/ciphertext.
(2) Encrypts or decrypts the input data for RSA or SM2 asymmetric encryption/decryption. This API uses an asynchronous callback to return the result. If a large amount of data needs to be encrypted/decrypted, call doFinal() multiple times and concatenate the result of each doFinal() to obtain the complete plaintext/ciphertext.
NOTE
- In symmetric encryption or decryption, calling doFinal() means the end of an encryption or decryption process, and the Cipher instance state will be cleared. To start a new encryption or decryption operation, you must call init() to pass in a complete parameter list for initialization. For example, if the same symmetric key is used for a Cipher instance to perform encryption and then decryption. After the encryption is complete, the params in init for decryption must be set instead of being null.
- If a decryption fails, check whether the data to be encrypted and decrypted matches the parameters in init(). For the GCM mode, check whether the authTag obtained after encryption is obtained from the GcmParamsSpec for decryption.
- The result of doFinal() may be null. To avoid exceptions, determine whether the result is null before using the .data field to access the doFinal() result.
- For details about the sample code for calling doFinal() multiple times during RSA or SM2 asymmetric encryption and decryption, see Encryption and Decryption.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob |null10+ | Yes | Data to encrypt or decrypt. It can be null in symmetric encryption or decryption, but cannot be {data:Uint8Array(empty)}. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
callback | AsyncCallback<DataBlob> | Yes | Callback invoked to return the result. If the data is successfully encrypted or decrypted, err is undefined, and data is the DataBlob (encryption or decryption result of the remaining data). Otherwise, err is an error object. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let cipher: cryptoFramework.Cipher; // The process of creating a Cipher instance is omitted here.
let data: cryptoFramework.DataBlob; // The process of preparing the data to encrypt or decrypt is omitted here.
// The init() and update() processes are omitted here.
cipher.doFinal(data, (err, output) => {
if (err) {
console.error(`Failed to finalize cipher, ${err.code}, ${err.message}`);
} else {
console.info(`Finalize cipher success`);
if (output != null) {
// Concatenate output.data to obtain the complete plaintext/ciphertext (and authTag).
}
}
})
doFinal
doFinal(data: DataBlob|null): Promise<DataBlob>
(1) Encrypts or decrypts the remaining data (generated by the block cipher mode) and the data passed in by doFinal() to finish the symmetric encryption or decryption. This API uses a promise to return the encrypted or decrypted data. If a small amount of data needs to be encrypted or decrypted, you can use doFinal() to pass in data without using update(). If all the data has been passed in by update(), you can pass in null in data of doFinal().
The output of doFinal() varies with the symmetric encryption/decryption mode in use.
- Symmetric encryption in GCM and CCM mode: The result consists of the ciphertext and authTag (the last 16 bytes for GCM and the last 12 bytes for CCM). If null is passed in by data of doFinal(), the result of doFinal() is authTag.
authTag must be GcmParamsSpec or CcmParamsSpec used for decryption. The ciphertext is the data passed in for decryption. - Symmetric encryption and decryption in other modes and symmetric decryption in GCM and CCM modes: The result is the complete plaintext/ciphertext.
(2) Encrypts or decrypts the input data for RSA or SM2 asymmetric encryption/decryption. This API uses a promise to return the result. If a large amount of data needs to be encrypted/decrypted, call doFinal() multiple times and concatenate the result of each doFinal() to obtain the complete plaintext/ciphertext.
NOTE
- In symmetric encryption or decryption, calling doFinal() means the end of an encryption or decryption process, and the Cipher instance state will be cleared. To start a new encryption or decryption operation, you must call init() to pass in a complete parameter list for initialization. For example, if the same symmetric key is used for a Cipher instance to perform encryption and then decryption. After the encryption is complete, the params in init for decryption must be set instead of being null.
- If a decryption fails, check whether the data to be encrypted and decrypted matches the parameters in init(). For the GCM mode, check whether the authTag obtained after encryption is obtained from the GcmParamsSpec for decryption.
- The result of doFinal() may be null. To avoid exceptions, determine whether the result is null before using the .data field to access the doFinal() result.
- For details about the sample code for calling doFinal() multiple times during RSA or SM2 asymmetric encryption and decryption, see Encryption and Decryption.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob |null10+ | Yes | Data to encrypt or decrypt. It can be null, but cannot be {data:Uint8Array(empty)}. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
Return value
Type | Description |
---|---|
Promise<DataBlob> | Promise used to return the DataBlob, which is the encryption or decryption result of the remaining data. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let cipher: cryptoFramework.Cipher; // The process of creating a Cipher instance is omitted here.
let data: cryptoFramework.DataBlob; // The process of preparing the data to encrypt or decrypt is omitted here.
// The init() and update() processes are omitted here.
cipher.doFinal(data)
.then(output => {
console.info(`Finalize cipher success`);
if (output != null) {
// Concatenate output.data to obtain the complete plaintext/ciphertext (and authTag).
}
}, (error: BusinessError) => {
console.error(`Failed to finish cipher, ${error.code}, ${error.message}`);
})
RSA encryption example (callback)
function stringToUint8Array(str: string) {
let arr = new Uint8Array(str.length);
for (let i = 0, j = str.length; i < j; ++i) {
arr[i] = str.charCodeAt(i);
}
return arr;
}
let rsaGenerator = cryptoFramework.createAsyKeyGenerator("RSA1024|PRIMES_2");
let cipher = cryptoFramework.createCipher("RSA1024|PKCS1");
rsaGenerator.generateKeyPair((err, keyPair) => {
let pubKey = keyPair.pubKey;
cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, pubKey, null, (err, data) => {
let plainText = "this is cipher text";
let input: cryptoFramework.DataBlob = {data: stringToUint8Array(plainText) };
cipher.doFinal(input, (err, data) => {
AlertDialog.show({ message: "EncryptOutPut is " + data.data} );
});
});
});
RSA encryption example (promise)
function stringToUint8Array(str: string) {
let arr = new Uint8Array(str.length);
for (let i = 0, j = str.length; i < j; ++i) {
arr[i] = str.charCodeAt(i);
}
return arr;
}
let rsaGenerator = cryptoFramework.createAsyKeyGenerator("RSA1024|PRIMES_2");
let cipher = cryptoFramework.createCipher("RSA1024|PKCS1");
let keyGenPromise = rsaGenerator.generateKeyPair();
keyGenPromise.then((rsaKeyPair: cryptoFramework.KeyPair): Promise<void> => {
let pubKey = rsaKeyPair.pubKey;
return cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, pubKey, null); // Pass in the private key and DECRYPT_MODE to initialize the decryption mode.
}).then(() => {
let plainText = "this is cipher text";
let input: cryptoFramework.DataBlob = { data: stringToUint8Array(plainText) };
return cipher.doFinal(input);
}).then(dataBlob => {
console.info("EncryptOutPut is " + dataBlob.data);
});
NOTE
For more encryption and decryption examples, see Encryption and Decryption.
setCipherSpec10+
setCipherSpec(itemType: CipherSpecItem, itemValue: Uint8Array): void
Sets cipher specifications. You can use this API to set cipher specifications that cannot be set by createCipher. Currently, only the RSA is supported.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
itemType | CipherSpecItem | Yes | Cipher parameter to set. |
itemValue | Uint8Array | Yes | Value of the parameter to set. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let cipher: cryptoFramework.Cipher; // The process of generating the Cipher instance is omitted here.
let pSource = new Uint8Array([1,2,3,4]);
cipher.setCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR, pSource);
getCipherSpec10+
getCipherSpec(itemType: CipherSpecItem): string|Uint8Array
Obtains cipher specifications. Currently, only the RSA is supported.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
itemType | CipherSpecItem | Yes | Cipher parameter to obtain. |
Return value
Type | Description |
---|---|
string|Uint8Array | Returns the value of the cipher parameter obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let cipher: cryptoFramework.Cipher; // The process of generating the Cipher instance is omitted here.
let mdName = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MD_NAME_STR);
cryptoFramework.createSign
createSign(algName: string): Sign
Creates a Sign instance.
For details about the supported specifications, see Signing and Signature Verification Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
algName | string | Yes | Signing algorithm, which can be RSA, ECC, DSA, or SM210+. If the RSA PKCS1 mode is used, you need to set the digest. If the RSA PSS mode is used, you need to set the digest and mask digest. |
Return value
Type | Description |
---|---|
Sign | Returns the Sign instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
Example
let signer1 = cryptoFramework.createSign("RSA1024|PKCS1|SHA256");
let signer2 = cryptoFramework.createSign("RSA1024|PSS|SHA256|MGF1_SHA256");
let signer3 = cryptoFramework.createSign("ECC224|SHA256");
let signer4 = cryptoFramework.createSign("DSA2048|SHA256");
Sign
Provides APIs for signing. Before using any API of the Sign class, you must create a Sign instance by using createSign(algName: string): Sign. Invoke init(), update(), and sign() in this class in sequence to complete the signing operation. For details about the sample code, see Signing and Signature Verification.
The Sign class does not support repeated initialization. When a new key is used for signing, you must create a new Sign object and call init() for initialization.
The signing mode is determined in createSign(), and the key is set by init().
If the data to be signed is short, you can directly call sign() to pass in the original data for signing after init(). That is, you do not need to use update().
If the data to be signed is long, you can use update() to pass in the data by segment, and then use sign() to sign the entire data.
When update() is used, the sign() API supports only DataBlob in versions earlier than API version 10 and starts to support null since API version 10. After all the data is passed in by using update(), sign() can be called to sign the data.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Algorithm to use. |
init
init(priKey: PriKey, callback: AsyncCallback<void>): void
Initializes the Sign instance with a private key. This API uses an asynchronous callback to return the result.
The Sign class does not support repeated use of init().
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
priKey | PriKey | Yes | Private key used for the initialization. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
init
init(priKey: PriKey): Promise<void>
Initializes the Sign instance with a private key. This API uses a promise to return the result.
The Sign class does not support repeated use of init().
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
priKey | PriKey | Yes | Private key used for the initialization. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
update
update(data: DataBlob, callback: AsyncCallback<void>): void
Updates the data to be signed. This API uses an asynchronous callback to return the result.
This API can be called only after the Sign instance is initialized by using init().
NOTE
update() may be called multiple times or may not be called (call sign after init), depending on the size of the data. The algorithm library does not set a limit on the amount of data to be updated (once or accumulatively). If a large amount of data needs to be signed, you are advised to use update() multiple times to pass in data. This can prevent too much memory from being requested at a time. For details about the sample code for calling update() multiple times, see Signing and Signature verification.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob | Yes | Data to pass in. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
update
update(data: DataBlob): Promise<void>
Updates the data to be signed. This API uses a promise to return the result.
This API can be called only after the Sign instance is initialized by using init().
NOTE
update() may be called multiple times or may not be called (call sign after init), depending on the size of the data.
The algorithm library does not set a limit on the amount of data to be updated (once or accumulatively). If a large amount of data needs to be signed, you are advised to use update() multiple times to pass in data. This can prevent too much memory from being requested at a time. For details about the sample code for calling update() multiple times, see Signing and Signature verification.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob | Yes | Data to pass in. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
sign
sign(data: DataBlob|null, callback: AsyncCallback<DataBlob>): void
Signs the data. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob |null10+ | Yes | Data to pass in. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
callback | AsyncCallback<DataBlob > | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
sign
sign(data: DataBlob|null): Promise<DataBlob>
Signs the data. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob |null10+ | Yes | Data to pass in. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Callback example:
function stringToUint8Array(str: string) {
let arr = new Uint8Array(str.length);
for (let i = 0, j = str.length; i < j; ++i) {
arr[i] = str.charCodeAt(i);
}
return arr;
}
let globalKeyPair: cryptoFramework.KeyPair;
let signMessageBlob: cryptoFramework.DataBlob;
let plan1 = "This is Sign test plan1"; // The first segment of the data.
let plan2 = "This is Sign test plan2"; // The second segment of the data.
let input1: cryptoFramework.DataBlob = { data: stringToUint8Array(plan1) };
let input2: cryptoFramework.DataBlob = { data: stringToUint8Array(plan2) };
function signMessageCallback() {
let rsaGenerator = cryptoFramework.createAsyKeyGenerator("RSA1024|PRIMES_2");
let signer = cryptoFramework.createSign("RSA1024|PKCS1|SHA256");
rsaGenerator.generateKeyPair((err, keyPair) => {
globalKeyPair = keyPair;
let priKey = globalKeyPair.priKey;
signer.init(priKey, err => {
signer.update(input1, err => { // add first segment of data
signer.sign(input2, (err, data) => { // add second segment of data, sign input1 and input2
signMessageBlob = data;
AlertDialog.show({message: "res" + signMessageBlob.data});
});
});
});
});
}
Example (promise)
function stringToUint8Array(str: string) {
let arr = new Uint8Array(str.length);
for (let i = 0, j = str.length; i < j; ++i) {
arr[i] = str.charCodeAt(i);
}
return arr;
}
let globalKeyPair: cryptoFramework.KeyPair;
let signMessageBlob: cryptoFramework.DataBlob;
let plan1 = "This is Sign test plan1"; // The first segment of the data.
let plan2 = "This is Sign test plan2"; // The second segment of the data.
let input1: cryptoFramework.DataBlob = { data: stringToUint8Array(plan1) };
let input2: cryptoFramework.DataBlob = { data: stringToUint8Array(plan2) };
function signMessagePromise() {
let rsaGenerator = cryptoFramework.createAsyKeyGenerator("RSA1024|PRIMES_2");
let signer = cryptoFramework.createSign("RSA1024|PKCS1|SHA256"); // From API version 10, a Sign instance can be created by specifying a string parameter defining the key specifications.
let keyGenPromise = rsaGenerator.generateKeyPair();
keyGenPromise.then(keyPair => {
globalKeyPair = keyPair;
let priKey = globalKeyPair.priKey;
return signer.init(priKey);
}).then(() => {
return signer.update(input1);
}).then(() => {
return signer.sign(input2);
}).then(dataBlob => {
signMessageBlob = dataBlob;
console.info("sign output is " + signMessageBlob.data);
});
}
setSignSpec10+
setSignSpec(itemType: SignSpecItem, itemValue: number): void
Sets signing specifications. You can use this API to set signing parameters that cannot be set by createSign.
Currently, only the RSA is supported.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
itemType | SignSpecItem | Yes | Signing parameter to set. |
itemValue | number | Yes | Value of the signing parameter to set. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let signer: cryptoFramework.Sign; // The process of generating the Sign instance is omitted here.
let setN = 20;
signer.setSignSpec(cryptoFramework.SignSpecItem.PSS_SALT_LEN_NUM, setN);
getSignSpec10+
getSignSpec(itemType: SignSpecItem): string|number
Obtains signing specifications. Currently, only the RSA is supported.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
itemType | SignSpecItem | Yes | Signing parameter to obtain. |
Return value
Type | Description |
---|---|
string|number | Returns the value of the signing parameter obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let signer: cryptoFramework.Sign; // The process of generating the Sign instance is omitted here.
let saltLen = signer.getSignSpec(cryptoFramework.SignSpecItem.PSS_SALT_LEN_NUM);
cryptoFramework.createVerify
createVerify(algName: string): Verify
Creates a Verify instance.
For details about the supported specifications, see Signing and Signature Verification Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
algName | string | Yes | Signing algorithm, which can be RSA, ECC, DSA, or SM210+. If the RSA PKCS1 mode is used, you need to set the digest. If the RSA PSS mode is used, you need to set the digest and mask digest. |
Return value
Type | Description |
---|---|
Verify | Returns the Verify instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
Example
let verifyer1 = cryptoFramework.createVerify("RSA1024|PKCS1|SHA256");
let verifyer2 = cryptoFramework.createVerify("RSA1024|PSS|SHA256|MGF1_SHA256")
Verify
Provides APIs for signature verification. Before using any API of the Verify class, you must create a Verify instance by using createVerify(algName: string): Verify. Invoke init(), update(), and sign() in this class in sequence to complete the signature verification. For details about the sample code, see Signing and Signature Verification.
The Verify class does not support repeated initialization. When a new key is used for signature verification, you must create a new Verify object and call init() for initialization.
The signature verification mode is determined in createVerify(), and key is set by init().
If the signed message is short, you can call verify() to pass in the signed message and signature (signatureData) for signature verification after init(). That is, you do not need to use update().
If the signed message is too long, you can call update() multiple times to pass in the signed message by segment, and then call verify() to verify the full text of the message. In versions earlier than API version 10, the input parameter data of verify() supports only DataBlob. Since API version 10, data also supports null. After all the data is passed in by using update(), verify() can be called to verify the signature data.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Algorithm to be used for signature verification. |
init
init(pubKey: PubKey, callback: AsyncCallback<void>): void
Initializes the Verify instance with a public key. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
pubKey | PubKey | Yes | Public key used to initialize the Verify instance. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
init
init(pubKey: PubKey): Promise<void>
Initializes the Verify instance with a public key. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
pubKey | PubKey | Yes | Public key used to initialize the Verify instance. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
update
update(data: DataBlob, callback: AsyncCallback<void>): void
Updates the data for signature verification. This API uses an asynchronous callback to return the result.
This API can be called only after the Verify instance is initialized using init().
NOTE
update() may be called multiple times or may not be called (call verify after init), depending on the size of the data.
The algorithm library does not set a limit on the amount of data to be updated (once or accumulatively). If a large amount of data is involved in signature verification, you are advised to use update() multiple times to pass in data. This can prevent too much memory from being requested at a time.
For details about the sample code for calling update() multiple times, see Signing and Signature verification.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob | Yes | Data to pass in. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
update
update(data: DataBlob): Promise<void>
Updates the data for signature verifications. This API uses a promise to return the result.
This API can be called only after the Verify instance is initialized using init().
NOTE
update() may be called multiple times or may not be called (call verify after init), depending on the size of the data. The algorithm library does not set a limit on the amount of data to be updated (once or accumulatively). If a large amount of data is involved in signature verification, you are advised to use update() multiple times to pass in data. This can prevent too much memory from being requested at a time.
For details about the sample code for calling update() multiple times, see Signing and Signature verification.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob | Yes | Data to pass in. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
verify
verify(data: DataBlob|null, signatureData: DataBlob, callback: AsyncCallback<boolean>): void
Verifies the signature. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob |null10+ | Yes | Data to pass in. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
signatureData | DataBlob | Yes | Signature data. |
callback | AsyncCallback<boolean> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
verify
verify(data: DataBlob|null, signatureData: DataBlob): Promise<boolean>
Verifies the signature. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
data | DataBlob |null10+ | Yes | Data to pass in. In versions earlier than API version 10, only DataBlob is supported. Since API version 10, null is also supported. |
signatureData | DataBlob | Yes | Signature data. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Callback example:
let globalKeyPair: cryptoFramework.KeyPair; // globalKeyPair is an asymmetric key object generated by the asymmetric key generator. The generation process is omitted here.
let input1: cryptoFramework.DataBlob;
let input2: cryptoFramework.DataBlob;
let signMessageBlob: cryptoFramework.DataBlob;// Signed data, which is omitted here.
let verifyer = cryptoFramework.createVerify("RSA1024|PKCS1|SHA25");
verifyer.init(globalKeyPair.pubKey, (err, data) => {
verifyer.update(input1, (err, data) => {
verifyer.verify(input2, signMessageBlob, (err, data) => {
console.info("verify result is " + data);
})
});
})
Example (promise)
let globalKeyPair: cryptoFramework.KeyPair; // globalKeyPair is an asymmetric key object generated by the asymmetric key generator. The generation process is omitted here.
let verifyer = cryptoFramework.createVerify("RSA1024|PKCS1|SHA256");
let verifyInitPromise = verifyer.init(globalKeyPair.pubKey);
let input1: cryptoFramework.DataBlob;;
let input2: cryptoFramework.DataBlob;;
let signMessageBlob: cryptoFramework.DataBlob;; // Signed data, which is omitted here.
verifyInitPromise.then((): Promise<void> => {
return verifyer.update(input1);
}).then(() => {
return verifyer.verify(input2, signMessageBlob);
}).then(res => {
console.log("Verify result is " + res);
});
setVerifySpec10+
setVerifySpec(itemType: SignSpecItem, itemValue: number): void
Set signature verification specifications. You can use this API to set signature verification parameters that cannot be set by createVerify. Currently, only the RSA is supported.
The parameters for signature verification must be the same as those for signing.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
itemType | SignSpecItem | Yes | Signature verification parameter to set. |
itemValue | number | Yes | Value of the signature verification parameter to set. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let verifyer: cryptoFramework.Verify; //The process of generating the Verify instance is omitted here.
let setN = 20;
verifyer.setVerifySpec(cryptoFramework.SignSpecItem.PSS_SALT_LEN_NUM, setN);
getVerifySpec10+
getVerifySpec(itemType: SignSpecItem): string|number
Obtains signature verification specifications. Currently, only the RSA is supported.
The parameters for signature verification must be the same as those for signing.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
itemType | SignSpecItem | Yes | Signature verification parameter to obtain. |
Return value
Type | Description |
---|---|
string|number | Returns the value of the parameter obtained. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
let verifyer: cryptoFramework.Verify; //The process of generating the Verify instance is omitted here.
let saltLen = verifyer.getVerifySpec(cryptoFramework.SignSpecItem.PSS_SALT_LEN_NUM);
cryptoFramework.createKeyAgreement
createKeyAgreement(algName: string): KeyAgreement
Creates a KeyAgreement instance.
For details about the supported specifications, see Key Agreement Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
algName | string | Yes | Key agreement algorithm to use. Currently, only the ECC is supported. |
Return value
Type | Description |
---|---|
KeyAgreement | Returns the KeyAgreement instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
801 | this operation is not supported. |
17620001 | memory error. |
Example
let keyAgreement = cryptoFramework.createKeyAgreement("ECC256");
KeyAgreement
Provides APIs for key agreement operations. Before using any API of the KeyAgreement class, you must create a KeyAgreement instance by using createKeyAgreement(algName: string): KeyAgreement.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Algorithm used for key agreement. |
generateSecret
generateSecret(priKey: PriKey, pubKey: PubKey, callback: AsyncCallback<DataBlob>): void
Performs key agreement based on a private key and a public key. This API uses an asynchronous callback to return the shared secret generated.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
priKey | PriKey | Yes | Private key used for key agreement. |
pubKey | PubKey | Yes | Public key used for key agreement. |
callback | AsyncCallback<DataBlob> | Yes | Callback invoked to return the shared secret. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
generateSecret
generateSecret(priKey: PriKey, pubKey: PubKey): Promise<DataBlob>
Performs key agreement based on a private key and a public key. This API uses a promise to return the shared secret generated.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
priKey | PriKey | Yes | Private key used for key agreement. |
pubKey | PubKey | Yes | Public key used for key agreement. |
Return value
Type | Description |
---|---|
Promise<DataBlob> | Promise used to return the shared secret. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17620002 | runtime error. |
17630001 | crypto operation error. |
Callback example:
import { BusinessError } from '@ohos.base';
let globalKeyPair: cryptoFramework.KeyPair; // globalKeyPair is an asymmetric key object generated by the asymmetric key generator. The generation process is omitted here.
let keyAgreement = cryptoFramework.createKeyAgreement("ECC256");
keyAgreement.generateSecret(globalKeyPair.priKey, globalKeyPair.pubKey, (err, secret) => {
if (err) {
console.error("keyAgreement error.");
return;
}
console.info("keyAgreement output is " + secret.data);
});
Example (promise)
import { BusinessError } from '@ohos.base';
let globalKeyPair: cryptoFramework.KeyPair; // globalKeyPair is an asymmetric key object generated by the asymmetric key generator. The generation process is omitted here.
let keyAgreement = cryptoFramework.createKeyAgreement("ECC256");
let keyAgreementPromise = keyAgreement.generateSecret(globalKeyPair.priKey, globalKeyPair.pubKey);
keyAgreementPromise.then((secret) => {
console.info("keyAgreement output is " + secret.data);
}).catch((error: BusinessError) => {
console.error("keyAgreement error.");
});
cryptoFramework.createMd
createMd(algName: string): Md
Creates an Md instance for message digest operations.
For details about the supported specifications, see MD Algorithm Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
algName | string | Yes | Digest algorithm. For details about the supported algorithms, see MD Algorithm Specifications. |
Return value
Type | Description |
---|---|
Md | Returns the Md instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
try {
// Set algName based on the algorithm supported.
let md = cryptoFramework.createMd("SHA256");
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`sync error, ${e.code}, ${e.message}`);
}
Md
Provides APIs for message digest (MD) operations. Before using any API of the Md class, you must create an Md instance by using createMd.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Digest algorithm. |
update
update(input: DataBlob, callback: AsyncCallback<void>): void
Updates the message for MD operations. This API uses an asynchronous callback to return the result.
NOTE
For details about the sample code for calling update() multiple times, see Generating a Digest.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
input | DataBlob | Yes | Data to pass in. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let md = cryptoFramework.createMd("SHA256");
console.info("Md algName is: " + md.algName);
let blob: cryptoFramework.DataBlob;
md.update(blob, (err,) => {
if (err) {
console.error("[Callback] err: " + err.code);
}
});
update
update(input: DataBlob): Promise<void>
Updates the message for MD operations. This API uses a promise to return the result.
NOTE
For details about the sample code for calling update() multiple times, see Generating a Digest.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Mandatory | Description |
---|---|---|---|
input | DataBlob | Yes | Data to pass in. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let md = cryptoFramework.createMd("SHA256");
console.info("Md algName is: " + md.algName);
let blob: cryptoFramework.DataBlob;
let promiseMdUpdate = md.update(blob);
promiseMdUpdate.then(() => {
// do something
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
digest
digest(callback: AsyncCallback<DataBlob>): void
Generates a message digest. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<DataBlob> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let md = cryptoFramework.createMd("SHA256");
console.info("Md algName is: " + md.algName);
let blob: cryptoFramework.DataBlob;
md.update(blob, (err,) => {
if (err) {
console.error("[Callback] err: " + err.code);
}
md.digest((err1, mdOutput) => {
if (err1) {
console.error("[Callback] err: " + err1.code);
} else {
console.error("[Callback]: MD result: " + mdOutput);
}
});
});
digest
digest(): Promise<DataBlob>
Generates a message digest. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Promise<DataBlob> | Promise that returns the result. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let md = cryptoFramework.createMd("SHA256");
console.info("Md algName is: " + md.algName);
let blob: cryptoFramework.DataBlob;
let promiseMdUpdate = md.update(blob);
promiseMdUpdate.then(() => {
let promiseMdDigest = md.digest();
return promiseMdDigest;
}).then(mdOutput => {
console.error("[Promise]: MD result: " + mdOutput.data);
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
getMdLength
getMdLength(): number
Obtains the message digest length, in bytes.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
number | Returns the length of the message digest obtained. |
Error codes
ID | Error Message |
---|---|
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let md = cryptoFramework.createMd("SHA256");
console.info("Md algName is: " + md.algName);
let blob: cryptoFramework.DataBlob;
let promiseMdUpdate = md.update(blob);
promiseMdUpdate.then(() => {
let promiseMdDigest = md.digest();
return promiseMdDigest;
}).then(mdOutput => {
console.error("[Promise]: MD result: " + mdOutput.data);
let mdLen = md.getMdLength();
console.error("MD len: " + mdLen);
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
cryptoFramework.createMac
createMac(algName: string): Mac
Creates a Mac instance for message authentication code (MAC) operations.
For details about the supported specifications, see HMAC Algorithm Specifications.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
algName | string | Yes | Digest algorithm. For details about the supported algorithms, see HMAC Algorithm Specifications. |
Return value
Type | Description |
---|---|
Mac | Returns the Mac instance created. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
try {
// Set algName based on the algorithm supported.
let mac = cryptoFramework.createMac("SHA256");
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`sync error, ${e.code}, ${e.message}`);
}
Mac
Provides APIs for MAC operations. Before using any API of the Mac class, you must create a Mac instance by using createMac.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName | string | Yes | No | Digest algorithm. |
init
init(key: SymKey, callback: AsyncCallback<void>): void
Initializes the MAC computation with a symmetric key. This API uses an asynchronous callback to return the result.
NOTE
You are advised to use HMAC key generation specifications to create a symmetric key generator, and call generateSymKey to generate a symmetric key at random or call convertKey to generate a key that is of the same length as the key specifications.
If HMAC is specified to generate the symmetric key generator, only convertKey can be called to pass in a binary key of 1 to 4096 bytes.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | SymKey | Yes | Shared symmetric key. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let mac = cryptoFramework.createMac("SHA256");
let keyBlob: cryptoFramework.DataBlob;
let symKeyGenerator = cryptoFramework.createSymKeyGenerator("AES128");
symKeyGenerator.convertKey(keyBlob, (err, symKey) => {
if (err) {
console.error("[Callback] err: " + err.code);
}
mac.init(symKey, (err1, ) => {
if (err1) {
console.error("[Callback] err: " + err1.code);
}
});
});
init
init(key: SymKey): Promise<void>
Initializes the MAC computation with a symmetric key. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | SymKey | Yes | Shared symmetric key. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let mac = cryptoFramework.createMac("SHA256");
console.info("Mac algName is: " + mac.algName);
let keyBlob: cryptoFramework.DataBlob;
let symKeyGenerator = cryptoFramework.createSymKeyGenerator("AES128");
let promiseConvertKey = symKeyGenerator.convertKey(keyBlob);
promiseConvertKey.then(symKey => {
let promiseMacInit = mac.init(symKey);
return promiseMacInit;
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
update
update(input: DataBlob, callback: AsyncCallback<void>): void
Updates the message for MAC computation. This API uses an asynchronous callback to return the result.
NOTE
For details about the sample code for calling update() multiple times, see Generating a MAC.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
input | DataBlob | Yes | Data to pass in. |
callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let keyBlob: cryptoFramework.DataBlob;
let mac = cryptoFramework.createMac("SHA256");
let symKeyGenerator = cryptoFramework.createSymKeyGenerator("AES128");
symKeyGenerator.convertKey(keyBlob, (err, symKey) => {
if (err) {
console.error("[Callback] err: " + err.code);
}
mac.init(symKey, (err1, ) => {
if (err1) {
console.error("[Callback] err: " + err1.code);
}
let blob: cryptoFramework.DataBlob;
mac.update(blob, (err2, data) => {
if (err2) {
console.error("[Callback] err: " + err2.code);
}
});
});
});
update
update(input: DataBlob): Promise<void>
Updates the message for MAC computation. This API uses a promise to return the result.
NOTE
For details about the sample code for calling update() multiple times, see Generating a MAC.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
input | DataBlob | Yes | Data to pass in. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let mac = cryptoFramework.createMac("SHA256");
console.info("Mac algName is: " + mac.algName);
let keyBlob: cryptoFramework.DataBlob;
let symKeyGenerator = cryptoFramework.createSymKeyGenerator("AES128");
let promiseConvertKey = symKeyGenerator.convertKey(keyBlob);
promiseConvertKey.then(symKey => {
let promiseMacInit = mac.init(symKey);
return promiseMacInit;
}).then(() => {
let blob: cryptoFramework.DataBlob;
let promiseMacUpdate = mac.update(blob);
return promiseMacUpdate;
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
doFinal
doFinal(callback: AsyncCallback<DataBlob>): void
Finishes the MAC computation. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<DataBlob> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let keyBlob: cryptoFramework.DataBlob;
let mac = cryptoFramework.createMac("SHA256");
let symKeyGenerator = cryptoFramework.createSymKeyGenerator("AES128");
symKeyGenerator.convertKey(keyBlob, (err, symKey) => {
if (err) {
console.error("[Callback] err: " + err.code);
}
mac.init(symKey, (err1, ) => {
if (err1) {
console.error("[Callback] err: " + err1.code);
}
let blob: cryptoFramework.DataBlob;
mac.update(blob, (err2, ) => {
if (err2) {
console.error("[Callback] err: " + err2.code);
}
mac.doFinal((err3, macOutput) => {
if (err3) {
console.error("[Callback] err: " + err3.code);
} else {
console.error("[Promise]: HMAC result: " + macOutput);
}
});
});
});
});
doFinal
doFinal(): Promise<DataBlob>
Finishes the MAC computation. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Promise<DataBlob> | Promise that returns the result. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let mac = cryptoFramework.createMac("SHA256");
console.info("Mac algName is: " + mac.algName);
let keyBlob: cryptoFramework.DataBlob;
let symKeyGenerator = cryptoFramework.createSymKeyGenerator("AES128");
let promiseConvertKey = symKeyGenerator.convertKey(keyBlob);
promiseConvertKey.then(symKey => {
let promiseMacInit = mac.init(symKey);
return promiseMacInit;
}).then(() => {
let blob: cryptoFramework.DataBlob;
let promiseMacUpdate = mac.update(blob);
return promiseMacUpdate;
}).then(() => {
let promiseMacDoFinal = mac.doFinal();
return promiseMacDoFinal;
}).then(macOutput => {
console.error("[Promise]: HMAC result: " + macOutput.data);
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
getMacLength
getMacLength(): number
Obtains the MAC length, in bytes.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
number | Returns the MAC length obtained. |
Error codes
ID | Error Message |
---|---|
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let mac = cryptoFramework.createMac("SHA256");
console.info("Mac algName is: " + mac.algName);
let keyBlob: cryptoFramework.DataBlob;
let symKeyGenerator = cryptoFramework.createSymKeyGenerator("AES128");
let promiseConvertKey = symKeyGenerator.convertKey(keyBlob);
promiseConvertKey.then(symKey => {
let promiseMacInit = mac.init(symKey);
return promiseMacInit;
}).then(() => {
let blob: cryptoFramework.DataBlob;
let promiseMacUpdate = mac.update(blob);
return promiseMacUpdate;
}).then(() => {
let promiseMacDoFinal = mac.doFinal();
return promiseMacDoFinal;
}).then(macOutput => {
console.error("[Promise]: HMAC result: " + macOutput.data);
let macLen = mac.getMacLength();
console.error("MAC len: " + macLen);
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
cryptoFramework.createRandom
createRandom(): Random
Creates a Random instance for generating random numbers and setting seeds.
For details about the supported specifications, see Random Number Specifications.
System capability: SystemCapability.Security.CryptoFramework
Return value
Type | Description |
---|---|
Random | Returns the Random instance created. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
try {
let rand = cryptoFramework.createRandom();
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`sync error, ${e.code}, ${e.message}`);
}
Random
Provides APIs for computing random numbers and setting seeds. Before using any API of the Random class, you must create a Random instance by using createRandom.
Attributes
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
algName10+ | string | Yes | No | Algorithm used to generate the random number. Currently, only CTR_DRBG is supported. |
generateRandom
generateRandom(len: number, callback: AsyncCallback<DataBlob>): void
Generates a random number of the specified length. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
len | number | Yes | Length of the random number to generate, in bytes. The value range is [1, INT_MAX]. |
callback | AsyncCallback<DataBlob> | Yes | Callback invoked to return the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let rand = cryptoFramework.createRandom();
rand.generateRandom(12, (err, randData) => {
if (err) {
console.error("[Callback] err: " + err.code);
} else {
console.error("[Callback]: generate random result: " + randData.data);
}
});
generateRandom
generateRandom(len: number): Promise<DataBlob>
Generates a random number of the specified length. This API uses a promise to return the result.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
len | number | Yes | Length of the random number to generate, in bytes. The value range is [1, INT_MAX]. |
Return value
Type | Description |
---|---|
Promise<DataBlob> | Promise that returns the result. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let rand = cryptoFramework.createRandom();
let promiseGenerateRand = rand.generateRandom(12);
promiseGenerateRand.then(randData => {
console.error("[Promise]: rand result: " + randData.data);
}).catch((error: BusinessError) => {
console.error("[Promise]: error: " + error.message);
});
generateRandomSync10+
generateRandomSync(len: number): DataBlob
Generates a random number of the specified length. This API returns the result synchronously.
System capability: SystemCapability.Security.CryptoFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
len | number | Yes | Length of the random number to generate, in bytes. The value range is [1, INT_MAX]. |
Return value
Type | Description |
---|---|
DataBlob | Returns the generated random number. |
Error codes
ID | Error Message |
---|---|
401 | invalid parameters. |
17620001 | memory error. |
17630001 | crypto operation error. |
Example
import { BusinessError } from '@ohos.base';
let rand = cryptoFramework.createRandom();
try {
let randData = rand.generateRandomSync(12);
if (randData != null) {
console.info("[Sync]: rand result: " + randData.data);
} else {
console.error("[Sync]: get rand result fail!");
}
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`sync error, ${e.code}, ${e.message}`);
}
setSeed
setSeed(seed: DataBlob): void
Sets a seed.
System capability: SystemCapability.Security.CryptoFramework
Name | Type | Mandatory | Description |
---|---|---|---|
seed | DataBlob | Yes | Seed to set. |
Error codes
ID | Error Message |
---|---|
17620001 | memory error. |
Example
import { BusinessError } from '@ohos.base';
let rand = cryptoFramework.createRandom();
rand.generateRandom(12, (err, randData) => {
if (err) {
console.error("[Callback] err: " + err.code);
} else {
console.info("[Callback]: generate random result: " + randData.data);
try {
rand.setSeed(randData);
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`sync error, ${e.code}, ${e.message}`);
}
}
});
你可能感兴趣的鸿蒙文章
harmony 鸿蒙System Common Events (To Be Deprecated Soon)
harmony 鸿蒙System Common Events
harmony 鸿蒙API Reference Document Description
harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)
harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)
harmony 鸿蒙@ohos.bundle (Bundle)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦