التحقّق من رموز "فحص التطبيق" من واجهة خلفية مخصَّصة

Node.js

إذا لم تكن قد ثبتّ SDK لمشرف Node.js من قبل، القيام بذلك.

ثم، باستخدام البرمجيات الوسيطة Express.js كمثال:

import express from "express";
import { initializeApp } from "firebase-admin/app";
import { getAppCheck } from "firebase-admin/app-check";

const expressApp = express();
const firebaseApp = 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 getAppCheck().verifyToken(appCheckToken);

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

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

Python

إذا لم تكن قد ثبتّ SDK لمشرف Python من قبل، القيام بذلك.

بعد ذلك، في معالِجات نقطة نهاية واجهة برمجة التطبيقات، يمكنك استدعاء app_check.verify_token() ورفضه في حالة عدم نجاحه. في المثال التالي، دالة المصمم بـ @before_request يؤدي إلى تنفيذ هذه المهمة مع جميع الطلبات:

import firebase_admin
from firebase_admin import app_check
import flask
import jwt

firebase_app = firebase_admin.initialize_app()
flask_app = flask.Flask(__name__)

@flask_app.before_request
def verify_app_check() -> None:
    app_check_token = flask.request.headers.get("X-Firebase-AppCheck", default="")
    try:
        app_check_claims = app_check.verify_token(app_check_token)
        # If verify_token() succeeds, okay to continue to route handler.
    except (ValueError, jwt.exceptions.DecodeError):
        flask.abort(401)

@flask_app.route("/yourApiEndpoint")
def your_api_endpoint(request: flask.Request):
    # Handle request.
    ...

انتقال

إذا لم يسبق لك تثبيت SDK للمشرف for Go، القيام بذلك.

بعد ذلك، في معالِجات نقطة نهاية واجهة برمجة التطبيقات، يمكنك استدعاء appcheck.Client.VerifyToken(). ورفضه في حالة فشله. في المثال التالي، يوجد برنامج تضمين هذا المنطق إلى معالجات نقطة النهاية:

package main

import (
    "context"
    "log"
    "net/http"

    firebaseAdmin "firebase.google.com/go/v4"
    "firebase.google.com/go/v4/appcheck"
)

var (
    appCheck *appcheck.Client
)

func main() {
    app, err := firebaseAdmin.NewApp(context.Background(), nil)
    if err != nil {
        log.Fatalf("error initializing app: %v\n", err)
    }

    appCheck, err = app.AppCheck(context.Background())
    if err != nil {
        log.Fatalf("error initializing app: %v\n", err)
    }

    http.HandleFunc("/yourApiEndpoint", requireAppCheck(yourApiEndpointHandler))
    log.Fatal(http.ListenAndServe(":8080", nil))
}

func requireAppCheck(handler func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request) {
    wrappedHandler := func(w http.ResponseWriter, r *http.Request) {
        appCheckToken, ok := r.Header[http.CanonicalHeaderKey("X-Firebase-AppCheck")]
        if !ok {
            w.WriteHeader(http.StatusUnauthorized)
            w.Write([]byte("Unauthorized."))
            return
        }

        _, err := appCheck.VerifyToken(appCheckToken[0])
        if err != nil {
            w.WriteHeader(http.StatusUnauthorized)
            w.Write([]byte("Unauthorized."))
            return
        }

        // If VerifyToken() succeeds, continue with the provided handler.
        handler(w, r)
    }
    return wrappedHandler
}

func yourApiEndpointHandler(w http.ResponseWriter, r *http.Request) {
    // Handle request.
}

غير ذلك

إذا كانت الخلفية مكتوبة بلغة أخرى، يمكنك استخدام مكتبة JWT للأغراض العامة، مثل المكتبة الموجودة في jwt.io، للتحقّق من الرموز المميّزة لفحص التطبيقات.

يجب أن يكمل منطق إثبات ملكية الرمز المميّز الخطوات التالية:

1. الحصول على مفتاح الويب JSON العام للتحقق من التطبيقات في Firebase الذي تم ضبطه من التطبيق التحقّق من نقطة نهاية JWKS: https://firebaseappcheck.googleapis.com/v1/jwks
2. تحقَّق من توقيع الرمز المميّز لميزة "فحص التطبيقات" للتأكُّد من صحته.
3. تأكَّد من أنّ عنوان الرمز المميّز يستخدم الخوارزمية RS256.
4. تأكَّد من أنّ عنوان الرمز المميّز نوع JWT.
5. تأكَّد من أنّ الرمز المميّز تم إصداره من خلال ميزة "التحقّق من التطبيقات في Firebase" ضمن مشروعك.
6. تأكَّد من عدم انتهاء صلاحية الرمز المميّز.
7. تأكَّد من أنّ جمهور الرمز المميّز يتطابق مع مشروعك.
8. اختياري: تأكَّد من أنّ موضوع الرمز المميّز يتطابق مع رقم تعريف التطبيق في تطبيقك.

قد تختلف إمكانيات مكتبات JWT، فتأكد من إكمال وأي خطوات لم تتم معالجتها في المكتبة التي تختارها.

ينفذ المثال التالي الخطوات اللازمة في Ruby باستخدام jwt كطبقة من طبقات البرمجيات الوسيطة Rack.

require 'json'
require 'jwt'
require 'net/http'
require 'uri'

class AppCheckVerification
def initialize(app, options = {})
    @app = app
    @project_number = options[:project_number]
end

def call(env)
    app_id = verify(env['HTTP_X_FIREBASE_APPCHECK'])
    return [401, { 'Content-Type' => 'text/plain' }, ['Unauthenticated']] unless app_id
    env['firebase.app'] = app_id
    @app.call(env)
end

def verify(token)
    return unless token

    # 1. Obtain the Firebase App Check Public Keys
    # Note: It is not recommended to hard code these keys as they rotate,
    # but you should cache them for up to 6 hours.
    uri = URI('https://firebaseappcheck.googleapis.com/v1/jwks')
    jwks = JSON(Net::HTTP.get(uri))

    # 2. Verify the signature on the App Check token
    payload, header = JWT.decode(token, nil, true, jwks: jwks, algorithms: 'RS256')

    # 3. Ensure the token's header uses the algorithm RS256
    return unless header['alg'] == 'RS256'

    # 4. Ensure the token's header has type JWT
    return unless header['typ'] == 'JWT'

    # 5. Ensure the token is issued by App Check
    return unless payload['iss'] == "https://firebaseappcheck.googleapis.com/#{@project_number}"

    # 6. Ensure the token is not expired
    return unless payload['exp'] > Time.new.to_i

    # 7. Ensure the token's audience matches your project
    return unless payload['aud'].include? "projects/#{@project_number}"

    # 8. The token's subject will be the app ID, you may optionally filter against
    # an allow list
    payload['sub']
rescue
end
end

class Application
def call(env)
    [200, { 'Content-Type' => 'text/plain' }, ["Hello app #{env['firebase.app']}"]]
end
end

use AppCheckVerification, project_number: 1234567890
run Application.new