# wx.startSoterAuthentication(Object object)

基础库 1.5.0 开始支持,低版本需做兼容处理

Promise 风格 调用:支持

小程序插件:不支持

相关文档: 生物认证

# 功能描述

开始 SOTER 生物认证。验证流程请参考说明

# 参数

# Object object

属性 类型 默认值 必填 说明
requestAuthModes Array.<string> 请求使用的可接受的生物认证方式
合法值 说明
fingerPrint 指纹识别
facial 人脸识别
speech 声纹识别(暂未支持)
challenge string 挑战因子。挑战因子为调用者为此次生物鉴权准备的用于签名的字符串关键识别信息,将作为 resultJSON 的一部分,供调用者识别本次请求。例如:如果场景为请求用户对某订单进行授权确认,则可以将订单号填入此参数。
authContent string '' 验证描述,即识别过程中显示在界面上的对话框提示内容
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

# object.success 回调函数

# 参数
# Object res
属性 类型 说明
authMode string 生物认证方式
resultJSON string 在设备安全区域(TEE)内获得的本机安全信息(如 TEE 名称版本号等以及防重放参数)以及本次认证信息(仅 Android 支持,本次认证的指纹ID)。具体说明见下文
resultJSONSignature string 用 SOTER 安全密钥对 resultJSON 的签名(SHA256 with RSA/PSS, saltlen=20)
errCode number 错误码
errMsg string 错误信息

# resultJSON 说明

此数据为设备 TEE 中,将传入的 challenge 和TEE内其他安全信息组成的数据进行组装而来的JSON,对下述字段的解释如下表。例子如下:

字段名 说明
raw 调用者传入的challenge
fid (仅 Android 支持)本次生物识别认证的生物信息编号(如指纹识别则是指纹信息在本设备内部编号)
counter 防重放特征参数
tee_n TEE名称(如高通或者 trustonic 等)
tee_v TEE版本号
fp_n 指纹以及相关逻辑模块提供商(如 FPC 等)
fp_v 指纹以及相关模块版本号
cpu_id 机器唯一识别ID
uid 概念同 Android 系统定义uid,即应用程序编号
{
  "raw":"msg",
  "fid":"2",
  "counter":123,
  "tee_n":"TEE Name",
  "tee_v":"TEE Version",
  "fp_n":"Fingerprint Sensor Name",
  "fp_v":"Fingerprint Sensor Version",
  "cpu_id":"CPU Id",
  "uid":"21"
}

# 示例代码

在开发者工具中预览效果

wx.startSoterAuthentication({
   requestAuthModes: ['fingerPrint'],
   challenge: '123456',
   authContent: '请用指纹解锁',
   success(res) {
   }
})