• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用SM4对称密钥（CBC模式）加解密(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-ndk.md)理解，参考文档与当前示例可能存在入参差异，请在阅读时注意区分。
22
232. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定字符串参数'SM4_128|CBC|PKCS7'，创建对称密钥类型为SM4_128、分组模式为CBC、填充模式为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）和CBC模式对应的加密参数（OH_CryptoSymCipherParams），初始化加密Cipher实例。
28
295. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（明文）。
30
31   - 当数据量较小时，可以在init完成后直接调用final。
32   - 当数据量较大时，可以多次调用update，即分段加解密。
33
346. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取加密后的数据。
35
36   - 由于已使用update传入数据，此处data传入null。
37   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
38
397. 调用[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)销毁各对象。
40
41**解密**
42
431. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定字符串参数'SM4_128|CBC|PKCS7'，创建对称密钥类型为SM4_128、分组模式为CBC、填充模式为PKCS7的Cipher实例，用于完成解密操作。
44
452. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_init)，设置模式为解密（CRYPTO_DECRYPT_MODE），指定解密密钥（OH_CryptoSymKey）和CBC模式对应的解密参数（OH_CryptoSymCipherParams），初始化解密Cipher实例。
46
473. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（密文）。
48
494. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取解密后的数据。
50
51```c++
52#include "CryptoArchitectureKit/crypto_common.h"
53#include "CryptoArchitectureKit/crypto_sym_cipher.h"
54#include <string.h>
55
56static OH_Crypto_ErrCode doTestSm4Cbc()
57{
58    OH_CryptoSymKeyGenerator *genCtx = nullptr;
59    OH_CryptoSymCipher *encCtx = nullptr;
60    OH_CryptoSymCipher *decCtx = nullptr;
61    OH_CryptoSymKey *keyCtx = nullptr;
62    OH_CryptoSymCipherParams *params = nullptr;
63    Crypto_DataBlob outUpdate = {.data = nullptr, .len = 0};
64    Crypto_DataBlob decUpdate = {.data = nullptr, .len = 0};
65
66    char *plainText = const_cast<char *>("this is test!");
67    Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
68    uint8_t iv[16] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4, 3, 1, 0, 10}; // iv使用安全随机数生成。
69    Crypto_DataBlob ivBlob = {.data = iv, .len = sizeof(iv)};
70    // 生成对称密钥。
71    OH_Crypto_ErrCode ret;
72    ret = OH_CryptoSymKeyGenerator_Create("SM4_128", &genCtx);
73    if (ret != CRYPTO_SUCCESS) {
74        goto end;
75    }
76    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
77    if (ret != CRYPTO_SUCCESS) {
78        goto end;
79    }
80
81    // 设置参数。
82    ret = OH_CryptoSymCipherParams_Create(&params);
83    if (ret != CRYPTO_SUCCESS) {
84        goto end;
85    }
86    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivBlob);
87    if (ret != CRYPTO_SUCCESS) {
88        goto end;
89    }
90
91    // 加密。
92    ret = OH_CryptoSymCipher_Create("SM4_128|CBC|PKCS7", &encCtx);
93    if (ret != CRYPTO_SUCCESS) {
94        goto end;
95    }
96    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
97    if (ret != CRYPTO_SUCCESS) {
98        goto end;
99    }
100    ret = OH_CryptoSymCipher_Final(encCtx, &msgBlob, &outUpdate);
101    if (ret != CRYPTO_SUCCESS) {
102        goto end;
103    }
104
105    // 解密。
106    ret = OH_CryptoSymCipher_Create("SM4_128|CBC|PKCS7", &decCtx);
107    if (ret != CRYPTO_SUCCESS) {
108        goto end;
109    }
110    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
111    if (ret != CRYPTO_SUCCESS) {
112        goto end;
113    }
114    ret = OH_CryptoSymCipher_Final(decCtx, &outUpdate, &decUpdate);
115    if (ret != CRYPTO_SUCCESS) {
116        goto end;
117    }
118
119    // 资源释放。
120end:
121    OH_CryptoSymCipherParams_Destroy(params);
122    OH_CryptoSymCipher_Destroy(encCtx);
123    OH_CryptoSymCipher_Destroy(decCtx);
124    OH_CryptoSymKeyGenerator_Destroy(genCtx);
125    OH_CryptoSymKey_Destroy(keyCtx);
126    OH_Crypto_FreeDataBlob(&outUpdate);
127    OH_Crypto_FreeDataBlob(&decUpdate);
128    return ret;
129}
130```