目录

SecurityAudit（安全审计）

提供统一的安全审计数据订阅与取消订阅接口，应用可以获取设备上的安全审计数据，以支撑审计业务。

起始版本：5.0.0(12)

导入模块

import { securityAudit } from '@kit.DeviceSecurityKit';

AuditEventInfo

用于订阅或取消订阅接口的请求参数。

系统能力：SystemCapability.Security.SecurityAudit

起始版本：5.0.0(12)

名称

类型

只读

可选

说明

eventId

number

否

否

审计事件ID，用于指定需要获取的安全审计数据。例如：0x810800800

审计事件ID的取值范围是[0, 0xFFFFFFFFF]。

AuditEvent

安全审计数据。

系统能力：SystemCapability.Security.SecurityAudit

起始版本：5.0.0(12)

名称

类型

只读

可选

说明

eventId

number

否

否

审计事件ID，与请求参数中的审计事件ID相同。

version

string

否

是

审计事件版本号。

timestamp

string

否

是

审计事件发生时间。格式为： YYYYMMDDHHMMSS

content

string

否

是

审计事件内容。不同审计事件具备不同的内容，内容为json格式字符串。例如：{"type": 1}

userId

number

否

是

发生审计事件时，登录的用户ID。

deviceId

string

否

是

审计事件发生的设备Id。

on("auditEventOccur")

on(type: 'auditEventOccur', auditEventInfo: AuditEventInfo, callback: Callback<AuditEvent>): void

订阅安全审计数据。

需要权限：ohos.permission.QUERY_AUDIT_EVENT

系统能力：SystemCapability.Security.SecurityAudit

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

订阅的事件类型名称，固定值 ‘auditEventOccur’，表示审计事件。

auditEventInfo

AuditEventInfo

是

订阅的审计数据信息。

callback

Callback<AuditEvent>

是

用于接收审计事件的回调函数。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID

错误信息

201

check permission fail.

401

invalid parameters.

Possible causes:

1. Mandatory parameters are left unspecified.

2. Incorrect parameter types.

3. Parameter verification failed.

示例：

import { securityAudit } from '@kit.DeviceSecurityKit';
import { BusinessError} from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

const TAG = "SecurityAuditAuditJsTest";
const callback = (event: securityAudit.AuditEvent) => {
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func eventId= ' + event.eventId);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func version= ' + event.version);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func content= ' + event.content);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func timestamp= ' + event.timestamp);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func userId= ' + event.userId);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func deviceId= ' + event.deviceId);
};
let auditEventInfo: securityAudit.AuditEventInfo = {
   eventId: 0x810800800
};

try {
  hilog.info(0x0000, TAG, 'on begin.');
  securityAudit.on('auditEventOccur', auditEventInfo, callback);
  hilog.info(0x0000, TAG, 'Succeeded in on.');
} catch (err) {
  let e: BusinessError = err as BusinessError;
  hilog.error(0x0000, TAG, 'on failed: %{public}d %{public}s', e.code, e.message);
}

off("auditEventOccur")

off(type: 'auditEventOccur', auditEventInfo: AuditEventInfo, callback?: Callback<AuditEvent>): void

取消订阅安全审计数据。

需要权限：ohos.permission.QUERY_AUDIT_EVENT

系统能力：SystemCapability.Security.SecurityAudit

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

取消订阅的事件类型名称，固定值 ‘auditEventOccur’，表示审计事件。

auditEventInfo

AuditEventInfo

是

取消订阅的审计数据信息。

callback

Callback<AuditEvent>

否

用于接收审计数据的回调函数。如果传入了 callback，则取消该callback的订阅，否则取消所有callback的订阅。

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

错误码ID

错误信息

201

check permission fail.

401

invalid parameters.

Possible causes:

1. Mandatory parameters are left unspecified.

2. Incorrect parameter types.

3. Parameter verification failed.

示例：

import { securityAudit } from '@kit.DeviceSecurityKit';
import { BusinessError} from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

const TAG = "SecurityAuditAuditJsTest";
let auditEventInfo: securityAudit.AuditEventInfo = {
   eventId: 0x810800800
};

try {
  hilog.info(0x0000, TAG, 'off begin.');
  securityAudit.off('auditEventOccur', auditEventInfo);
  hilog.info(0x0000, TAG, 'Succeeded in off.');
} catch (err) {
  let e: BusinessError = err as BusinessError;
  hilog.error(0x0000, TAG, 'off failed: %{public}d %{public}s', e.code, e.message);
}