• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# CA证书开发指导
2
3> **说明**
4>
5> 本开发指导需使用API version 12及以上版本SDK。
6
7## 场景说明
8
9典型场景。
10
11- 安装用户CA证书。调用者可以将用户CA证书安装在当前用户或者设备公共位置下。
12  - 安装在当前用户时，仅当前用户的业务可以访问该证书。
13  - 安装在设备公共位置下，所有用户下的业务都可以访问。
14- 获取用户CA证书列表。可以选择获取当前用户或者设备公共位置下的用户CA证书列表。
15- 获取用户CA证书详情。
16- 删除指定的用户CA证书。
17- 获取CA证书的存储路径。
18
19## 接口说明
20
21详细接口说明可参考[API参考](../../reference/apis-device-certificate-kit/js-apis-certManager.md)。
22
23以上场景涉及的常用接口如下表所示。
24
25| 实例名          | 接口名                                                       | 描述                                         |
26| --------------- | ------------------------------------------------------------ | -------------------------------------------- |
27| certificateManager        | installUserTrustedCertificateSync(cert: Uint8Array, certScope: CertScope) : CMResult<sup>18+</sup> | 安装用户CA证书。        |
28| certificateManager        | uninstallUserTrustedCertificateSync(certUri: string) : void<sup>18+</sup> | 删除用户CA证书。       |
29| certificateManager        | getAllUserTrustedCertificates(): Promise\<CMResult> | 获取当前用户和设备公共位置的所有用户根CA证书列表。 |
30| certificateManager        | getAllUserTrustedCertificates(scope: CertScope): Promise\<CMResult><sup>18+</sup> | 根据证书的位置获取用户根CA证书列表。 |
31| certificateManager        | getUserTrustedCertificate(certUri: string): Promise\<CMResult> | 获取用户根CA证书的详细信息。 |
32| certificateManager | getCertificateStorePath(property: CertStoreProperty): string<sup>18+</sup> | 获取证书的存储路径。 |
33
34## 开发步骤
35
361. 权限申请和声明。
37
38    使用安装和删除接口需要申请权限：ohos.permission.ACCESS_ENTERPRISE_USER_TRUSTED_CERT或ohos.permission.ACCESS_USER_TRUSTED_CERT
39
40    使用获取列表和获取详情接口需要申请权限：ohos.permission.ACCESS_CERT_MANAGER
41
42    申请流程请参考：[申请应用权限](../AccessToken/determine-application-mode.md)
43
44    声明权限请参考：[声明权限](../AccessToken/declare-permissions.md)
45
462. 导入相关模块。
47
48   ```ts
49   import { certificateManager } from '@kit.DeviceCertificateKit';
50   ```
51
523. 安装用户CA证书、获取用户CA证书列表、获取用户证书详情、删除用户CA证书。
53
54   ```ts
55   async function userCASample() {
56     /* 安装的用户CA证书数据需要业务赋值。 */
57     let userCAData: Uint8Array = new Uint8Array([
58       0x30, 0x82, 0x01, 0x2E, 0x30, 0x81, 0xD5, 0x02, 0x14, 0x28, 0x75, 0x71, 0x22, 0xDF, 0xDC, 0xCB,
59       0xD4, 0xE5, 0x6B, 0x6B, 0x89, 0xEB, 0x77, 0x97, 0xF6, 0x1D, 0xF4, 0x62, 0x81, 0x30, 0x0A, 0x06,
60       0x08, 0x2A, 0x86, 0x48, 0xCE, 0x3D, 0x04, 0x03, 0x02, 0x30, 0x1A, 0x31, 0x18, 0x30, 0x16, 0x06,
61       0x03, 0x55, 0x04, 0x03, 0x0C, 0x0F, 0x45, 0x78, 0x61, 0x6D, 0x70, 0x6C, 0x65, 0x20, 0x52, 0x6F,
62       0x6F, 0x74, 0x20, 0x43, 0x41, 0x30, 0x1E, 0x17, 0x0D, 0x32, 0x35, 0x30, 0x32, 0x32, 0x37, 0x31,
63       0x31, 0x35, 0x38, 0x30, 0x34, 0x5A, 0x17, 0x0D, 0x32, 0x37, 0x31, 0x31, 0x32, 0x33, 0x31, 0x31,
64       0x35, 0x38, 0x30, 0x34, 0x5A, 0x30, 0x1A, 0x31, 0x18, 0x30, 0x16, 0x06, 0x03, 0x55, 0x04, 0x03,
65       0x0C, 0x0F, 0x45, 0x78, 0x61, 0x6D, 0x70, 0x6C, 0x65, 0x20, 0x52, 0x6F, 0x6F, 0x74, 0x20, 0x43,
66       0x41, 0x30, 0x59, 0x30, 0x13, 0x06, 0x07, 0x2A, 0x86, 0x48, 0xCE, 0x3D, 0x02, 0x01, 0x06, 0x08,
67       0x2A, 0x86, 0x48, 0xCE, 0x3D, 0x03, 0x01, 0x07, 0x03, 0x42, 0x00, 0x04, 0x39, 0xCC, 0xE1, 0x3F,
68       0x36, 0x57, 0x73, 0x82, 0x28, 0x56, 0xBB, 0xE7, 0x97, 0x6C, 0xA9, 0x66, 0x3E, 0xD7, 0x2C, 0xF2,
69       0x7B, 0x05, 0x81, 0xE8, 0xA4, 0x57, 0x90, 0x5D, 0x64, 0x6A, 0xAD, 0x30, 0x2F, 0x1D, 0x6F, 0x31,
70       0x31, 0xCB, 0x35, 0x84, 0x7F, 0xF6, 0xE4, 0xD5, 0x7B, 0x66, 0xDD, 0x93, 0x2B, 0x0C, 0x1B, 0x42,
71       0xA4, 0x68, 0xE3, 0xC6, 0x9C, 0xF5, 0xFE, 0x66, 0x78, 0xF7, 0xBD, 0x9C, 0x30, 0x0A, 0x06, 0x08,
72       0x2A, 0x86, 0x48, 0xCE, 0x3D, 0x04, 0x03, 0x02, 0x03, 0x48, 0x00, 0x30, 0x45, 0x02, 0x21, 0x00,
73       0xCC, 0xA7, 0x34, 0xC5, 0xC0, 0x31, 0x36, 0x19, 0x3F, 0xA4, 0x34, 0x48, 0xC3, 0x2C, 0x7D, 0x33,
74       0x1F, 0x0A, 0xCF, 0xB0, 0x73, 0x58, 0x6B, 0xB7, 0xC9, 0xAE, 0x16, 0x34, 0xF1, 0x8F, 0xAF, 0xC8,
75       0x02, 0x20, 0x70, 0x9C, 0x64, 0xC2, 0xE2, 0x60, 0x26, 0x01, 0x5F, 0xF2, 0x0B, 0x8C, 0x9F, 0x7D,
76       0x18, 0x6E, 0x91, 0xA6, 0xB3, 0x5E, 0x2C, 0xF0, 0x68, 0x45, 0x11, 0x1D, 0xA0, 0xCB, 0x83, 0xEB,
77       0xE6, 0x25,
78     ]);
79
80     let certUri: string = '';
81     let certScope = certificateManager.CertScope.CURRENT_USER;
82     try {
83       /* 在当前用户下，安装用户CA证书。 */
84       let result = certificateManager.installUserTrustedCertificateSync(userCAData, certScope);
85       certUri = (result.uri != undefined) ? result.uri : '';
86       console.info(`Succeeded in install user ca cert, certUri is ${certUri}`);
87     } catch (err) {
88       console.error(`Failed to install user ca cert. Code: ${err.code}, message: ${err.message}`);
89     }
90
91     try {
92       /* 获取用户CA证书详情。 */
93       let result = await certificateManager.getUserTrustedCertificate(certUri);
94       if (result === undefined || result.certInfo == undefined) {
95         console.error('The result of getting user ca cert is undefined.');
96       } else {
97         let certInfo = result.certInfo;
98         console.info('Succeeded in getting user ca cert.');
99       }
100     } catch (err) {
101       console.error(`Failed to get user ca certificate. Code: ${err.code}, message: ${err.message}`);
102     }
103
104     try {
105       /* 获取当前用户下的用户CA证书列表。 */
106       let result = await certificateManager.getAllUserTrustedCertificates(certScope);
107       if (result == undefined) { /* 用户根CA证书个数为0时，返回result为undefined。 */
108         console.info('the count of the user trusted certificates is 0');
109       } else if (result.certList == undefined) {
110         console.error('The result of getting current user trusted certificates is undefined.');
111       } else {
112         let list = result.certList;
113         console.info('Succeeded in getting user ca cert list.');
114       }
115     } catch (err) {
116       console.error(`Failed to get user ca certificate. Code: ${err.code}, message: ${err.message}`);
117     }
118
119     try {
120       /* 删除安装的用户CA证书。 */
121       certificateManager.uninstallUserTrustedCertificateSync(certUri);
122     } catch (err) {
123       console.error(`Failed to uninstall user ca certificate. Code: ${err.code}, message: ${err.message}`);
124     }
125   }
126   ```
127
1284. 获取系统CA证书路径、用户CA证书路径。应用可以直接通过该路径访问CA证书。
129
130   ```ts
131   function getUserCAPath() {
132     try {
133       /* 获取系统CA的存储位置。 */
134       let property1: certificateManager.CertStoreProperty = {
135         certType: certificateManager.CertType.CA_CERT_SYSTEM,
136       }
137       let systemCAPath = certificateManager.getCertificateStorePath(property1);
138       console.info(`Success to get system ca path: ${systemCAPath}`);
139
140       /* 获取当前用户的用户CA存储位置。 */
141       let property2: certificateManager.CertStoreProperty = {
142         certType: certificateManager.CertType.CA_CERT_USER,
143         certScope: certificateManager.CertScope.CURRENT_USER,
144       }
145       let userCACurrentPath = certificateManager.getCertificateStorePath(property2);
146       console.info(`Success to get current user's user ca path: ${userCACurrentPath}`);
147
148       /* 获取设备公共的用户CA存储位置。 */
149       let property3: certificateManager.CertStoreProperty = {
150         certType: certificateManager.CertType.CA_CERT_USER,
151         certScope: certificateManager.CertScope.GLOBAL_USER,
152       }
153       let globalCACurrentPath = certificateManager.getCertificateStorePath(property3);
154       console.info(`Success to get global user's user ca path: ${globalCACurrentPath}`);
155     } catch (error) {
156       console.error(`Failed to get store path. Code: ${error.code}, message: ${error.message}`);
157     }
158   }
159   ```