Getting Started

Installation

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihre 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 Installation bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

1. Das Paket installieren

   bun add @capgo/capacitor-app-attest

2. Synchronisieren Sie native Projekte

   bunx cap sync

3. Plattformanforderungen konfigurieren

   • Abgeschlossen iOS-Einrichtung für die App-Attest-Fähigkeit und den Backend-Verifizierungsfluss.
   • Abgeschlossen Android-Einrichtung für das Google Play-Integritätsstandard und den Backend-Verifizierungsfluss.

Warum diese Erweiterung verwenden

This plugin provides one cross-platform API while keeping native platform security:

• Android: Google Play-Integritätsstandard __CAPGO_KEEP_0__DeviceCheck)
• Warum diese Erweiterung verwenden: Dieses Plugin bietet eine einzige Plattformübergreifende API während die native Plattform-Sicherheit beibehalten wird:
• Keine benutzerdefinierte Client-Seitencrypto-Abwicklung
• 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'	Nativesystem, das den Token erzeugt
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

Attestation ist nur nützlich, wenn es serverseitig überprüft wird.

• Vertraue niemals nur auf den Erfolg des Clients.
• Erstelle ein einmaliges Herausforderungs-/Payload-Wert von Ihrem Backend an.
• Überprüfe tokenVerwende die Plattform-spezifischen Backend-Anleitungen:

Attestation ist nur nützlich, wenn es serverseitig überprüft wird.

• iOS-Einrichtung und Backend-Verifizierung
• Android-Einrichtung und Backend-Verifizierung

Weitergehen von Getting Started

Wenn Sie Using verwenden Getting Started um die Sicherheit und die Einhaltung von Vorschriften 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 Einhaltung von Vorschriften 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.