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

Puedes utilizar nuestra configuración asistida por IA para instalar el plugin. Agrega las Capgo habilidades a tu herramienta de IA utilizando el siguiente comando:

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

Luego utiliza el siguiente prompt:

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

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

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

¿Por qué utilizar este plugin?

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

iOS: Apple App Attest (DeviceCheck)
Android: Google Play Integrity Standard API
Sin esquema de criptografía cliente personalizado
Salidas normalizadas para verificaciones 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() devuelva 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`	clave de proveedor utilizada para la autenticación
`token`	`string`	Token para verificar en su servidor

Requisito del servidor

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

Nunca confíes en el éxito solo del cliente.
Requiere valores de desafío/payload de una sola vez desde tu backend.
Verificar token, app identity, and replay protections in backend logic.

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

Sigue adelante desde Inicio

Si estás utilizando Getting Started para planificar la seguridad y la conformidad, conectarlo con Usando @capgo/capacitor-app-attest para la capacidad nativa en Usando @capgo/capacitor-app-attest, Encriptación para el detalle de implementación en Encriptación, Conformidad para el detalle de implementación en Conformidad, 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.