Getting Started

Copas prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        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.

Pasang paket
Jendela terminal
```
bun add @capgo/capacitor-app-attest
```
Sinkronkan proyek native
Jendela terminal
```
bunx cap sync
```
Konfigurasi persyaratan platform
- Selesai Pengaturan iOS untuk kemampuan verifikasi App Attest dan alur verifikasi backend.
- Selesai Pengaturan Android untuk Standar Integritas Play dan alur verifikasi backend.

Mengapa menggunakan plugin ini

Plugin ini menyediakan satu API lintas platform sementara menjaga keamanan platform native:

iOS: Apple App Attest (DeviceCheck)
Android: Standar Integritas Google Play API
Tidak ada skema kriptografi klien custom
Keluaran yang dinormalisasi untuk periksa backend

Penggunaan

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

Bentuk respons yang diintegrasikan

createAttestation() dan createAssertion() kembalikan bidang kunci yang sama pada iOS dan Android:

Bidang	Tipe	Deskripsi
`platform`	`'ios' \| 'android' \| 'web'`	Platform native yang menghasilkan token
`format`	`AttestationFormat`	`apple-app-attest` atau `google-play-integrity-standard`
`keyId`	`string`	Tanggung jawab penyedia untuk pengesahan
`token`	`string`	__CAPGO_KEEP_0__ untuk memverifikasi di backend Anda

Persyaratan backend

Pengesahan hanya berguna ketika diverifikasi di sisi server.

Jangan pernah percaya pada kesuksesan hanya di klien.
Tuntukan nilai tantangan/payload satu kali dari backend Anda.
Verifikasi tokenGunakan logika backend untuk melindungi identitas aplikasi, dan perlindungan ulang.

Gunakan panduan backend spesifik platform:

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan keamanan dan kinerja, hubungkan dengan Menggunakan @capgo/capacitor-app-attest untuk kemampuan asli dalam Menggunakan @capgo/capacitor-app-attest, Enkripsi untuk detail implementasi dalam Enkripsi, Kinerja untuk detail implementasi dalam Kinerja, Capgo Scanner Keamanan untuk alur kerja produk di Capgo Scanner Keamanan, dan Capgo Keamanan untuk alur kerja produk di Capgo Keamanan.