إعداد الوصول المناسب لإحدى الإضافات

لكي تنفّذ الإضافة إجراءاتها المحدّدة، تمنح Firebase كل نسخة من الإضافة المثبّتة إذن وصول محدودًا إلى المشروع وبياناته من خلال حساب خدمة.

ما هو حساب الخدمة؟

حساب الخدمة هو نوع خاص من حسابات مستخدمي Google. وهو يمثّل مستخدمًا غير بشري يمكنه إجراء طلبات بيانات من واجهة برمجة التطبيقات (API) لخدمات Google.

أثناء تثبيت الإضافة، تنشئ Firebase حساب خدمة للإضافة في المشروع. لكل نسخة مثبّتة من الإضافة حساب خدمة خاص بها. في حال إلغاء تثبيت نسخة من الإضافة، تحذف منصة Firebase حساب الخدمة الخاص بالإضافة.

تكون حسابات الخدمة التي يتم إنشاؤها للإضافات بالتنسيق التالي:

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

يحدّ Firebase من وصول الإضافة إلى المشروع وبياناته من خلال تعيين أدوار محدّدة (حِزم من الأذونات) لحساب الخدمة الخاص بالإضافة. عند إنشاء إضافة، عليك تحديد الأدوار التي تتطلّبها الإضافة لتعمل، ثم إدراج هذه الأدوار وسبب احتياج الإضافة إليها في ملف extension.yaml (يُرجى الاطّلاع على المثال في أسفل هذه الصفحة).

تحديد الأدوار التي تتطلّبها الإضافة

عند إنشاء الإضافة، يمكنك تحديد مستوى الوصول الذي تتطلّبه الإضافة لتعمل.

During installation, the Firebase CLI prompts for the user to accept the access level granted by each role. إذا طلبت الإضافة أدوارًا أكثر مما تحتاجه فعليًا، فقد يقل احتمال تثبيت المستخدمين لها.

  1. حدِّد ما إذا كانت الإضافة تتفاعل مع منتج:

    • إذا كانت الإضافة تتفاعل مع منتج، عليك منحها إذن الوصول إلى ذلك المنتج.

      على سبيل المثال، إذا كانت الإضافة تكتب البيانات في مثيل Realtime Database، ستحتاج الإضافة إلى دور Realtime Database (على وجه التحديد، firebasedatabase.admin).

    • إذا كانت الإضافة تستمع فقط إلى حدث تشغيل من منتج، فإن الإضافة لا تحتاج إلى دور مرتبط بهذا المنتج.

      على سبيل المثال، إذا كانت الإضافة يتم تفعيلها عند الكتابة في مثيل Realtime Database (ولكنّها لا تكتب أي شيء في قاعدة البيانات)، لا تحتاج الإضافة إلى دور Realtime Database.

  2. بعد تحديد المنتجات التي تتفاعل معها الإضافة، عليك تحديد الدور المطلوب لهذا التفاعل المحدّد. توفّر بعض المنتجات أدوارًا مختلفة حسب الإجراء أو مجموعة الإجراءات التي يتم تنفيذها.

    على سبيل المثال، لنفترض أنّ إضافتك تتفاعل مع حزمة Cloud Storage. يسمح دور storage.objectCreator للإضافة بإنشاء عنصر في حزمة Cloud Storage، ولكنّه لا يسمح لها بعرض العناصر أو حذفها أو استبدالها. لتفعيل الإضافة من أجل تنفيذ هذه الإجراءات الإضافية، عليك منح دور storage.objectAdmin بدلاً من ذلك.

يمكنك الرجوع إلى القسم في أسفل هذه الصفحة للاطّلاع على جميع الأدوار المتاحة التي يمكنك منحها لحساب الخدمة الخاص بإضافتك. للاطّلاع على وصف كل دور والأذونات الممنوحة له، يُرجى الانتقال إلى مستندات Firebase أو مستندات Google Cloud. يمكنك أيضًا البحث عن الأدوار في لوحة "المشرف وإدارة الهوية وإمكانية الوصول " في وحدة تحكّم Google Cloud.

كيفية إسناد الأدوار إلى إضافة

أدرِج أدوار "إدارة الهوية وإمكانية الوصول" المطلوبة لكي تعمل الإضافة في قسم roles من ملف extension.yaml.

في ما يلي مثال على إضافة تستمع إلى مسار 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
(مطلوب)
سلسلة اسم دور إدارة الهوية وإمكانية الوصول الذي تحتاجه الإضافة لتعمل
reason
(مطلوب)
سلسلة

وصف موجز لسبب حاجة الإضافة إلى الوصول الذي يمنحه الدور

يُرجى التأكّد من تقديم تفاصيل كافية ليفهم المستخدم كيفية استخدام الإضافة للدور.

resource
(اختياري)
سلسلة

سياسة "إدارة الهوية وإمكانية الوصول" للمورد الذي يجب إضافة هذا الدور إليه في حال عدم إدخال قيمة، يتم استخدام 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}).

الأدوار المتوافقة مع الإضافات

يسرد الجدول التالي أدوار "إدارة الهوية وإمكانية الوصول" المتوافقة للتفاعل مع منتجات 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
Cloud Asset cloudasset.owner
cloudasset.viewer
Cloud Data Fusion datafusion.admin
datafusion.viewer
برنامج تصحيح الأخطاء في السحابة الإلكترونية clouddebugger.agent
clouddebugger.user
وظائف السحابة الإلكترونية 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
منع فقدان البيانات من Cloud 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
دفاتر ملاحظات الذكاء الاصطناعي 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