@ohos.security.certManager (证书管理模块)

证书管理主要提供系统级的证书管理能力，实现证书全生命周期（安装，存储，使用，销毁）的管理和安全使用 。

说明：

本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import certManager from '@ohos.security.certManager';

CmKeyPurpose

表示密钥使用目的的枚举，用于签名、验签。

系统能力： SystemCapability.Security.CertificateManager

CmKeyDigest

表示签名、验签使用的摘要算法的枚举。

系统能力： SystemCapability.Security.CertificateManager

CmKeyPadding

表示签名、验签使用的填充方式的枚举。

系统能力： SystemCapability.Security.CertificateManager

CMSignatureSpec

表示签名、验签操作使用的参数集合，包括密钥使用目的、填充方式和摘要算法。

系统能力： SystemCapability.Security.CertificateManager

CertInfo

表示证书详细信息。

系统能力： SystemCapability.Security.CertificateManager

CertAbstract

表示证书简要信息。

系统能力： SystemCapability.Security.CertificateManager

Credential

表示凭据详细信息。

系统能力： SystemCapability.Security.CertificateManager

CredentialAbstract

表示凭据的简要信息。

系统能力： SystemCapability.Security.CertificateManager

CMResult

表示接口的返回结果。

系统能力： SystemCapability.Security.CertificateManager

CMHandle

表示签名、验签的初始化操作句柄。

系统能力： SystemCapability.Security.CertificateManager

CMErrorCode

表示调用证书管理相关API的错误码。

系统能力： SystemCapability.Security.CertificateManager

certManager.installPrivateCertificate

installPrivateCertificate(keystore: Uint8Array, keystorePwd: string, certAlias: string, callback: AsyncCallback<CMResult>) : void

表示安装私有凭据，使用Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

/* 安装的凭据数据需要业务赋值，本例数据非凭据数据 */
let keystore: Uint8Array = new Uint8Array([
  0x30, 0x82, 0x0b, 0xc1, 0x02, 0x01,
]);
let keystorePwd: string = "123456";
try {
  certManager.installPrivateCertificate(keystore, keystorePwd, "test", (err, cmResult) => {
    if (err != null) {
      console.error("[Callback]installPrivateCertificate err: " + err.code);
    } else {
      let uri: string = (cmResult.uri == undefined) ? '' : cmResult.uri;
      console.log("[Callback]installPrivateCertificate success");
    }
  });
} catch (error) {
  console.error("[Callback]installPrivateCertificate failed");
}

certManager.installPrivateCertificate

installPrivateCertificate(keystore: Uint8Array, keystorePwd: string, certAlias: string) : Promise<CMResult>

表示安装私有证书，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';
import { BusinessError } from '@ohos.base';

/* 安装的凭据数据需要业务赋值，本例数据非凭据数据 */
let keystore: Uint8Array = new Uint8Array([
  0x30, 0x82, 0x0b, 0xc1, 0x02, 0x01,
]);
let keystorePwd: string = "123456";
try {
  certManager.installPrivateCertificate(keystore, keystorePwd, 'test').then((cmResult) => {
    let uri: string = (cmResult.uri == undefined) ? '' : cmResult.uri;
    console.log("[Promise]installPrivateCertificate success");
  }).catch((err: BusinessError) => {
    console.error('[Promise]installPrivateCertificate failed');
  })
} catch (err) {
  console.error("[Promise]installPrivateCertificate failed");
}

certManager.getPrivateCertificate

getPrivateCertificate(keyUri: string, callback: AsyncCallback<CMResult>) : void

表示获取私有凭据详情，使用Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

let uri: string = 'test'; /* 业务安装凭据，返回唯一标识符，此处省略 */
try {
  certManager.getPrivateCertificate(uri, (err, cmResult) => {
    if (err != null) {
      console.error("getPrivateCertificate error");
    } else {
      if (cmResult.credential == undefined) {
        console.log("[Callback]getPrivateCertificate result is undefined");
      } else {
        let list = cmResult.credential;
        console.log("[Callback]getPrivateCertificate success");
      }
    }
  });
} catch (error) {
  console.error("[Callback]installPrivateCertificate failed");
}

certManager.getPrivateCertificate

getPrivateCertificate(keyUri: string) : Promise<CMResult>

表示获取私有凭据详情，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';
import { BusinessError } from '@ohos.base';

let uri: string = 'test'; /* 业务安装凭据，返回唯一标识符，此处省略 */
try {
  certManager.getPrivateCertificate(uri).then((cmResult) => {
    if (cmResult.credential == undefined) {
      console.log("[Promise]getPrivateCertificate result is undefined");
    } else {
      let list = cmResult.credential;
      console.log("[Promise]getPrivateCertificate success");
    }
  }).catch((err: BusinessError) => {
    console.error('[Promise]getPrivateCertificate failed');
  })
} catch (err) {
  console.error("[Promise]getPrivateCertificate failed");
}

certManager.uninstallPrivateCertificate

uninstallPrivateCertificate(keyUri: string, callback: AsyncCallback<void>) : void

表示卸载指定的私有凭据，使用Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

let uri: string = 'test'; /* 业务安装凭据，返回唯一标识符，此处省略 */
try {
  certManager.uninstallPrivateCertificate(uri, (err, result) => {
    if (err != null) {
      console.error("[Callback]uninstallPrivateCertificate error");
    } else {
      console.log("[Callback]uninstallPrivateCertificate success");
    }
  });
} catch (err) {
  console.error("[Callback]uninstallPrivateCertificate failed");
}

certManager.uninstallPrivateCertificate

uninstallPrivateCertificate(keyUri: string) : Promise<void>

表示卸载指定的私有凭据，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';
import { BusinessError } from '@ohos.base';

let uri: string = 'test'; /* 业务安装凭据，返回唯一标识符，此处省略 */
try {
  certManager.uninstallPrivateCertificate(uri).then((cmResult) => {
    console.log("[Promise]uninstallPrivateCertificate success");
  }).catch((err: BusinessError) => {
    console.error('[Promise]uninstallPrivateCertificate failed, code =', err.code);
  })
} catch (err) {
  console.error("[Promise]uninstallPrivateCertificate failed");
}

certManager.init

init(authUri: string, spec: CMSignatureSpec, callback: AsyncCallback<CMHandle>) : void

表示使用凭据进行签名、验签的初始化操作，使用Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

let uri: string = 'test'; /* 业务安装凭据，返回唯一标识符，此处省略 */
const req: certManager.CMSignatureSpec = {
  purpose: certManager.CmKeyPurpose.CM_KEY_PURPOSE_SIGN,
  padding: certManager.CmKeyPadding.CM_PADDING_PSS,
  digest: certManager.CmKeyDigest.CM_DIGEST_SHA256
}
try {
  certManager.init(uri, req, (err, cmHandle) => {
    if (err != null) {
      console.error("[Callback]init err");
    } else {
      console.log("[Callback]init success");
    }
  })
} catch (err) {
  console.error("[Callback]init failed");
}

certManager.init

init(authUri: string, spec: CMSignatureSpec) : Promise<CMHandle>

表示使用凭据进行签名、验签的初始化操作，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';
import { BusinessError } from '@ohos.base';

let uri: string = 'test'; /* 业务安装凭据，返回唯一标识符，此处省略 */
const req: certManager.CMSignatureSpec = {
  purpose: certManager.CmKeyPurpose.CM_KEY_PURPOSE_VERIFY,
  padding: certManager.CmKeyPadding.CM_PADDING_PSS,
  digest: certManager.CmKeyDigest.CM_DIGEST_MD5
}
try {
  certManager.init(uri, req).then((handle) => {
    console.log('[Promise]init success');
  }).catch((error: BusinessError) => {
    console.error('[Promise]init failed');
  })
} catch (err) {
  console.error("[Promise]init failed");
}

certManager.update

update(handle: Uint8Array, data: Uint8Array, callback: AsyncCallback<void>): void

表示签名、验签时对数据的更新操作，使用Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

/* cmHandle为业务调用init接口的返回值，此处仅为示例 */
let cmHandle: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
let srcData: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
try {
  certManager.update(cmHandle, srcData, (err, result) => {
    if (err != null) {
      console.error("[Callback]certManager update error");
    } else {
      console.log("[Callback]certManager update success");
    }
  });
} catch (err) {
  console.error("[Callback]update failed");
}

certManager.update

update(handle: Uint8Array, data: Uint8Array): Promise<void>

表示签名、验签时对数据的更新操作，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';
import { BusinessError } from '@ohos.base';

/* cmHandle为业务调用init接口的返回值，此处仅为示例 */
let cmHandle: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
let srcData: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
try {
  certManager.update(cmHandle, srcData).then((result) => {
    console.log('[Promise]update success');
  }).catch((error: BusinessError) => {
    console.error('[Promise]update failed');
  })
} catch (err) {
  console.error("[Promise]certManager update error");
}

certManager.finish

finish(handle: Uint8Array, callback: AsyncCallback<CMResult>) : void

表示完成签名的操作，Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

/* cmHandle为业务调用init接口的返回值，此处仅为示例 */
let cmHandle: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
try {
  certManager.finish(cmHandle, (err, cmResult) => {
    if (err != null) {
      console.error("[Callback]certManager sign failed");
    } else {
      if (cmResult.outData != undefined) {
        let signRes: Uint8Array = cmResult.outData;
        console.log("[Callback]certManager sign success");
      } else {
        console.error("[Callback]certManager sign failed");
      }
    }
  });
} catch(error) {
  console.error("[Callback]certManager finish error");
}

certManager.finish

finish(handle: Uint8Array, signature: Uint8Array, callback: AsyncCallback<CMResult>) : void

表示完成验签的操作，使用Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

/* cmHandle为业务调用init接口的返回值，此处仅为示例 */
let cmHandle: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
let signRes: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
try {
  certManager.finish(cmHandle, signRes, (err, cmResult) => {
    if (err != null) {
      console.error("[Callback]certManager verify failed");
    } else {
      console.log("[Callback]certManager verify success");
    }
  });
} catch(error) {
  console.error("[Callback]certManager finish error");
}

certManager.finish

finish(handle: Uint8Array, signature?: Uint8Array) : Promise<CMResult>

表示完成签名、验签的操作，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';
import { BusinessError } from '@ohos.base';

/* cmHandle为业务调用init接口的返回值，此处仅为示例 */
let cmHandle: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
try {
  /* 签名的finish操作 */
  certManager.finish(cmHandle).then((cmResult) => {
    if (cmResult.outData != undefined) {
      let signRes1: Uint8Array = cmResult.outData;
      console.log("[Promise]finish sign success");
    } else {
      console.error("[Promise]finish sign failed");
    }
  }).catch((err: BusinessError) => {
    console.error('[Promise]finish sign failed');
  })

  /* 签名的结果 */
  let signRes: Uint8Array = new Uint8Array([
    0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
  ]);
  /* 验签的finish操作 */
  certManager.finish(cmHandle, signRes).then((cmResult) => {
    console.log("[Promise]finish verify success");
  }).catch((err: BusinessError) => {
    console.error('[Promise]finish verify failed');
  })
} catch(error) {
  console.error("[Promise]certManager finish error");
}

certManager.abort

abort(handle: Uint8Array, callback: AsyncCallback<void>) : void

表示中止签名、验签的操作，使用Callback回调异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';

/* cmHandle为业务调用init接口的返回值，此处仅为示例 */
let cmHandle: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
try {
  certManager.abort(cmHandle, (err, cmResult) => {
    if (err != null) {
      console.error("[Callback]certManager abort failed");
    } else {
      console.log("[Callback]certManager abort success");
    }
  });
} catch(error) {
  console.error("[Callback]certManager abort error");
}

certManager.abort

abort(handle: Uint8Array) : Promise<void>

表示中止签名、验签的操作，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_CERT_MANAGER

系统能力： SystemCapability.Security.CertificateManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见证书管理错误码。

示例：

import certManager from '@ohos.security.certManager';
import { BusinessError } from '@ohos.base';

/* cmHandle为业务调用init接口的返回值，此处仅为示例 */
let cmHandle: Uint8Array = new Uint8Array([
  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
]);
try {
  certManager.abort(cmHandle).then((result) => {
    console.log('[Promise]abort success');
  }).catch((error: BusinessError) => {
    console.error('[Promise]abort failed');
  })
} catch (err) {
  console.error("[Promise]certManager abort error");
}