• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 安全随机数生成(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> **说明：**
11>
12> 从API version 12开始，轻量级智能穿戴设备支持获取随机数相关操作。
13
14随机数主要用于临时会话密钥生成和非对称加密算法密钥生成等场景。在加解密场景中，安全随机数生成器需要具备随机性、不可预测性与不可重现性。当前系统生成的随机数满足密码学安全伪随机性要求。
15
16开发者可以调用接口，完成以下功能：
17
18- 生成指定长度的安全随机数，并将其用于生成对应的密钥。
19
20- 指定随机种子，生成一系列的随机序列。
21
22在开发前，开发者应该先对加解密基础知识有一定了解，并熟知以下随机数相关的基本概念：
23
24- **内部状态**
25
26  代表随机数生成器内存中的数值，当内部状态相同时，随机数生成器会生成固定的随机数序列。
27
28- **随机种子**
29
30  一个用来对伪随机数的内部状态进行初始化的数据，随机数生成器通过种子来生成一系列的随机序列。
31
32  当前OpenSSL实现方式，随机数生成器内部状态是不断变化的，即使设置相同的种子，生成的随机数序列也不会相同。
33
34## 支持的算法与规格
35
36随机数生成算法使用OpenSSL的RAND_priv_bytes接口生成安全随机数。
37
38| 算法 | 长度（Byte） |
39| -------- | -------- |
40| CTR_DRBG | [1, INT_MAX] |
41
42## 开发步骤
43
441. 调用[cryptoFramework.createRandom](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreaterandom)，生成随机数实例。
45
462. （可选）设置DataBlob数据，调用[Random.setSeed](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#setseed)，为随机数生成池设置种子。
47
483. 设置指定字节长度，调用[Random.generateRandom](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#generaterandom)或[Random.generateRandomSync](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#generaterandomsync10)，生成安全随机数。
49
50   指定字节长度范围为1~INT_MAX。
51
52- 通过await返回异步结果：
53  ```ts
54  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
55
56  async function doRand() {
57    let rand = cryptoFramework.createRandom();
58    let seed = new Uint8Array([1, 2, 3]);
59    rand.setSeed({ data: seed });
60    let len = 12;
61    let randOutput = await rand.generateRandom(len);
62    console.info('rand output:' + randOutput.data);
63  }
64  ```
65
66- 同步返回结果：
67  ```ts
68  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
69  import { BusinessError } from '@kit.BasicServicesKit';
70
71  function doRandBySync() {
72    let rand = cryptoFramework.createRandom();
73    let len = 24; // Generate a 24-byte random number.
74    try {
75      let randData = rand.generateRandomSync(len);
76      if (randData !== null) {
77        console.info("[Sync]: rand result: " + randData.data);
78      } else {
79        console.error("[Sync]: get rand result fail!");
80      }
81    } catch (error) {
82      let e: BusinessError = error as BusinessError;
83      console.error(`do rand failed, ${e.code}, ${e.message}`);
84    }
85  }
86  ```
87