Schützen Sie Nicht-Firebase-Ressourcen mit App Check auf Android

Sie können die Nicht-Firebase-Ressourcen Ihrer App, z. B. selbstgehostete Back-Ends, mit App Check schützen. Dazu müssen Sie Ihren App-Client so ändern, dass er mit jeder Anfrage ein App-Check-Token an Ihr Back-End sendet, und Ihr Back-End so ändern, dass bei jeder Anfrage ein gültiges App-Check-Token erforderlich ist. beide Aufgaben werden im Folgenden beschrieben.

Bevor Sie beginnen

In App überprüfen , um Ihre Anwendung, entweder den Standard mit SafetyNet - Provider oder einen benutzerdefinierten Anbieter .

Senden Sie App-Check-Token mit Back-End-Anfragen

Um sicherzustellen , dass Ihre Backend - Anforderungen umfassen ein gültiger, noch nicht abgelaufen, App überprüfen Token, wickelt jede Anforderung in einem Aufruf an getAppCheckToken() . Die App Check-Bibliothek aktualisiert das Token bei Bedarf, und Sie können auf das Token im Erfolgslistener der Methode zugreifen.

Sobald Sie ein gültiges Token haben, senden Sie es zusammen mit der Anfrage an Ihr Backend. Die Besonderheiten, wie Sie dies zu erreichen sind bis zu Ihnen, aber nicht App überprüfen Token als Teil von URLs, einschließlich in Abfrageparametern senden, da dies sie anfällig für versehentliche Leckage und Abfangen macht. Der empfohlene Ansatz besteht darin, das Token in einem benutzerdefinierten HTTP-Header zu senden.

Wenn Sie beispielsweise Retrofit verwenden:

Java

public class ApiWithAppCheckExample {
    private interface YourExampleBackendService {
        @GET("yourExampleEndpoint")
        Call<List<String>> exampleData(
                @Header("X-Firebase-AppCheck") String appCheckToken);
    }

    YourExampleBackendService yourExampleBackendService = new Retrofit.Builder()
            .baseUrl("https://yourbackend.example.com/")
            .build()
            .create(YourExampleBackendService.class);

    public void callApiExample() {
        FirebaseAppCheck.getInstance()
                .getAppCheckToken(false)
                .addOnSuccessListener(new OnSuccessListener<AppCheckToken>() {
                    @Override
                    public void onSuccess(@NonNull AppCheckToken tokenResponse) {
                        String appCheckToken = tokenResponse.getToken();
                        Call<List<String>> apiCall =
                                yourExampleBackendService.exampleData(appCheckToken);
                        // ...
                    }
                });
    }
}

Kotlin+KTX

class ApiWithAppCheckExample {
    interface YourExampleBackendService {
        @GET("yourExampleEndpoint")
        fun exampleData(
            @Header("X-Firebase-AppCheck") appCheckToken: String
        ): Call<List<String>>
    }

    var yourExampleBackendService: YourExampleBackendService = Retrofit.Builder()
        .baseUrl("https://yourbackend.example.com/")
        .build()
        .create(YourExampleBackendService::class.java)

    fun callApiExample() {
        FirebaseAppCheck.getInstance()
            .getAppCheckToken(false)
            .addOnSuccessListener { tokenResponse ->
                val appCheckToken = tokenResponse.token
                val apiCall = yourExampleBackendService.exampleData(appCheckToken)
                // ...
            }
    }
}

Überprüfen Sie die App-Check-Token im Back-End

In Ihrem Backend - Code, wenn Sie nicht bereits installiert haben Node.js Admin SDK , dazu. Fügen Sie dann Ihren API-Endpunkten Logik hinzu, die Folgendes bewirkt:

  • Stellen Sie sicher, dass jede Anfrage ein App Check-Token enthält.

  • Überprüfen Sie die App überprüfen Token des Admin SDK mit appCheck().verifyToken() Methode.

    Wenn die Überprüfung erfolgreich, verifyToken() gibt die decodierte App Token prüfen. Eine erfolgreiche Überprüfung zeigt an, dass das Token von einer App stammt, die zu Ihrem Firebase-Projekt gehört.

Lehnen Sie alle Anfragen ab, die eine der beiden Prüfungen nicht bestehen. Verwenden Sie beispielsweise die Express.js-Middleware:

const express = require('express');
const app = express();

const firebaseAdmin = require('firebase-admin');
const firebaseApp = firebaseAdmin.initializeApp();

const appCheckVerification = async (req, res, next) => {
    const appCheckToken = req.header('X-Firebase-AppCheck');

    if (!appCheckToken) {
        res.status(401);
        return next('Unauthorized');
    }

    try {
        const appCheckClaims = await firebaseAdmin.appCheck().verifyToken(appCheckToken);

        // If verifyToken() succeeds, continue with the next middleware
        // function in the stack.
        return next();
    } catch (err) {
        res.status(401);
        return next('Unauthorized');
    }
}

app.get('/yourApiEndpoint', [appCheckVerification], (req, res) => {
    // Handle request.
});