Getting Started
Kopieren Sie einen Einrichtungsprompt mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen 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.
-
Installieren Sie das Paket
Terminalfenster bun add @capgo/capacitor-app-attest -
Synchronisieren Sie native Projekte
Terminalfenster 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 das Google Play Integrity Standard und den Backend-Verifizierungsfluss.
Warum diese Erweiterung verwenden
Abschnitt mit dem Titel “Warum diese Erweiterung verwenden”Diese Erweiterung bietet eine einheitliche Plattform API während die native Plattform-Sicherheit beibehalten wird:
- iOS: Apple App Attest (
DeviceCheck) - Android: Google Play Integrity Standard API
- Keine benutzerdefinierte Client-Seitige Kryptoscheme
- Normalisierte Ausgaben für Backend-Überprüfungen
Verwendung
Abschnitt mit dem Titel „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
Abschnitt mit dem Titel „Einheitliche Antwortform”createAttestation() und createAssertion() die gleichen Schlüsselfelder auf iOS und Android zurückgeben:
| Feld | Typ | Beschreibung |
|---|---|---|
platform | 'ios' | 'android' | 'web' | Natives Plattform, die den Token erzeugt hat |
format | AttestationFormat | apple-app-attest oder google-play-integrity-standard |
keyId | string | Schlüssel/Anbieter-Handle zur Attestation |
token | string | Token zur Überprüfung auf Ihrem Backend |
Backend-Anforderung
Abschnitt mit dem Titel „Backend-Anforderung“Die Attestation ist nur nützlich, wenn sie serverseitig überprüft wird.
- Vertraue niemals einem nur clientseitigen Erfolg.
- Erfordere einmalige Herausforderungs-/Payload-Werte von Ihrem Backend.
- Überprüfe
tokenVerwende die Plattform-spezifischen Backend-Anleitungen:
iOS-Einrichtung und Backend-Verifizierung
- Android-Einrichtung und Backend-Verifizierung
- Verwende die Plattform-spezifischen Backend-Anleitungen: iOS-Einrichtung und Backend-Verifizierung, Android-Einrichtung und Backend-Verifizierung
Weitermachen von Getting Started
Abschnitt mit dem Titel “Weitermachen von Getting Started”Wenn Sie " Getting Started um Sicherheit und Compliance zu planen, verbinden Sie es mit Mit @capgo/capacitor-app-attest für die native Fähigkeit in Mit @capgo/capacitor-app-attest for the native capability in Using @capgo/capacitor-app-attest, für die Implementierungsdetails in Verschlüsselung Compliance für die Implementierungsdetails in Compliance __CAPGO_KEEP_0__ Security Scanner Capgo Sicherheits-Scanner für den Produktworkflow in Capgo Sicherheits-Scanner und Capgo Sicherheit für den Produktworkflow in Capgo Sicherheit.