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 Continuous Integration-Umgebung (CI), können Sie einen Debug-Build Ihrer App erstellen, der anstelle eines echten Attestierungsanbieters den App Check Debug-Anbieter verwendet.

Debug-Anbieter in der Entwicklung verwenden

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

  1. Erstellen und legen Sie in Ihrem Debug-Build die App Check Debug-Anbieter-Factory fest, bevor Sie Firebase-Backend-Dienste verwenden:

    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 die Debug-Protokollierung 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 Bereich 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. Rufen Sie in der Firebase Konsole Sicherheit > App Check auf.

  5. Registrieren Sie das gerade protokollierte Debug-Token.

    1. Suchen Sie auf dem Tab Apps nach Ihrer App.
    2. Wählen Sie im Überlaufmenü Ihrer App Debug-Tokens verwalten aus.
    3. Folgen Sie der Anleitung auf dem Bildschirm, um Ihr Debug-Token zu registrieren.

    Screenshot des Menüpunkts „Debug-Tokens verwalten“

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

Da dieses Token den Zugriff auf Ihre Firebase-Ressourcen ohne gültiges Gerät ermöglicht, ist es wichtig, dass Sie es privat halten. Übertragen Sie es nicht in ein öffentliches Repository und widerrufen Sie es sofort in der Firebase Konsole, wenn ein registriertes Token kompromittiert wird.

Debug-Anbieter in einer CI-Umgebung verwenden

So verwenden Sie den Debug-Anbieter in einer Continuous Integration-Umgebung (CI):

  1. Rufen Sie in der Firebase Konsole Sicherheit > App Check auf.

  2. Erstellen Sie ein Debug-Token. Sie benötigen dieses Token im nächsten Schritt.

    1. Suchen Sie auf dem Tab Apps nach Ihrer App.
    2. Wählen Sie im Überlaufmenü Ihrer App Debug-Tokens verwalten aus.
    3. Folgen Sie der Anleitung auf dem Bildschirm, um ein neues Debug-Token zu erstellen.

    Da dieses Token den Zugriff auf Ihre Firebase-Ressourcen ohne gültiges Gerät ermöglicht, ist es wichtig, dass Sie es privat halten. Übertragen Sie es nicht in ein öffentliches Repository und widerrufen Sie es sofort in der Firebase Konsole, wenn ein registriertes Token kompromittiert wird.

    Screenshot des Menüpunkts „Debug-Tokens verwalten“

  3. Fügen Sie das gerade erstellte Debug-Token dem sicheren Schlüsselspeicher Ihres CI-Systems hinzu (z. B. verschlüsselte Secrets von GitHub Actions oder verschlüsselte Variablen von Travis CI).

  4. Konfigurieren Sie Ihr CI-System gegebenenfalls so, dass Ihr Debug-Token in der CI-Umgebung als Umgebungsvariable verfügbar ist. Geben Sie der Variablen einen Namen wie APP_CHECK_DEBUG_TOKEN_FROM_CI.

  5. Fügen Sie in Xcode Ihrem Testschema eine Umgebungsvariable mit dem Namen FIRAAppCheckDebugToken und einem Wert wie $(APP_CHECK_DEBUG_TOKEN) hinzu.

  6. Konfigurieren Sie Ihr CI-Testskript so, dass das Debug-Token als Umgebungsvariable übergeben wird. Beispiel:

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

  7. Erstellen und legen Sie in Ihrem Debug-Build die App Check Debug-Anbieter-Factory fest, bevor Sie Firebase-Backend-Dienste verwenden:

    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-Backend-Dienste das gesendete Token als gültig.