• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用3DES对称密钥加解密(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对应的算法规格请查看[对称密钥加解密算法规格：3DES](crypto-sym-encrypt-decrypt-spec.md#3des)。
11
12## 在CMake脚本中链接相关动态库
13```txt
14target_link_libraries(entry PUBLIC libohcrypto.so)
15```
16
17## 开发步骤
18
19**创建对象**
20
21调用[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)，生成密钥算法为3DES、密钥长度为192位的对称密钥（OH_CryptoSymKey）。
22
23   如何生成3DES对称密钥，开发者可参考下文示例，并结合[对称密钥生成和转换规格：3DES](crypto-sym-key-generation-conversion-spec.md#3des)和[指定二进制数据转换对称密钥](crypto-convert-binary-data-to-sym-key-ndk.md)理解，参考文档与当前示例可能存在入参差异，请注意区分。
24
25**加密**
26
271. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定字符串参数'3DES192|ECB|PKCS7'，创建对称密钥类型为3DES192、分组模式为ECB、填充模式为PKCS7的Cipher实例，用于完成加密操作。
28
292. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_init)，设置模式为加密（CRYPTO_ENCRYPT_MODE），指定加密密钥（OH_CryptoSymKey），初始化加密Cipher实例。
30
31   ECB模式无加密参数，params直接传入null。
32
333. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（明文）。
34
35   - 当数据量较小时，可以在init完成后直接调用final。
36   - 当数据量较大时，可以多次调用update，即分段加密。
37
384. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取加密后的数据。
39
40   - 如果使用update接口传入数据，此处data传入null。如果使用final接口传入数据，此处data传入明文数据。
41   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
42
43**解密**
44
451. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定字符串参数'3DES192|ECB|PKCS7'，创建对称密钥类型为3DES192、分组模式为ECB、填充模式为PKCS7的Cipher实例，用于完成解密操作。
46
472. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_init)，设置模式为解密（CRYPTO_DECRYPT_MODE），指定解密密钥（OH_CryptoSymKey），初始化解密Cipher实例。ECB模式无加密参数，传入null。
48
493. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（密文）。
50
51   - 当数据量较小时，可以在init完成后直接调用final。
52   - 当数据量较大时，可以多次调用update，即分段解密。
53   - 用户可以根据数据量大小自行决定操作方式。例如，当数据量超过20时，使用 update。
54
554. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取解密数据。
56
57   - 如果使用update接口传入数据，此处data传入null。如果使用final接口传入数据，此处data传入密文数据。
58   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
59
60**销毁对象**
61
62调用[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_CryptoSymKey_Destroy](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-key-h.md#oh_cryptosymkey_destroy)、[OH_Crypto_FreeDataBlob](../../reference/apis-crypto-architecture-kit/capi-crypto-common-h.md#oh_crypto_freedatablob)释放申请的内存，销毁对象。
63
64## 开发示例
65
66当前示例以ECB分组模式为例，不需要设置加解密参数。
67
68如果使用CBC、CTR、OFB、CFB分组模式，需设置加解密参数IV。请参考[设置加解密参数IV](#设置加解密参数iv)，无论加密还是解密，在生成和初始化Cipher实例时均需修改相关参数。
69
70```c++
71#include "CryptoArchitectureKit/crypto_common.h"
72#include "CryptoArchitectureKit/crypto_sym_cipher.h"
73#include <string.h>
74
75static OH_Crypto_ErrCode doTest3DesEcb()
76{
77    OH_CryptoSymKeyGenerator *genCtx = nullptr;
78    OH_CryptoSymCipher *encCtx = nullptr;
79    OH_CryptoSymCipher *decCtx = nullptr;
80    OH_CryptoSymKey *keyCtx = nullptr;
81    char *plainText = const_cast<char *>("this is test!");
82    Crypto_DataBlob input = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
83    Crypto_DataBlob encData = {.data = nullptr, .len = 0};
84    Crypto_DataBlob decData = {.data = nullptr, .len = 0};
85
86    // 随机生成对称密钥。
87    OH_Crypto_ErrCode ret;
88    ret = OH_CryptoSymKeyGenerator_Create("3DES192", &genCtx);
89    if (ret != CRYPTO_SUCCESS) {
90        goto end;
91    }
92    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
93    if (ret != CRYPTO_SUCCESS) {
94        goto end;
95    }
96
97    // 加密操作。
98    ret = OH_CryptoSymCipher_Create("3DES192|ECB|PKCS7", &encCtx);
99    if (ret != CRYPTO_SUCCESS) {
100        goto end;
101    }
102    // 如果是CBC、CTR、OFB、CFB分段模式，此处需要修改为对应模式并添加加解密参数IV。
103    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, nullptr);
104    if (ret != CRYPTO_SUCCESS) {
105        goto end;
106    }
107    ret = OH_CryptoSymCipher_Final(encCtx, &input, &encData);
108    if (ret != CRYPTO_SUCCESS) {
109        goto end;
110    }
111
112    // 解密操作。
113    ret = OH_CryptoSymCipher_Create("3DES192|ECB|PKCS7", &decCtx);
114    if (ret != CRYPTO_SUCCESS) {
115        goto end;
116    }
117    // 如果是CBC、CTR、OFB、CFB分段模式，此处需要修改为对应模式并添加加解密参数IV。
118    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, nullptr);
119    if (ret != CRYPTO_SUCCESS) {
120        goto end;
121    }
122    ret = OH_CryptoSymCipher_Final(decCtx, &encData, &decData);
123    if (ret != CRYPTO_SUCCESS) {
124        goto end;
125    }
126
127end:
128    OH_CryptoSymCipher_Destroy(encCtx);
129    OH_CryptoSymCipher_Destroy(decCtx);
130    OH_CryptoSymKeyGenerator_Destroy(genCtx);
131    OH_CryptoSymKey_Destroy(keyCtx);
132    OH_Crypto_FreeDataBlob(&encData);
133    OH_Crypto_FreeDataBlob(&decData);
134    return ret;
135}
136```
137
138### 设置加解密参数IV
139
140下述示例为CBC分组模式，需要设置加解密参数IV。
141
142如果分组模式为CBC、CTR、OFB或CFB，需参考如下设置IV。ECB模式无需设置加解密参数。
143
144```c++
145    OH_CryptoSymCipherParams *params = nullptr;
146    uint8_t iv[8] = {1, 2, 4, 12, 3, 4, 2, 3}; // 示例代码iv值，开发者可使用安全随机数生成。
147    Crypto_DataBlob ivBlob = {.data = iv, .len = sizeof(iv)};
148
149    ret = OH_CryptoSymCipherParams_Create(&params);
150    if (ret != CRYPTO_SUCCESS) {
151        goto end;
152    }
153    // 设置参数。
154    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivBlob); // CBC模式只需要设置iv。
155    if (ret != CRYPTO_SUCCESS) {
156        goto end;
157    }
158
159    // 加密。
160    ret = OH_CryptoSymCipher_Create("3DES192|CBC|PKCS7", &encCtx);
161    if (ret != CRYPTO_SUCCESS) {
162        goto end;
163    }
164    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
165    if (ret != CRYPTO_SUCCESS) {
166        goto end;
167    }
168    // 本段代码只展示CBC、CTR、OFB、CFB分段模式的不同，其他流程请参考开发示例。
169```