Seleziona la piattaforma: Android iOS JavaScript

Utilizzare App Check per proteggere la chiave API

Firebase App Check protegge le chiamate dalla tua app a Google Maps Platform bloccando il traffico proveniente da fonti diverse dalle app legittime. A questo scopo, controlla la presenza di un token di un fornitore di attestazioni come App Attest. L'integrazione delle tue app con App Check aiuta a proteggerti da richieste dannose, in modo da non addebitarti chiamate API non autorizzate.

App Check è adatto a me?

App Check è consigliato nella maggior parte dei casi, ma non è necessario o non è supportato nei seguenti casi:

  • Stai utilizzando l'SDK Places originale. App Check è supportato solo per Places SDK (New).
  • App private o sperimentali. Se la tua app non è accessibile pubblicamente, App Check non è necessario.
  • Se la tua app viene utilizzata solo server-to-server, App Check non è necessario. Tuttavia, se il server che comunica con GMP viene utilizzato da client pubblici (come le app mobile), valuta la possibilità di utilizzare App Check per proteggere il server anziché GMP.
  • I fornitori di attestazione consigliati da App Check non funzioneranno sui dispositivi considerati compromessi o non attendibili dal tuo fornitore di attestazione. Se devi supportare questi dispositivi, puoi implementare un servizio di attestazione personalizzato. Per ulteriori informazioni, consulta le istruzioni.

Panoramica dei passaggi di implementazione

In linea generale, ecco i passaggi da seguire per integrare l'app con App Check:

  1. Aggiungi Firebase alla tua app.
  2. Aggiungi e inizializza la libreria App Check.
  3. Aggiungi il fornitore di token alla tua app.
  4. Inizializza le API Places e App Check.
  5. Attiva il debug.
  6. Monitora le richieste dell'app e decidi l'applicazione.

Una volta completata l'integrazione con App Check, potrai visualizzare le metriche del traffico di backend nella console Firebase. Queste metriche forniscono una suddivisione delle richieste in base alla presenza o meno di un token App Check valido. Per maggiori informazioni, consulta la documentazione di Firebase App Check.

Quando avrai la certezza che la maggior parte delle richieste proviene da fonti legittime e che gli utenti hanno eseguito l'aggiornamento all'ultima versione della tua app che include l'implementazione di App Check, potrai attivare l'applicazione. Una volta attivata l'applicazione, App Check rifiuterà tutto il traffico senza un token App Check valido.

Considerazioni per la pianificazione di un'integrazione di App Check

Ecco alcuni aspetti da considerare durante la pianificazione dell'integrazione:

  • I fornitori di attestazione che consigliamo, Device Check o App Attest, sono soggetti a quote e limitazioni stabilite da Apple.

    Puoi scegliere di utilizzare un fornitore di attestazione personalizzato, anche se si tratta di un caso d'uso avanzato. Per maggiori informazioni, consulta la documentazione di Firebase App Check.

  • Gli utenti della tua app riscontreranno una certa latenza all'avvio. Tuttavia, in seguito, qualsiasi riattestazione periodica avverrà in background e gli utenti non dovrebbero più riscontrare latenza. L'esatta quantità di latenza all'avvio dipende dal fornitore di attestazione che scegli.

    La durata di validità del token App Check (la durata o TTL) determina la frequenza delle riattestazioni. Questa durata può essere configurata nella console Firebase. La riattestazione si verifica quando è trascorso circa metà del TTL. Per saperne di più, consulta la documentazione di Firebase per il tuo fornitore di attestazioni.

Integrare l'app con App Check

Prerequisiti e requisiti

  • Un'app con Places SDK versione 9.2 o successive installata.
  • L'ID bundle dell'app.
  • Il tuo ID team del Member Center (Centro membri) di Apple, nella sezione Membership (Appartenenza).
  • Se prevedi di utilizzare Device Check, il file della chiave privata e l'ID chiave.
  • Devi essere il proprietario dell'app nella console Cloud.
  • Avrai bisogno dell'ID progetto dell'app dalla console Cloud

Passaggio 1: aggiungi Firebase alla tua app

Segui le istruzioni nella documentazione per gli sviluppatori di Firebase per aggiungere Firebase alla tua app.

Quando registri la tua app, ricevi un file di configurazione, GoogleService-Info.plist. Aggiungi questo file, senza modifiche, al livello root della tua app.

Places Swift SDK per iOS

import FirebaseCore
import FirebaseAppCheck
import GooglePlacesSwift

Swift

import FirebaseCore
import FirebaseAppCheck
import GooglePlaces

Objective-C

@import FirebaseCore;      
@import FirebaseAppCheck;
@import GooglePlaces;

Passaggio 2: aggiungi la libreria App Check e inizializza App Check

Firebase fornisce istruzioni per ogni fornitore di attestazione predefinito. Queste istruzioni mostrano come configurare un progetto Firebase e aggiungere la libreria App Check alla tua app. Segui gli esempi di codice forniti per inizializzare App Check.

  1. Segui le istruzioni di Firebase per aggiungere la libreria App Check:
  2. Inizializza App Check.
    • Se utilizzi App Attest, segui la documentazione per sviluppatori di Firebase per App Attest.

      Segui le istruzioni di Firebase App Check per creare un'implementazione di AppCheckProviderFactory e aggiungerla al file AppDelegate.

      Places Swift SDK per iOS

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

      Swift

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

      Objective-C

      YourAppCheckProviderFactory *providerFactory =
    [[YourAppCheckProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];
    • Se utilizzi il controllo del dispositivo, aggiungi quanto segue al tuo AppDelegate:

      Places Swift SDK per iOS

      AppCheck.setAppCheckProviderFactory(DeviceCheckProviderFactory())

      Swift

      AppCheck.setAppCheckProviderFactory(DeviceCheckProviderFactory())

      Objective-C

      [FIRAppCheck setAppCheckProviderFactory:providerFactory];

Passaggio 3: aggiungi il fornitore di token

Crea un file chiamato AppCheckTokenProvider (o, se utilizzi Objective-C, due file chiamati AppCheckTokenProvider.h e AppCheckTokenProvider.m) a livello di root della tua app. Aggiungi le seguenti istruzioni di importazione e definizione di classe:

Places Swift SDK per iOS

// AppCheckTokenProvider.swift

import FirebaseAppCheck
import Foundation
import GooglePlacesSwift
      
struct TokenProvider: AppCheckTokenProvider {
  func fetchAppCheckToken() async throws -> String {
    return try await AppCheck.appCheck().token(forcingRefresh: false).token
  }
}

Swift

// AppCheckTokenProvider.swift

import FirebaseAppCheck
import Foundation
import GooglePlaces

class AppCheckTokenProvider: NSObject, GMSPlacesAppCheckTokenProvider {
  func fetchAppCheckToken() async throws -> String {
    return try await AppCheck.appCheck().token(forcingRefresh: false).token
  }
}

Objective-C

// AppCheckTokenProvider.h

@import Foundation;
@import GooglePlaces;

@interface AppCheckTokenProvider : NSObject <GMSPlacesAppCheckTokenProvider>
@end

// AppCheckTokenProvider.m

#import "AppCheckTokenProvider.h"

@import FirebaseAppCheck;

@implementation AppCheckTokenProvider

- (void)fetchAppCheckTokenWithCompletion:(nonnull GMSAppCheckTokenCompletion)completion {
  [[FIRAppCheck appCheck]
      tokenForcingRefresh:NO
               completion:^(FIRAppCheckToken *_Nullable token, NSError *_Nullable error) {
                 if (token) {
                   completion(token.token, nil);
                 } else {
                   completion(nil, error);
                 }
               }];
}

@end

Passaggio 4: inizializza le API Places e App Check

  1. Nel file AppDelegate, inizializza l'API Places:

    Places Swift SDK per iOS

    PlacesClient.provideAPIKey("YOUR_API_KEY")

    Swift

    GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

    Objective-C

    [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];
  2. Quindi, inizializza l'API App Check:

    Places Swift SDK per iOS

    PlacesClient.setAppCheckTokenProvider(AppCheckTokenProvider())

    Swift

    GMSPlacesClient.setAppCheckTokenProvider(AppCheckTokenProvider())

    Objective-C

    [GMSPlacesClient setAppCheckTokenProvider:[[AppCheckTokenProvider alloc] init]];

(Facoltativo) Passaggio 5: attiva il debug

Se vuoi sviluppare e testare la tua app in locale o eseguirla in un ambiente di integrazione continua (CI), puoi creare una build di debug dell'app che utilizza un secret di debug per ottenere token App Check validi. In questo modo puoi evitare di utilizzare fornitori di attestazione reali nella build di debug.

Per testare la tua app nel simulatore o su un dispositivo di test:

  • Crea e imposta la fabbrica del provider di debug di App Check.

    Questo codice campione gestisce gli scenari di debug e di produzione:

    Places Swift SDK per iOS

    #if targetEnvironment(simulator)
      let providerFactory = AppCheckDebugProviderFactory()
#else
      let providerFactory = YourAppCheckProviderFactory()
#endif

    Swift

    #if targetEnvironment(simulator)
      let providerFactory = AppCheckDebugProviderFactory()
#else
      let providerFactory = YourAppCheckProviderFactory()
#endif

    Objective-C

    if (targetEnvironment == simulator){

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

else {

YourAppCheckProviderFactory *providerFactory =
      [[YourAppCheckProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];
}
  • Attiva la registrazione nel progetto Xcode, avvia l'app e trova il token di debug locale nel log.
  • Aggiungi questo token alla console Firebase.
  • Per ulteriori informazioni e istruzioni, consulta la documentazione di App Check.

Per eseguire l'app in un ambiente CI:

  • Crea un token di debug nella console Firebase e aggiungilo all'archivio chiavi sicuro del sistema di integrazione continua.
  • In Xcode, aggiungi una variabile di ambiente allo schema di test con il nome FIRAAppCheckDebugToken e $(APP_CHECK_DEBUG_TOKEN) (o un valore simile).
  • Nello script di test CI, trasmetti il token di debug come ambiente

  • Crea e imposta la fabbrica del provider di debug di App Check.

    Questo codice campione gestisce gli scenari di debug e di produzione:

    Places Swift SDK per iOS

    #if DEBUG
  let providerFactory = AppCheckDebugProviderFactory()
#else
  let providerFactory = YourAppCheckProviderFactory()
#endif
AppCheck.setAppCheckProviderFactory(providerFactory)

    Swift

    #if DEBUG
  let providerFactory = AppCheckDebugProviderFactory()
#else
  let providerFactory = YourAppCheckProviderFactory()
#endif
AppCheck.setAppCheckProviderFactory(providerFactory)

    Objective-C

    #if DEBUG
id<FIRAppCheckProviderFactory> providerFactory =
    [[FIRAppCheckDebugProviderFactory alloc] init];
#else  // DEBUG
id<FIRAppCheckProviderFactory> providerFactory =
    [[YourAppCheckProviderFactory alloc] init];
#endif  // DEBUG
AppCheck.setAppCheckProviderFactory(providerFactory)
  • Per ulteriori informazioni e istruzioni, consulta la documentazione di App Check.

Passaggio 6: monitora le richieste di app e decidi l'applicazione

Prima di iniziare l'applicazione, assicurati di non interrompere l'attività degli utenti legittimi della tua app. A questo scopo, visita la schermata delle metriche di App Check per visualizzare la percentuale di traffico della tua app verificato, obsoleto o illegittimo. Una volta verificato che la maggior parte del traffico è verificata, puoi attivare l'applicazione.

Per ulteriori informazioni e istruzioni, consulta la documentazione di Firebase App Check.