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