1# 应用证书凭据开发指导 2 3> **说明** 4> 5> 本开发指导需使用API version 11及以上版本SDK。 6 7## 场景说明 8 91. 典型场景。 10 11 - 安装应用证书凭据。 12 - 获取应用证书凭据。 13 - 使用应用证书凭据对数据进行签名、验签。 14 - 卸载指定的应用证书凭据。 15 162. 支持安装的应用证书凭据算法类型和签名验签支持的参数组合。 17 18 - 证书管理安装凭据及使用凭据中的密钥进行签名、验签,依赖[密钥管理服务](../UniversalKeystoreKit/huks-overview.md)(HUKS)能力。 19 - 证书管理支持的算法为其子集,当前仅支持RSA、ECC及SM2算法类型的私有凭据安装及使用。 20 - 签名、验签支持的参数组合,详见HUKS声明的[签名/验签介绍及算法规格](../UniversalKeystoreKit/huks-signing-signature-verification-overview.md)中RSA、ECC及SM2的描述。 21 22## 接口说明 23 24详细接口说明可参考[API参考](../../reference/apis-device-certificate-kit/js-apis-certManager.md)。 25 26以上场景涉及的常用接口如下表所示。 27 28| 实例名 | 接口名 | 描述 | 29| --------------- | ------------------------------------------------------------ | -------------------------------------------- | 30| certificateManager | installPrivateCertificate(keystore: Uint8Array, keystorePwd: string, certAlias: string, callback: AsyncCallback\<CMResult>) : void | 使用callback方式安装应用证书凭据。 | 31| certificateManager | installPrivateCertificate(keystore: Uint8Array, keystorePwd: string, certAlias: string) : Promise\<CMResult> | 使用promise方式安装应用证书凭据。 | 32| certificateManager | installPrivateCertificate(keystore: Uint8Array, keystorePwd: string, certAlias: string, level: AuthStorageLevel) : Promise\<CMResult><sup>18+</sup> | 使用promise方式安装应用证书凭据,并指定凭据的存储级别。 | 33| certificateManager | getPrivateCertificate(keyUri: string, callback: AsyncCallback\<CMResult>) : void | 使用callback方式获取应用证书凭据。 | 34| certificateManager | getPrivateCertificate(keyUri: string) : Promise\<CMResult> | 使用promise方式获取应用证书凭据。 | 35| certificateManager | uninstallPrivateCertificate(keyUri: string, callback: AsyncCallback\<void>) : void | 使用callback方式卸载应用证书凭据。 | 36| certificateManager | uninstallPrivateCertificate(keyUri: string) : Promise\<void> | 使用promise方式卸载应用证书凭据。 | 37| certificateManager | init(authUri: string, spec: CMSignatureSpec, callback: AsyncCallback\<CMHandle>) : void | 使用callback方式进行签名验签的初始化操作。 | 38| certificateManager | init(authUri: string, spec: CMSignatureSpec) : Promise\<CMHandle> | 使用promise方式进行签名验签的初始化操作。 | 39| certificateManager | update(handle: Uint8Array, data: Uint8Array, callback: AsyncCallback\<void>) : void | 使用callback方式对待签名、验签的数据进行更新操作。 | 40| certificateManager | update(handle: Uint8Array, data: Uint8Array) : Promise\<void> | 使用promise方式对待签名、验签的数据进行更新操作。 | 41| certificateManager | finish(handle: Uint8Array, callback: AsyncCallback\<CMResult>) : void | 使用callback方式完成数据的签名操作。 | 42| certificateManager | finish(handle: Uint8Array, signature: Uint8Array, callback: AsyncCallback\<CMResult>) : void | 使用callback方式完成数据的签名操作。 | 43| certificateManager | finish(handle: Uint8Array, signature?: Uint8Array) : Promise\<CMResult> | 使用promise方式完成数据的签名、验签操作。 | 44| certificateManager | abort(handle: Uint8Array, callback: AsyncCallback\<void>) : void | 使用callback方式中止签名、验证操作。 | 45| certificateManager | abort(handle: Uint8Array) : Promise\<void> | 使用promise方式中止签名、验证操作。 | 46 47## 开发步骤 48 491. 权限申请和声明。 50 51 需要申请的权限:ohos.permission.ACCESS_CERT_MANAGER 52 53 申请流程请参考:[申请应用权限](../AccessToken/determine-application-mode.md) 54 55 声明权限请参考:[声明权限](../AccessToken/declare-permissions.md) 56 572. 导入相关模块。 58 59 ```ts 60 import { certificateManager } from '@kit.DeviceCertificateKit'; 61 ``` 62 633. 安装应用证书凭据,获取应用证书凭据,并使用应用证书凭据进行签名、验签,最后删除应用证书凭据。 64 65 ```ts 66 async function privateCredSample() { 67 /* 安装的凭据数据需要业务赋值,本例数据非凭据数据。 */ 68 let keystore: Uint8Array = new Uint8Array([ 69 0x30, 0x82, 0x04, 0x6a, 0x02, 0x01, 0x03, 0x30, 0x82, 0x04, 0x30, 0x06, 0x09, 70 ]); 71 72 /* 安装凭据对应的密码,业务赋值。 */ 73 let keystorePwd: string = '123456'; 74 let appKeyUri: string = ''; 75 try { 76 /* 安装应用证书凭据。 */ 77 const res: certificateManager.CMResult = await certificateManager.installPrivateCertificate(keystore, keystorePwd, "testPriCredential"); 78 appKeyUri = (res.uri != undefined) ? res.uri : ''; 79 } catch (err) { 80 console.error(`Failed to install private certificate. Code: ${err.code}, message: ${err.message}`); 81 } 82 83 try { 84 /* 获取应用证书凭据。 */ 85 let res: certificateManager.CMResult = await certificateManager.getPrivateCertificate(appKeyUri); 86 if (res === undefined || res.credential == undefined) { 87 console.error('The result of getting private certificate is undefined.'); 88 } else { 89 let credential = res.credential; 90 console.info('Succeeded in getting private certificate.'); 91 } 92 } catch (err) { 93 console.error(`Failed to get private certificate. Code: ${err.code}, message: ${err.message}`); 94 } 95 96 try { 97 /* srcData为待签名、验签的数据,业务自行赋值。 */ 98 let srcData: Uint8Array = new Uint8Array([ 99 0x86, 0xf7, 0x0d, 0x01, 0x07, 0x01, 100 ]); 101 102 /* 构造签名的属性参数。 */ 103 const signSpec: certificateManager.CMSignatureSpec = { 104 purpose: certificateManager.CmKeyPurpose.CM_KEY_PURPOSE_SIGN, 105 padding: certificateManager.CmKeyPadding.CM_PADDING_PSS, 106 digest: certificateManager.CmKeyDigest.CM_DIGEST_SHA256 107 }; 108 109 /* 签名。 */ 110 const signHandle: certificateManager.CMHandle = await certificateManager.init(appKeyUri, signSpec); 111 await certificateManager.update(signHandle.handle, srcData); 112 const signResult: certificateManager.CMResult = await certificateManager.finish(signHandle.handle); 113 114 /* 构造验签的的属性参数。 */ 115 const verifySpec: certificateManager.CMSignatureSpec = { 116 purpose: certificateManager.CmKeyPurpose.CM_KEY_PURPOSE_VERIFY, 117 padding: certificateManager.CmKeyPadding.CM_PADDING_PSS, 118 digest: certificateManager.CmKeyDigest.CM_DIGEST_SHA256 119 }; 120 121 /* 验签。 */ 122 const verifyHandle: certificateManager.CMHandle = await certificateManager.init(appKeyUri, verifySpec); 123 await certificateManager.update(verifyHandle.handle, srcData); 124 const verifyResult = await certificateManager.finish(verifyHandle.handle, signResult.outData); 125 console.info('Succeeded in signing and verifying.'); 126 } catch (err) { 127 console.error(`Failed to sign or verify. Code: ${err.code}, message: ${err.message}`); 128 } 129 130 try { 131 /* 删除应用证书凭据。 */ 132 await certificateManager.uninstallPrivateCertificate(appKeyUri); 133 } catch (err) { 134 console.error(`Failed to uninstall private certificate. Code: ${err.code}, message: ${err.message}`); 135 } 136 } 137 ```