कस्टम बैकएंड से ऐप चेक टोकन सत्यापित करें

आप ऐप चेक के साथ अपने ऐप के गैर-फ़ायरबेस संसाधनों, जैसे स्व-होस्ट किए गए बैकएंड की सुरक्षा कर सकते हैं। ऐसा करने के लिए, आपको निम्नलिखित दोनों कार्य करने होंगे:

  • अपने बैकएंड पर प्रत्येक अनुरोध के साथ एक ऐप चेक टोकन भेजने के लिए अपने ऐप क्लाइंट को संशोधित करें, जैसा कि iOS+ , Android और वेब के पेजों पर बताया गया है।
  • प्रत्येक अनुरोध के साथ एक वैध ऐप चेक टोकन की आवश्यकता के लिए अपने बैकएंड को संशोधित करें, जैसा कि इस पृष्ठ पर बताया गया है।

टोकन सत्यापन

अपने बैकएंड पर ऐप चेक टोकन को सत्यापित करने के लिए, अपने एपीआई एंडपॉइंट में तर्क जोड़ें जो निम्न कार्य करता है:

  • जांचें कि प्रत्येक अनुरोध में एक ऐप चेक टोकन शामिल है।

  • एडमिन एसडीके का उपयोग करके ऐप चेक टोकन सत्यापित करें।

    यदि सत्यापन सफल हो जाता है, तो एडमिन एसडीके डिकोडेड ऐप चेक टोकन लौटा देता है। सफल सत्यापन इंगित करता है कि टोकन आपके फायरबेस प्रोजेक्ट से संबंधित ऐप से उत्पन्न हुआ है।

किसी भी जांच में विफल होने वाले किसी भी अनुरोध को अस्वीकार करें। उदाहरण के लिए:

नोड.जे.एस

यदि आपने पहले से Node.js एडमिन SDK इंस्टॉल नहीं किया है, तो ऐसा करें।

फिर, एक उदाहरण के रूप में 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 इंस्टॉल नहीं किया है, तो ऐसा करें।

फिर, अपने एपीआई एंडपॉइंट हैंडलर में, 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.
    ...

जाना

यदि आपने गो के लिए एडमिन एसडीके पहले से इंस्टॉल नहीं किया है, तो ऐसा करें।

फिर, अपने एपीआई एंडपॉइंट हैंडलर में, 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 वेब कुंजी (JWK) सेट की जांच करें JWKS एंडपॉइंट की जांच करें: https://firebaseappcheck.googleapis.com/v1/jwks
  2. यह सुनिश्चित करने के लिए ऐप चेक टोकन के हस्ताक्षर को सत्यापित करें कि यह वैध है।
  3. सुनिश्चित करें कि टोकन का हेडर एल्गोरिथम RS256 का उपयोग करता है।
  4. सुनिश्चित करें कि टोकन के हेडर में JWT प्रकार है।
  5. सुनिश्चित करें कि टोकन आपके प्रोजेक्ट के तहत फायरबेस ऐप चेक द्वारा जारी किया गया है।
  6. सुनिश्चित करें कि टोकन समाप्त नहीं हुआ है।
  7. सुनिश्चित करें कि टोकन की ऑडियंस आपके प्रोजेक्ट से मेल खाती है।
  8. वैकल्पिक : जांचें कि टोकन का विषय आपके ऐप की ऐप आईडी से मेल खाता है।

JWT पुस्तकालयों की क्षमताएँ भिन्न हो सकती हैं; आपके द्वारा चुनी गई लाइब्रेरी द्वारा नियंत्रित नहीं किए जाने वाले किसी भी चरण को मैन्युअल रूप से पूरा करना सुनिश्चित करें।

निम्नलिखित उदाहरण रैक मिडलवेयर परत के रूप में jwt रत्न का उपयोग करके रूबी में आवश्यक कदम उठाता है।

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

रीप्ले सुरक्षा (बीटा)

किसी एंडपॉइंट को रीप्ले हमलों से बचाने के लिए, आप ऐप चेक टोकन को सत्यापित करने के बाद उसका उपभोग कर सकते हैं ताकि इसका उपयोग केवल एक बार किया जा सके।

रीप्ले सुरक्षा का उपयोग करने से verifyToken() कॉल में एक नेटवर्क राउंड ट्रिप जुड़ जाता है, और इसलिए इसका उपयोग करने वाले किसी भी समापन बिंदु पर विलंबता जुड़ जाती है। इस कारण से, हम अनुशंसा करते हैं कि आप केवल विशेष रूप से संवेदनशील समापन बिंदुओं पर रीप्ले सुरक्षा सक्षम करें।

रीप्ले सुरक्षा का उपयोग करने के लिए, निम्नलिखित कार्य करें:

  1. क्लाउड कंसोल में, टोकन सत्यापित करने के लिए उपयोग किए जाने वाले सेवा खाते को "फ़ायरबेस ऐप चेक टोकन सत्यापनकर्ता" भूमिका प्रदान करें।

    • यदि आपने फायरबेस कंसोल से डाउनलोड किए गए एडमिन एसडीके सेवा खाता क्रेडेंशियल के साथ एडमिन एसडीके को आरंभ किया है, तो आवश्यक भूमिका पहले ही दी गई है।
    • यदि आप डिफ़ॉल्ट एडमिन एसडीके कॉन्फ़िगरेशन के साथ पहली पीढ़ी के क्लाउड फ़ंक्शंस का उपयोग कर रहे हैं, तो ऐप इंजन डिफ़ॉल्ट सेवा खाते को भूमिका प्रदान करें। सेवा खाता अनुमतियाँ बदलना देखें.
    • यदि आप डिफ़ॉल्ट एडमिन एसडीके कॉन्फ़िगरेशन के साथ दूसरी पीढ़ी के क्लाउड फ़ंक्शंस का उपयोग कर रहे हैं, तो डिफ़ॉल्ट कंप्यूट सेवा खाते को भूमिका प्रदान करें।
  2. फिर, एक टोकन का उपभोग करने के लिए, verifyToken() विधि को { consume: true } करें और परिणाम ऑब्जेक्ट की जांच करें; यदि alreadyConsumed संपत्ति true है, तो अनुरोध को अस्वीकार कर दें या किसी प्रकार की सुधारात्मक कार्रवाई करें, जैसे कि कॉल करने वाले को अन्य जांच पास करने की आवश्यकता होगी।

    उदाहरण के लिए:

    const appCheckClaims = await getAppCheck().verifyToken(appCheckToken, { consume: true });
    
    if (appCheckClaims.alreadyConsumed) {
        res.status(401);
        return next('Unauthorized');
    }
    
    // If verifyToken() succeeds and alreadyConsumed is not set, okay to continue.
    

    यह टोकन को सत्यापित करता है और फिर इसे उपभोग के रूप में चिह्नित करता है। उसी टोकन पर verifyToken(appCheckToken, { consume: true }) के भविष्य के आह्वान alreadyConsumed true पर सेट हो जाएंगे। (ध्यान दें कि verifyToken() उपभोग किए गए टोकन को अस्वीकार नहीं करता है या यह भी जांच नहीं करता है कि consume सेट नहीं होने पर इसका उपभोग किया गया है या नहीं।)

जब आप किसी विशेष समापन बिंदु के लिए इस सुविधा को सक्षम करते हैं, तो आपको समापन बिंदु के साथ उपयोग के लिए उपभोज्य सीमित-उपयोग टोकन प्राप्त करने के लिए अपने ऐप क्लाइंट कोड को भी अपडेट करना होगा। Apple प्लेटफ़ॉर्म , Android और वेब के लिए क्लाइंट-साइड दस्तावेज़ देखें।