Proteggi le credenziali Cloud della tua app per Android Firebase ML

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

Per le tue app di produzione, ti assicurerai che solo i client autenticati possano accedere ai servizi cloud. Tieni presente che solo i dispositivi non rooted possono eseguire l'autenticazione utilizzando il metodo descritto.

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

1. Registrare le 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. Per scoprire come fare, consulta la sezione Autenticare il cliente.

  2. Vai alle impostazioni del progetto in Play Console, quindi seleziona la scheda Impostazioni.Firebase

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

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

2. Limitare l'ambito delle 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 progetto.

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

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

    Quando configuri le restrizioni delle 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, una chiave API può essere utilizzata per accedere a qualsiasi API abilitata per il progetto.

Ora, le tue chiavi API esistenti non concederanno l'accesso ai servizi cloud ML, ma ogni chiave continuerà a funzionare per le API che hai aggiunto al suo elenco di limitazioni API.

Tieni presente che se in futuro abiliti altre API, devi aggiungerle all'elenco delle limitazioni API per la chiave API applicabile.

3. Creare e utilizzare una chiave API solo per il 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 progetto.

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

  2. Per assicurarti 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 hai già 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 manifest 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 in modo che utilizzi la corrispondenza delle impronte dei certificati per autenticare il client in produzione e per utilizzare le chiavi API (la chiave di debug) solo nelle build di debug:

    Kotlin 

    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)
    MainActivity.kt

    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);
    MainActivity.java

Passaggi successivi

Consulta l'elenco di controllo per il lancio per informazioni sulla preparazione della tua app al lancio quando utilizzi altre funzionalità di Firebase.