openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-04-16 20:21:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
interface_sdk-js/api/@ohos.security.cert.d.ts
QuentinLee 32e3c40cc3 Merge branch 'master' of gitee.com:openharmony/interface_sdk-js into master 
Signed-off-by: QuentinLee <quentin.lee@huawei.com>
2023-12-22 16:14:52 +08:00

2866 lines
94 KiB
TypeScript
Raw Blame History

/*
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit Device Certificate Kit
*/
import type { AsyncCallback } from './@ohos.base';
import cryptoFramework from '@ohos.security.cryptoFramework';
/**
* Provides a series of capabilities related to certificates,
* which supports parsing, verification, and output of certificates, extensions, and CRLs.
*
* @namespace cert
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides a series of capabilities related to certificates,
* which supports parsing, verification, and output of certificates, extensions, and CRLs.
*
* @namespace cert
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
declare namespace cert {
/**
* Enum for result code
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Enum for result code
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
enum CertResult {
/**
* Indicates that input parameters is invalid.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that input parameters is invalid.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
INVALID_PARAMS = 401,
/**
* Indicates that function or algorithm is not supported.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that function or algorithm is not supported.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
NOT_SUPPORT = 801,
/**
* Indicates the memory error.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the memory error.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_OUT_OF_MEMORY = 19020001,
/**
* Indicates that runtime error.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that runtime error.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_RUNTIME_ERROR = 19020002,
/**
* Indicates the crypto operation error.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the crypto operation error.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_CRYPTO_OPERATION = 19030001,
/**
* Indicates that the certificate signature verification failed.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that the certificate signature verification failed.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_CERT_SIGNATURE_FAILURE = 19030002,
/**
* Indicates that the certificate has not taken effect.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that the certificate has not taken effect.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_CERT_NOT_YET_VALID = 19030003,
/**
* Indicates that the certificate has expired.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that the certificate has expired.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_CERT_HAS_EXPIRED = 19030004,
/**
* Indicates a failure to obtain the certificate issuer.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates a failure to obtain the certificate issuer.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY = 19030005,
/**
* The key cannot be used for signing a certificate.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The key cannot be used for signing a certificate.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_KEYUSAGE_NO_CERTSIGN = 19030006,
/**
* The key cannot be used for digital signature.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The key cannot be used for digital signature.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE = 19030007
}
/**
* Provides the data blob type.
*
* @typedef DataBlob
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the data blob type.
*
* @typedef DataBlob
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface DataBlob {
/**
* Indicates the content of data blob.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the content of data blob.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
data: Uint8Array;
}
/**
* Provides the data array type.
*
* @typedef DataArray
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the data array type.
*
* @typedef DataArray
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface DataArray {
/**
* Indicates the content of data array.
*
* @type { Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the content of data array.
*
* @type { Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
data: Array<Uint8Array>;
}
/**
* Enum for supported cert encoding format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Enum for supported cert encoding format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
enum EncodingFormat {
/**
* The value of cert DER format.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The value of cert DER format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
FORMAT_DER = 0,
/**
* The value of cert PEM format.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The value of cert PEM format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
FORMAT_PEM = 1,
/**
* The value of cert chain PKCS7 format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
FORMAT_PKCS7 = 2
}
/**
* Enum for the certificate item type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Enum for the certificate item type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
enum CertItemType {
/**
* Indicates to get certificate TBS(to be signed) value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate TBS(to be signed) value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CERT_ITEM_TYPE_TBS = 0,
/**
* Indicates to get certificate public key.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate public key.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CERT_ITEM_TYPE_PUBLIC_KEY = 1,
/**
* Indicates to get certificate issuer unique id value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate issuer unique id value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CERT_ITEM_TYPE_ISSUER_UNIQUE_ID = 2,
/**
* Indicates to get certificate subject unique id value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate subject unique id value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CERT_ITEM_TYPE_SUBJECT_UNIQUE_ID = 3,
/**
* Indicates to get certificate extensions value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate extensions value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CERT_ITEM_TYPE_EXTENSIONS = 4
}
/**
* Enumerates for the certificate extension object identifier (OID) types.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Enumerates for the certificate extension object identifier (OID) types.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
enum ExtensionOidType {
/**
* Indicates to obtain all types of OIDs, including critical and uncritical types.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to obtain all types of OIDs, including critical and uncritical types.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
EXTENSION_OID_TYPE_ALL = 0,
/**
* Indicates to obtain OIDs of the critical type.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to obtain OIDs of the critical type.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
EXTENSION_OID_TYPE_CRITICAL = 1,
/**
* Indicates to obtain OIDs of the uncritical type.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to obtain OIDs of the uncritical type.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
EXTENSION_OID_TYPE_UNCRITICAL = 2
}
/**
* Enum for the certificate extension entry type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Enum for the certificate extension entry type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
enum ExtensionEntryType {
/**
* Indicates to get extension entry.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get extension entry.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
EXTENSION_ENTRY_TYPE_ENTRY = 0,
/**
* Indicates to get extension entry critical.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get extension entry critical.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
EXTENSION_ENTRY_TYPE_ENTRY_CRITICAL = 1,
/**
* Indicates to get extension entry value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get extension entry value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
EXTENSION_ENTRY_TYPE_ENTRY_VALUE = 2
}
/**
* Provides the cert encoding blob type.
*
* @typedef EncodingBlob
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the cert encoding blob type.
*
* @typedef EncodingBlob
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface EncodingBlob {
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
data: Uint8Array;
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
encodingFormat: EncodingFormat;
}
/**
* Provides the cert chain data type.
*
* @typedef CertChainData
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the cert chain data type.
*
* @typedef CertChainData
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface CertChainData {
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
data: Uint8Array;
/**
* The number of certs.
*
* @type { number }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The number of certs.
*
* @type { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
count: number;
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
encodingFormat: EncodingFormat;
}
/**
* Provides the x509 cert type.
*
* @typedef X509Cert
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the x509 cert type.
*
* @typedef X509Cert
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface X509Cert {
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @param { AsyncCallback<void> } callback - the callback of verify.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @param { AsyncCallback<void> } callback - the callback of verify.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
verify(key: cryptoFramework.PubKey, callback: AsyncCallback<void>): void;
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
verify(key: cryptoFramework.PubKey): Promise<void>;
/**
* Get X509 cert encoded data.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert encoded data.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Get X509 cert encoded data.
*
* @returns { Promise<EncodingBlob> } the promise of X509 cert encoded data.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert encoded data.
*
* @returns { Promise<EncodingBlob> } the promise of X509 cert encoded data.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Get X509 cert public key.
*
* @returns { cryptoFramework.PubKey } X509 cert pubKey.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert public key.
*
* @returns { cryptoFramework.PubKey } X509 cert pubKey.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getPublicKey(): cryptoFramework.PubKey;
/**
* Check the X509 cert validity with date.
*
* @param { string } date - indicates the cert date.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Check the X509 cert validity with date.
*
* @param { string } date - indicates the cert date.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
checkValidityWithDate(date: string): void;
/**
* Get X509 cert version.
*
* @returns { number } X509 cert version.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert version.
*
* @returns { number } X509 cert version.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getVersion(): number;
/**
* Get X509 cert serial number.
*
* @returns { number } X509 cert serial number.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 10
* @useinstead ohos.security.cert.X509Cert.getCertSerialNumber
*/
getSerialNumber(): number;
/**
* Get X509 cert serial number.
*
* @returns { bigint } X509 cert serial number.
* @throws { BusinessError } 19020002 - runtime error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get X509 cert serial number.
*
* @returns { bigint } X509 cert serial number.
* @throws { BusinessError } 19020002 - runtime error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getCertSerialNumber(): bigint;
/**
* Get X509 cert issuer name.
*
* @returns { DataBlob } X509 cert issuer name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert issuer name.
*
* @returns { DataBlob } X509 cert issuer name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getIssuerName(): DataBlob;
/**
* Get X509 cert subject name.
*
* @returns { DataBlob } X509 cert subject name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert subject name.
*
* @returns { DataBlob } X509 cert subject name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSubjectName(): DataBlob;
/**
* Get X509 cert not before time.
*
* @returns { string } X509 cert not before time.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert not before time.
*
* @returns { string } X509 cert not before time.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getNotBeforeTime(): string;
/**
* Get X509 cert not after time.
*
* @returns { string } X509 cert not after time.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert not after time.
*
* @returns { string } X509 cert not after time.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getNotAfterTime(): string;
/**
* Get X509 cert signature.
*
* @returns { DataBlob } X509 cert signature.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature.
*
* @returns { DataBlob } X509 cert signature.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignature(): DataBlob;
/**
* Get X509 cert signature's algorithm name.
*
* @returns { string } X509 cert signature's algorithm name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature's algorithm name.
*
* @returns { string } X509 cert signature's algorithm name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignatureAlgName(): string;
/**
* Get X509 cert signature's algorithm oid.
*
* @returns { string } X509 cert signature's algorithm oid.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature's algorithm oid.
*
* @returns { string } X509 cert signature's algorithm oid.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignatureAlgOid(): string;
/**
* Get X509 cert signature's algorithm name.
*
* @returns { DataBlob } X509 cert signature's algorithm name.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature's algorithm name.
*
* @returns { DataBlob } X509 cert signature's algorithm name.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignatureAlgParams(): DataBlob;
/**
* Get X509 cert key usage.
*
* @returns { DataBlob } X509 cert key usage.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert key usage.
*
* @returns { DataBlob } X509 cert key usage.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getKeyUsage(): DataBlob;
/**
* Get X509 cert extended key usage.
*
* @returns { DataArray } X509 cert extended key usage.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert extended key usage.
*
* @returns { DataArray } X509 cert extended key usage.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getExtKeyUsage(): DataArray;
/**
* Get X509 cert basic constraints path len.
*
* @returns { number } X509 cert basic constraints path len.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert basic constraints path len.
*
* @returns { number } X509 cert basic constraints path len.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getBasicConstraints(): number;
/**
* Get X509 cert subject alternative name.
*
* @returns { DataArray } X509 cert subject alternative name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert subject alternative name.
*
* @returns { DataArray } X509 cert subject alternative name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSubjectAltNames(): DataArray;
/**
* Get X509 cert issuer alternative name.
*
* @returns { DataArray } X509 cert issuer alternative name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert issuer alternative name.
*
* @returns { DataArray } X509 cert issuer alternative name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getIssuerAltNames(): DataArray;
/**
* Get certificate item value.
*
* @param { CertItemType } itemType
* @returns { DataBlob } cert item value.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate item value.
*
* @param { CertItemType } itemType
* @returns { DataBlob } cert item value.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getItem(itemType: CertItemType): DataBlob;
/**
* Check the X509 cert if match the parameters.
*
* @param { X509CertMatchParameters } param - indicate the match parameters.
* @returns { boolean } true - match X509Cert, false - not match.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
match(param: X509CertMatchParameters): boolean;
}
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509Cert> } callback - the callback of createX509Cert.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509Cert> } callback - the callback of createX509Cert.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createX509Cert(inStream: EncodingBlob, callback: AsyncCallback<X509Cert>): void;
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509Cert> } the promise of X509 cert instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509Cert> } the promise of X509 cert instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createX509Cert(inStream: EncodingBlob): Promise<X509Cert>;
/**
* The CertExtension interface is used to parse and verify certificate extension.
*
* @typedef CertExtension
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* The CertExtension interface is used to parse and verify certificate extension.
*
* @typedef CertExtension
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface CertExtension {
/**
* Get certificate extension encoded data.
*
* @returns { EncodingBlob } cert extension encoded data.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate extension encoded data.
*
* @returns { EncodingBlob } cert extension encoded data.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEncoded(): EncodingBlob;
/**
* Get certificate extension oid list.
*
* @param { ExtensionOidType } valueType
* @returns { DataArray } cert extension OID list value.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate extension oid list.
*
* @param { ExtensionOidType } valueType
* @returns { DataArray } cert extension OID list value.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getOidList(valueType: ExtensionOidType): DataArray;
/**
* Get certificate extension entry.
*
* @param { ExtensionEntryType } valueType
* @param { DataBlob } oid
* @returns { DataBlob } cert extension entry value.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate extension entry.
*
* @param { ExtensionEntryType } valueType
* @param { DataBlob } oid
* @returns { DataBlob } cert extension entry value.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEntry(valueType: ExtensionEntryType, oid: DataBlob): DataBlob;
/**
* Check whether the certificate is a CA(The keyusage contains signature usage and the value of cA in BasicConstraints is true).
* If not a CA, return -1, otherwise return the path length constraint in BasicConstraints.
* If the certificate is a CA and the path length constraint does not appear, then return -2 to indicate that there is no limit to path length.
*
* @returns { number } path length constraint.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Check whether the certificate is a CA(The keyusage contains signature usage and the value of cA in BasicConstraints is true).
* If not a CA, return -1, otherwise return the path length constraint in BasicConstraints.
* If the certificate is a CA and the path length constraint does not appear, then return -2 to indicate that there is no limit to path length.
*
* @returns { number } path length constraint.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
checkCA(): number;
/**
* Check If exists Unsupported critical extension.
*
* @returns { boolean } true - exists unsupported critical extension, false - else.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
hasUnsupportedCriticalExtension(): boolean;
}
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @param { AsyncCallback<CertExtension> } callback - the callback of of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @param { AsyncCallback<CertExtension> } callback - the callback of of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createCertExtension(inStream: EncodingBlob, callback: AsyncCallback<CertExtension>): void;
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @returns { Promise<CertExtension> } the promise of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @returns { Promise<CertExtension> } the promise of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createCertExtension(inStream: EncodingBlob): Promise<CertExtension>;
/**
* Interface of X509CrlEntry.
*
* @typedef X509CrlEntry
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry
*/
interface X509CrlEntry {
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getEncoded
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @returns { Promise<EncodingBlob> } the promise of crl entry blob data.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getEncoded
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Get the serial number from this x509crl entry.
*
* @returns { number } serial number of crl entry.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getSerialNumber
*/
getSerialNumber(): number;
/**
* Get the issuer of the x509 certificate described by this entry.
*
* @returns { DataBlob } DataBlob of issuer.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getCertIssuer
*/
getCertIssuer(): DataBlob;
/**
* Get the revocation date from x509crl entry.
*
* @returns { string } string of revocation date.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getRevocationDate
*/
getRevocationDate(): string;
}
/**
* Interface of X509CRLEntry.
*
* @typedef X509CRLEntry
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface X509CRLEntry {
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @returns { Promise<EncodingBlob> } the promise of CRL entry blob data.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Get the serial number from this x509CRL entry.
*
* @returns { bigint } serial number of CRL entry.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSerialNumber(): bigint;
/**
* Get the issuer of the x509 certificate described by this entry.
*
* @returns { DataBlob } DataBlob of issuer.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getCertIssuer(): DataBlob;
/**
* Get the revocation date from x509CRL entry.
*
* @returns { string } string of revocation date.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getRevocationDate(): string;
/**
* Get Extensions of CRL Entry.
*
* @returns { DataBlob } DataBlob of extensions
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getExtensions(): DataBlob;
/**
* Check If CRL Entry has extension .
*
* @returns { boolean } true - CRL Entry has extension, false - else.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
hasExtensions(): boolean;
}
/**
* Interface of X509Crl.
*
* @typedef X509Crl
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL
*/
interface X509Crl {
/**
* Check if the given certificate is on this CRL.
*
* @param { X509Cert } cert - input cert data.
* @returns { boolean } result of Check cert is revoked or not.
* @throws { BusinessError } 401 - invalid parameters.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#isRevoked
*/
isRevoked(cert: X509Cert): boolean;
/**
* Returns the type of this CRL.
*
* @returns { string } string of crl type.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getType
*/
getType(): string;
/**
* Get the der coding format.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getEncoded
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Get the der coding format.
*
* @returns { Promise<EncodingBlob> } the promise of crl blob data.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getEncoded
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @param { AsyncCallback<void> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#verify
*/
verify(key: cryptoFramework.PubKey, callback: AsyncCallback<void>): void;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#verify
*/
verify(key: cryptoFramework.PubKey): Promise<void>;
/**
* Get version number from CRL.
*
* @returns { number } version of crl.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getVersion
*/
getVersion(): number;
/**
* Get the issuer name from CRL. Issuer means the entity that signs and publishes the CRL.
*
* @returns { DataBlob } issuer name of crl.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getIssuerName
*/
getIssuerName(): DataBlob;
/**
* Get lastUpdate value from CRL.
*
* @returns { string } last update of crl.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getLastUpdate
*/
getLastUpdate(): string;
/**
* Get nextUpdate value from CRL.
*
* @returns { string } next update of crl.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getNextUpdate
*/
getNextUpdate(): string;
/**
* This method can be used to find CRL entries in specified CRLs.
*
* @param { number } serialNumber - serial number of crl.
* @returns { X509CrlEntry } next update of crl.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCert
*/
getRevokedCert(serialNumber: number): X509CrlEntry;
/**
* This method can be used to find CRL entries in specified cert.
*
* @param { X509Cert } cert - cert of x509.
* @returns { X509CrlEntry } X509CrlEntry instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCertWithCert
*/
getRevokedCertWithCert(cert: X509Cert): X509CrlEntry;
/**
* Get all entries in this CRL.
*
* @param { AsyncCallback<Array<X509CrlEntry>> } callback - the callback of getRevokedCerts.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCerts
*/
getRevokedCerts(callback: AsyncCallback<Array<X509CrlEntry>>): void;
/**
* Get all entries in this CRL.
*
* @returns { Promise<Array<X509CrlEntry>> } the promise of X509CrlEntry instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCerts
*/
getRevokedCerts(): Promise<Array<X509CrlEntry>>;
/**
* Get the CRL information encoded by Der from this CRL.
*
* @returns { DataBlob } DataBlob of tbs info.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getTBSInfo
*/
getTbsInfo(): DataBlob;
/**
* Get signature value from CRL.
*
* @returns { DataBlob } DataBlob of signature.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignature
*/
getSignature(): DataBlob;
/**
* Get the signature algorithm name of the CRL signature algorithm.
*
* @returns { string } string of signature algorithm name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignatureAlgName
*/
getSignatureAlgName(): string;
/**
* Get the signature algorithm oid string from CRL.
*
* @returns { string } string of signature algorithm oid.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignatureAlgOid
*/
getSignatureAlgOid(): string;
/**
* Get the der encoded signature algorithm parameters from the CRL signature algorithm.
*
* @returns { DataBlob } DataBlob of signature algorithm params.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignatureAlgParams
*/
getSignatureAlgParams(): DataBlob;
}
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @param { AsyncCallback<X509Crl> } callback - the callback of createX509Crl to return x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert#createX509CRL
*/
function createX509Crl(inStream: EncodingBlob, callback: AsyncCallback<X509Crl>): void;
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @returns { Promise<X509Crl> } the promise of x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert#createX509CRL
*/
function createX509Crl(inStream: EncodingBlob): Promise<X509Crl>;
/**
* Interface of X509CRL.
*
* @typedef X509CRL
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface X509CRL {
/**
* Check if the given certificate is on this CRL.
*
* @param { X509Cert } cert - input cert data.
* @returns { boolean } result of Check cert is revoked or not.
* @throws { BusinessError } 401 - invalid parameters.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
isRevoked(cert: X509Cert): boolean;
/**
* Returns the type of this CRL.
*
* @returns { string } string of CRL type.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getType(): string;
/**
* Get the der coding format.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Get the der coding format.
*
* @returns { Promise<EncodingBlob> } the promise of CRL blob data.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @param { AsyncCallback<void> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
verify(key: cryptoFramework.PubKey, callback: AsyncCallback<void>): void;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
verify(key: cryptoFramework.PubKey): Promise<void>;
/**
* Get version number from CRL.
*
* @returns { number } version of CRL.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getVersion(): number;
/**
* Get the issuer name from CRL. Issuer means the entity that signs and publishes the CRL.
*
* @returns { DataBlob } issuer name of CRL.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getIssuerName(): DataBlob;
/**
* Get lastUpdate value from CRL.
*
* @returns { string } last update of CRL.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getLastUpdate(): string;
/**
* Get nextUpdate value from CRL.
*
* @returns { string } next update of CRL.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getNextUpdate(): string;
/**
* This method can be used to find CRL entries in specified CRLs.
*
* @param { bigint } serialNumber - serial number of CRL.
* @returns { X509CRLEntry } next update of CRL.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getRevokedCert(serialNumber: bigint): X509CRLEntry;
/**
* This method can be used to find CRL entries in specified cert.
*
* @param { X509Cert } cert - cert of x509.
* @returns { X509CRLEntry } X509CRLEntry instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getRevokedCertWithCert(cert: X509Cert): X509CRLEntry;
/**
* Get all entries in this CRL.
*
* @param { AsyncCallback<Array<X509CRLEntry>> } callback - the callback of getRevokedCerts.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getRevokedCerts(callback: AsyncCallback<Array<X509CRLEntry>>): void;
/**
* Get all entries in this CRL.
*
* @returns { Promise<Array<X509CRLEntry>> } the promise of X509CRLEntry instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getRevokedCerts(): Promise<Array<X509CRLEntry>>;
/**
* Get the CRL information encoded by Der from this CRL.
*
* @returns { DataBlob } DataBlob of tbs info.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getTBSInfo(): DataBlob;
/**
* Get signature value from CRL.
*
* @returns { DataBlob } DataBlob of signature.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignature(): DataBlob;
/**
* Get the signature algorithm name of the CRL signature algorithm.
*
* @returns { string } string of signature algorithm name.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignatureAlgName(): string;
/**
* Get the signature algorithm oid string from CRL.
*
* @returns { string } string of signature algorithm oid.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignatureAlgOid(): string;
/**
* Get the der encoded signature algorithm parameters from the CRL signature algorithm.
*
* @returns { DataBlob } DataBlob of signature algorithm params.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getSignatureAlgParams(): DataBlob;
/**
* Get Extensions of CRL Entry.
*
* @returns { DataBlob } DataBlob of extensions
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getExtensions(): DataBlob;
/**
* Check if the X509 CRL match the parameters.
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @returns { boolean } true - match X509CRL, false - not match.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
match(param: X509CRLMatchParameters): boolean;
}
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @param { AsyncCallback<X509CRL> } callback - the callback of createX509CRL to return x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createX509CRL(inStream: EncodingBlob, callback: AsyncCallback<X509CRL>): void;
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @returns { Promise<X509CRL> } the promise of x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createX509CRL(inStream: EncodingBlob): Promise<X509CRL>;
/**
* Certification chain validator.
*
* @typedef CertChainValidator
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Certification chain validator.
*
* @typedef CertChainValidator
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface CertChainValidator {
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @param { AsyncCallback<void> } callback - the callback of validate.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @param { AsyncCallback<void> } callback - the callback of validate.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
validate(certChain: CertChainData, callback: AsyncCallback<void>): void;
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
validate(certChain: CertChainData): Promise<void>;
/**
* The cert chain related algorithm.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The cert chain related algorithm.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
readonly algorithm: string;
}
/**
* Provides to create certificate chain object. The returned object provides the verification capability.
*
* @param { string } algorithm - indicates the cert chain validator type.
* @returns { CertChainValidator } the cert chain validator instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides to create certificate chain object. The returned object provides the verification capability.
*
* @param { string } algorithm - indicates the cert chain validator type.
* @returns { CertChainValidator } the cert chain validator instance.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createCertChainValidator(algorithm: string): CertChainValidator;
/**
* X509 Cert match parameters
*
* @typedef X509CertMatchParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface X509CertMatchParameters {
/**
* To match X509Cert:
* [Rule]
* null : Do not match.
* NOT null : match if x509Cert.getEncoding is equal.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
x509Cert?: X509Cert;
/**
* To match the validDate of cert:
* [Rule]
* null : Do not match.
* NOT null : match if [notBefore of cert] <= [validDate] <= [notAfter of cert].
*
* @type { ?string } format is YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
validDate?: string;
/**
* To match the issuer of cert:
* [Rule]
* null : Do not match.
* NOT null : match if it is equal with [issuer of cert] in DER encoding.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
issuer?: Uint8Array;
/**
* To match the KeyUsage of cert extensions: :
* [Rule]
* null : Do not match.
* NOT null : match ok if [KeyUsage of cert extensions] is null, or
* [KeyUsage of cert extensions] include [keyUsage].
*
* @type { ?Array<boolean> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
keyUsage?: Array<boolean>;
/**
* The specified serial number must match the serialnumber for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [serialNumber of cert].
*
* @type { ?bigint }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
serialNumber?: bigint;
/**
* The specified value must match the subject for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [subject of cert].
*
* @type { ?Uint8Array } subject in DER encoding format
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
subject?: Uint8Array;
/**
* The specified value must match the publicKey for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [publicKey of cert].
*
* @type { ?DataBlob } publicKey
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
publicKey?: DataBlob;
/**
* The specified value must match the publicKey for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [publicKey of cert].
*
* @type { ?string } the object identifier (OID) of the signature algorithm to check.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
publicKeyAlgID?: string;
}
/**
* X509 CRL match parameters
*
* @typedef X509CRLMatchParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface X509CRLMatchParameters {
/**
* To match the issuer of cert:
* [Rule]
* null : Do not match.
* NOT null : match if it is equal with [issuer of cert] in DER encoding.
*
* @type { ?Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
issuer?: Array<Uint8Array>;
/**
* To match X509Cert:
* [Rule]
* null : Do not match.
* NOT null : match if x509Cert.getEncoding is equal.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
x509Cert?: X509Cert;
}
/**
* The certificate and CRL collection object.
*
* @typedef CertCRLCollection
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface CertCRLCollection {
/**
* return all Array<X509Cert> which match X509CertMatchParameters
*
* @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object.
* @returns { Promise<Array<X509Cert>> }
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
selectCerts(param: X509CertMatchParameters): Promise<Array<X509Cert>>;
/**
* return the X509 Cert which match X509CertMatchParameters
*
* @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object.
* @param { AsyncCallback<Array<X509Cert>> } callback - the callback of select cert.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
selectCerts(param: X509CertMatchParameters, callback: AsyncCallback<Array<X509Cert>>): void;
/**
* return all X509 CRL which match X509CRLMatchParameters
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @returns { Promise<Array<X509CRL>> }
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
selectCRLs(param: X509CRLMatchParameters): Promise<Array<X509CRL>>;
/**
* return all X509 CRL which match X509CRLMatchParameters
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @param { AsyncCallback<Array<X509CRL>> } callback - the callback of select CRL.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
selectCRLs(param: X509CRLMatchParameters, callback: AsyncCallback<Array<X509CRL>>): void;
}
/**
* create object CertCRLCollection
*
* @param { Array<X509Cert> } certs - array of X509Cert.
* @param { Array<X509CRL> } [options] crls - array of X509CRL.
* @returns { CertCRLCollection }
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createCertCRLCollection(certs: Array<X509Cert>, crls?: Array<X509CRL>): CertCRLCollection;
/**
* X509 Certification chain object.
*
* @typedef X509CertChain
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface X509CertChain {
/**
* Get the X509 certificate list.
*
* @returns { Array<X509Cert> } the X509 certificate list.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
getCertList(): Array<X509Cert>;
/**
* Validate the cert chain with validate parameters.
*
* @param { CertChainValidationParameters } param - indicate the cert chain Validate parameters.
* @returns { Promise<CertChainValidationResult> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
validate(param: CertChainValidationParameters): Promise<CertChainValidationResult>;
/**
* Validate the cert chain with validate parameters.
*
* @param { CertChainValidationParameters } param - indicate the cert chain validate parameters.
* @param { AsyncCallback<CertChainValidationResult> } callback - indicate the cert chain validate result.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19020002 - runtime error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
validate(param: CertChainValidationParameters, callback: AsyncCallback<CertChainValidationResult>): void;
}
/**
* Provides to create X509 certificate chain object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509CertChain> }
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createX509CertChain(inStream: EncodingBlob): Promise<X509CertChain>;
/**
* Provides to create X509 certificate chain object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509CertChain> } callback
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createX509CertChain(inStream: EncodingBlob, callback: AsyncCallback<X509CertChain>): void;
/**
* Create certificate chain object with certificate array.
*
* @param { Array<X509Cert> } certs - indicate the certificate array.
* @returns { X509CertChain } the certificate chain object.
* @throws { BusinessError } 401 - invalid parameters.
* @throws { BusinessError } 19020001 - memory error.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
function createX509CertChain(certs: Array<X509Cert>): X509CertChain;
/**
* Provides the x509 trust anchor type.
*
* @typedef X509TrustAnchor
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface X509TrustAnchor {
/**
* The trust CA cert.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CACert?: X509Cert;
/**
* The trust CA public key in DER format.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CAPubKey?: Uint8Array;
/**
* The trust CA subject in DER format.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
CASubject?: Uint8Array;
}
/**
* Provides the certificate chain validate parameters type.
*
* @typedef CertChainValidationParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface CertChainValidationParameters {
/**
* The datetime to verify the certificate chain validity period.
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
date?: string;
/**
* The trust ca certificates to verify the certificate chain.
*
* @type { Array<X509TrustAnchor> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
trustAnchors: Array<X509TrustAnchor>;
/**
* The cert and CRL list to build cert chain and verify the certificate chain revocation state.
*
* @type { ?Array<CertCRLCollection> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
certCRLs?: Array<CertCRLCollection>;
}
/**
* Certification chain validate result.
*
* @typedef CertChainValidationResult
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
interface CertChainValidationResult {
/**
* The cert chain trust anchor.
*
* @type { X509TrustAnchor }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
readonly trustAnchor: X509TrustAnchor;
/**
* The target certificate.
*
* @type { X509Cert }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
readonly entityCert: X509Cert;
}
}
export default cert;
Reference in New Issue View Git Blame Copy Permalink