diff --git a/api/@ohos.deviceAttest.d.ts b/api/@ohos.deviceAttest.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..863d29f3020d162db149d871210d1d6f3771749a --- /dev/null +++ b/api/@ohos.deviceAttest.d.ts @@ -0,0 +1,105 @@ +/* + * Copyright (c) 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. + */ + +import { AsyncCallback, Callback } from './basic'; + +/** + * xts_device_attest authResult information + * + * @since 9 + * @syscap SystemCapability.XTS.DeviceAttest + */ +declare namespace deviceAttest { + /** + * Obtains the AttestResultInfo object. + * + * @param callback Indicates the callback containing the AttestResultInfo object. + * @since 9 + * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. + * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 20000001 - system service exception. + * @systemapi + */ + function getAttestStatus(callback: AsyncCallback) : void; + + /** + * Obtains the AttestResultInfo object. + * + * @returns Returns that the AttestResultInfo object is returned in Promise mode. + * @since 9 + * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. + * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 20000001 - system service exception. + * @systemapi + */ + function getAttestStatus() : Promise; + + /** + * Obtains the AttestResultInfo object. + * + * @returns Obtains the AttestResultInfo object synchronously. + * @since 9 + * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. + * @throws { BusinessError } 401 - The parameter check failed. + * @throws { BusinessError } 20000001 - system service exception. + * @systemapi + */ + function getAttestStatusSync() : AttestResultInfo; + + /** + * Device attest result information. + * @typedef AttestResultInfo + * @syscap SystemCapability.XTS.DeviceAttest + * @since 9 + * @systemapi + */ + export interface AttestResultInfo { + + /** + * Result of the device hardware information authentication. + * + * @type { number } + * @since 9 + */ + authResult : number; + + /** + * Result of the device software information authentication. + * + * @type { number } + * @since 9 + */ + softwareResult : number; + + /** + * Software result detail array that includes versionId, patchLevel, + * rootHash and a reserved space. + * + * @type { Array } + * @since 9 + */ + softwareResultDetail : Array; + + /** + * Credential sent from the cloud. + * + * @type { string } + * @since 9 + */ + ticket : string; + } +} + +export default deviceAttest; \ No newline at end of file diff --git a/build-tools/api_check_plugin/code_style_rule.json b/build-tools/api_check_plugin/code_style_rule.json index a638432928d66a4f36471c56ac2d07a042b212a0..54556c73ea57ad2d0f8125c4f8401010bf84b838 100644 --- a/build-tools/api_check_plugin/code_style_rule.json +++ b/build-tools/api_check_plugin/code_style_rule.json @@ -490,6 +490,10 @@ "AAID", "OAID", "VAID" + ], + "XTS":[ + "DeviceAttest", + "DeviceAttestLite" ] } }