Getting Started

Copie un prompt de configuración con los pasos de instalación y la guía de markdown completa para este plugin.

        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.

Instalación

Puede utilizar nuestra configuración asistida por IA para instalar el complemento. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Usar luego la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

Instalar el paquete
Ventana de terminal
```
bun add @capgo/capacitor-app-attest
```
Sincronizar proyectos nativos
Ventana de terminal
```
bunx cap sync
```
Configure requisitos de plataforma
- Complete Configuración de iOS para la capacidad de Attest de la aplicación y el flujo de verificación de backend.
- Complete Configuración de Android para el estándar de integridad de Play y el flujo de verificación de backend.

¿Por qué utilizar este plugin?

Este plugin proporciona una API de una sola plataforma cruzada mientras mantiene la seguridad de la plataforma nativa:

iOS: Attest de la aplicación de Apple (DeviceCheck)
Android: estándar de integridad de Google Play API
No esquema de criptografía cliente personalizado
Salidas normalizadas para comprobaciones de backend

Uso

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);

Forma de respuesta unificada

createAttestation() y createAssertion() devuelve los mismos campos clave en iOS y Android:

Campo	Tipo	Descripción
`platform`	`'ios' \| 'android' \| 'web'`	Plataforma nativa que produjo el token
`format`	`AttestationFormat`	`apple-app-attest` o `google-play-integrity-standard`
`keyId`	`string`	Identificador clave/proveedor utilizado para la attestación
`token`	`string`	Token para verificar en tu backend

Requisito del backend

La attestación solo es útil cuando se verifica en el lado del servidor.

Nunca confíes en el éxito solo del lado del cliente.
Requiere valores de desafío/payload de una sola vez desde tu backend.
Verificar tokenUsa la protección de identidad de la aplicación, y la protección contra retransmisiones en la lógica del backend.

Utiliza las guías de backend específicas de la plataforma:

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la seguridad y la conformidad, conecta con Usando @capgo/capacitor-app-attest para la capacidad nativa en Usando @capgo/capacitor-app-attest, Cifrado para el detalle de implementación en Cifrado, Conformidad para el detalle de implementación en Compliance, Capgo Escáner de Seguridad para el flujo de trabajo del producto en Capgo Escáner de Seguridad, y Capgo Seguridad para el flujo de trabajo del producto en Capgo Seguridad.