KiwiGuard SDK（iOS）下载与接入文档

1 名称解释

2 法规要求

您应向您的终端用户逐一明示您嵌入的第三方SDK收集使用个人信息的目的、方式和范围。

您应当在《隐私政策》中明确告知终端用户，您选择了成都盈海益讯科技有限公司作为合作方，并委托其收集、使用、加工和处理终端用户个人信息。成都盈海益讯科技有限公司建议您在《隐私政策》中的“我们如何共享、转让、公开披露您的个人信息”的表述条款中增加如下内容（关于个人信息共享给第三方说明的部分，强烈建议此部分由您专业的法务团队优化完善，详情可参考《KiwiGuard SDK隐私政策》）：

为了识别客户端或终端用户的异常状态，为了对盗版应用、虚假设备、游戏外挂、环境风险、对抗事件等威胁场景进行监测与管控，我们的产品会集成第三方的SDK或类似应用程序，具体如下：

3 KiwiGuard SDK手动接入流程

3.1 KiwiGuard SDK前端接入

集成KiwiGuard SDK之前：请先在几维安全《移动应用安全管理平台》创建应用组、创建App，获取appID。

3.1.1 集成KiwiGuard SDK

3.1.2 接口使用说明

3.2 KiwiGuard SDK后端接入

备注：本节可通过访问几维安全服务端API获取终端威胁数据源；可在App测试环节与上线后进行操作。

3.2.1 HTTP接口接入方法

（1） 接口地址

（2） 请求参数

*如何生成参数sign？

【Python实例】

① 构建待加密的指定规则字符串 ；

AppGroupSecret： 几维安全SaaS平台获取( KiwiGuard > 应用管理 > 应用组AppGroupSecret )

encrypt_key = 'secret:{AppGroupSecret}*{deviceToken}*{timestamp}:encrypt'.format(AppGroupSecret=AppGroupSecret, deviceToken=deviceToken, timestamp=timestamp)

② 使用md5加密，获取加密后的数据传递给sign字段；

import hashlib
m = hashlib.md5()
m.update(encrypt_key.encode())
sign = m.hexdigest()

【Java实例】

// 封装的计算sign函数    
public String getStrArrMd5Sign(String []strArr){
        StringBuilder sb = new StringBuilder();
        String signStr = null, signMd5 = null;
        if(strArr != null && strArr.length > 0){
            sb.append("secret:");
            for(int i=0; i<strArr.length; i++){
                sb.append(strArr[i]);
                if(i != (strArr.length-1))
                    sb.append("*");
            }
            sb.append(":encrypt");
            signStr = sb.toString();
            Log.d(TAG,signStr);
            if(!signStr.isEmpty()){
                MessageDigest md = null;
                try{
                    md = MessageDigest.getInstance("MD5");
                    // 计算md5函数
                    md.update(signStr.getBytes());


                    signMd5 = new BigInteger(1, md.digest()).toString(16);
                                        // (fix)不满32位前面添加0
                    while(signMd5.length() < 32 ){
                        signMd5 = "0" + signMd5;
                    }
                }catch (Exception e){
                    Log.d(TAG,"no such MD5 algorithm"+e.getMessage());
                }
            }
        }

        return signMd5;
    }
// 调用上面封装的函数获取sign 
String sign = getStrArrMd5Sign(new String[]{AppGroupSecret
,deviceToken,"时间戳"});//请严格按照该拼接顺序(时间戳例如:"16509345787")

// 封装json 请求体
// appGroupID 和 appID 至少任意填一个
JSONObject jsonBody = new JSONObject();
                    jsonBody.put("deviceToken",deviceToken);
                    jsonBody.put("appGroupID","");
                    jsonBody.put("sign",sign);
                    jsonBody.put("timestamp","时间戳");
                    jsonBody.put("appID","");

// TODO 发起网络请求

*如何发送POST请求？

【Java实例】

public class HttpUtils {
    private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
    private static OkHttpClient client = new OkHttpClient();

    public static Response post(String url, String json) throws IOException {
        RequestBody body = RequestBody.create(JSON, json);
        Request request = new Request.Builder()
                .url(url)      //填写接口地址
                .post(body)    //填写请求参数
                .build();
        Response response = client.newCall(request).execute();
        return response;
    }
}

【Python实例】

import hashlib, requests, pprint, json


def md5_convert(string):
    """
    计算字符串md5值
    :param string: 输入字符串
    :return: 字符串md5
    """
    m = hashlib.md5()
    m.update(string.encode())
    return m.hexdigest()

if __name__ == '__main__':
    appSecretKey = '****'  # 应用管理应用组所对应的 SecretKey
    deviceToken = '****'  # deviceID
    ts = ****  # 时间戳

    md5_key = 'secret:{appSecretKey}*{deviceToken}*{ts}:encrypt'.format(appSecretKey=appSecretKey, deviceToken=deviceToken, ts=ts)
    sign = md5_convert(md5_key)

    body = {
        "appGroupID": "****",  # 应用组id
，web端获取
        "appID": "****",  # appID，web端获取
        "deviceToken": deviceToken,
        "sign": sign,
        "timestamp": ts
    }

    pprint.pprint(json.loads(requests.post(url='****', json=body).text), depth=4)

（备注：若没有查看appGroupSecret的权限，请联系几维安全工作人员。）

（3）成功响应

成功示例：

{
    "message": "success!",
    "code": 1,
    "data": {
            "deviceID":"xxx",
            "fakeRiskDevice":{        
                "emulator":{               
                key1:value1,
            }
            },
            "environmentRiskDevice":{
                "hook":{
                key1:value1
                key2:value2
            }       
            },
            "fightRiskDevice":{
                "anti_debug":{
                key1:value1
            }
            },
            "suspiciousRiskDevice":{
                "sim": {
                key1:value1,
            } 
            }
        “uoloadTime”：1635486916
        }
}

（4）错误响应

失败示例：

{
    "message": '缺少查询参数！', 
    "code": 1880001
}

3.2.2 HTTP接口返回参数明细说明

成功响应时候，data字段Json类型的内容为：

（1）fakeRiskDevice详细内容

① 云真机检测：

cloud_machine详细内容：

② 模拟器检测：

emulator详细内容：

（2）environmentRiskDevice详细内容

① hook检测

hook环境详细内容：

② 越狱检测

jailbreak详细内容：

③ 签名校验检测

sign详细内容：

④ VPN/代理检测

VPN详细内容：

（3）fightRiskDevice详细内容

danti_debug详细内容：

（4）suspiciousRiskDevice详细内容

① SIM卡状态检测

sim详细内容：