# 订阅地址越界事件（C/C++）

#### 接口说明

API接口的具体使用说明（参数使用限制、具体取值范围等）请参考hiappevent.h。

**订阅接口功能介绍**：

| 接口名 | 描述 |
| --- | --- |
| int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher *watcher) | 添加应用事件观察者，以添加对应用事件的订阅。 |
| int OH_HiAppEvent_RemoveWatcher(HiAppEvent_Watcher *watcher) | 移除应用事件观察者，以移除对应用事件的订阅。 |

#### 开发步骤

以实现对写数组越界场景生成的地址越界事件订阅为例，说明开发步骤。

#### 步骤一：新建工程

1.  参考三方开源库jsoncpp代码仓README中**Using JsonCpp in your project**介绍的使用方法获取到jsoncpp.cpp、json.h和json-forwards.h三个文件。
    
2.  新建Native C++工程，并将上述文件导入到新建工程内，目录结构如下：
    
    ```
    entry:
      src:
        main:
          cpp:
            - json:
                - json.h
                - json-forwards.h
            - types:
                libentry:
                  - index.d.ts
            - CMakeLists.txt
            - napi_init.cpp
            - jsoncpp.cpp
          ets:
            - entryability:
                - EntryAbility.ets
            - pages:
                - Index.ets
    ```
    
3.  编辑"CMakeLists.txt"文件，添加源文件及动态库：
    
    ```
    # 新增jsoncpp.cpp(解析订阅事件中的json字符串)源文件
    add_library(entry SHARED napi_init.cpp jsoncpp.cpp)
    # 新增动态库依赖libhiappevent_ndk.z.so和libhilog_ndk.z.so(日志输出)
    target_link_libraries(entry PUBLIC libace_napi.z.so libhilog_ndk.z.so libhiappevent_ndk.z.so)
    ```
    
4.  编辑"napi\_init.cpp"文件，导入依赖的文件，并定义LOG\_TAG：
    
    ```
    #include "napi/native_api.h"
    #include "json/json.h"
    #include "hilog/log.h"
    #include "hiappevent/hiappevent.h"
    
    #undef LOG_TAG
    #define LOG_TAG "testTag"
    ```
    

#### 步骤二：订阅地址越界事件

1.  订阅系统事件：
    
    *   onReceive类型观察者：
        
        编辑"napi\_init.cpp"文件，定义onReceive类型观察者相关方法：
        
        ```
        // 定义一个变量，用来缓存创建的观察者的指针。
        static HiAppEvent_Watcher *systemEventWatcher;
        
        static void OnReceive(const char *domain, const struct HiAppEvent_AppEventGroup *appEventGroups, uint32_t groupLen) {
            for (int i = 0; i < groupLen; ++i) {
                for (int j = 0; j < appEventGroups[i].infoLen; ++j) {
                    OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", appEventGroups[i].appEventInfos[j].domain);
                    OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", appEventGroups[i].appEventInfos[j].name);
                    OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", appEventGroups[i].appEventInfos[j].type);
                    if (strcmp(appEventGroups[i].appEventInfos[j].domain, DOMAIN_OS) == 0 &&
                        strcmp(appEventGroups[i].appEventInfos[j].name, EVENT_ADDRESS_SANITIZER) == 0) {
                        Json::Value params;
                        Json::Reader reader(Json::Features::strictMode());
                        Json::FastWriter writer;
                        if (reader.parse(appEventGroups[i].appEventInfos[j].params, params)) {
                            auto time = params["time"].asInt64();
                            auto bundleVersion = params["bundle_version"].asString();
                            auto bundleName = params["bundle_name"].asString();
                            auto pid = params["pid"].asInt();
                            auto uid = params["uid"].asInt();
                            auto type = params["type"].asString();
                            std::string logOverLimit = params["log_over_limit"].asBool() ? "true" : "false";
                            auto externalLog = writer.write(params["external_log"]);
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str());
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str());
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.type=%{public}s", type.c_str());
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str());
                            OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}s", logOverLimit.c_str());
                        }
                    }
                }
            }
        }
        
        static napi_value RegisterWatcher(napi_env env, napi_callback_info info) {
            // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
            systemEventWatcher = OH_HiAppEvent_CreateWatcher("onReceiverWatcher");
            // 设置订阅的事件为EVENT_ADDRESS_SANITIZER。
            const char *names[] = {EVENT_ADDRESS_SANITIZER};
            // 开发者订阅感兴趣的事件，此处订阅了系统事件。
            OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1);
            // 开发者设置已实现的回调函数，观察者接收到事件后回立即触发OnReceive回调。
            OH_HiAppEvent_SetWatcherOnReceive(systemEventWatcher, OnReceive);
            // 使观察者开始监听订阅的事件。
            OH_HiAppEvent_AddWatcher(systemEventWatcher);
            return {};
        }
        ```
        
    *   onTrigger类型观察者：
        
        编辑"napi\_init.cpp"文件，定义OnTrigger类型观察者相关方法：
        
        ```
        // 定义一个变量，用来缓存创建的观察者的指针。
        static HiAppEvent_Watcher *systemEventWatcher;
        
        // 开发者可以自行实现获取已监听到事件的回调函数，其中events指针指向内容仅在该函数内有效。
        static void OnTake(const char *const *events, uint32_t eventLen) {
            Json::Reader reader(Json::Features::strictMode());
            Json::FastWriter writer;
            for (int i = 0; i < eventLen; ++i) {
                Json::Value eventInfo;
                if (reader.parse(events[i], eventInfo)) {
                    auto domain =  eventInfo["domain_"].asString();
                    auto name = eventInfo["name_"].asString();
                    auto type = eventInfo["type_"].asInt();
                    OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", domain.c_str());
                    OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", name.c_str());
                    OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", type);
                    if (domain ==  DOMAIN_OS && name == EVENT_ADDRESS_SANITIZER) {
                        auto time = eventInfo["time"].asInt64();
                        auto bundleVersion = eventInfo["bundle_version"].asString();
                        auto bundleName = eventInfo["bundle_name"].asString();
                        auto pid = eventInfo["pid"].asInt();
                        auto uid = eventInfo["uid"].asInt();
                        auto asanType = eventInfo["type"].asString();
                        auto externalLog = writer.write(eventInfo["external_log"]);
                        std::string logOverLimit = eventInfo["log_over_limit"].asBool() ? "true" : "false";
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str());
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str());
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.crash_type=%{public}s", asanType.c_str());
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str());
                        OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}s", logOverLimit.c_str());
                    }
                }
            }
        }
        
        // 开发者可以自行实现订阅回调函数，以便对获取到的事件打点数据进行自定义处理。
        static void OnTrigger(int row, int size) {
            // 接收回调后，获取指定数量的已接收事件。
            OH_HiAppEvent_TakeWatcherData(systemEventWatcher, row, OnTake);
        }
        
        static napi_value RegisterWatcher(napi_env env, napi_callback_info info) {
            // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
            systemEventWatcher = OH_HiAppEvent_CreateWatcher("onTriggerWatcher");
            // 设置订阅的事件为EVENT_ADDRESS_SANITIZER。
            const char *names[] = {EVENT_ADDRESS_SANITIZER};
            // 开发者订阅感兴趣的事件，此处订阅了系统事件。
            OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1);
            // 开发者设置已实现的回调函数，需OH_HiAppEvent_SetTriggerCondition设置的条件满足方可触发。
            OH_HiAppEvent_SetWatcherOnTrigger(systemEventWatcher, OnTrigger);
            // 开发者可以设置订阅触发回调的条件，此处是设置新增事件打点数量为1个时，触发onTrigger回调。
            OH_HiAppEvent_SetTriggerCondition(systemEventWatcher, 1, 0, 0);
            // 使观察者开始监听订阅的事件。
            OH_HiAppEvent_AddWatcher(systemEventWatcher);
            return {};
        }
        ```
        

#### 步骤三：构造地址越界错误

1.  编辑"napi\_init.cpp"文件，定义Test方法，方法中对一个整数数组进行越界访问：
    
    ```
    static napi_value Test(napi_env env, napi_callback_info info)
    {
        int a[10];
        a[10] = 1;
        return {};
    }
    ```
    
2.  将RegisterWatcher和Test注册为ArkTS接口，编辑"napi\_init.cpp"文件，将RegisterWatcher和Test注册为ArkTS接口：
    
    ```
    static napi_value Init(napi_env env, napi_value exports)
    {
        napi_property_descriptor desc[] = {
            { "registerWatcher", nullptr, RegisterWatcher, nullptr, nullptr, nullptr, napi_default, nullptr },
            { "test", nullptr, Test, nullptr, nullptr, nullptr, napi_default, nullptr}
        };
        napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
        return exports;
    }
    ```
    
    编辑"index.d.ts"文件，定义ArkTS接口：
    
    ```
    export const registerWatcher: () => void;
    export const test: () => void;
    ```
    
3.  编辑"EntryAbility.ets"文件，在onCreate()函数中新增接口调用：
    
    ```
    // 导入依赖模块
    import testNapi from 'libentry.so';
    
    // 在onCreate()函数中新增接口调用
    // 启动时，注册系统事件观察者
    testNapi.registerWatcher();
    ```
    
4.  编辑“entry > src > main > ets > pages > Index.ets”文件，新增按钮触发地址越界事件：
    
    ```
    import testNapi from 'libentry.so';
    
    @Entry
    @Component
    struct Index {
      build() {
        Row() {
          Column() {
            Button("address-sanitizer").onClick(() => {
              testNapi.test();
            })
          }
          .width('100%')
        }
        .height('100%')
      }
    }
    ```
    
5.  点击DevEco Studio界面中的“entry”，点击“Edit Configurations”，点击“Diagnostics”，勾选“Address Sanitizer”，保存设置。点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“address-sanitizer”，触发一次地址越界事件。应用崩溃后重新进入应用，可以在Log窗口看到对系统事件数据的处理日志：
    
    ```
    HiAppEvent eventInfo.domain=OS
    HiAppEvent eventInfo.name=ADDRESS_SANITIZER
    HiAppEvent eventInfo.eventType=1
    HiAppEvent eventInfo.params.time=1713148093326
    HiAppEvent eventInfo.params.bundle_version=1.0.0
    HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
    HiAppEvent eventInfo.params.pid=3378
    HiAppEvent eventInfo.params.uid=20020140
    HiAppEvent eventInfo.params.type="stack-buffer-overflow"
    HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/ADDRESS_SANITIZER_1713148093326_3378.log"]
    HiAppEvent eventInfo.params.log_over_limit=false
    ```
    

#### 步骤四：销毁事件观察者

1.  移除事件观察者：
    
    ```
    static napi_value RemoveWatcher(napi_env env, napi_callback_info info) {
        // 使观察者停止监听事件
        OH_HiAppEvent_RemoveWatcher(systemEventWatcher);
        return {};
    }
    ```
    
2.  销毁事件观察者：
    
    ```
    static napi_value DestroyWatcher(napi_env env, napi_callback_info info) {
        // 销毁创建的观察者，并置systemEventWatcher为nullptr。
        OH_HiAppEvent_DestroyWatcher(systemEventWatcher);
        systemEventWatcher = nullptr;
        return {};
    }
    ```