Getting Started

GitHub

Eine Einrichtungsanweisung mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin kopieren.

        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.

Installation

Sie können unsere AI-gestützte Einrichtung verwenden, um den Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten zu Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

Dann verwenden Sie die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

Installieren Sie das Paket
Terminal-Fenster
```
bun add @capgo/capacitor-app-attest
```
Synchronisieren Sie native Projekte
Terminal-Fenster
```
bunx cap sync
```
Konfigurieren Sie die Plattformanforderungen
- Vollständig iOS-Einrichtung für die App-Attest-Fähigkeit und den Backend-Verifizierungsfluss.
- Vollständig Android-Einrichtung für Play Integrity Standard und Hintergrundüberprüfungsfluss.

Warum diese Erweiterung verwenden

Diese Erweiterung bietet eine Plattformübergreifende API während die native Plattformssicherheit erhalten bleibt:

iOS: Apple App Attest (DeviceCheck)
Android: Google Play Integrity Standard API
Keine benutzerdefinierte Clientseitencryptoscheme
Normalisierte Ausgaben für Hintergrundprüfungen

Verwendung

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

Eine einheitliche Antwortform

createAttestation() und createAssertion() Die gleichen Schlüsselfelder auf iOS und Android zurückgeben:

Feld	Typ	Beschreibung
`platform`	`'ios' \| 'android' \| 'web'`	Native Plattform, die den Token erzeugt
`format`	`AttestationFormat`	`apple-app-attest` oder `google-play-integrity-standard`
`keyId`	`string`	Sicherheits-Handle für die Bestätigung
`token`	`string`	Schlüssel/Anbieter-Handle zur Attestation

Hintergrundanforderung

Die Attestation ist nur nützlich, wenn sie serverseitig verifiziert wird.

Vertraue niemals nur auf Client-Erfolge.
Erforderliche Einmal-Challenge-/Payload-Werte von Ihrem Backend anfordern.
Verifizieren token, App-Identität und Wiederholungsschutz in der Backend-Logik.

Verwenden Sie die plattformspezifischen Backend-Anleitungen:

Fortsetzen von Getting Started

Wenn Sie Capgo verwenden Zur Einführung um Sicherheit und Compliance zu planen, verbinden Sie es mit Mit @capgo/capacitor-app-attest zur nativen Fähigkeit in Mit @capgo/capacitor-app-attest, Verschlüsselung zur Implementierungsdetails in Verschlüsselung, Kontrollen zur Implementierungsdetails in Kontrollen, Capgo Sicherheits-Scanner zur Produktworkflow in Capgo Sicherheits-Scanner, und Capgo Sicherheit zur Produktworkflow in Capgo Sicherheit.