证书管理对话框开发指导

说明

本开发指导需使用API version 13及以上版本SDK。

证书管理对话框,可用于拉起证书管理页面并管理证书,如安装、存储、使用、销毁证书。

接口说明

详细接口说明可参考API参考

以上场景涉及的常用接口如下表所示。

实例名 接口名 描述
certificateManagerDialog openCertificateManagerDialog(context: common.Context, pageType: CertificateDialogPageType): Promise<void> 拉起证书管理对话框,显示相应的页面,使用Promise方式异步返回结果。
certificateManagerDialog openInstallCertificateDialog(context: common.Context, certType: CertificateType, certScope: CertificateScope, cert: Uint8Array): Promise<string>14+ 调用安装证书对话框接口进行证书安装,使用Promise方式异步返回安装证书的唯一标识符。
仅2in1设备支持。
certificateManagerDialog openUninstallCertificateDialog(context: common.Context, certType: CertificateType, certUri: string): Promise<void>18+ 调用删除证书对话框接口删除指定的证书,使用Promise方式异步返回结果。
仅2in1设备支持。
certificateManagerDialog openCertificateDetailDialog(context: common.Context, cert: Uint8Array, property: CertificateDialogProperty): Promise<void>18+ 调用查看证书详情的对话框接口,展示证书的详情。使用Promise方式异步返回结果。
仅2in1设备支持。

开发步骤

  1. 权限申请和声明。

    需要申请的权限:ohos.permission.ACCESS_CERT_MANAGER

    申请流程请参考:申请应用权限

    声明权限请参考:声明权限

  2. 导入相关模块。

    import { certificateManagerDialog } from '@kit.DeviceCertificateKit';
    import { BusinessError } from '@kit.BasicServicesKit';
    import { common } from '@kit.AbilityKit';
    
  3. 拉起证书管理界面。

    /* context为应用的上下文信息,由调用方自行获取,此处仅为示例。 */
    let context: common.Context = getContext(this);
    async function certificateManagerDialogSample() {
      /* pageType为页面类型,此处赋值PAGE_MAIN,即拉起证书管理主界面。 */
      let pageType: certificateManagerDialog.CertificateDialogPageType = certificateManagerDialog.CertificateDialogPageType.PAGE_MAIN;
      try {
        certificateManagerDialog.openCertificateManagerDialog(context, pageType).then(() => {
          console.info('Succeeded in opening certificate manager dialog.');
        }).catch((err: BusinessError) => {
          console.error(`Failed to open certificate manager dialog. Code: ${err.code}, message: ${err.message}`);
        })
      } catch (error) {
        console.error(`Failed to open certificate manager dialog. Code: ${error.code}, message: ${error.message}`);
      }
    }
    
  4. 调用安装证书对话框接口进行证书安装、调用删除证书对话框接口进行证书删除、调用查看证书详情的对话框接口、展示证书的详情。以上场景仅2in1设备支持。

    /* context为应用的上下文信息,由调用方自行获取,此处仅为示例。 */
    let context: common.Context = getContext(this);
    async function userCADialogSample() {
      let certUri: string = '';
      let certType = certificateManagerDialog.CertificateType.CA_CERT;
      /* 用户CA证书数据需要业务赋值。 */
      let cert = new Uint8Array([
        0x30, 0x82, 0x01, 0x2E, 0x30, 0x81, 0xD5, 0x02, 0x14, 0x28, 0x75, 0x71, 0x22, 0xDF, 0xDC, 0xCB,
      ]);
    
      try {
        /* 安装证书。 */
        let certScope = certificateManagerDialog.CertificateScope.CURRENT_USER; /* 安装在当前用户下。 */
        certificateManagerDialog.openInstallCertificateDialog(context, certType, certScope, cert).then((result) => {
          console.info('Succeeded in opening install ca dialog.');
          certUri = result;
        }).catch((err: BusinessError) => {
          console.error(`Failed to open install ca dialog. Code: ${err.code}, message: ${err.message}`);
        })
      } catch (error) {
        console.error(`Failed to open install ca dialog. Code: ${error.code}, message: ${error.message}`);
      }
    
      try {
        /* 删除证书。 */
        certificateManagerDialog.openUninstallCertificateDialog(context, certType, certUri).then(() => {
          console.info('Succeeded in opening uninstall ca dialog.');
        }).catch((err: BusinessError) => {
          console.error(`Failed to open uninstall ca dialog. Code: ${err.code}, message: ${err.message}`);
        })
      } catch (error) {
        console.error(`Failed to open uninstall ca dialog. Code: ${error.code}, message: ${error.message}`);
      }
    
      try {
        let property: certificateManagerDialog.CertificateDialogProperty = {
          showInstallButton: false    /* 不显示安装按钮。 */
        };
        /* 显示证书详情。 */
        certificateManagerDialog.openCertificateDetailDialog(context, cert, property).then(() => {
          console.info('Succeeded in opening show ca detail dialog.');
        }).catch((err: BusinessError) => {
          console.error(`Failed to open show ca detail dialog. Code: ${err.code}, message: ${err.message}`);
        })
      } catch (error) {
        console.error(`Failed to open show ca detail dialog. Code: ${error.code}, message: ${error.message}`);
      }
    }