Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 5f79bfe4 编写于 作者: H haixiangw
浏览文件
操作

【同步3.2beta5】增加cert文档中的错误码描述 

Signed-off-by: Nhaixiangw <wanghaixiang@huawei.com>
上级 07e35445
隐藏空白更改
内联 并排
Showing with 342 addition and 1 deletion
zh-cn/application-dev/reference/apis/js-apis-cert.md
浏览文件 @ 5f79bfe4
......@@ -104,6 +104,11 @@ createX509Cert(inStream : EncodingBlob, callback : AsyncCallback\<X509Cert>) : v
| inStream | [EncodingBlob](#encodingblob) | 是 | X509证书序列化数据 |
| callback | AsyncCallback\<X509Cert> | 是 | 回调函数。表示X509证书对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 19020001 | memory error. |
**示例：**
......@@ -146,6 +151,12 @@ createX509Cert(inStream : EncodingBlob) : Promise\<X509Cert>
| ------- | ---------------- |
| Promise\<X509Cert> | 表示X509证书对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 19020001 | memory error. |
**示例：**
```js
......@@ -184,6 +195,11 @@ verify(key : cryptoFramework.PubKey, callback : AsyncCallback\<void>) : void
| key | cryptoFramework.PubKey | 是 | 用于验签的公钥对象 |
| callback | AsyncCallback\<void> | 是 | 回调函数。使用AsyncCallback的第一个error参数判断是否验签成功，error为null表示成功，不为null表示失败 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 19030001 | crypto operation error. |
**示例：**
......@@ -235,6 +251,12 @@ verify(key : cryptoFramework.PubKey) : Promise\<void>
| -------------- | ----------- |
| Promise\<void> | Promise对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -275,6 +297,13 @@ getEncoded(callback : AsyncCallback\<EncodingBlob>) : void
| -------- | --------------------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<[EncodingBlob](#encodingblob)> | 是 | 回调函数。表示X509证书序列化数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
......@@ -318,6 +347,14 @@ getEncoded() : Promise\<EncodingBlob>
| --------------------------------------- | ---------------------- |
| Promise\<[EncodingBlob](#encodingblob)> | 表示X509证书序列化数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -356,6 +393,13 @@ getPublicKey() : cryptoFramework.PubKey
| ------ | ---------------- |
| cryptoFramework.PubKey | X509证书公钥对象：仅用于X509Cert的verify接口 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -398,6 +442,15 @@ checkValidityWithDate(date: string) : void
| -------- | -------------- | ---- | ---------- |
| date | string | 是 | 日期（格式：YYMMDDHHMMSSZ 或 YYYYMMDDHHMMSSZ，时间必须以Z结尾：表示标准时间） |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19030001 | crypto operation error.|
| 19030003 | the certificate has not taken effect. |
| 19030004 | the certificate has expired.|
**示例：**
```js
......@@ -513,6 +566,14 @@ getIssuerName() : DataBlob
| --------------------- | ---------------------- |
| [DataBlob](#datablob) | 表示X509证书颁发者名称 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -549,6 +610,14 @@ getSubjectName() : DataBlob
| --------------------- | -------------------- |
| [DataBlob](#datablob) | 表示X509证书主体名称 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -585,6 +654,14 @@ getNotBeforeTime() : string
| ------ | ------------------------------------------------------------ |
| string | 表示X509证书有效期起始时间（格式：YYMMDDHHMMSSZ 或 YYYYMMDDHHMMSSZ，时间以Z结尾：表示标准时间） |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -621,6 +698,14 @@ getNotAfterTime() : string
| ------ | ------------------------------------------------------------ |
| string | 表示X509证书有效期截止时间（格式：YYMMDDHHMMSSZ 或 YYYYMMDDHHMMSSZ，时间以Z结尾：表示标准时间） |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -657,6 +742,14 @@ getSignature() : DataBlob
| --------------------- | -------------------- |
| [DataBlob](#datablob) | 表示X509证书签名数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -693,6 +786,14 @@ getSignatureAlgName() : string
| ------ | ------------------------ |
| string | 表示X509证书签名算法名称 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -729,6 +830,14 @@ getSignatureAlgOid() : string
| ------ | --------------------------------- |
| string | 表示X509证书签名算法对象标志符OID |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -765,6 +874,14 @@ getSignatureAlgParams() : DataBlob
| --------------------- | ------------------------ |
| [DataBlob](#datablob) | 表示X509证书签名算法参数 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -801,6 +918,13 @@ getKeyUsage() : DataBlob
| --------------------- | -------------------- |
| [DataBlob](#datablob) | 表示X509证书秘钥用途 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -837,6 +961,14 @@ getExtKeyUsage() : DataArray
| ----------------------- | ------------------------ |
| [DataArray](#dataarray) | 表示X509证书扩展秘钥用途 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -909,6 +1041,14 @@ getSubjectAltNames() : DataArray
| ----------------------- | ------------------------ |
| [DataArray](#dataarray) | 表示X509证书主体可选名称 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -945,6 +1085,14 @@ getIssuerAltNames() : DataArray
| ----------------------- | -------------------------- |
| [DataArray](#dataarray) | 表示X509证书颁发者可选名称 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error.|
**示例：**
```js
......@@ -982,6 +1130,11 @@ createX509Crl(inStream : EncodingBlob, callback : AsyncCallback\<X509Crl>) : voi
| inStream | [EncodingBlob](#encodingblob) | 是 | 表示证书吊销列表序列化数据 |
| callback | AsyncCallback\<X509Crl> | 是 | 回调函数。表示证书吊销列表对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 19020001 | memory error. |
**示例：**
......@@ -1024,6 +1177,12 @@ createX509Crl(inStream : EncodingBlob) : Promise\<X509Crl>
| ----------------- | -------------------- |
| Promise\<X509Crl> | 表示证书吊销列表对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 19020001 | memory error. |
**示例：**
```js
......@@ -1145,6 +1304,13 @@ getEncoded(callback : AsyncCallback\<EncodingBlob>) : void
| -------- | ---------------------------- | ---- | ------------------------------------------ |
| callback | AsyncCallback\<EncodingBlob> | 是 | 回调函数，表示X509证书吊销列表的序列化数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
......@@ -1188,6 +1354,14 @@ getEncoded() : Promise\<EncodingBlob>
| ---------------------- | -------------------------------- |
| Promise\<EncodingBlob> | 表示X509证书吊销列表的序列化数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1227,6 +1401,11 @@ verify(key : cryptoFramework.PubKey, callback : AsyncCallback\<void>) : void
| key | cryptoFramework.PubKey | 是 | 表示用于验签的公钥对象 |
| callback | AsyncCallback\<void> | 是 | 回调函数,使用AsyncCallback的第一个error参数判断是否验签成功，error为null表示成功，error不为null表示失败。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19030001 | crypto operation error. |
**示例：**
......@@ -1279,6 +1458,12 @@ verify(key : cryptoFramework.PubKey) : Promise\<void>
| ---- | ------------------------------------------------------------ |
| Promise\<void> | Promise对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1356,6 +1541,14 @@ getIssuerName() : DataBlob
| --------------------- | ------------------------------ |
| [DataBlob](#datablob) | 表示X509证书吊销列表颁发者名称 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1392,6 +1585,14 @@ getLastUpdate() : string
| ------ | ------------------------------------ |
| string | 表示X509证书吊销列表最后一次更新日期 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1428,6 +1629,14 @@ getNextUpdate() : string
| ------ | ------------------------------------ |
| string | 表示X509证书吊销列表下一次更新的日期 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1470,6 +1679,13 @@ getRevokedCert(serialNumber : number) : X509CrlEntry
| ---------------------- | --------------------- |
| X509CrlEntry | 表示被吊销X509证书对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1518,6 +1734,13 @@ getRevokedCertWithCert(cert : X509Cert) : X509CrlEntry
| ------------ | -------------------- |
| X509CrlEntry | 表示被吊销X509证书对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1560,6 +1783,12 @@ getRevokedCerts(callback : AsyncCallback<Array\<X509CrlEntry>>) : void
| -------- | ----------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback<Array\<X509CrlEntry>> | 是 | 回调函数。表示被吊销X509证书列表 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19030001 | crypto operation error. |
**示例：**
......@@ -1603,6 +1832,13 @@ getRevokedCerts() : Promise<Array\<X509CrlEntry>>
| ----------------------------- | ---------------------- |
| Promise<Array\<X509CrlEntry>> | 表示被吊销X509证书列表 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1641,6 +1877,14 @@ getTbsInfo() : DataBlob
| --------------------- | ------------------------------- |
| [DataBlob](#datablob) | 表示证书吊销列表的tbsCertList信息 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1681,6 +1925,14 @@ getSignature() : DataBlob
| --------------------- | ------------------------------ |
| [DataBlob](#datablob) | 表示X509证书吊销列表的签名数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1717,6 +1969,14 @@ getSignatureAlgName() : string
| ------ | -------------------------------- |
| string | 表示X509证书吊销列表签名的算法名 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1753,6 +2013,14 @@ getSignatureAlgOid() : string
| ------ | --------------------------------------------- |
| string | 表示X509证书吊销列表签名算法的对象标志符OID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1789,6 +2057,14 @@ getSignatureAlgParams() : DataBlob
| --------------------- | ---------------------------------- |
| [DataBlob](#datablob) | 表示X509证书吊销列表签名的算法参数 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1831,6 +2107,14 @@ createCertChainValidator(algorithm :string) : CertChainValidator
| ------------------ | -------------------- |
| CertChainValidator | 表示证书链校验器对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -1846,7 +2130,7 @@ let validator = cryptoCert.createCertChainValidator("PKIX");
### 属性
**系统能力：** SystemCapability.Security.CryptoFramework
**系统能力：** SystemCapability.Security.Cert
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ------ | ---- | ---- | -------------------------- |
......@@ -1869,6 +2153,19 @@ validate(certChain : CertChainData, callback : AsyncCallback\<void>) : void
| certChain | [CertChainData](#certchaindata) | 是 | 表示X509证书链序列化数据 |
| callback | AsyncCallback\<void> | 是 | 回调函数。使用AsyncCallback的第一个error参数判断是否校验成功，error为null表示成功，error不为null表示失败 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
| 19030002 | the certificate signature verification failed. |
| 19030003 | the certificate has not taken effect. |
| 19030004 | the certificate has expired. |
| 19030005 | failed to obtain the certificate issuer. |
| 19030006 | the key cannot be used for signing a certificate. |
| 19030007 | the key cannot be used for digital signature. |
**示例：**
......@@ -1916,6 +2213,20 @@ validate(certChain : CertChainData) : Promise\<void>
| -------------- | ----------- |
| Promise\<void> | Promise对象 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
| 19030002 | the certificate signature verification failed. |
| 19030003 | the certificate has not taken effect. |
| 19030004 | the certificate has expired. |
| 19030005 | failed to obtain the certificate issuer. |
| 19030006 | the key cannot be used for signing a certificate. |
| 19030007 | the key cannot be used for digital signature. |
**示例：**
```js
......@@ -1980,6 +2291,13 @@ getEncoded(callback : AsyncCallback\<EncodingBlob>) : void
| -------- | --------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback\<[EncodingBlob](#encodingblob)> | 是 | 回调函数。表示被吊销证书的序列化数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
......@@ -2011,6 +2329,14 @@ getEncoded() : Promise\<EncodingBlob>
| --------------------------------------- | -------------------------- |
| Promise\<[EncodingBlob](#encodingblob)> | 表示被吊销证书的序列化数据 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......@@ -2063,6 +2389,13 @@ getCertIssuer() : DataBlob
| --------------------- | ----------------------- |
| [DataBlob](#datablob) | 表示被吊销证书的颁发者信息 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | -------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
**示例：**
```js
......@@ -2091,6 +2424,14 @@ getRevocationDate() : string
| ------ | ------------------ |
| string | 表示证书被吊销的日期 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ----------------------- |
| 19020001 | memory error. |
| 19020002 | runtime error. |
| 19030001 | crypto operation error. |
**示例：**
```js
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或