Getting Started

Copia una richiesta di configurazione con i passaggi di installazione e la guida markdown completa per questo 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.

Installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Usa poi il seguente prompt:

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

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

Installa il pacchetto
Finestra del terminale
```
bun add @capgo/capacitor-app-attest
```
Sincronizza progetti nativi
Finestra del terminale
```
bunx cap sync
```
Configura le richieste della piattaforma
- Completa Configurazione iOS per la capacità di attestazione dell'app e il flusso di verifica del backend.
- Completo Configurazione Android per lo Standard di integrità di Play e il flusso di verifica del backend.

Perché utilizzare questo plugin

Questo plugin fornisce un API cross-platform mentre mantiene la sicurezza delle piattaforme native:

iOS: Apple App Attest (DeviceCheck)
Android: Google Play Integrity Standard API
Nessun schema di crittografia client-side personalizzato
Output normalizzati per le verifiche del backend

Utilizzo

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 di risposta unificata

createAttestation() e createAssertion() restituire i medesimi campi chiave su iOS e Android:

Campo	Tipo	Descrizione
`platform`	`'ios' \| 'android' \| 'web'`	Piattaforma nativa che ha prodotto il token
`format`	`AttestationFormat`	`apple-app-attest` o `google-play-integrity-standard`
`keyId`	`string`	Chiave/maniglia del provider utilizzata per l'attestazione
`token`	`string`	Token per verificare sul tuo backend

Requisito del backend

L'attestazione è utile solo quando viene verificata dal lato server.

Non fidarti mai del successo solo dal lato client.
Richiedi valori di sfida/payload unici da parte del tuo backend.
Verifica tokenVerifica l'identità dell'app, le protezioni contro il replay e altre funzionalità nel codice del backend.

Utilizza le guide del backend specifiche per la piattaforma:

Continua da Getting Started

Se stai utilizzando Getting Started per pianificare la sicurezza e la conformità, connettilo con Utilizzando @capgo/capacitor-app-attest per la capacità nativa in Utilizzando @capgo/capacitor-app-attest, Crittografia per il dettaglio di implementazione in Crittografia, Conformità per il dettaglio di implementazione in Conformità, Capgo Scanner di Sicurezza per il flusso di lavoro del prodotto in Capgo Scanner di Sicurezza, e Capgo Sicurezza per il flusso di lavoro del prodotto in Capgo Sicurezza.