Getting Started

Installation

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie folgenden Befehl ausführen:

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

Verwenden Sie dann folgende Anweisung:

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:

1. Das Paket installieren

   bun add @capgo/capacitor-app-attest

2. Synchronisieren Sie native Projekte

   bunx cap sync

3. Konfigurieren Sie die Plattformanforderungen

   • Abschließen iOS-Einrichtung zur App-Attest-Fähigkeit und zum Backend-Verifizierungsfluss.
   • Vollständig Android-Einrichtung zur Play-Integritäts-Standard und zum Backend-Verifizierungsfluss.

Wozu dieses Plugin nutzen?

Dieses Plugin bietet eine einzelne Plattform API während die native Plattform-Sicherheit beibehält:

• iOS: Apple App-Attest (DeviceCheck)
• Android: Google Play-Integritäts-Standard API
• Keine benutzerdefinierte Client-Seitige Kryptoscheme
• 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'	Natives Betriebssystem, das 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

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

• Vertraue niemals nur auf den Erfolg des Clients.
• Erwarte einmalige Herausforderungs/Wert-Paare von Ihrem Backend.
• Überprüfe tokenVerwende die Plattform-spezifischen Backend-Anleitungen:

iOS-Einrichtung und Backend-Verifizierung

• Android-Einrichtung und Backend-Verifizierung
• Use the platform-specific backend guides for iOS and Android to learn how to set up and verify your app's identity, and implement protections against replay attacks in your backend logic.

Weitermachen von Getting Started

Wenn Sie Using 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 Kongruenz Capgo Sicherheits-Scanner für den Produktworkflow in Capgo Sicherheits-Scanner und Capgo Sicherheit für den Produktworkflow in Capgo Sicherheit.