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