Getting Started

Copiar un prompt de configuración con los pasos de instalación y la guía 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

Luego utilice 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
```
Configurar 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 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 Play de Google API
No esquema de criptografía cliente personalizado
Salidas normalizadas para comprobaciones de servidor

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() devuelve los mismos campos de clave en iOS y Android: createAssertion() Campo

Tipo	Descripción	y
`platform`	`'ios' \| 'android' \| 'web'`	Plataforma nativa que produjo el token
`format`	`AttestationFormat`	`apple-app-attest` o `google-play-integrity-standard`
`keyId`	`string`	¿Otra alternativa?
`token`	`string`	Identificador clave o proveedor utilizado para la attestación

Token para verificar en su servidor

Requisito del servidor

La attestación solo es útil cuando se verifica en el servidor.
Jamás confíe en el éxito del lado del cliente.
Requiere valores de desafío/payload de una sola vez desde su servidor. tokenVerificar

Verificar, identidad de la aplicación, y protecciones contra retransmisiones en la lógica del servidor.

Sigue adelante desde Inicio

Si estás utilizando Inicio 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 los detalles 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.