• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 生成密钥(ArkTS)
2
3以生成DH密钥为例，生成随机密钥。具体的场景介绍及支持的算法规格，请参考[密钥生成支持的算法](huks-key-generation-overview.md#支持的算法)。
4
5> **注意：**
6> 密钥别名中禁止包含个人数据等敏感信息。
7
8## 开发步骤
9
101. 指定待生成的密钥别名keyAlias。
11   - 密钥别名的最大长度为128字节，建议不包含个人信息等敏感词汇。
12   - 对于不同业务间生成的密钥，HUKS将基于业务身份信息进行存储路径隔离，不会因为和其他业务密钥同名导致冲突。
13
142. 初始化密钥属性集。通过[HuksParam](../../reference/apis-universal-keystore-kit/js-apis-huks.md#huksparam)封装密钥属性，搭配Array组成密钥属性集，并赋值给[HuksOptions](../../reference/apis-universal-keystore-kit/js-apis-huks.md#huksoptions)中的properties字段。
15   密钥属性集中必须包含[HuksKeyAlg](../../reference/apis-universal-keystore-kit/js-apis-huks.md#hukskeyalg)、[HuksKeySize](../../reference/apis-universal-keystore-kit/js-apis-huks.md#hukskeysize)、[HuksKeyPurpose](../../reference/apis-universal-keystore-kit/js-apis-huks.md#hukskeypurpose)属性，即必传TAG，HUKS_TAG_ALGORITHM、HUKS_TAG_PURPOSE、HUKS_TAG_KEY_SIZE。注：一个密钥只能有一类PURPOSE，并且，生成密钥时指定的用途要与使用时的方式一致，否则会导致异常，请参考[密钥用途](huks-key-generation-overview.md#密钥用途)。
16
173. 调用[huks.generateKeyItem](../../reference/apis-universal-keystore-kit/js-apis-huks.md#huksgeneratekeyitem9)，传入密钥别名和密钥属性集，生成密钥。
18
19> **说明：**
20> 如果业务再次使用相同别名调用HUKS生成密钥，HUKS将生成新密钥并直接覆盖历史的密钥文件。
21
22```ts
23/* 以下以生成DH密钥为例 */
24import { huks } from '@kit.UniversalKeystoreKit';
25
26/* 1.确定密钥别名 */
27let keyAlias = 'dh_key';
28/* 2.初始化密钥属性集 */
29let properties1: Array<huks.HuksParam> = [
30  {
31    tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
32    value: huks.HuksKeyAlg.HUKS_ALG_DH
33  },
34  {
35    tag: huks.HuksTag.HUKS_TAG_PURPOSE,
36    value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_AGREE
37  },
38  {
39    tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
40    value: huks.HuksKeySize.HUKS_DH_KEY_SIZE_2048
41  }
42];
43let huksOptions: huks.HuksOptions = {
44  properties: properties1,
45  inData: new Uint8Array(new Array())
46}
47
48/* 3.生成密钥 */
49function generateKeyItem(keyAlias: string, huksOptions: huks.HuksOptions) {
50  return new Promise<void>((resolve, reject) => {
51    try {
52      huks.generateKeyItem(keyAlias, huksOptions, (error, data) => {
53        if (error) {
54          reject(error);
55        } else {
56          resolve(data);
57        }
58      });
59    } catch (error) {
60      throw (error as Error);
61    }
62  });
63}
64
65async function publicGenKeyFunc(keyAlias: string, huksOptions: huks.HuksOptions) {
66  console.info(`enter promise generateKeyItem`);
67  try {
68    await generateKeyItem(keyAlias, huksOptions)
69      .then((data) => {
70        console.info(`promise: generateKeyItem success, data = ${JSON.stringify(data)}`);
71      })
72      .catch((error: Error) => {
73        console.error(`promise: generateKeyItem failed, ${JSON.stringify(error)}`);
74      });
75  } catch (error) {
76    console.error(`promise: generateKeyItem input arg invalid, ` + JSON.stringify(error));
77  }
78}
79
80async function TestGenKey() {
81  await publicGenKeyFunc(keyAlias, huksOptions);
82}
83```
84