Getting Started

GitHub

Einen Einrichtungsbefehl mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation 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.

Einrichtung

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

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

Verwenden Sie dann 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 aufgeführten plattform-spezifischen Anweisungen befolgen:

Das Paket installieren
Terminal-Fenster
```
bun add @capgo/capacitor-app-attest
```
Natives Projekte synchronisieren
Terminal-Fenster
```
bunx cap sync
```
Konfiguration der Plattformanforderungen
- Abschließen iOS-Einrichtung zur App-Attest-Fähigkeit und zur Backend-Verifizierungsfluss.
- Abschließen Android-Einrichtung zum Google Play Integrity Standard und zum Backend-Verifizierungsfluss.

Wozu dieses Plugin nutzen?

Dieses Plugin bietet eine Plattformübergreifende API während die native Plattformsicherheit beibehalten wird:

iOS: Apple App Attest (DeviceCheck)
Android: Google Play Integrity Standard API
No eigene Client-Seitencryptoschema
Normalisierte Ausgaben für Backend-Überprü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);

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`	Alternativen zum Live-Update von Capacitor
`token`	`string`	Schlüssel/Anbieter-Handle zur Attestation

Token zur Überprüfung auf Ihrem Backend

Abschnitt mit dem Titel "Hintergrundanforderung"

Die Attestation ist nur nützlich, wenn sie serverseitig überprüft wird.
Vertraue niemals nur auf den Erfolg des Clients.
Erfordere einmalige Herausforderungs-/Payload-Werte von Ihrem Backend. tokenÜberprüfe

, App-Identität und Wiederholungsschutz in der Backend-Logik verwenden.

Weitergehen von Getting Started

Wenn Sie Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-app-attest verwenden Getting Started um Sicherheit und Compliance zu planen, verbinden Sie es mit Using @capgo/capacitor-app-attest für die native Fähigkeit in Using @capgo/capacitor-app-attest Verschlüsselung für die Implementierungsdetails in Verschlüsselung Kongruenz für die Implementierungsdetails in Compliance, Capgo Sicherheits-Scanner für den Produktworkflow in Capgo Sicherheits-Scanner und Capgo Sicherheit für den Produktworkflow in Capgo Sicherheit.