• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用RSA非对称密钥（PKCS1_OAEP模式）加解密
2
3<!--Kit: Crypto Architecture Kit-->
4<!--Subsystem: Security-->
5<!--Owner: @zxz--3-->
6<!--Designer: @lanming-->
7<!--Tester: @PAFT-->
8<!--Adviser: @zengyawen-->
9
10对应的算法规格请查看[非对称密钥加解密算法规格：RSA](crypto-asym-encrypt-decrypt-spec.md#rsa)。
11
12**加密**
13
141. 调用[cryptoFramework.createAsyKeyGeneratorBySpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreateasykeygeneratorbyspec10)、[AsyKeyGeneratorBySpec.generateKeyPair](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#generatekeypair10)，指定密钥参数，生成RSA非对称密钥对（KeyPair）。
15
16   如何生成RSA非对称密钥对，开发者可参考下文示例，并结合[非对称密钥生成和转换规格：RSA](crypto-asym-key-generation-conversion-spec.md#rsa)和[指定密钥参数生成非对称密钥对](crypto-generate-asym-key-pair-from-key-spec.md)理解，参考文档与当前示例可能存在入参差异，请在阅读时注意区分。
17
182. 调用[cryptoFramework.createCipher](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatecipher)，指定字符串参数'RSA2048|PKCS1_OAEP|SHA256|MGF1_SHA1'，创建非对称密钥类型为RSA2048、填充模式为PKCS1_OAEP、摘要算法为SHA256、掩码摘要为MGF1_SHA1的RSA密钥的Cipher实例，用于完成加解密操作。
19
203. 调用[Cipher.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-1)，设置模式为加密（CryptoMode.ENCRYPT_MODE），指定加密密钥（KeyPair.PubKey），初始化加密Cipher实例。
21
22   非对称密钥无加密参数，直接传入null。
23
244. 在调用Cipher.doFinal前，调用[Cipher.setCipherSpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#setcipherspec10)设置PKCS1_OAEP填充参数pSource。调用[Cipher.getCipherSpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getcipherspec10)可获得OAEP相关参数。
25
265. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，传入明文，获取加密后的数据。
27
28**解密**
29
30
311. 由于RSA算法的Cipher实例不支持重复init操作，需要调用[cryptoFramework.createCipher](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatecipher)，重新生成Cipher实例。
32
332. 调用[Cipher.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-1)，设置模式为解密（CryptoMode.DECRYPT_MODE），指定解密密钥（KeyPair.PriKey）初始化解密Cipher实例。PKCS1模式无加密参数，直接传入null。
34
353. 在调用Cipher.doFinal前，调用[Cipher.setCipherSpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#setcipherspec10)设置PKCS1_OAEP填充参数pSource，此处需要和加密时设置的保持一致。调用[Cipher.getCipherSpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getcipherspec10)可获得OAEP相关参数。
36
374. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，传入密文，获取解密后的数据。
38
39- 异步方法示例：
40
41  ```ts
42  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
43  import { buffer } from '@kit.ArkTS';
44  // 根据密钥参数属性构造RSA非对称密钥对密钥参数。
45  function genRsaKeyPairSpec(nIn: bigint, eIn: bigint, dIn: bigint) {
46    let rsaCommSpec: cryptoFramework.RSACommonParamsSpec = {
47      n: nIn,
48      algName: "RSA",
49      specType: cryptoFramework.AsyKeySpecType.COMMON_PARAMS_SPEC
50    };
51    let rsaKeyPairSpec: cryptoFramework.RSAKeyPairSpec = {
52      params: rsaCommSpec,
53      sk: dIn,
54      pk: eIn,
55      algName: "RSA",
56      specType: cryptoFramework.AsyKeySpecType.KEY_PAIR_SPEC
57    };
58    return rsaKeyPairSpec;
59  }
60  // 生成RSA2048密钥对参数。
61  function genRsa2048KeyPairSpec(): cryptoFramework.RSAKeyPairSpec {
62    let nIn = BigInt("0x9260d0750ae117eee55c3f3deaba74917521a262ee76007cdf8a56755ad73a1598a1408410a01434c3f5bc54a88b57fa19fc4328daea0750a4c44e88cff3b2382621b80f670464433e4336e6d003e8cd65bff211da144b88291c2259a00a72b711c116ef7686e8fee34e4d933c868187bdc26f7be071493c86f7a5941c3510806ad67b0f94d88f5cf5c02a092821d8626e8932b65c5bd8c92049c210932b7afa7ac59c0e886ae5c1edb00d8ce2c57633db26bd6639bff73cee82be9275c402b4cf2a4388da8cf8c64eefe1c5a0f5ab8057c39fa5c0589c3e253f0960332300f94bea44877b588e1edbde97cf2360727a09b775262d7ee552b3319b9266f05a25");
63    let eIn = BigInt("0x010001");
64    let dIn = BigInt("0x6a7df2ca63ead4dda191d614b6b385e0d9056a3d6d5cfe07db1daabee022db08212d97613d3328e0267c9dd23d787abde2afcb306aeb7dfce69246cc73f5c87fdf06030179a2114b767db1f083ff841c025d7dc00cd82435b9a90f695369e94df23d2ce458bc3b3283ad8bba2b8fa1ba62e2dce9accff3799aae7c840016f3ba8e0048c0b6cc4339af7161003a5beb864a0164b2c1c9237b64bc87556994351b27506c33d4bcdfce0f9c491a7d6b0628c7c852be4f0a9c3132b2ed3a2c8881e9aab07e20e17deb074691be677776a78b5c502e05d9bdde72126b3738695e2dd1a0a98a14247c65d8a7ee79432a092cb0721a12df798e44f7cfce0c498147a9b1");
65    return genRsaKeyPairSpec(nIn, eIn, dIn);
66  }
67  async function rsaUseSpecDecryptOAEPPromise() {
68    let plan = "This is a test";
69    // 获得RSA密钥对密钥参数对象。
70    let rsaKeyPairSpec = genRsa2048KeyPairSpec();
71    // 根据RSA密钥对参数生成RSA密钥对。
72    let rsaGeneratorSpec = cryptoFramework.createAsyKeyGeneratorBySpec(rsaKeyPairSpec);
73    let cipher = cryptoFramework.createCipher("RSA2048|PKCS1_OAEP|SHA256|MGF1_SHA1");
74    let decoder = cryptoFramework.createCipher("RSA2048|PKCS1_OAEP|SHA256|MGF1_SHA1");
75    // RSA加解密PKCS1-OAEP模式填充字节流P。
76    let pSource = new Uint8Array([1, 2, 3, 4]); // 此处为示例，可以是任意值，由开发者自行决定。
77    let input: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(plan, 'utf-8').buffer) };
78    // 生成密钥对。
79    let keyPair = await rsaGeneratorSpec.generateKeyPair();
80    // 进行加密操作初始化。
81    await cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, keyPair.pubKey, null);
82    // get和set操作可以放在Cipher对象init之后，此处对cipher进行set和get操作。
83    cipher.setCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR, pSource);
84    let retP = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR);
85    // 比较get出来的P字节流与set进去的P字节流是否一致。
86    if (retP.toString() !== pSource.toString()) {
87      console.error("error init pSource" + retP);
88    } else {
89      console.info("pSource changed ==" + retP);
90    }
91    // 进行OAEP其他参数的get操作。
92    let md = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MD_NAME_STR);
93    console.info("md == " + md);
94    let mgf = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF_NAME_STR);
95    console.info("mgf == " + mgf);
96    let mgf1Md = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_MD_STR);
97    console.info("mgf1Md == " + mgf1Md);
98    let cipherDataBlob = await cipher.doFinal(input);
99    // get和set操作可以放在Cipher对象init之前，且与init之后等价，此处对decoder进行set和get操作。
100    decoder.setCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR, pSource);
101    retP = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR);
102    // 比较get出来的P字节流与set进去的P字节流是否一致。
103    if (retP.toString() !== pSource.toString()) {
104      console.error("error init pSource" + retP);
105    } else {
106      console.info("pSource changed ==" + retP);
107    }
108    // 进行OAEP其他参数的get操作。
109    md = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MD_NAME_STR);
110    console.info("md == " + md);
111    mgf = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF_NAME_STR);
112    console.info("mgf == " + mgf);
113    mgf1Md = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_MD_STR);
114    console.info("mgf1Md == " + mgf1Md);
115    // 初始化解密操作。
116    await decoder.init(cryptoFramework.CryptoMode.DECRYPT_MODE, keyPair.priKey, null);
117    let decodeData = await decoder.doFinal(cipherDataBlob);
118    // 解密成功。
119    if (decodeData.data.toString() === input.data.toString()) {
120      console.info("oaep decrypt success");
121    } else {
122      console.error("oaep decrypt fail");
123    }
124  }
125  ```
126
127- 同步方法示例：
128
129  ```ts
130  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
131  import { buffer } from '@kit.ArkTS';
132  // 根据密钥参数属性构造RSA非对称密钥对密钥参数。
133  function genRsaKeyPairSpec(nIn: bigint, eIn: bigint, dIn: bigint) {
134    let rsaCommSpec: cryptoFramework.RSACommonParamsSpec = {
135      n: nIn,
136      algName: "RSA",
137      specType: cryptoFramework.AsyKeySpecType.COMMON_PARAMS_SPEC
138    };
139    let rsaKeyPairSpec: cryptoFramework.RSAKeyPairSpec = {
140      params: rsaCommSpec,
141      sk: dIn,
142      pk: eIn,
143      algName: "RSA",
144      specType: cryptoFramework.AsyKeySpecType.KEY_PAIR_SPEC
145    };
146    return rsaKeyPairSpec;
147  }
148  // 生成RSA2048密钥对参数。
149  function genRsa2048KeyPairSpec(): cryptoFramework.RSAKeyPairSpec {
150    let nIn = BigInt("0x9260d0750ae117eee55c3f3deaba74917521a262ee76007cdf8a56755ad73a1598a1408410a01434c3f5bc54a88b57fa19fc4328daea0750a4c44e88cff3b2382621b80f670464433e4336e6d003e8cd65bff211da144b88291c2259a00a72b711c116ef7686e8fee34e4d933c868187bdc26f7be071493c86f7a5941c3510806ad67b0f94d88f5cf5c02a092821d8626e8932b65c5bd8c92049c210932b7afa7ac59c0e886ae5c1edb00d8ce2c57633db26bd6639bff73cee82be9275c402b4cf2a4388da8cf8c64eefe1c5a0f5ab8057c39fa5c0589c3e253f0960332300f94bea44877b588e1edbde97cf2360727a09b775262d7ee552b3319b9266f05a25");
151    let eIn = BigInt("0x010001");
152    let dIn = BigInt("0x6a7df2ca63ead4dda191d614b6b385e0d9056a3d6d5cfe07db1daabee022db08212d97613d3328e0267c9dd23d787abde2afcb306aeb7dfce69246cc73f5c87fdf06030179a2114b767db1f083ff841c025d7dc00cd82435b9a90f695369e94df23d2ce458bc3b3283ad8bba2b8fa1ba62e2dce9accff3799aae7c840016f3ba8e0048c0b6cc4339af7161003a5beb864a0164b2c1c9237b64bc87556994351b27506c33d4bcdfce0f9c491a7d6b0628c7c852be4f0a9c3132b2ed3a2c8881e9aab07e20e17deb074691be677776a78b5c502e05d9bdde72126b3738695e2dd1a0a98a14247c65d8a7ee79432a092cb0721a12df798e44f7cfce0c498147a9b1");
153    return genRsaKeyPairSpec(nIn, eIn, dIn);
154  }
155  function main() {
156    let plan = "This is a test";
157    // 获得RSA密钥对密钥参数对象。
158    let rsaKeyPairSpec = genRsa2048KeyPairSpec();
159    // 根据RSA密钥对参数生成RSA密钥对。
160    let rsaGeneratorSpec = cryptoFramework.createAsyKeyGeneratorBySpec(rsaKeyPairSpec);
161    let cipher = cryptoFramework.createCipher("RSA2048|PKCS1_OAEP|SHA256|MGF1_SHA1");
162    let decoder = cryptoFramework.createCipher("RSA2048|PKCS1_OAEP|SHA256|MGF1_SHA1");
163    // RSA加解密PKCS1-OAEP模式填充字节流P。
164    let pSource = new Uint8Array([1, 2, 3, 4]); // 此处为示例，可以是任意值，由开发者自行决定。
165    let input: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(plan, 'utf-8').buffer) };
166    // 生成密钥对。
167    let keyPair = rsaGeneratorSpec.generateKeyPairSync();
168    // 进行加密操作初始化。
169    cipher.initSync(cryptoFramework.CryptoMode.ENCRYPT_MODE, keyPair.pubKey, null);
170    // get和set操作可以放在Cipher对象init之后，此处对cipher进行set和get操作。
171    cipher.setCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR, pSource);
172    let retP = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR);
173    // 比较get出来的P字节流与set进去的P字节流是否一致。
174    if (retP.toString() !== pSource.toString()) {
175      console.error("error init pSource" + retP);
176    } else {
177      console.info("pSource changed ==" + retP);
178    }
179    // 进行OAEP其他参数的get操作。
180    let md = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MD_NAME_STR);
181    console.info("md == " + md);
182    let mgf = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF_NAME_STR);
183    console.info("mgf == " + mgf);
184    let mgf1Md = cipher.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_MD_STR);
185    console.info("mgf1Md == " + mgf1Md);
186    let cipherDataBlob = cipher.doFinalSync(input);
187    // get和set操作可以放在Cipher对象init之前，且与init之后等价，此处对decoder进行set和get操作。
188    decoder.setCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR, pSource);
189    retP = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_PSRC_UINT8ARR);
190    // 比较get出来的P字节流与set进去的P字节流是否一致。
191    if (retP.toString() !== pSource.toString()) {
192      console.error("error init pSource" + retP);
193    } else {
194      console.info("pSource changed ==" + retP);
195    }
196    // 进行OAEP其他参数的get操作。
197    md = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MD_NAME_STR);
198    console.info("md == " + md);
199    mgf = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF_NAME_STR);
200    console.info("mgf == " + mgf);
201    mgf1Md = decoder.getCipherSpec(cryptoFramework.CipherSpecItem.OAEP_MGF1_MD_STR);
202    console.info("mgf1Md == " + mgf1Md);
203    // 初始化解密操作。
204    decoder.initSync(cryptoFramework.CryptoMode.DECRYPT_MODE, keyPair.priKey, null);
205    let decodeData = decoder.doFinalSync(cipherDataBlob);
206    // 解密成功。
207    if (decodeData.data.toString() === input.data.toString()) {
208      console.info("oaep decrypt success");
209    } else {
210      console.error("oaep decrypt fail");
211    }
212  }
213  ```