跳转到正文

@capgo/capacitor-app-attest

通过 Apple App Attest、Google Play Integrity 以及可选的 Android Widevine 信号进行设备认证。

在信任敏感的 API 调用前,先证明请求来自你真实的应用安装。 prepare() 以及 createAttestation() 覆盖 Apple App Attest 流程,同时通过 Play Integrity Standard 和可选的 Widevine 指纹方法覆盖 Android。使用内置辅助方法安全存储密钥 ID。

典型适用场景:防欺诈、高价值交易,以及登录或打款端点的防篡改检查。

平台支持备注
iOS是App Attest 密钥、断言及 DeviceCheck 令牌辅助工具
Android是Play Integrity Standard,可选 Widevine 指纹
Web 端回退原生 API 不可用时的 Web 证明格式
  • isSupported - 检查此设备是否支持原生证明。
  • prepare - 准备证明状态,并返回后续调用所需的 key handle。
  • createAttestation - 创建与后端下发的 challenge 绑定的注册证明 token。
  • createAssertion - 创建与请求负载绑定的请求断言 token。
方法描述
isSupported检查此设备是否支持原生 attestation。
prepare准备 attestation 状态并返回供后续调用使用的 key handle。
createAttestation创建与后端下发的 challenge 绑定的注册 attestation token。
createAssertion创建与请求负载绑定的请求断言 token。
storeKeyId存储/准备密钥标识符以供复用。
getStoredKeyId返回当前存储/准备的密钥标识符。
clearStoredKeyId清除已存储/准备的密钥标识符。
generateKey旧版别名,对应 prepare().
attestKey旧版别名,对应 createAttestation().
generateAssertion旧版别名,对应 createAssertion().

此参考文档同步自 src/definitions.ts 中的 capacitor-app-attest.

如果你正在使用 @capgo/capacitor-app-attest 来规划安全与合规,请结合 使用 @capgo/capacitor-app-attest 用于“使用 @capgo/capacitor-app-attest”中的原生能力, 加密 了解 Encryption 的实现细节, 合规性 了解合规部分的实现细节, Capgo 安全扫描器 用于 Capgo Security Scanner 中的产品工作流,以及 Capgo 安全 用于 Capgo Security 中的产品工作流。