Check out what’s new from Firebase at Google I/O 2022. Learn more

אפשר App Check עם reCAPTCHA v3 באפליקציות אינטרנט

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

reCAPTCHA v3 הוא שירות ללא עלות. App Check תומך גם ב- reCAPTCHA Enterprise , שירות בתשלום עם מכסה ללא עלות. כדי ללמוד את ההבדלים בין reCAPTCHA v3 ל-reCAPTCHA Enterprise, עיין בהשוואת התכונות .

שימו לב ש-reCAPTCHA v3 אינו נראה למשתמשים. ספק reCAPTCHA v3 לא ידרוש מהמשתמשים לפתור אתגר בכל עת. עיין בתיעוד reCAPTCHA v3 .

אם ברצונך להשתמש ב-App Check עם ספק מותאם אישית משלך, ראה יישום ספק App Check מותאם אישית .

1. הגדר את פרויקט Firebase שלך

  1. הוסף את Firebase לפרויקט ה-JavaScript שלך אם עדיין לא עשית זאת.

  2. רשום את האתר שלך ל-reCAPTCHA v3 וקבל את מפתח האתר והמפתח הסודי של reCAPTCHA v3.

  3. רשום את האפליקציות שלך כדי להשתמש ב-App Check עם ספק reCAPTCHA בקטע App Check של מסוף Firebase. תצטרך לספק את המפתח הסודי שקיבלת בשלב הקודם.

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

  4. אופציונלי : בהגדרות רישום האפליקציה, הגדר זמן מותאם אישית עד לחיות (TTL) עבור אסימוני App Check שהונפקו על ידי הספק. אתה יכול להגדיר את ה-TTL לכל ערך בין 30 דקות ל-7 ימים. בעת שינוי ערך זה, שים לב להפרעות הבאות:

    • אבטחה: TTLs קצרים יותר מספקים אבטחה חזקה יותר, מכיוון שהיא מצמצמת את החלון שבו אסימון שדלף או יורט יכול להיות מנוצל לרעה על ידי תוקף.
    • ביצועים: TTL קצר יותר אומר שהאפליקציה שלך תבצע אישור בתדירות גבוהה יותר. מכיוון שתהליך אישור האפליקציה מוסיף זמן אחזור לבקשות הרשת בכל פעם שהוא מבוצע, TTL קצר יכול להשפיע על ביצועי האפליקציה שלך.
    • מכסה ועלות: TTL קצרים יותר ואישור חוזר תכוף מוציאים את המכסה שלך מהר יותר, ועבור שירותים בתשלום, פוטנציאל לעלות יותר. ראה מכסות ומגבלות .

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

2. הוסף את ספריית App Check לאפליקציה שלך

הוסף את Firebase לאפליקציית האינטרנט שלך אם עדיין לא עשית זאת. הקפד לייבא את ספריית App Check.

3. אתחול App Check

הוסף את קוד האתחול הבא לאפליקציה שלך, לפני שאתה ניגש לשירותי Firebase כלשהם. תצטרך להעביר את מפתח האתר reCAPTCHA שלך, שיצרת במסוף reCAPTCHA, כדי activate() .

Web version 9

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

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

// Pass your reCAPTCHA v3 site key (public key) to activate(). Make sure this
// key is the counterpart to the secret key you set in the Firebase console.
const appCheck = initializeAppCheck(app, {
  provider: new ReCaptchaV3Provider('abcdefghijklmnopqrstuvwxy-1234567890abcd'),

  // 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();
// Pass your reCAPTCHA v3 site key (public key) to activate(). Make sure this
// key is the counterpart to the secret key you set in the Firebase console.
appCheck.activate(
  'abcdefghijklmnopqrstuvwxy-1234567890abcd',

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

לאחר שספריית App Check מותקנת באפליקציה שלך, פרוס אותה.

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

4. עקוב אחר מדדי בקשות

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

מסד נתונים בזמן אמת, Cloud Firestore ואחסון בענן

כלי חשוב שאתה יכול להשתמש בו כדי לקבל החלטה זו עבור מסד נתונים בזמן אמת, Cloud Firestore ו-Cloud Storage הוא מסך מדדי הבקשה של App Check.

כדי להציג את מדדי בקשת בדיקת האפליקציה עבור מוצר, פתח את הקטע בדיקת אפליקציות במסוף Firebase. לדוגמה:

צילום מסך של דף מדדי בדיקת האפליקציה

מדדי הבקשות עבור כל מוצר מחולקים לארבע קטגוריות:

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

  • בקשות לקוח מיושנות הן אלו שחסר בהן אסימון App Check. בקשות אלה עשויות להיות מגרסה ישנה יותר של Firebase SDK לפני בדיקת האפליקציה נכללה באפליקציה.

  • בקשות מקור לא ידועות הן אלו שחסר להן אסימון App Check, ולא נראה שהן מגיעות מה-SDK של Firebase. אלה עשויים להיות מבקשות שנעשו עם מפתחות API גנובים או בקשות מזויפות שנעשו ללא Firebase SDK.

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

ההפצה של קטגוריות אלו עבור האפליקציה שלך צריכה להודיע ​​​​כאשר תחליט לאפשר אכיפה. הנה כמה קווים מנחים:

  • אם כמעט כל הבקשות האחרונות הן מלקוחות מאומתים, שקול לאפשר אכיפה כדי להתחיל להגן על משאבי הקצה האחורי שלך.

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

  • אם האפליקציה שלך עדיין לא הושקה, עליך להפעיל מיד את אכיפת בדיקת האפליקציה, מכיוון שאין לקוחות מיושנים בשימוש.

פונקציות ענן

עבור פונקציות ענן, אתה יכול לקבל מדדי בדיקת אפליקציות על ידי בחינת יומני הפונקציות שלך. כל הפעלת פונקציה הניתנת להתקשרות פולטת ערך יומן מובנה כמו הדוגמה הבאה:

{
  "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 Firestore (iOS ו-Android) ואחסון בענן:

  1. פתח את הקטע App Check של מסוף Firebase.

  2. הרחב את תצוגת המדדים של המוצר שעבורו ברצונך להפעיל אכיפה.

  3. לחץ על אכוף ואשר את בחירתך.

שים לב שיחלפו עד 15 דקות לאחר הפעלת האכיפה עד שהוא ייכנס לתוקף.

פונקציות ענן

ראה הפעלת אכיפה של בדיקת אפליקציות עבור פונקציות ענן .

הצעדים הבאים

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

ראה שימוש בבדיקת אפליקציות עם ספק ניפוי הבאגים באפליקציות אינטרנט .