Getting Started

复制安装步骤和完整的markdown指南

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-app-attest`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/app-attest/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

您可以使用我们的AI辅助安装工具安装插件。将Capgo技能添加到您的AI工具中，使用以下命令：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-app-attest` plugin in my project.

如果您更喜欢手动设置，请运行以下命令安装插件，并按照以下平台特定的说明进行操作:

安装包
终端窗口
```
bun add @capgo/capacitor-app-attest
```
同步本机项目
终端窗口
```
bunx cap sync
```
配置平台要求
- 完成 iOS 设置为 App Attest 能力和后端验证流程而设立。
- Complete Android 设置为 Play Integrity Standard 和后端验证流程而设立。

为什么使用这个插件

这个插件提供了一个跨平台的 API ，同时保持了原生平台的安全性：

iOS：Apple App Attest (DeviceCheck)
Android：Google Play Integrity Standard API
不需要自定义客户端端口加密方案
为后端检查而规范化的输出

使用

import { AppAttest } from '@capgo/capacitor-app-attest';

const support = await AppAttest.isSupported();
if (!support.isSupported) {
  throw new Error(`Attestation not supported on ${support.platform}`);
}

const prepared = await AppAttest.prepare();

const registration = await AppAttest.createAttestation({
  keyId: prepared.keyId,
  challenge: 'backend-one-time-registration-challenge',
});

const assertion = await AppAttest.createAssertion({
  keyId: prepared.keyId,
  payload: 'backend-one-time-request-payload',
});

console.log(registration.platform, registration.format, registration.token);
console.log(assertion.platform, assertion.format, assertion.token);

统一响应形状

createAttestation() 并 createAssertion() 在iOS和Android上返回相同的键字段：

字段	类型	描述
`platform`	`'ios' \| 'android' \| 'web'`	原生平台生成令牌
`format`	`AttestationFormat`	`apple-app-attest` 或 `google-play-integrity-standard`
`keyId`	`string`	用于证明的关键/提供者句柄
`token`	`string`	用于在您的后端验证的令牌

后端要求

只有在服务器端验证时，证明才有用。

永远不要相信客户端成功。
要求您的后端一次性挑战/载荷值。
验证 token在后端逻辑中使用平台特定的身份验证、应用程序身份和重放保护。

使用以下平台特定的后端指南:

继续从 Getting Started

如果您正在使用 Getting Started 来规划安全性和合规性，连接它到使用 @capgo/capacitor-app-attest 为 native capability 在使用 @capgo/capacitor-app-attest 中加密为加密实现细节合规为合规实现细节 Capgo 安全扫描器为 Capgo 安全扫描器中的产品工作流程, Capgo 安全为 Capgo 安全中的产品工作流程,