بررسی برنامه را با ارائه دهنده سفارشی در برنامه های وب فعال کنید

این صفحه به شما نشان می‌دهد چگونه با استفاده از ارائه‌دهنده بررسی برنامه سفارشی خود ، بررسی برنامه را در یک برنامه وب فعال کنید. وقتی برنامه بررسی را فعال می‌کنید، مطمئن می‌شوید که فقط برنامه شما می‌تواند به منابع Firebase پروژه شما دسترسی داشته باشد.

اگر می‌خواهید از App Check با یکی از ارائه‌دهندگان داخلی استفاده کنید، به اسناد مربوط به App Check with reCAPTCHA v3 و App Check با reCAPTCHA Enterprise مراجعه کنید.

قبل از اینکه شروع کنی

1. کتابخانه App Check را به برنامه خود اضافه کنید

اگر قبلاً این کار را نکرده اید، Firebase را به برنامه وب خود اضافه کنید . حتماً کتابخانه App Check را وارد کنید.

2. شیء ارائه دهنده App Check را ایجاد کنید

یک شیء ارائه دهنده App Check برای ارائه دهنده سفارشی خود ایجاد کنید. این شی باید دارای یک getToken() باشد، که هر اطلاعاتی را که ارائه‌دهنده App Check سفارشی شما به عنوان اثبات صحت نیاز دارد، جمع‌آوری می‌کند و آن را در ازای توکن App Check به سرویس جذب توکن می‌فرستد. App Check SDK ذخیره رمز را کنترل می کند، بنابراین همیشه یک توکن جدید در پیاده سازی getToken() خود دریافت کنید.

Web version 9

const { CustomProvider } = require("firebase/app-check");

const appCheckCustomProvider = new CustomProvider({
  getToken: () => {
    return new Promise((resolve, _reject) => {
      // TODO: Logic to exchange proof of authenticity for an App Check token and
      // expiration time.

      // ...

      const appCheckToken = {
        token: tokenFromServer,
        expireTimeMillis: expirationFromServer * 1000
      };

      resolve(appCheckToken);
    });
  }
});

Web version 8

const appCheckCustomProvider = {
  getToken: () => {
    return new Promise((resolve, _reject) => {
      // TODO: Logic to exchange proof of authenticity for an App Check token and
      // expiration time.

      // ...

      const appCheckToken = {
        token: tokenFromServer,
        expireTimeMillis: expirationFromServer * 1000
      };

      resolve(appCheckToken);
    });
  }
};

3. App Check را اولیه کنید

قبل از دسترسی به خدمات Firebase، کد اولیه زیر را به برنامه خود اضافه کنید:

Web version 9

const { initializeApp } = require("firebase/app");
const { initializeAppCheck } = require("firebase/app-check");

const app = initializeApp({
  // Your firebase configuration object
});

const appCheck = initializeAppCheck(app, {
  provider: appCheckCustomProvider,

  // Optional argument. If true, the SDK automatically refreshes App Check
  // tokens as needed.
  isTokenAutoRefreshEnabled: true    
});

Web version 8

firebase.initializeApp({
  // Your firebase configuration object
});

const appCheck = firebase.appCheck();
appCheck.activate(
  appCheckCustomProvider,

  // Optional argument. If true, the SDK automatically refreshes App Check
  // tokens as needed.
  true);

هنگامی که کتابخانه App Check در برنامه شما نصب شد، آن را مستقر کنید.

برنامه کلاینت به‌روزرسانی‌شده، به همراه هر درخواستی که به Firebase می‌کند، نشانه‌های App Check را ارسال می‌کند، اما محصولات Firebase تا زمانی که اعمال را در بخش App Check کنسول Firebase فعال نکنید، نیازی به معتبر بودن توکن‌ها ندارند. برای جزئیات بیشتر به دو بخش بعدی مراجعه کنید.

4. معیارهای درخواست را رصد کنید

اکنون که برنامه به‌روزرسانی شده شما در دست کاربران است، می‌توانید اجرای App Check را برای محصولات Firebase که استفاده می‌کنید فعال کنید. با این حال، قبل از انجام این کار، باید مطمئن شوید که انجام این کار باعث اختلال در کاربران قانونی فعلی شما نمی شود.

پایگاه داده بیدرنگ، Cloud Firestore و Cloud Storage

ابزار مهمی که می‌توانید برای اتخاذ این تصمیم برای پایگاه داده بیدرنگ، Cloud Firestore و Cloud Storage استفاده کنید، صفحه معیارهای درخواست بررسی برنامه است.

برای مشاهده معیارهای درخواست بررسی برنامه برای یک محصول، بخش بررسی برنامه کنسول Firebase را باز کنید. مثلا:

نماگرفت صفحه معیارهای بررسی برنامه

معیارهای درخواست برای هر محصول به چهار دسته تقسیم می شوند:

  • درخواست‌های تایید شده آنهایی هستند که دارای نشانه معتبر App Check هستند. پس از فعال کردن اجرای بررسی برنامه، فقط درخواست‌های این دسته موفق خواهند شد.

  • درخواست‌های مشتری منسوخ شده آنهایی هستند که کد App Check را ندارند. این درخواست‌ها ممکن است از یک نسخه قدیمی‌تر Firebase SDK قبل از گنجاندن App Check در برنامه باشد.

  • درخواست‌های مبدأ ناشناخته آن‌هایی هستند که کد App Check را ندارند و به نظر نمی‌رسد از Firebase SDK آمده باشند. اینها ممکن است از درخواست‌هایی باشد که با کلیدهای API به سرقت رفته یا درخواست‌های جعلی که بدون Firebase SDK انجام شده‌اند.

  • درخواست‌های نامعتبر درخواست‌هایی هستند که دارای یک رمز برنامه بررسی نامعتبر هستند، که ممکن است از یک کلاینت غیر معتبر باشد که سعی در جعل هویت برنامه شما دارد، یا از محیط‌های شبیه‌سازی شده.

توزیع این دسته‌ها برای برنامه شما باید زمانی را که تصمیم به فعال کردن اعمال می‌کنید به شما اطلاع دهد. در اینجا چند دستورالعمل وجود دارد:

  • اگر تقریباً تمام درخواست‌های اخیر از مشتریان تأیید شده است، برای شروع محافظت از منابع باطن خود، اجرای را فعال کنید.

  • اگر بخش قابل‌توجهی از درخواست‌های اخیر از کلاینت‌هایی هستند که احتمالاً قدیمی هستند، برای جلوگیری از ایجاد مزاحمت در کاربران، قبل از فعال کردن اعمال، منتظر بمانید تا کاربران بیشتری برنامه شما را به‌روزرسانی کنند. اجرای بررسی برنامه در یک برنامه منتشر شده، نسخه های قبلی برنامه را که با SDK بررسی برنامه ادغام نشده اند، خراب می کند.

  • اگر برنامه شما هنوز راه اندازی نشده است، باید فوراً اجرای بررسی برنامه را فعال کنید، زیرا هیچ کلاینت قدیمی در حال استفاده نیست.

توابع ابری

برای توابع Cloud، می‌توانید با بررسی گزارش‌های عملکردهای خود، معیارهای App Check را دریافت کنید. هر فراخوانی یک تابع قابل فراخوانی یک ورودی گزارش ساختار یافته مانند مثال زیر منتشر می کند:

{
  "severity": "INFO",    // INFO, WARNING, or ERROR
  "logging.googleapis.com/labels": {"firebase-log-type": "callable-request-verification"},
  "jsonPayload": {
    "message": "Callable header verifications passed.",
    "verifications": {
      // ...
      "app": "MISSING",  // VALID, INVALID, or MISSING
    }
  }
}

می‌توانید این معیارها را در Google Cloud Console با ایجاد یک سنجه شمارنده مبتنی بر گزارش‌ها با فیلتر متریک زیر تجزیه و تحلیل کنید:

resource.type="cloud_function"
resource.labels.function_name="YOUR_CLOUD_FUNCTION"
resource.labels.region="us-central1"
labels.firebase-log-type="callable-request-verification"

با استفاده از فیلد jsonPayload.verifications.appCheck ، متریک را برچسب گذاری کنید.

5. اجرا را فعال کنید

برای فعال کردن اعمال، دستورالعمل‌های مربوط به هر محصول را در زیر دنبال کنید. هنگامی که اجرای یک محصول را فعال کنید، همه درخواست‌های تأیید نشده برای آن محصول رد می‌شوند.

پایگاه داده بیدرنگ، Cloud Firestore و Cloud Storage

برای فعال کردن اعمال برای پایگاه داده Realtime، Cloud Firestore (iOS و Android) و Cloud Storage:

  1. بخش App Check را در کنسول Firebase باز کنید.

  2. نمای معیارهای محصولی را که می‌خواهید اجرای آن را فعال کنید، گسترش دهید.

  3. روی Enforce کلیک کنید و انتخاب خود را تایید کنید.

توجه داشته باشید که تا 15 دقیقه پس از فعال کردن اجرای اعمال می‌تواند طول بکشد.

توابع ابری

به فعال کردن اجرای بررسی برنامه برای عملکردهای ابری مراجعه کنید.