• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用RSA密钥对（PKCS1模式）签名验签(ArkTS)
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-sign-sig-verify-overview.md#rsa)。
11
12**签名**
13
141. 调用[cryptoFramework.createAsyKeyGenerator](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreateasykeygenerator)、[AsyKeyGenerator.generateKeyPair](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#generatekeypair-1)，生成密钥算法为RSA、密钥长度为1024位、素数个数为2的非对称密钥对象（KeyPair），包括公钥（PubKey）和私钥（PriKey）。
15
16   如何生成RSA非对称密钥，开发者可参考下文示例，并结合[非对称密钥生成和转换规格：RSA](crypto-asym-key-generation-conversion-spec.md#rsa)和[随机生成非对称密钥对](crypto-generate-asym-key-pair-randomly.md)理解，参考文档与当前示例可能存在入参差异，请在阅读时注意区分。
17
182. 调用[cryptoFramework.createSign](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatesign)，指定字符串参数'RSA1024|PKCS1|SHA256'，创建非对称密钥类型为RSA1024、填充模式为PKCS1、摘要算法为SHA256的Sign实例，用于完成签名操作。
19
203. 调用[Sign.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-3)，使用私钥（PriKey）初始化Sign实例。
21
224. 调用[Sign.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-3)，传入待签名的数据。
23
24   当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
25
26   - 当待签名的数据较短时，可以在init完成后直接调用sign。
27   - 当数据量较大时，可以多次调用update，即[分段签名验签](crypto-rsa-sign-sig-verify-pkcs1-by-segment.md)。
28
295. 调用[Sign.sign](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#sign-1)，生成数据签名。
30
31**验签**
32
331. 调用[cryptoFramework.createVerify](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreateverify)，指定字符串参数'RSA1024|PKCS1|SHA256'，与签名的Sign实例保持一致。创建Verify实例，用于完成验签操作。
34
352. 调用[Verify.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-5)，使用公钥（PubKey）初始化Verify实例。
36
373. 调用[Verify.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-5)，传入待验证的数据。
38   当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
39
40   - 当待签名的数据较短时，可以在init完成后直接调用verify。
41   - 当数据量较大时，可以多次调用update，即[分段签名验签](crypto-rsa-sign-sig-verify-pkcs1-by-segment.md)。
42
434. 调用[Verify.verify](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#verify-1)，对数据进行验签。
44
45- 异步方法示例：
46
47  ```ts
48  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
49  import { buffer } from '@kit.ArkTS';
50  // 完整的明文被拆分为input1和input2。
51  let input1: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from("This is Sign test plan1", 'utf-8').buffer) };
52  let input2: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from("This is Sign test plan2", 'utf-8').buffer) };
53  async function signMessagePromise(priKey: cryptoFramework.PriKey) {
54    let signAlg = "RSA1024|PKCS1|SHA256";
55    let signer = cryptoFramework.createSign(signAlg);
56    await signer.init(priKey);
57    await signer.update(input1); // 如果明文较短，可以直接调用sign接口一次性传入。
58    let signData = await signer.sign(input2);
59    return signData;
60  }
61  async function verifyMessagePromise(signMessageBlob: cryptoFramework.DataBlob, pubKey: cryptoFramework.PubKey) {
62    let verifyAlg = "RSA1024|PKCS1|SHA256";
63    let verifier = cryptoFramework.createVerify(verifyAlg);
64    await verifier.init(pubKey);
65    await verifier.update(input1); // 如果明文较短，可以直接调用verify接口一次性传入。
66    let res = await verifier.verify(input2, signMessageBlob);
67    console.info("verify result is " + res);
68    return res;
69  }
70  async function main() {
71    let keyGenAlg = "RSA1024";
72    let generator = cryptoFramework.createAsyKeyGenerator(keyGenAlg);
73    let keyPair = await generator.generateKeyPair();
74    let signData = await signMessagePromise(keyPair.priKey);
75    let verifyResult = await verifyMessagePromise(signData, keyPair.pubKey);
76    if (verifyResult === true) {
77      console.info('verify success');
78    } else {
79      console.error('verify failed');
80    }
81  }
82  ```
83
84- 同步方法示例：
85
86  ```ts
87  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
88  import { buffer } from '@kit.ArkTS';
89  // 完整的明文被拆分为input1和input2。
90  let input1: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from("This is Sign test plan1", 'utf-8').buffer) };
91  let input2: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from("This is Sign test plan2", 'utf-8').buffer) };
92  function signMessagePromise(priKey: cryptoFramework.PriKey) {
93    let signAlg = "RSA1024|PKCS1|SHA256";
94    let signer = cryptoFramework.createSign(signAlg);
95    signer.initSync(priKey);
96    signer.updateSync(input1); // 如果明文较短，可以直接调用sign接口一次性传入。
97    let signData = signer.signSync(input2);
98    return signData;
99  }
100  function verifyMessagePromise(signMessageBlob: cryptoFramework.DataBlob, pubKey: cryptoFramework.PubKey) {
101    let verifyAlg = "RSA1024|PKCS1|SHA256";
102    let verifier = cryptoFramework.createVerify(verifyAlg);
103    verifier.initSync(pubKey);
104    verifier.updateSync(input1); // 如果明文较短，可以直接调用verify接口一次性传入。
105    let res = verifier.verifySync(input2, signMessageBlob);
106    console.info("verify result is " + res);
107    return res;
108  }
109  function main() {
110    let keyGenAlg = "RSA1024";
111    let generator = cryptoFramework.createAsyKeyGenerator(keyGenAlg);
112    let keyPair = generator.generateKeyPairSync();
113    let signData = signMessagePromise(keyPair.priKey);
114    let verifyResult = verifyMessagePromise(signData, keyPair.pubKey);
115    if (verifyResult === true) {
116      console.info('verify success');
117    } else {
118      console.error('verify failed');
119    }
120  }
121  ```