איך להגדיר גישה מתאימה לתוסף

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

מה זה חשבון שירות?

חשבון שירות הוא סוג מיוחד של חשבון משתמש ב-Google. הוא מייצג משתמש שאינו אנושי, שיכול לבצע קריאות מורשות ל-API לשירותי Google.

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

חשבונות שירות שנוצרו עבור תוספים הם בפורמט:

ext-extension-instance-id@project-id.iam.gserviceaccount.com

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

איך קובעים אילו תפקידים נדרשים לתוסף

כשאתם יוצרים את התוסף, אתם קובעים את רמת הגישה שהתוסף צריך כדי לפעול.

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

  1. בודקים אם התוסף יוצר אינטראקציה עם מוצר:

    • אם התוסף מקיים אינטראקציה עם מוצר, צריך לתת לתוסף גישה למוצר הזה.

      לדוגמה, אם התוסף כותב נתונים למכונה של Realtime Database, התוסף צריך תפקיד של Realtime Database (באופן ספציפי, firebasedatabase.admin).

    • אם התוסף רק מאזין לאירוע טריגר ממוצר, התוסף לא צריך תפקיד שמשויך למוצר הזה.

      לדוגמה, אם התוסף מופעל כשמתבצעת כתיבה למכונה של Realtime Database (אבל לא כותב שום דבר במסד הנתונים), התוסף לא צריך תפקיד ב-Realtime Database.

  2. אחרי שקובעים עם אילו מוצרים התוסף מקיים אינטראקציה, צריך להחליט איזה תפקיד נדרש לאינטראקציה הספציפית הזו. במוצרים מסוימים יש תפקידים שונים בהתאם לפעולה או לקבוצת הפעולות שמבוצעות.

    לדוגמה, נניח שהתוסף שלכם יוצר אינטראקציה עם קטגוריה ב-Cloud Storage. התפקיד storage.objectCreator יאפשר לתוסף ליצור אובייקט בקטגוריה של Cloud Storage, אבל לא יאפשר לו להציג, למחוק או להחליף אובייקטים. כדי לאפשר לתוסף לבצע את הפעולות הנוספות האלה, צריך להקצות במקום זאת את התפקיד storage.objectAdmin.

בקטע שבתחתית הדף מפורטים כל התפקידים הנתמכים שאפשר להקצות לחשבון השירות של התוסף. כדי לקבל מידע על התיאור וההרשאות של כל תפקיד, אפשר לעיין במסמכי התיעוד של Firebase או במסמכי התיעוד של Google Cloud. אפשר גם לחפש תפקידים בחלונית IAM & Admin במסוף Google Cloud.

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

בקטע roles בקובץ extension.yaml, מפרטים את תפקידי ה-IAM שנדרשים כדי שהתוסף יפעל.

דוגמה לתוסף שמאזין לנתיב Firebase Realtime Database שצוין. כשהתוסף מופעל, הוא מעדכן את כתובת האימייל של חשבון המשתמש (אינטראקציה עם Firebase Authentication) ושולח התראה (אינטראקציה עם Firebase Cloud Messaging). שימו לב:

  • למרות שהתוסף מופעל מאירוע Realtime Database, התפקיד firebasedatabase.admin לא מופיע ברשימה (האזנה לא נחשבת לאינטראקציה).
  • מכיוון שהתוסף מקיים אינטראקציה עם Authentication ו-Cloud Messaging, הוא צריך תפקידים כדי לגשת למוצרים האלה (firebaseauth.admin ו-firebasenotifications.admin, בהתאמה).
# extension.yaml
...

# Roles assigned to the extension's service account by Firebase during installation
roles:
  - role: firebaseauth.admin
    reason: Required to update the email address of the user account

  - role: firebasenotifications.admin
    reason: Required to send a notification that the email address has been updated

...

בקובץ extension.yaml, משתמשים בשדות הבאים כדי להקצות תפקיד לחשבון השירות של התוסף:

שדה סוג תיאור
role
(חובה)
מחרוזת שם תפקיד ה-IAM שהתוסף צריך כדי לפעול
reason
(חובה)
מחרוזת

תיאור קצר של הסיבה שבגללה התוסף צריך את הגישה שניתנת על ידי התפקיד

חשוב לספק מספיק פרטים כדי שהמשתמשים יוכלו להבין איך התוסף משתמש בתפקיד.

resource
(אופציונלי)
מחרוזת

לאיזו מדיניות IAM של משאב צריך להוסיף את התפקיד הזה. אם לא מציינים את הפרמטר, ערך ברירת המחדל הוא projects/${project_id}.

הערכים הנתמכים הם projects/* ו-projects/*/buckets/*.

צמצום היקף התפקידים

התוספים צריכים לפעול בהתאם לעיקרון של הרשאות מינימליות ולבקש גישה רק למשאבים שהם צריכים. אפשר להגביל את היקף הגישה של תוסף באמצעות השדה role.resource. לדוגמה, אם התוסף צריך לכתוב אובייקטים בקטגוריה של Cloud Storage, אפשר להשתמש בתפקיד הבא:

roles:
  - role: storage.objectCreator
    reason: Needed in order to write
    resource: projects/${PROJECT_ID}/buckets/${STORAGE_BUCKET}

כך התוסף יכול לגשת רק לקטגוריה שהוא צריך, ולא לקטגוריות אחרות באותו פרויקט.

השדה הזה תומך בפרויקטים (projects/{project_id}) ובקטגוריות אחסון (projects/{project_id}/buckets/{bucket_id}).

תפקידים נתמכים לתוספים

בטבלה הבאה מפורטים תפקידי IAM שנתמכים לאינטראקציה עם מוצרי Firebase. רוב התפקידים בטבלה הזו הם תפקידים ברמת המוצר של Firebase, אבל חלק מהם מנוהלים ישירות על ידי Google Cloud (באופן ספציפי, Cloud Firestore ו-Cloud Storage).

מוצרי Firebase

אם התוסף שלכם יוצר אינטראקציה עם... מקצים את אחד מהתפקידים הבאים…
Cloud Firestore datastore.importExportAdmin
datastore.indexAdmin
datastore.owner
datastore.user
datastore.viewer
Cloud Storage for Firebase storage.admin
storage.objectAdmin
storage.objectCreator
storage.objectViewer
Firebase App Distribution firebaseappdistro.admin
firebaseappdistro.viewer
Firebase Authentication firebaseauth.admin
firebaseauth.viewer
Firebase A/B Testing firebaseabt.admin
firebaseabt.viewer
Firebase Cloud Messaging ‫firebasenotifications.admin
firebasenotifications.viewer
Firebase Crashlytics firebasecrashlytics.admin
firebasecrashlytics.viewer
Firebase Hosting firebasehosting.admin
firebasehosting.viewer
Firebase In-App Messaging firebaseinappmessaging.admin
firebaseinappmessaging.viewer
Firebase ML firebaseml.admin
firebaseml.viewer
Firebase Performance Monitoring firebaseperformance.viewer
firebaseperformance.reader
firebaseperformance.writer
Firebase Realtime Database firebasedatabase.admin
firebasedatabase.viewer
כללי אבטחה firebaserules.viewer
firebaserules.developer
firebaserules.deployer
Google Analytics firebaseanalytics.admin
firebaseanalytics.viewer

מוצרי Google Cloud

מידע נוסף על התפקידים האלה זמין במאמרי העזרה של Google Cloud.

אם התוסף שלכם יוצר אינטראקציה עם... מקצים את אחד מהתפקידים הבאים…
פעולות actions.Admin
actions.Viewer
Apigee apigee.analyticsAgent
apigee.analyticsEditor
apigee.analyticsViewer
apigee.apiCreator
apigee.deployer
apigee.developerAdmin
apigee.readOnlyAdmin
apigee.synchronizerManager
App Engine appengine.appAdmin
appengine.appViewer
appengine.codeViewer
appengine.deployer
appengine.serviceAdmin
AutoML automl.editor
automl.predictor
automl.viewer
BigQuery bigquery.connectionAdmin
bigquery.connectionUser
bigquery.dataEditor
bigquery.dataOwner
bigquery.dataViewer
bigquery.jobUser
bigquery.metadataViewer
bigquery.readSessionUser
bigquery.user
Cloud Bigtable bigtable.reader
bigtable.user
bigtable.viewer
חיוב billing.viewer
צ'אטים ב-Hangouts chat.owner
chat.reader
נכס בענן cloudasset.owner
cloudasset.viewer
Cloud Data Fusion datafusion.admin
datafusion.viewer
כלי לניפוי באגים בענן clouddebugger.agent
clouddebugger.user
Cloud Functions cloudfunctions.invoker
cloudfunctions.viewer
Cloud IAP iap.admin
iap.httpsResourceAccessor
iap.settingsAdmin
iap.tunnelResourceAccessor
Cloud IoT cloudiot.deviceController
cloudiot.editor
cloudiot.provisioner
cloudiot.viewer
Stackdriver Profiler cloudprofiler.agent
cloudprofiler.user
Cloud Scheduler cloudscheduler.admin
cloudscheduler.jobRunner
cloudscheduler.viewer
Cloud Security Scanner cloudsecurityscanner.editor
cloudsecurityscanner.runner
cloudsecurityscanner.viewer
Cloud SQL cloudsql.client
cloudsql.editor
cloudsql.viewer
Cloud Trace cloudtrace.admin
cloudtrace.agent
cloudtrace.user
Dataflow dataflow.developer
dataflow.viewer
dataflow.worker
Dialogflow dialogflow.admin
dialogflow.client
dialogflow.reader
מניעת אובדן נתונים בענן dlp.reader
dlp.user
Error Reporting errorreporting.user
errorreporting.viewer
errorreporting.writer
Eventarc eventarc.publisher
eventarc.eventReceiver
Cloud Filestore file.editor
file.viewer
רישום ביומן logging.configWriter
logging.logWriter
logging.privateLogViewer
logging.viewer
מנוע למידת מכונה ‫ml.developer
ml.jobOwner
ml.modelOwner
ml.modelUser
ml.operationOwner
ml.viewer
מעקב monitoring.editor
monitoring.metricWriter
monitoring.viewer
תיקיות Notebook ב-AI notebooks.admin
notebooks.viewer
Pub/Sub pubsub.editor
pubsub.publisher
pubsub.subscriber
pubsub.viewer
Memorystore Redis ‫redis.editor
redis.viewer
Cloud Run run.invoker
מקור source.reader
source.writer
Cloud Spanner spanner.databaseAdmin
spanner.databaseReader
spanner.databaseUser
spanner.viewer
שימוש בשירות serviceusage.apiKeysMetadataViewer
Cloud Storage Transfer Service storagetransfer.user
storagetransfer.viewer
Cloud Transcoder transcoder.admin
transcoder.viewer
Vertex AI aiplatform.user
אחר identitytoolkit.admin
identitytoolkit.viewer