• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用SM4对称密钥（GCM模式）加解密(C/C++)
2
3对应的算法规格请查看[对称密钥加解密算法规格：SM4](crypto-sym-encrypt-decrypt-spec.md#sm4)。
4
5## 在CMake脚本中链接相关动态库
6```txt
7target_link_libraries(entry PUBLIC libohcrypto.so)
8```
9
10**加密**
11
121. 调用[OH_CryptoSymKeyGenerator_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_key_api.md#oh_cryptosymkeygenerator_create)、[OH_CryptoSymKeyGenerator_Generate](../../reference/apis-crypto-architecture-kit/_crypto_sym_key_api.md#oh_cryptosymkeygenerator_generate)，生成密钥算法为SM4、密钥长度为128位的对称密钥（OH_CryptoSymKey）。
13
14   如何生成SM4对称密钥，开发者可参考下文示例，并结合[对称密钥生成和转换规格：SM4](crypto-sym-key-generation-conversion-spec.md#sm4)和[随机生成对称密钥](crypto-generate-sym-key-randomly.md)理解，参考文档与当前示例可能存在入参差异，请在阅读时注意区分。
15
162. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_create)，指定字符串参数'SM4_128|GCM|PKCS7'，创建对称密钥类型为SM4_128、分组模式为GCM、填充模式为PKCS7的Cipher实例，用于完成加密操作。
17
183. 调用[OH_CryptoSymCipherParams_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_create)创建参数对象，调用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_setparam)设置对应的加密参数。
19
204. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_init)，设置模式为加密（CRYPTO_ENCRYPT_MODE），指定加密密钥（OH_CryptoSymKey）和GCM模式对应的加密参数（OH_CryptoSymCipherParams），初始化加密Cipher实例。
21
225. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update)，更新数据（明文）。
23
24   当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
25
26   - 当数据量较小时，可以在init完成后直接调用final。
27   - 当数据量较大时，可以多次调用update，即[分段加解密](crypto-sm4-sym-encrypt-decrypt-gcm-by-segment-ndk.md)。
28
296. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取加密后的数据。
30   - 由于已使用update传入数据，此处data传入null。
31   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
32
337. 使用[OH_CryptoSymCipherParams_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_create)创建Params，使用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_setparam)设置authTag，作为解密的认证信息。在GCM模式下，需要从加密后的数据中取出末尾16字节，作为解密时初始化的认证信息。示例中authTag恰好为16字节。
34
358. 调用[OH_CryptoSymKeyGenerator_Destroy](../../reference/apis-crypto-architecture-kit/_crypto_sym_key_api.md#oh_cryptosymkeygenerator_destroy)、[OH_CryptoSymCipher_Destroy](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_destroy)、[OH_CryptoSymCipherParams_Destroy](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_destroy)销毁各对象。
36
37**解密**
38
391. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_create)，指定字符串参数'SM4_128|GCM|PKCS7'，创建对称密钥类型为SM4_128、分组模式为GCM、填充模式为PKCS7的Cipher实例，用于完成解密操作。
40
412. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_init)，设置模式为解密（CRYPTO_DECRYPT_MODE），指定解密密钥（OH_CryptoSymKey）和GCM模式对应的解密参数（OH_CryptoSymCipherParams），初始化解密Cipher实例。
42
433. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update)，更新数据（密文）。
44
454. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取解密后的数据。
46
47- 示例：
48
49```c++
50#include "CryptoArchitectureKit/crypto_common.h"
51#include "CryptoArchitectureKit/crypto_sym_cipher.h"
52#include <string.h>
53
54static OH_Crypto_ErrCode doTestSm4Gcm()
55{
56    OH_CryptoSymKeyGenerator *genCtx = nullptr;
57    OH_CryptoSymCipher *encCtx = nullptr;
58    OH_CryptoSymCipher *decCtx = nullptr;
59    OH_CryptoSymKey *keyCtx = nullptr;
60    OH_CryptoSymCipherParams *params = nullptr;
61
62    Crypto_DataBlob outUpdate = {.data = nullptr, .len = 0};
63    Crypto_DataBlob decUpdate = {.data = nullptr, .len = 0};
64
65    uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8};
66    uint8_t tag[16] = {0};
67    uint8_t iv[12] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4}; // iv使用安全随机数生成。
68    Crypto_DataBlob ivData = {.data = iv, .len = sizeof(iv)};
69    Crypto_DataBlob aadData = {.data = aad, .len = sizeof(aad)};
70    Crypto_DataBlob tagData = {.data = tag, .len = sizeof(tag)};
71    Crypto_DataBlob tagOutPut = {.data = nullptr, .len = 0};
72    char *plainText = const_cast<char *>("this is test!");
73    Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
74    // 生成对称密钥。
75    OH_Crypto_ErrCode ret;
76    ret = OH_CryptoSymKeyGenerator_Create("SM4_128", &genCtx);
77    if (ret != CRYPTO_SUCCESS) {
78        goto end;
79    }
80    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
81    if (ret != CRYPTO_SUCCESS) {
82        goto end;
83    }
84
85    // 设置参数。
86    ret = OH_CryptoSymCipherParams_Create(&params);
87    if (ret != CRYPTO_SUCCESS) {
88        goto end;
89    }
90    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivData);
91    if (ret != CRYPTO_SUCCESS) {
92        goto end;
93    }
94    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadData);
95    if (ret != CRYPTO_SUCCESS) {
96        goto end;
97    }
98    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagData);
99    if (ret != CRYPTO_SUCCESS) {
100        goto end;
101    }
102
103    // 加密。
104    ret = OH_CryptoSymCipher_Create("SM4_128|GCM|PKCS7", &encCtx);
105    if (ret != CRYPTO_SUCCESS) {
106        goto end;
107    }
108    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
109    if (ret != CRYPTO_SUCCESS) {
110        goto end;
111    }
112    ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &outUpdate);
113    if (ret != CRYPTO_SUCCESS) {
114        goto end;
115    }
116    ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tagOutPut);
117    if (ret != CRYPTO_SUCCESS) {
118        goto end;
119    }
120
121    // 解密。
122    ret = OH_CryptoSymCipher_Create("SM4_128|GCM|PKCS7", &decCtx);
123    if (ret != CRYPTO_SUCCESS) {
124        goto end;
125    }
126    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagOutPut);
127    if (ret != CRYPTO_SUCCESS) {
128        goto end;
129    }
130    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
131    if (ret != CRYPTO_SUCCESS) {
132        goto end;
133    }
134    ret = OH_CryptoSymCipher_Final(decCtx, &outUpdate, &decUpdate);
135    if (ret != CRYPTO_SUCCESS) {
136        goto end;
137    }
138
139    // 释放资源。
140end:
141    OH_CryptoSymCipherParams_Destroy(params);
142    OH_CryptoSymCipher_Destroy(encCtx);
143    OH_CryptoSymCipher_Destroy(decCtx);
144    OH_CryptoSymKeyGenerator_Destroy(genCtx);
145    OH_CryptoSymKey_Destroy(keyCtx);
146    OH_Crypto_FreeDataBlob(&outUpdate);
147    OH_Crypto_FreeDataBlob(&decUpdate);
148    OH_Crypto_FreeDataBlob(&tagOutPut);
149    return ret;
150}
151```
152