App Check mit dem Debugging-Anbieter auf Apple-Plattformen verwenden

Wenn Sie Ihre App für App Check registriert haben und sie in einer Umgebung ausführen möchten, die von App Check normalerweise nicht als gültig eingestuft wird, z. B. in einem Simulator oder auf einem Gerät während der Entwicklung oder in einer CI-Umgebung (Continuous Integration), können Sie einen Debug-Build Ihrer App erstellen, bei dem der App Check-Debuganbieter anstelle eines echten Attestierungsanbieters verwendet wird.

Anbieter für Fehlerbehebung in der Entwicklung verwenden

So verwenden Sie den Debug-Anbieter, während Ihre App interaktiv ausgeführt wird (z. B. während der Entwicklung):

  1. Bevor Sie Firebase-Back-End-Dienste verwenden, erstellen Sie in Ihrem Debug-Build Legen Sie die App Check-Debugging-Anbieter-Factory fest:

    Swift

    let providerFactory = AppCheckDebugProviderFactory()
AppCheck.setAppCheckProviderFactory(providerFactory)

FirebaseApp.configure()

    Objective-C

    FIRAppCheckDebugProviderFactory *providerFactory =
      [[FIRAppCheckDebugProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];

// Use Firebase library to configure APIs
[FIRApp configure];

  2. Aktivieren Sie das Debugging-Logging in Ihrem Xcode-Projekt (Version 11.0 oder höher):

    1. Öffnen Sie Produkt > Schema > Schema bearbeiten.
    2. Wählen Sie im Menü auf der linken Seite Ausführen und dann den Tab Argumente aus.
    3. Fügen Sie im Abschnitt Arguments Passed on Launch (Beim Start übergebene Argumente) -FIRDebugEnabled hinzu.

  3. Starten Sie die App. Ein lokales Debug-Token wird protokolliert, wenn das SDK versucht, eine Anfrage an das Backend zu senden. Beispiel:

    [Firebase/AppCheck][I-FAA001001] Firebase App Check Debug Token:
123a4567-b89c-12d3-e456-789012345678

  4. Im Bereich App Check der Firebase-Konsole die Option Fehlerbehebungstokens verwalten aus der Dreipunkt-Menü. Registrieren Sie dann das Fehlerbehebungstoken, das Sie im vorherigen Schritt Schritt.

    Screenshot des Menüpunkts „Fehlerbehebungstokens verwalten“

Nachdem Sie das Token registriert haben, akzeptieren die Firebase-Back-End-Dienste es als gültig.

Da dieses Token den Zugriff auf Ihre Firebase-Ressourcen ermöglicht, ein gültiges Gerät haben, müssen Sie es privat halten. Speichern Sie es nicht in einem öffentlichen Repository. Wenn ein registriertes Token manipuliert wird, widerrufen Sie es sofort in der Firebase-Konsole.

Debug-Anbieter in einer CI-Umgebung verwenden

Um den Debug-Anbieter in einer CI-Umgebung (Continuous Integration) zu verwenden, führen Sie die folgenden Schritte aus: Folgendes:

  1. Wählen Sie in der Firebase-Konsole im Bereich App Check im Dreipunkt-Menü Ihrer App die Option Debug-Tokens verwalten aus. Erstellen Sie dann ein neues Fehlerbehebungstoken. Sie benötigen das Token für den nächsten Schritt.

    Da mit diesem Token ohne gültiges Gerät auf Ihre Firebase-Ressourcen zugegriffen werden kann, ist es wichtig, dass Sie es für sich behalten. Committe es nicht in ein öffentliches Repository. Wenn ein registriertes Token manipuliert wird, widerrufe es sofort in der Firebase-Konsole.

    Screenshot des Menüpunkts „Debug-Tokens verwalten“

  2. Fügen Sie das soeben erstellte Fehlerbehebungstoken dem sicheren Schlüsselspeicher Ihres CI-Systems hinzu. (z. B. verschlüsselte Secrets von GitHub Actions) oder die verschlüsselten Variablen von Travis CI.

  3. Konfigurieren Sie bei Bedarf Ihr CI-System so, dass Ihr Debug-Token in der CI-Umgebung als Umgebungsvariable verfügbar ist. Benennen Sie die Variable etwa APP_CHECK_DEBUG_TOKEN_FROM_CI.

  4. Fügen Sie in Xcode eine Umgebungsvariable mit dem Namen FIRAAppCheckDebugToken und etwa $(APP_CHECK_DEBUG_TOKEN) als den Wert.

  5. CI-Testskript konfigurieren, um das Fehlerbehebungstoken als Umgebung zu übergeben . Beispiel:

    xcodebuild test -scheme YourTestScheme -workspace YourProject.xcworkspace \
APP_CHECK_DEBUG_TOKEN=$(APP_CHECK_DEBUG_TOKEN_FROM_CI)

  6. Bevor Sie Firebase-Back-End-Dienste verwenden, erstellen Sie in Ihrem Debug-Build Legen Sie die App Check-Debugging-Anbieter-Factory fest:

    Swift

    let providerFactory = AppCheckDebugProviderFactory()
AppCheck.setAppCheckProviderFactory(providerFactory)

FirebaseApp.configure()

    Objective-C

    FIRAppCheckDebugProviderFactory *providerFactory =
      [[FIRAppCheckDebugProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];

// Use Firebase library to configure APIs
[FIRApp configure];

Wenn Ihre App in einer CI-Umgebung ausgeführt wird, akzeptieren die Firebase-Back-End-Dienste das gesendete Token als gültig.