किसी कस्टम बैकएंड से, ऐप्लिकेशन की जांच वाले टोकन की पुष्टि करें

App Check का इस्तेमाल करके, अपने ऐप्लिकेशन के लिए Google से बाहर के कस्टम बैकएंड संसाधनों को सुरक्षित रखा जा सकता है. जैसे, खुद होस्ट किया गया बैकएंड. ऐसा करने के लिए, आपको ये दोनों काम करने होंगे:

  • अपने ऐप्लिकेशन क्लाइंट में बदलाव करें, ताकि आपके बैकएंड को भेजे जाने वाले हर अनुरोध के साथ App Check टोकन भेजा जा सके. इसके बारे में iOS+, Android, वेब, Flutter, Unity या C++ के पेजों पर बताया गया है.
  • अपने बैकएंड में बदलाव करें, ताकि हर अनुरोध के साथ एक मान्य App Check टोकन की ज़रूरत पड़े. इस बारे में इस पेज पर बताया गया है.

टोकन की पुष्टि करना

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

  • देखें कि हर अनुरोध में App Check टोकन शामिल हो.

  • Admin SDK का इस्तेमाल करके, App Check टोकन की पुष्टि करें.

    अगर पुष्टि हो जाती है, तो Admin SDK, डिकोड किया गया App Check टोकन दिखाता है. पुष्टि होने का मतलब है कि टोकन, आपके Firebase प्रोजेक्ट से जुड़े किसी ऐप्लिकेशन से जनरेट हुआ है.

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

Node.js

अगर आपने अब तक Node.js Admin 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

अगर आपने अब तक Python Admin 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.
    ...

जाएं

अगर आपने अब तक Go के लिए Admin SDK इंस्टॉल नहीं किया है, तो इसे इंस्टॉल करें.

इसके बाद, अपने एपीआई एंडपॉइंट हैंडलर में, 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.
}

Java

अगर आपने अब तक Java के लिए Admin SDK (वर्शन 9.12.0 या इसके बाद का वर्शन) इंस्टॉल नहीं किया है, तो इसे इंस्टॉल करें.

इसके बाद, अपने एपीआई एंडपॉइंट हैंडलर या अनुरोध फ़िल्टर में, FirebaseAppCheck.getInstance().verifyToken() (या verifyTokenAsync()) को कॉल करें. अगर अनुरोध पूरा नहीं होता है, तो उसे अस्वीकार कर दें. यहां दिए गए उदाहरण में, Spring Boot फ़िल्टर का इस्तेमाल करके, आने वाले अनुरोधों के लिए टोकन की पुष्टि की गई है:

import com.google.firebase.FirebaseApp;
import com.google.firebase.appcheck.FirebaseAppCheck;
import com.google.firebase.appcheck.FirebaseAppCheckException;
import com.google.firebase.appcheck.VerifyAppCheckTokenResponse;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.filter.OncePerRequestFilter;

@SpringBootApplication
@RestController
public class Application {

    public static void main(String[] args) {
        FirebaseApp.initializeApp();
        SpringApplication.run(Application.class, args);
    }

    @GetMapping("/yourApiEndpoint")
    public String yourApiEndpoint() {
        // Handle request.
        return "Success";
    }

    @Component
    public static class AppCheckFilter extends OncePerRequestFilter {
        @Override
        protected void doFilterInternal(
                HttpServletRequest request,
                HttpServletResponse response,
                FilterChain filterChain) throws ServletException, IOException {
            String appCheckToken = request.getHeader("X-Firebase-AppCheck");
            if (appCheckToken == null || appCheckToken.isEmpty()) {
                response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Unauthorized");
                return;
            }

            try {
                VerifyAppCheckTokenResponse appCheckResponse =
                    FirebaseAppCheck.getInstance().verifyToken(appCheckToken);
                // If verifyToken() succeeds, continue with the filter chain.
                filterChain.doFilter(request, response);
            } catch (FirebaseAppCheckException e) {
                response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Unauthorized");
            }
        }
    }
}

अन्य

अगर आपका बैकएंड किसी दूसरी भाषा में लिखा गया है, तो App Check टोकन की पुष्टि करने के लिए, अलग-अलग कामों के लिए इस्तेमाल की जाने वाली JWT लाइब्रेरी का इस्तेमाल किया जा सकता है. जैसे, jwt.io पर मौजूद लाइब्रेरी.

टोकन की पुष्टि करने के लॉजिक को ये चरण पूरे करने होंगे:

  1. App Check के JWKS एंडपॉइंट से, Firebase App Check का सार्वजनिक JSON वेब पासकोड (JWK) सेट पाएं: https://firebaseappcheck.googleapis.com/v1/jwks
  2. App Check टोकन के सिग्नेचर की पुष्टि करें, ताकि यह पक्का किया जा सके कि वह मान्य है.
  3. पक्का करें कि टोकन का हेडर, RS256 एल्गोरिदम का इस्तेमाल करता हो.
  4. पक्का करें कि टोकन के हेडर का टाइप JWT हो.
  5. पक्का करें कि टोकन, आपके प्रोजेक्ट के तहत Firebase App Check से जारी किया गया हो.
  6. पक्का करें कि टोकन की समयसीमा खत्म न हुई हो.
  7. पक्का करें कि टोकन की ऑडियंस आपके प्रोजेक्ट से मैच करती हो.
  8. ज़रूरी नहीं: देखें कि टोकन का सब्जेक्ट, आपके ऐप्लिकेशन के ऐप्लिकेशन आईडी से मैच करता हो.

JWT लाइब्रेरी की क्षमताएं अलग-अलग हो सकती हैं. इसलिए, पक्का करें कि आपने जो लाइब्रेरी चुनी है उससे जो चरण पूरे नहीं हुए हैं उन्हें मैन्युअल तरीके से पूरा करें.

यहां दिए गए उदाहरण में, रैक मिडलवेयर लेयर के तौर पर jwt जेम का इस्तेमाल करके, Ruby में ज़रूरी चरणों को पूरा करने का तरीका बताया गया है.

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

रीप्ले प्रोटेक्शन (बीटा वर्शन)

किसी एंडपॉइंट को रीप्ले अटैक से बचाने के लिए, App Check टोकन की पुष्टि करने के बाद उसका इस्तेमाल किया जा सकता है, ताकि उसे सिर्फ़ एक बार इस्तेमाल किया जा सके.

रीप्ले प्रोटेक्शन का इस्तेमाल करने से, टोकन की पुष्टि करने वाले कॉल में नेटवर्क राउंड ट्रिप जुड़ जाती है. इस वजह से, इसका इस्तेमाल करने वाले किसी भी एंडपॉइंट पर इंतज़ार का समय बढ़ जाता है. इसलिए, हमारा सुझाव है कि आप रीप्ले प्रोटेक्शन की सुविधा को सिर्फ़ संवेदनशील एंडपॉइंट पर चालू करें.

रीप्ले प्रोटेक्शन का इस्तेमाल करने के लिए, यह तरीका अपनाएं:

  1. Cloud Console में, टोकन की पुष्टि करने के लिए इस्तेमाल किए जाने वाले सेवा खाते को "Firebase App Check टोकन की पुष्टि करने वाला" भूमिका दें.

    • अगर आपने Firebase कंसोल से डाउनलोड किए गए Admin SDK सेवा खाते के क्रेडेंशियल की मदद से Admin SDK को शुरू किया है, तो ज़रूरी भूमिका पहले ही दी जा चुकी है.
    • अगर डिफ़ॉल्ट Admin SDK कॉन्फ़िगरेशन के साथ पहली जनरेशन के Cloud Functions का इस्तेमाल किया जा रहा है, तो App Engine के डिफ़ॉल्ट सेवा खाते को यह भूमिका दें. सेवा खाते की अनुमतियां बदलना देखें.
    • अगर डिफ़ॉल्ट Admin SDK कॉन्फ़िगरेशन के साथ दूसरी जनरेशन के Cloud Functions का इस्तेमाल किया जा रहा है, तो डिफ़ॉल्ट कंप्यूट सेवा खाते को यह भूमिका दें.
  2. टोकन का इस्तेमाल करने के लिए, टोकन की पुष्टि करने वाले कॉल में { consume: true } (Node.js), consume=True (Python) या VerifyAppCheckTokenOptions के साथ setConsume(true) (Java) पास करें या VerifyOneTimeToken() (Go) को कॉल करें. इसके बाद, नतीजे वाले ऑब्जेक्ट की जांच करें. अगर टोकन का इस्तेमाल पहले ही किया जा चुका है, तो अनुरोध को अस्वीकार करें या सुधार करने के लिए कार्रवाई करें. जैसे, कॉलर को अन्य जांच पास करने के लिए कहें:

    Node.js

    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 पर सेट कर दिया जाता है. (ध्यान दें कि अगर consume सेट नहीं है, तो verifyToken() इस्तेमाल किए गए टोकन को अस्वीकार नहीं करता है. इसके अलावा, यह भी नहीं देखता कि टोकन का इस्तेमाल किया गया है या नहीं.)

    Python

    app_check_claims = app_check.verify_token(app_check_token, consume=True)
    
    if app_check_claims.get("already_consumed"):
        return "App Check token already consumed", 401
    
    # If verify_token() succeeds and already_consumed is not set, okay to continue.
    

    इससे टोकन की पुष्टि होती है. इसके बाद, इसे इस्तेमाल किए गए टोकन के तौर पर फ़्लैग किया जाता है. एक ही टोकन सेट already_consumed पर app_check.verify_token(app_check_token, consume=True) को आगे कॉल करने पर, True दिखेगा. (ध्यान दें कि app_check.verify_token(), इस्तेमाल किए गए टोकन को अस्वीकार नहीं करता है. इसके अलावा, अगर consume सेट नहीं है, तो यह भी नहीं देखता कि टोकन का इस्तेमाल किया गया है या नहीं.)

    जाएं

    decodedToken, err := appCheck.VerifyOneTimeToken(r.Context(), appCheckToken[0])
    if err != nil || (decodedToken.AlreadyConsumed != nil && *decodedToken.AlreadyConsumed) {
        w.WriteHeader(http.StatusUnauthorized)
        w.Write([]byte("Unauthorized."))
        return
    }
    
    // If VerifyOneTimeToken() succeeds and AlreadyConsumed is not true, okay to
    // continue with the provided handler.
    

    इससे टोकन की पुष्टि होती है. इसके बाद, इसे इस्तेमाल किए गए टोकन के तौर पर फ़्लैग किया जाता है. आने वाले समय में, टोकन के उसी सेट पर appCheck.VerifyOneTimeToken() को कॉल करने पर, AlreadyConsumed से true पर सेट हो जाएगा. (ध्यान दें कि appCheck.VerifyToken(), इस्तेमाल किए गए टोकन को अस्वीकार नहीं करता है या यह भी नहीं देखता कि उसका इस्तेमाल किया गया है या नहीं.)

    Java

    VerifyAppCheckTokenOptions options = VerifyAppCheckTokenOptions.builder()
        .setConsume(true)
        .build();
    VerifyAppCheckTokenResponse appCheckResponse =
        FirebaseAppCheck.getInstance().verifyToken(appCheckToken, options);
    
    if (appCheckResponse.isAlreadyConsumed().orElse(false)) {
        response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Unauthorized");
        return;
    }
    
    // If verifyToken() succeeds and isAlreadyConsumed() is not true, continue
    // with the filter chain.
    

    इससे टोकन की पुष्टि होती है. इसके बाद, इसे इस्तेमाल किए गए टोकन के तौर पर फ़्लैग किया जाता है. एक ही टोकन पर setConsume(true) के साथ verifyToken(appCheckToken, options) को आने वाले समय में शुरू करने पर, isAlreadyConsumed() से Optional.of(true) मिलता है. (ध्यान दें कि verifyToken(), इस्तेमाल किए गए टोकन को अस्वीकार नहीं करता. इसके अलावा, अगर setConsume(true) सेट नहीं है, तो यह भी नहीं देखता कि टोकन का इस्तेमाल किया गया है या नहीं.)

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