订阅通知类事件
=======

#### 场景介绍

从6.0.0(20)开始，新增提供统一的安全审计数据多客户端订阅/取消订阅与添加/删除过滤条件接口，应用可以获取设备上的安全审计数据（详见[API参考](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/devicesecurity-capi-securityaudit#securityaudit_notify_event)），并按需进行过滤，以支撑审计相关业务。

#### 约束与限制

1.  当前能力仅支持2in1设备。
    
2.  一个进程最大只允许创建2个客户端实例，当前设备最多只允许创建16个客户端实例。
    
3.  一个客户端实例最大只允许设置256个Filter，每个Filter限制10条过滤value。
    

#### 业务流程

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/83/v3/NDR3_BS7SZS8WZuMHSzpZw/zh-cn_image_0000002664208213.png?HW-CC-KV=V1&HW-CC-Date=20260709T132416Z&HW-CC-Expire=86400&HW-CC-Sign=AD2624280DB35801A46D3D69B2A6D593C30219F6F66A6DCE6FD464CA55DE087D)

**流程说明：**

1.  开发者创建审计通知类事件(以下统称为事件)订阅客户端实例，需要提供CallBack。
    
2.  开发者使用1中创建的实例订阅事件，需要提供想要订阅的事件id。
    
3.  开发者使用1中创建的实例设置事件过滤条件，需要提供事件id和过滤条件信息。
    
4.  当事件发生时，审计服务先根据事件过滤条件过滤事件，当事件满足过滤条件时，触发回调通知订阅当前事件的客户端。
    
5.  开发者根据审计数据处理业务。
    
6.  当开发者应用不需要过滤/使用该审计数据时，开发者可以使用1中创建的实例解除过滤条件，取消对应的订阅事件。
    
7.  当开发者应用不需要使用当前实例时，开发者可以删除实例。
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/5b/v3/1hE_FTo8SMqnwDrQuKwaQA/note_3.0-zh-cn.png?HW-CC-KV=V1&HW-CC-Date=20260709T132416Z&HW-CC-Expire=86400&HW-CC-Sign=C2801BE4EF3528427B1FBE7CC54ADA714EE5E791DD34E0CDDECDCB6216218553)
    
    支持先设置过滤条件再订阅事件。
    
    删除实例后，被删除的实例所有的订阅以及过滤条件将被全部解除。
    

#### 接口说明

接口如下表，更多接口及使用方法请参见[API参考](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/devicesecurity-capi-securityaudit#hms_securityaudit_newclient)。

| 接口名 | 描述 |
| :-- | :-- |
| int32\_t HMS\_SecurityAudit\_NewClient(SecurityAudit\_Client\*\* client, SecurityAudit\_Handler handler) | 创建通知类事件管理对象Client，Client提供订阅、解订阅、增加事件过滤、移除事件过滤功能。 |
| int32\_t HMS\_SecurityAudit\_DeleteClient(SecurityAudit\_Client\* client) | 删除审计通知类事件管理对象。 |
| int32\_t HMS\_SecurityAudit\_Subscribe(const SecurityAudit\_Client\* client, const SecurityAudit\_Notify\_Event \*events, uint64\_t count) | 订阅审计通知类事件。 |
| int32\_t HMS\_SecurityAudit\_Unsubscribe(const SecurityAudit\_Client\* client, const SecurityAudit\_Notify\_Event \*events, uint64\_t count) | 解订阅审计通知类事件。 |
| int32\_t HMS\_SecurityAudit\_AddFilter(const SecurityAudit\_Client\* client, SecurityAudit\_Notify\_Event event, const SecurityAudit\_Filter \*filter) | 添加审计通知类事件过滤条件。 |
| int32\_t HMS\_SecurityAudit\_RemoveFilter(const SecurityAudit\_Client\* client, SecurityAudit\_Notify\_Event event, const SecurityAudit\_Filter \*filter) | 移除审计通知类事件过滤条件。 |

#### 开发步骤

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/51/v3/2RI5Gw1XRByrBg2Almb21Q/note_3.0-zh-cn.png?HW-CC-KV=V1&HW-CC-Date=20260709T132416Z&HW-CC-Expire=86400&HW-CC-Sign=A62EDE6F8EBDF385528A3BC79BB6107DCA16C24DEC7FEF52A79505984F64B02C)

*   在开发准备过程中，需要申请权限：ohos.permission.QUERY\_AUDIT\_EVENT。
    
*   只允许清单内的企业类应用申请该权限，申请方式请参考：[申请使用企业类应用可用权限](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/permissions-for-enterprise-apps)。
    

1.  在CMakeLists.txt中导入安全审计共享库，并链接该库。
    
    find\_library(dsm-lib libsecurityaudit\_ndk.z.so)
    target\_link\_libraries(entry PUBLIC libace\_napi.z.so ${dsm-lib})
    
2.  导入安全审计的头文件。
    
    #include <DeviceSecurityKit/security\_audit.h>
    #include <cstdio>
    
3.  全局范围定义通知类事件的回调函数。
    
    void Notify(const SecurityAudit\_Event \*events, uint64\_t count)
    {
        if (events == nullptr) {
            printf("events nullptr");
            return;
        }
        for (uint64\_t i = 0; i < count; i++) {
            printf("event content = %s", events\[i\].content);
            printf("event id = %ld", events\[i\].eventId);
        }
    }
    
4.  创建审计通知类事件客户端实例。
    
    SecurityAudit\_Client \*client = NULL;
    SecurityAudit\_Handler handler = Notify;
    HMS\_SecurityAudit\_NewClient(&client, handler);
    if (client == nullptr) {
        printf("client is null");
        return 0;
    }
    
5.  订阅审计通知类事件。
    
    SecurityAudit\_Notify\_Event event\[1\] = {};
    event\[0\] = SECURITY\_AUDIT\_NOTIFY\_EVENT\_KIA\_READ;
    int ret = HMS\_SecurityAudit\_Subscribe(client, event, 1);
    if (ret != 0) {
        printf("subscribe fail");
        return;
    }
    
6.  设置审计通知类事件过滤条件。
    
    SecurityAudit\_Filter filter = {};
    filter.type = PROCESS\_NAME\_PREFIX;
    const char\* filterStr\[1\] = {};
    filterStr\[0\] = "1";
    filter.value = filterStr;
    filter.valueCount = 1;
    ret = HMS\_SecurityAudit\_AddFilter(client, SECURITY\_AUDIT\_NOTIFY\_EVENT\_KIA\_READ, &filter);
    if (ret != 0) {
        printf("addfilter fail");
        return;
    }
    
7.  解除审计通知类事件订阅。
    
    ret = HMS\_SecurityAudit\_Unsubscribe(client, event, 1);
    if (ret != 0) {
        printf("unsubscribe fail");
        return;
    }
    
8.  解除审计通知类事件过滤条件。
    
    ret = HMS\_SecurityAudit\_RemoveFilter(client, SECURITY\_AUDIT\_NOTIFY\_EVENT\_KIA\_READ, &filter);
    if (ret != 0) {
        printf("removefilter fail");
        return;
    }
    
9.  删除审计通知类事件客户端实例。
    
    ret = HMS\_SecurityAudit\_DeleteClient(client);
    if (ret != 0) {
        printf("deleteclient fail");
        return;
    }