Proteggi le credenziali cloud della tua app Android Firebase ML

Se la tua app Android utilizza una delle API cloud di Firebase ML, prima di lanciare l'app in produzione, dovresti adottare alcune misure aggiuntive per impedire l'accesso API non autorizzato.

Per le tue app di produzione, ti assicurerai che solo i client autenticati possano accedere ai servizi cloud. (Nota che solo i dispositivi non rootati possono autenticarsi utilizzando il metodo descritto.)

Quindi creerai una chiave API di solo debug che potrai utilizzare per comodità durante i test e lo sviluppo.

1. Registra le tue app di produzione con Firebase

Innanzitutto, registra le tue app di produzione con Firebase.

  1. Assicurati di avere le firme SHA-1 della tua app. Consulta Autenticazione del tuo client per sapere come.

  2. Vai alle Impostazioni progetto nella console Firebase, quindi seleziona la scheda Impostazioni .

  3. Scorri verso il basso fino alla scheda Le tue app , quindi seleziona la tua app Android.

  4. Aggiungi la firma SHA-1 della tua app alle informazioni della tua app.

2. Limita l'ambito delle tue chiavi API

Successivamente, configura le chiavi API esistenti per impedire l'accesso all'API Cloud Vision:

  1. Apri la pagina Credenziali della console Google Cloud. Quando richiesto, seleziona il tuo progetto.

  2. Per ogni chiave API esistente nell'elenco, apri la vista di modifica.

  3. Nella sezione Restrizioni API , seleziona Limita chiave , quindi aggiungi all'elenco tutte le API a cui desideri che la chiave API abbia accesso. Assicurati di non includere l'API Cloud Vision.

    Quando configuri le restrizioni API di una chiave API, dichiari esplicitamente le API a cui la chiave ha accesso. Per impostazione predefinita, quando nella sezione Restrizioni API è selezionata l' opzione Non limitare la chiave , è possibile utilizzare una chiave API per accedere a qualsiasi API abilitata per il progetto.

Ora, le tue chiavi API esistenti non garantiranno l'accesso ai servizi cloud ML, ma ciascuna chiave continuerà a funzionare per tutte le API che hai aggiunto al relativo elenco di restrizioni API .

Tieni presente che se in futuro abiliti API aggiuntive, dovrai aggiungerle all'elenco delle restrizioni API per la chiave API applicabile.

3. Crea e utilizza una chiave API di solo debug

Infine, crea una nuova chiave API da utilizzare solo per lo sviluppo. Firebase ML può utilizzare questa chiave API per accedere ai servizi Google Cloud in ambienti in cui l'autenticazione dell'app non è possibile, ad esempio quando viene eseguita su emulatori.

  1. Crea una nuova chiave API da utilizzare per lo sviluppo:

    1. Apri la pagina Credenziali della console Google Cloud. Quando richiesto, seleziona il tuo progetto.

    2. Fai clic su Crea credenziali > Chiave API e prendi nota della nuova chiave API. Questa chiave consente l'accesso API da app non autenticate, quindi mantieni la chiave riservata .

  2. Per garantire che la nuova chiave API di debug non venga divulgata con l'app rilasciata, specifica la chiave API di debug in un file manifest Android utilizzato solo per le build di debug:

    1. Se non disponi già di un manifest di debug, creane uno facendo clic su File > Nuovo > Altro > File manifest Android e selezionando debug dai set di origini di destinazione.

    2. Nel manifesto di debug, aggiungi la seguente dichiarazione:

      <application>
      <meta-data
          android:name="com.firebase.ml.cloud.ApiKeyForDebug"
          android:value="your-debug-api-key" />
      </application>
      
  3. Nella tua app, configura Firebase ML per utilizzare la corrispondenza dell'impronta digitale del certificato per autenticare il tuo client in produzione e per utilizzare le chiavi API, ovvero la chiave di debug, solo nelle build di debug:

    Kotlin+KTX

    val optionsBuilder = FirebaseVisionCloudImageLabelerOptions.Builder()
    if (!BuildConfig.DEBUG) {
        // Requires physical, non-rooted device:
        optionsBuilder.enforceCertFingerprintMatch()
    }
    
    // Set other options. For example:
    optionsBuilder.setConfidenceThreshold(0.8f)
    // ...
    
    // And lastly:
    val options = optionsBuilder.build()
    FirebaseVision.getInstance().getCloudImageLabeler(options).processImage(myImage)

    Java

    FirebaseVisionCloudImageLabelerOptions.Builder optionsBuilder =
            new FirebaseVisionCloudImageLabelerOptions.Builder();
    if (!BuildConfig.DEBUG) {
        // Requires physical, non-rooted device:
        optionsBuilder.enforceCertFingerprintMatch();
    }
    
    // Set other options. For example:
    optionsBuilder.setConfidenceThreshold(0.8f);
    // ...
    
    // And lastly:
    FirebaseVisionCloudImageLabelerOptions options = optionsBuilder.build();
    FirebaseVision.getInstance().getCloudImageLabeler(options).processImage(myImage);

Prossimi passi

Consulta l' elenco di controllo del lancio per informazioni su come preparare la tua app al lancio quando utilizzi altre funzionalità di Firebase.