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-ndk.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. 将一次传入数据量设置为20字节，多次调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（明文）。 30 31 - 当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。 32 - 建议开发者对每次update的结果都判断是否为null，并在结果不为null时取出其中的数据进行拼接，形成完整的密文。因为在不同的规格下，update的结果可能会受到不同影响。 33 34 1）比如ECB和CBC模式，始终以分组作为基本单位来加密，并输出本次update产生的加密分组结果。即当本次update操作凑满一个分组就输出密文，没有凑满则此次update输出null，将未加密的数据与下次输入的数据拼接凑分组再输出。等到最后doFinal的时候，将未加密的数据，根据指定的填充模式进行填充，在输出剩余加密结果。解密过程中的update同理。 35 36 2）对于流加密模式（比如CTR和OFB模式），通常密文长度和明文长度相等。 37 386. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取加密后的数据。 39 40 - 由于已使用update传入数据，此处data传入null。 41 - doFinal输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。 42 437. 使用[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，作为解密的认证信息。 44 在GCM模式下，需要从加密后的数据中取出末尾16字节，作为解密时初始化的认证信息。示例中authTag恰好为16字节。 45 468. 调用[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)销毁各对象。 47 48**解密** 49 501. 调用[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实例，用于完成解密操作。 51 522. 调用[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实例。 53 543. 将一次传入数据量设置为20字节，多次调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（密文）。 55 564. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取解密后的数据。 57 58```c++ 59#include <string.h> 60#include "CryptoArchitectureKit/crypto_common.h" 61#include "CryptoArchitectureKit/crypto_sym_cipher.h" 62 63#define OH_CRYPTO_GCM_TAG_LEN 16 64#define OH_CRYPTO_MAX_TEST_DATA_LEN 128 65static OH_Crypto_ErrCode doTestSm4GcmSeg() 66{ 67 OH_CryptoSymKeyGenerator *genCtx = nullptr; 68 OH_CryptoSymCipher *encCtx = nullptr; 69 OH_CryptoSymCipher *decCtx = nullptr; 70 OH_CryptoSymKey *keyCtx = nullptr; 71 OH_CryptoSymCipherParams *params = nullptr; 72 73 char *plainText = const_cast<char *>("aaaaa.....bbbbb.....ccccc.....ddddd.....eee"); 74 Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)}; 75 uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8}; 76 uint8_t tagArr[16] = {0}; 77 uint8_t iv[12] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4}; // iv使用安全随机数生成。 78 Crypto_DataBlob tag = {.data = nullptr, .len = 0}; 79 Crypto_DataBlob ivBlob = {.data = iv, .len = sizeof(iv)}; 80 Crypto_DataBlob aadBlob = {.data = aad, .len = sizeof(aad)}; 81 Crypto_DataBlob outUpdate = {.data = nullptr, .len = 0}; 82 Crypto_DataBlob decUpdate = {.data = nullptr, .len = 0}; 83 Crypto_DataBlob tagInit = {.data = tagArr, .len = sizeof(tagArr)}; 84 int32_t cipherLen = 0; 85 int blockSize = 20; 86 int32_t randomLen = strlen(plainText); 87 int cnt = randomLen / blockSize; 88 int rem = randomLen % blockSize; 89 uint8_t cipherText[OH_CRYPTO_MAX_TEST_DATA_LEN] = {0}; 90 Crypto_DataBlob cipherBlob; 91 92 // 生成密钥。 93 OH_Crypto_ErrCode ret; 94 ret = OH_CryptoSymKeyGenerator_Create("SM4_128", &genCtx); 95 if (ret != CRYPTO_SUCCESS) { 96 goto end; 97 } 98 ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx); 99 if (ret != CRYPTO_SUCCESS) { 100 goto end; 101 } 102 103 // 设置参数。 104 ret = OH_CryptoSymCipherParams_Create(¶ms); 105 if (ret != CRYPTO_SUCCESS) { 106 goto end; 107 } 108 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivBlob); 109 if (ret != CRYPTO_SUCCESS) { 110 goto end; 111 } 112 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadBlob); 113 if (ret != CRYPTO_SUCCESS) { 114 goto end; 115 } 116 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagInit); 117 if (ret != CRYPTO_SUCCESS) { 118 goto end; 119 } 120 121 // 加密。 122 ret = OH_CryptoSymCipher_Create("SM4_128|GCM|PKCS7", &encCtx); 123 if (ret != CRYPTO_SUCCESS) { 124 goto end; 125 } 126 ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params); 127 if (ret != CRYPTO_SUCCESS) { 128 goto end; 129 } 130 131 for (int i = 0; i < cnt; i++) { 132 msgBlob.len = blockSize; 133 ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &outUpdate); 134 if (ret != CRYPTO_SUCCESS) { 135 goto end; 136 } 137 msgBlob.data += blockSize; 138 memcpy(&cipherText[cipherLen], outUpdate.data, outUpdate.len); 139 cipherLen += outUpdate.len; 140 } 141 if (rem > 0) { 142 msgBlob.len = rem; 143 ret = OH_CryptoSymCipher_Update(encCtx, (Crypto_DataBlob *)&msgBlob, &outUpdate); 144 if (ret != CRYPTO_SUCCESS) { 145 goto end; 146 } 147 memcpy(&cipherText[cipherLen], outUpdate.data, outUpdate.len); 148 cipherLen += outUpdate.len; 149 } 150 ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tag); 151 if (ret != CRYPTO_SUCCESS) { 152 goto end; 153 } 154 155 // 解密。 156 cipherBlob = {.data = reinterpret_cast<uint8_t *>(cipherText), .len = (size_t)cipherLen}; 157 msgBlob.data -= strlen(plainText) - rem; 158 msgBlob.len = strlen(plainText); 159 ret = OH_CryptoSymCipher_Create("SM4_128|GCM|PKCS7", &decCtx); 160 if (ret != CRYPTO_SUCCESS) { 161 goto end; 162 } 163 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tag); 164 if (ret != CRYPTO_SUCCESS) { 165 goto end; 166 } 167 ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params); 168 if (ret != CRYPTO_SUCCESS) { 169 goto end; 170 } 171 ret = OH_CryptoSymCipher_Final(decCtx, &cipherBlob, &decUpdate); 172 if (ret != CRYPTO_SUCCESS) { 173 goto end; 174 } 175end: 176 OH_CryptoSymCipherParams_Destroy(params); 177 OH_CryptoSymCipher_Destroy(encCtx); 178 OH_CryptoSymCipher_Destroy(decCtx); 179 OH_CryptoSymKeyGenerator_Destroy(genCtx); 180 OH_CryptoSymKey_Destroy(keyCtx); 181 OH_Crypto_FreeDataBlob(&outUpdate); 182 OH_Crypto_FreeDataBlob(&tag); 183 OH_Crypto_FreeDataBlob(&decUpdate); 184 return ret; 185} 186``` 187