安全SDK信息

1. 关键版本Change Log

2 概述

• Android安全SDK又名——昊天SDK，是一个基于海量威胁情报数据的智能分析平台， 打通了移动、云、PC 的全链条安全数据，利用深度学习人工智能平台从海量的安全事件中进行关联分析，能感知出潜在的互联网威胁以及 APT 事件，并能对攻击阵营的基础设施和技术手段进行分析识别，告别被动防御局面， 为用户提供更加安全的互联网体验。为了使第三方应用能更简单地集成安全风控能力，本SDK为面向鸿蒙NEXT设备的应用程序提供安全风控解决方案。

3 客户端集成步骤

3.1 集成SDK

• 请集成Haotian安全SDK。 (包括base_haotian.har 、security_haotian.har两部分)
• 在oh-package.json5文件中进行如下配置：

1"dependencies": {
2    "@haotian/security": "file:./lib/security_haotian.har",
3    "@haotian/base": "file:./lib/base_haotian.har",
4  }

3.2 开通鸿蒙Device Security服务(开通此服务可提升风控能力)

• 请参考华为鸿蒙相关文档，开通鸿蒙Device Security服务：鸿蒙文档地址
• 备注：仅需"安全检测服务"和"应用设备状态检测"；"可信应用服务"和"涉诈剧本检测"无需开通。

3.3 权限申请

• 本 SDK 需要申请以下权限，请在APP的主Module的module.json5文件中配置如下权限：

  • 网络权限（ohos.permission.INTERNET）。
  • 获取网络状态权限（ohos.permission.GET_NETWORK_INFO）。
  • 获取OAID权限（ohos.permission.APP_TRACKING_CONSENT）。

1"requestPermissions": [
2      {
3        "name": "ohos.permission.INTERNET"
4      },
5      {
6        "name" : "ohos.permission.GET_NETWORK_INFO",
7        "reason": "$string:netstatus_reason",
8        "usedScene": {
9          "abilities": [
10            "EntryAbility", // 应用初始化本SDK的Ability和分发通知栏点击事件的Ability需要配置
11            "PushAbility"
12          ],
13          "when":"always"
14        }
15      },
16      {
17        "name" : "ohos.permission.APP_TRACKING_CONSENT",
18        "reason": "$string:oaid_reason",
19        "usedScene": {
20          "abilities": [
21            "EntryAbility", //  应用初始化本SDK的Ability和分发通知栏点击事件的Ability需要配置
22            "PushAbility"
23          ],
24          "when":"always"
25        }
26      }
27    ]

4 API 接口

• 本SDK所有API均在HTH类中。导入模块：

1import { HTH } from '@haotian/security';

4.1 初始化接口

• 程序启动后，需调用初始化方法。请在较早的时间点调用该方法。

1public static async init(context: Context, appkey: string, seckey: string): Promiseboolean

• 参数说明：

  • appkey，seckey： 用于服务器的访问校验，这是分配给渠道集成本SDK的凭证。这两个 key 是和集成宿主的包名和签名唯一关联的。如果包名或者签名有变化需要重新申请。

• 返回值说明:

  • 该方法返回值为初始化是否成功。若关注返回值，则需使用await方式等待init方法结束后获取返回值。

4.2 设置用户同意隐私协议接口

• 通过调用此接口告知本SDK用户是否同意了隐私协议。
• 在调用采集开始方法时，若尚未同意隐私协议，则初始化会直接失败。
• 若调用init后才调用同意隐私接口，会自动重新进行初始化。

1public static setAgreePolicy(context: Context, agree: boolean) 

• 参数说明：

  • agree：为用户是否同意了隐私协议，true为同意，false为不同意。

4.3 获取Ztoken

• 通过调用此接口可以获取当前Ztoken。该值只用于获取云端安全因子的的索引，不能应用于宿主业务。
• 该token可变，请不要对其进行持久化。

1public static async gzfi(context: Context, accountId: string, eventId: number, params: string): Promisestring

• 参数说明

  • accountId：账号ID,可以为空字符串 ""。
  • eventId：用于业务深度融合的风控场景；默认传0，即不触发安全环境扫描。若需要对接业务风控场景，请与我方商务对接分配对应值。
  • params：一个json字符串，可以将自定义的参数传给安全环境扫描，可以为空字符串 ""。

• 返回值说明：

  • 本方法返回一个Ztoken字符串。请使用await方式获取返回值。