Certificate Management Dialog Box Development

NOTE

This guide applies to the SDK of API version 13 or later.

You can use the certificateManagerDialog APIs to open the certificate management dialog box and perform certificate management, such as installing, storing, using, and destroying a certificate.

Available APIs

For details about the APIs, see @ohos.security.certManagerDialog (Certificate Management Dialog Box).

The following table describes the commonly used APIs.

Instance	API	Description
certificateManagerDialog	openCertificateManagerDialog(context: common.Context, pageType: CertificateDialogPageType): Promise<void>	Opens the certificate management dialog box and displays the page of the specified type. This API uses a promise to return the result.
certificateManagerDialog	openInstallCertificateDialog(context: common.Context, certType: CertificateType, certScope: CertificateScope, cert: Uint8Array): Promise<string>¹⁴⁺	Opens the certificate installation dialog box to install a certificate. This API uses a promise to return the unique identifier of the installed certificate. This API is available only to 2-in-1 devices.
certificateManagerDialog	openUninstallCertificateDialog(context: common.Context, certType: CertificateType, certUri: string): Promise<void>¹⁸⁺	Opens the certificate uninstallation dialog box to uninstall a certificate. This API uses a promise to return the result. This API is available only to 2-in-1 devices.
certificateManagerDialog	openCertificateDetailDialog(context: common.Context, cert: Uint8Array, property: CertificateDialogProperty): Promise<void>¹⁸⁺	Opens the certificate details dialog box to display the certificate details. This API uses a promise to return the result. This API is available only to 2-in-1 devices.

How to Develop

Request and declare permissions.

Required permission: ohos.permission.ACCESS_CERT_MANAGER

For details about how to request permissions, see Workflow for Requesting Permissions.

For details about how to declare permissions, see Declaring Permissions.

Import the required module.

import { certificateManagerDialog } from '@kit.DeviceCertificateKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
import { UIContext } from '@kit.ArkUI';

Open the certificate management dialog box.

import { certificateManagerDialog } from '@kit.DeviceCertificateKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';

async function certificateManagerDialogSample() {
  /* context is application context information, which is obtained by the caller. The context here is only an example. */
  let context: common.Context = new UIContext().getHostContext() as common.Context;
  /* pageType specifies the type of the page to display. In this example, pageType is PAGE_MAIN, which indicates the main page of the Certificate Manager application. */
  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}`);
  }
}

CertManagerDialogSample.ets

Call the APIs for installing a certificate, uninstalling a certificate, and viewing certificate details, respectively. These APIs are available only to 2-in-1 devices.

import { certificateManagerDialog } from '@kit.DeviceCertificateKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
import { UIContext } from '@kit.ArkUI';
import { util } from '@kit.ArkTS';

let certType = certificateManagerDialog.CertificateType.CA_CERT;
let certUri: string = '';
/* The user CA certificate data must be assigned based on the service. */
let cert: Uint8Array = new util.TextEncoder().encodeInto(`-----BEGIN CERTIFICATE-----
MIIDSTCCAjECFFRZKkiBuiZ+zqfjJOg05yeTePM9MA0GCSqGSIb3DQEBCwUAMGEx
CzAJBgNVBAYTAmNuMQ0wCwYDVQQIDARvaG9zMQswCQYDVQQHDAJjbTEhMB8GA1UE
CgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMRMwEQYDVQQDDApUZXN0Um9vdENB
MB4XDTI1MTAxNTA3MzE0MloXDTI2MTAxNTA3MzE0MlowYTELMAkGA1UEBhMCY24x
DTALBgNVBAgMBG9ob3MxCzAJBgNVBAcMAmNtMSEwHwYDVQQKDBhJbnRlcm5ldCBX
aWRnaXRzIFB0eSBMdGQxEzARBgNVBAMMClRlc3RSb290Q0EwggEiMA0GCSqGSIb3
DQEBAQUAA4IBDwAwggEKAoIBAQC5p4eoQJyTBvn01M8SwEi8dguTIPGmD3a8SGIj
KXaB6ltv742H5EBjgk+zC8+Gis0ehEqwk3pVnnmByeYvrERxsUqDt69/FndlfTxI
C2/2MxWVk97g/6TpJ5Lt2mTrH+rSOgUDyU27aPn12ZnDF1mLsT+U+CBmfj4+J4tW
yzdFNj7kcKMQQok+L1dtFlDNMNpMA1UqADzoC3XgFl49CpDtoFId9DVsgUPkPfX1
89cCunomgJe1b17FzxfNu2yhbl5cnUEjeHGbmBgBIB7uG8tjGstnDPx7fl3Xrj+Q
fRrwCpVKD9RxoyUBFbHttixxY5bHFUdvHRB251sxD+JfxxxLAgMBAAEwDQYJKoZI
hvcNAQELBQADggEBAEGbNqcMU7C/lrIytI/OTtzYbkWDsfnRSPxlCUoZ2Xh3S83A
SNQ9Ze5tDwWdW9Hlde9May6hzvuQSYeMLLnyM8WGResXCs7UbnSQe7fGfUu+xDGb
h4tamnRFtZydxCCgDT9lIdHeutlPwOuxlR4HXpeowGeGJX0iFrdo6D0iXAY34hic
yLQzuBqE/1s3PLA83Fi4EOOOV7P/ahmOLtBFlHbySHV68i9PNeNr9SDykH9/RgI9
5G8ZTZj8oSmbTGGtfNuVXybMyJMRlz6BkxG++kYcg7STRBqHGX7RrWHiupguNreO
4sJBdSpWBq172ZEyOvTqC4xX9lLYqwwBQ++TFoo=
-----END CERTIFICATE-----`);

async function installUserCADialogSample() {
  /* context is application context information, which is obtained by the caller. The context here is only an example. */
  let context: common.Context = new UIContext().getHostContext() as common.Context;
  let certScope = certificateManagerDialog.CertificateScope.CURRENT_USER; /* Install the certificate under the current user. */
  try {
    /* Install the certificate. */
    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}`);
  }
}

async function uninstallUserCADialogSample() {
  /* context is application context information, which is obtained by the caller. The context here is only an example. */
  let context: common.Context = new UIContext().getHostContext() as common.Context;
  try {
    /* Uninstall the certificate. */
    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}`);
  }
}

async function certDetailDialogSample() {
  /* context is application context information, which is obtained by the caller. The context here is only an example. */
  let context: common.Context = new UIContext().getHostContext() as common.Context;
  try {
    let property: certificateManagerDialog.CertificateDialogProperty = {
      showInstallButton: false    /* Do not display the button for installing the certificate. */
    };
    /* Display certificate details. */
    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}`);
  }
}

CertManagerCaDialogSample.ets