הגנה על משאבים שאינם של Firebase באמצעות App Check ב-Android

אפשר להגן על משאבים באפליקציה שלא קשורים ל-Firebase, כמו קצוות עורפיים באירוח עצמי, עם App Check. כדי לעשות זאת, צריך לבצע את שתי הפעולות הבאות:

• משנים את לקוח האפליקציה כך שישלח אסימון App Check יחד עם כל בקשה לקצה העורפי, כפי שמתואר בדף הזה.
• צריך לשנות את הקצה העורפי כך שיחייב אסימון App Check חוקי בכל בקשה, כפי שמתואר במאמר אימות App Check אסימונים בקצה עורפי בהתאמה אישית.

לפני שמתחילים

מוסיפים את App Check לאפליקציה ומשתמשים באחת מברירת המחדל ספק Play Integrity, או ספק מותאם אישית.

שליחת App Check אסימונים עם בקשות לקצה העורפי

כדי לוודא שהבקשות לקצה העורפי כוללות אסימון App Check בתוקף ותקף, כוללים כל בקשה בשיחה ל-getAppCheckToken(). הספרייה App Check תחדש את האסימון במקרה הצורך, ותוכלו לגשת לאסימון בבורר האירועים של הצלחת השיטה.

ברגע שיש לכם אסימון תקף, צריך לשלוח אותו יחד עם הבקשה לקצה העורפי. האופן שבו ניתן לעשות זאת תלוי בכם. אל תשלחו App Check אסימונים כחלק מכתובות URL, כולל בפרמטרים של שאילתה, כי שעלולות להיות חשופות לדליפה וליירוט בטעות. המומלצים היא לשלוח את האסימון בכותרת HTTP מותאמת אישית.

לדוגמה, אם משתמשים ב-Retrofit:

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() {
        Firebase.appCheck.getAppCheckToken(false).addOnSuccessListener { appCheckToken ->
            val token = appCheckToken.token
            val apiCall = yourExampleBackendService.exampleData(token)
            // ...
        }
    }
}
ApiWithAppCheckExample.kt

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 appCheckToken) {
                        String token = appCheckToken.getToken();
                        Call<List<String>> apiCall =
                                yourExampleBackendService.exampleData(token);
                        // ...
                    }
                });
    }
}
ApiWithAppCheckExample.java

הגנה מפני הפעלה חוזרת (בטא)

כששולחים בקשה לנקודת קצה (endpoint) שהפעלתם בה הגנה מפני הפעלה חוזרת, צריך לעטוף את הבקשה בקריאה ל-getLimitedUseAppCheckToken() במקום ל-getAppCheckToken():

Kotlin+KTX

Firebase.appCheck.limitedUseAppCheckToken.addOnSuccessListener {
    // ...
}
ApiWithAppCheckExample.kt

Java

FirebaseAppCheck.getInstance()
        .getLimitedUseAppCheckToken().addOnSuccessListener(
                new OnSuccessListener<AppCheckToken>() {
                    @Override
                    public void onSuccess(AppCheckToken appCheckToken) {
                        String token = appCheckToken.getToken();
                        // ...
                    }
                }
        );
ApiWithAppCheckExample.java