Luncurkan Firebase App Check secara bertahap menggunakan Firebase Remote Config

1. Perkenalan

Anda dapat menggunakan Firebase App Check dengan App Attest untuk melindungi layanan backend dan memverifikasi bahwa permintaan ke layanan Firebase berasal dari aplikasi asli Anda.

Biasanya disarankan untuk melakukan orientasi pengguna secara bertahap ke layanan App Attest untuk menghindari mencapai batas kuota. Untuk informasi lebih lanjut, lihat dokumentasi " Mempersiapkan Penggunaan App Attest Service " Apple.

Kemampuan untuk merilis pembaruan aplikasi secara bertahap menggunakan fitur App Store Connect Apple, seperti dijelaskan dalam " Merilis pembaruan versi secara bertahap ", dapat membuat peluncuran App Check lebih lancar. Ini adalah solusi yang mudah dan sederhana. Namun, merilis pembaruan versi aplikasi secara bertahap tidak memungkinkan Anda mengontrol peluncuran atau mengubah perilaku aplikasi yang sudah ada dan diperbarui tanpa memublikasikan versi aplikasi baru.

Salah satu cara untuk memiliki kontrol lebih besar terhadap peluncuran App Check dengan App Attest adalah dengan menggunakan Firebase Remote Config untuk mengaktifkan App Check dengan App Attest untuk persentase pengguna aplikasi Anda pada satu waktu. Hal ini dapat membantu menghindari pembatasan dari server pengesahan. Google Analytics dapat digunakan untuk mengamati dampak peluncuran terhadap pengguna.

Penting: Pastikan App Check tidak diterapkan untuk Firebase Firestore, RTDB, dan Cloud Storage saat App Attest diluncurkan, karena layanan yang diterapkan akan menolak permintaan yang datang dari instance aplikasi mana pun yang belum mengaktifkan App Check. Untuk mempelajari lebih lanjut tentang penerapan App Check, lihat penerapan App Attest Enable .

Apa yang akan Anda pelajari

Dalam codelab multilangkah ini, Anda akan mempelajari cara menggunakan Firebase Remote Config untuk meluncurkan App Check pada aplikasi Anda.

Codelab ini menggunakan proyek Firebase berdasarkan aplikasi quickstart DatabaseExample dan terintegrasi dengan Firebase App Check, seperti yang dijelaskan dalam codelab Firebase App Check untuk Platform Apple . Aplikasi quickstart DatabaseExample memungkinkan pengguna untuk login dan menambahkan postingan menggunakan fitur Firebase Realtime Database.

Anda juga dapat menyesuaikan langkah-langkah dalam codelab ini untuk menguji aplikasi Anda sendiri.

Prasyarat

• Menyelesaikan Pemeriksaan Aplikasi Firebase untuk codelab Platform Apple

Apa yang Anda perlukan

• Xkode 12.5+
• Untuk pengujian App Attest:
  • Akun Pengembang Apple yang memungkinkan Anda membuat pengidentifikasi aplikasi baru
  • Aplikasi dengan ID Aplikasi eksplisit dengan kemampuan App Attest diaktifkan. Lihat artikel Mendaftarkan ID Aplikasi dan Mengaktifkan kemampuan aplikasi jika Anda memerlukan bantuan dalam prosesnya.
  • Perangkat iOS/iPadOS yang mendukung App Attest
• Proyek Firebase dengan:
  • Aplikasi iOS dikonfigurasi ( pelajari lebih lanjut )
  • Google Analytics , Remote Config , dan App Check diaktifkan
• Akses ke proyek Firebase terkait aplikasi Anda, dengan izin untuk membuat dan mengelola Remote Config dan untuk melihat Google Analytics

2. Buat penyedia pengesahan khusus

Pada langkah ini, kita akan membuat kelas penyedia khusus untuk memberikan token hanya ketika App Attest diaktifkan. Remote Config bergantung pada instance aplikasi Firebase yang dikonfigurasi, dan penyedia khusus yang Anda terapkan pada langkah ini bertindak sebagai placeholder untuk menyelesaikan konfigurasi.

Untuk menyelesaikan langkah-langkah berikut, Anda harus menambahkan Firebase , FirebaseRemoteConfig , dan FirebaseAnalytics di bagian Frameworks, Libraries, dan Embedded Content aplikasi Anda di Xcode. Untuk contoh cara melakukan hal ini, lihat codelab pemeriksaan Aplikasi Firebase untuk platform Apple .

1. Buat file " MyAppCheckProvider " yang merupakan subkelas NSObject yang sesuai dengan protokol AppCheckProvider .
2. Sertakan metode getToken() kosong yang akan Anda isi nanti.

Lihat contoh kode berikut untuk kelas penyedia khusus dengan metode getToken() kosong.

// MyAppCheckProvider.swift

import Firebase
import FirebaseAnalytics
import FirebaseAppCheck
import FirebaseRemoteConfig

class MyAppCheckProvider: NSObject, AppCheckProvider {
  func getToken(completion handler: @escaping (AppCheckToken?, Error?) -> Void) {}
}

Untuk membuat instance AppAttestProvider , Anda harus meneruskan instance FirebaseApp yang sesuai. Buat properti tersimpan untuknya dan terima sebagai parameter penginisialisasi:

// MyAppCheckProvider.swift

import Firebase
import FirebaseAnalytics
import FirebaseAppCheck
import FirebaseRemoteConfig

class MyAppCheckProvider: NSObject, AppCheckProvider {
  // Firebase app instance served by the provider.
  let firebaseApp: FirebaseApp

  // The App Check provider factory should pass the FirebaseApp instance.
  init(app: FirebaseApp) {
    self.firebaseApp = app
    super.init()
  }

  func getToken(completion handler: @escaping (AppCheckToken?, Error?) -> Void) {}
}

Meneruskan permintaan token ke penyedia App Attest

Sekarang Anda memiliki segalanya untuk meneruskan permintaan token ke penyedia App Attest dalam metode getToken() Anda.

Catatan: Pelajari lebih lanjut tentang metode getToken() di Referensi Kerangka FirebaseAppCheck .

Tambahkan kode berikut ke metode getToken() Anda:

// MyAppCheckProvider.swift

import Firebase
import FirebaseAnalytics
import FirebaseAppCheck
import FirebaseRemoteConfig

class MyAppCheckProvider: NSObject, AppCheckProvider {
  // Firebase app instance served by the provider.
  let firebaseApp: FirebaseApp

  // The App Check provider factory should pass the FirebaseApp instance.
  init(app: FirebaseApp) {
    self.firebaseApp = app
    super.init()
  }

  private lazy var appAttestProvider = AppAttestProvider(app: firebaseApp)

  func getToken(completion handler: @escaping (AppCheckToken?, Error?) -> Void) {
    // Fetch App Attest flag from Remote Config
    let remoteConfig = RemoteConfig.remoteConfig(app: firebaseApp)
    remoteConfig.fetchAndActivate { remoteConfigStatus, error in
      // Get App Attest flag value
      let appAttestEnabled = remoteConfig.configValue(forKey: "AppAttestEnabled").boolValue

      guard appAttestEnabled else {
        // Skip attestation if App Attest is disabled. Another attestation
        // method like DeviceCheck may be used instead of just skipping.
        handler(nil, MyProviderError.appAttestIsDisabled)
        return
      }

      // Try to obtain an App Attest provider instance and fail if cannot
      guard let appAttestProvider = self.appAttestProvider else {
        handler(nil, MyProviderError.appAttestIsUnavailable)
        return
      }

      // If App Attest is enabled for the app instance, then forward the
      // Firebase App Check token request to the App Attest provider
      appAttestProvider.getToken(completion: handler)
    }
  }
}

enum MyProviderError: Error {
  case appAttestIsDisabled
  case appAttestIsUnavailable
  case unexpected(code: Int)
}

Kode sebelumnya memeriksa parameter boolean Remote Config AppAttestEnabled (parameter Remote Config ini akan dibuat nanti di codelab). Jika nilainya salah, kode akan gagal, yang menunjukkan bahwa App Check tidak diluncurkan pada perangkat saat ini. Jika nilainya benar, kode akan mencoba mendapatkan penyedia App Attest dan gagal jika tidak bisa. Jika pemeriksaan kesalahan ini berhasil, kode akan meneruskan permintaan token ke penyedia App Attest.

Tambahkan peristiwa Analytics

Dengan menambahkan peristiwa Analytics, Anda mendapatkan wawasan yang lebih baik tentang seberapa sukses peluncuran App Check. Analytics akan membantu menentukan apakah App Attest harus diaktifkan untuk audiens yang lebih besar.

Catatan: Jika Anda tidak mengaktifkan Google Analytics saat membuat proyek Firebase, aktifkan Google Analytics di halaman Integrasi proyek Anda, lalu hapus dan tambahkan kembali aplikasi tersebut. Setelah selesai, Anda akan melihat aplikasi Anda tercantum dengan ID Aliran di halaman Google Analytics di Firebase console.

Catat dua peristiwa Analytics: AppAttestSuccess jika berhasil, dan AppAttestFailure jika gagal. Kedua peristiwa Analytics ini dapat membantu melacak keberhasilan peluncuran App Check dan membantu Anda memutuskan apakah peluncuran yang lebih besar harus dilanjutkan.

func getToken(completion handler: @escaping (AppCheckToken?, Error?) -> Void) {
  // Fetch Remote Config.
  let remoteConfig = RemoteConfig.remoteConfig(app: firebaseApp)
  remoteConfig.fetchAndActivate { remoteConfigStatus, error in
    // Get App Attest flag value from Remote Config.
    let appAttestEnabled = remoteConfig.configValue(forKey: "AppAttestEnabled").boolValue

    guard appAttestEnabled else {
      // Skip attestation if App Attest is disabled. Another attestation
      // method like DeviceCheck may be used instead of just skipping.
      handler(nil, MyProviderError.appAttestIsDisabled)
      return
    }

    // Try to obtain an App Attest provider instance and fail otherwise.
    guard let appAttestProvider = self.appAttestProvider else {
      handler(nil, MyProviderError.appAttestIsUnavailable)
      return
    }

    // If App Attest is enabled for the app instance, then forward the
    // Firebase App Check token request to the App Attest provider.
    appAttestProvider.getToken { token, error in
      // Log an Analytics event to track attestation success rate.
      let appAttestEvent: String
      if (token != nil && error == nil) {
        appAttestEvent = "AppAttestSuccess"
      } else {
        appAttestEvent = "AppAttestFailure"
      }
      Analytics.logEvent(appAttestEvent, parameters: nil)

      // Pass the result to the handler
      handler(token, error)
    }
  }
}

3. Perbarui kelas Pabrik Penyedia

Setelah Anda menerapkan logika untuk meneruskan permintaan token ke penyedia App Attest dan menambahkan beberapa peristiwa Analytics, Anda perlu memperbarui MyAppCheckProviderFactory.class yang Anda buat di codelab App Check untuk Platform Apple . Kelas ini akan menargetkan penyedia debug App Check untuk simulator, dan sebaliknya menargetkan penyedia khusus Anda.

Edit kode berikut di kelas MyAppCheckProviderFactory yang Anda buat di codelab Firebase App Check untuk platform Apple :

// MyAppCheckProviderFactory.swift

import Firebase

class MyAppCheckProviderFactory: NSObject, AppCheckProviderFactory {
  func createProvider(with app: FirebaseApp) -> AppCheckProvider? {
      #if targetEnvironment(simulator)
      // App Attest is not available on simulators.
      // Use a debug provider.
      let provider = AppCheckDebugProvider(app: app)

      // Print only locally generated token to avoid a valid token leak on CI.
      print("Firebase App Check debug token: \(provider?.localDebugToken() ?? "" )")

      return provider
      #else
      if #available(iOS 14.0, *) {
        // Use your custom App Attest provider on real devices.
        return MyAppCheckProvider(app: app)
      } else {
        return DeviceCheckProvider(app: app)
      }
      #endif
  }
}

Konfirmasikan bahwa Anda telah menyetel AppCheckProviderFactory sebelum mengonfigurasi FirebaseApp :

// DatabaseExampleApp.swift

import SwiftUI
import Firebase
import FirebaseAppCheck

@main
struct DatabaseExampleApp: App {
  init() {
    AppCheck.setAppCheckProviderFactory(MyAppCheckProviderFactory())
    FirebaseApp.configure()
  }

  // ...
}

4. Tambahkan parameter Remote Config di Firebase console

Anda sekarang akan menambahkan parameter Remote Config AppAttestEnabled ke Firebase console . Metode getToken Anda memerlukan parameter ini.

Untuk membuat parameter Remote Config di Firebase console :

1. Buka Remote Config untuk proyek Anda dan klik Tambahkan parameter . Jika ini pertama kalinya Anda menggunakan Remote Config, klik Buat konfigurasi .
2. Di bidang Nama parameter (kunci) , masukkan AppAttestEnabled .
3. Dari tarik-turun Tipe data , pilih Boolean .
4. Dari tarik-turun Nilai default , pilih false .

Sebelum mengklik Simpan, buat nilai bersyarat untuk 10% pengguna:

1. Klik Tambah baru > Nilai bersyarat > Buat ketentuan baru .
2. Di kolom Nama , masukkan nama kondisi.
3. Di bawah Berlaku jika... , pilih Pengguna dalam persentil acak , <= , lalu masukkan 10 di bidang % .
4. Klik Buat kondisi .

Tetapkan nilai kondisional ke true sehingga App Attest akan diluncurkan ke 10% pengguna Anda.

1. Tetapkan nilainya menjadi true untuk kondisi yang baru saja Anda buat.
2. Klik Simpan .

Setelah selesai, publikasikan perubahan Remote Config.

Uji peluncuran di perangkat Anda

Untuk menguji berbagai nilai tanda Remote Config di perangkat Anda tanpa mengubah kode aplikasi, konfigurasikan eksperimen pada parameter AppAttestEnabled dengan mengikuti tutorial Membuat Eksperimen Firebase Remote Config dengan Pengujian A/B . Bagian tutorial " Validasi eksperimen Anda pada perangkat pengujian " menjelaskan cara menetapkan nilai yang berbeda untuk perangkat pengujian Anda.

Langkah terakhir adalah menggunakan Google Analytics untuk memantau keberhasilan peluncuran App Attest Anda.

5. Tinjau keberhasilan peluncuran AppCheck Anda

Anda dapat mengukur keberhasilan peluncuran Anda di dasbor Peristiwa Analytics. Perhatikan acara AppAttestSuccess dan AppAttestFailure . Mungkin diperlukan waktu hingga 24 jam untuk melihat acara di dasbor. Alternatifnya, Anda dapat mengaktifkan proses debug dan menggunakan DebugView untuk melihat peristiwa debug dengan lebih cepat.

Secara opsional, Anda dapat memantau dasbor Crashlytics untuk mengetahui peningkatan tingkat kerusakan. Untuk informasi selengkapnya tentang menambahkan Crashlytics ke aplikasi Anda, lihat Memulai Firebase Crashlytics .

Setelah Anda melihat sebagian besar peristiwa AppAttestSuccess dan beberapa peristiwa AppAttestFailure , ini pertanda baik bahwa Anda dapat meningkatkan persentase pengguna yang mengaktifkan App Attest dengan mengubah kondisi di parameter Remote Config AppAttestEnabled .

Opsional: Manfaatkan Pemirsa Google Analytics

Jika Anda ingin lebih memanfaatkan peristiwa AppAttestEnabled Analytics, Anda dapat membuat Audiens Analytics untuk melacak pengguna dengan AppAttestEnabled yang disetel ke true.

App Attest dirilis dengan iOS 14.0. Beberapa pengguna Anda mungkin tidak menggunakan rilis ini, sehingga tidak memenuhi syarat untuk App Attest. Anda dapat mencatat peristiwa Analytics lain untuk melacak pengguna ini, lalu menargetkan audiens tersebut untuk metode pengesahan lain, seperti DeviceCheck .

Opsional: Gunakan Crashlytics untuk memantau error

Untuk lebih memahami stabilitas aplikasi Anda selama peluncuran, gunakan Firebase Crashlytics untuk memantau error dan non-fatal.

6. Selamat!

Anda berhasil meluncurkan App Check dengan Remote Config 🎉

Sumber daya tambahan:

• Mulai Cepat Firebase untuk repositori iOS
• Aktifkan Pemeriksaan Aplikasi dengan App Attest di iOS
• Pemeriksaan Aplikasi Firebase di dokumentasi Firebase
• Membangun Integritas Aplikasi Anda
• Daftarkan ID Aplikasi
• Aktifkan kemampuan aplikasi