التحكّم في الوصول باستخدام المطالبات المخصّصة وقواعد الأمان

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

يمكن تحديد أدوار المستخدمين للحالات الشائعة التالية:

  • منح مستخدم امتيازات إدارية للوصول إلى البيانات والموارد
  • تحديد المجموعات المختلفة التي ينتمي إليها المستخدم
  • توفير إمكانية الوصول المتعدّد المستويات:
    • التمييز بين المشتركين الذين يدفعون رسومًا والذين لا يدفعون رسومًا
    • التمييز بين المشرفين والمستخدمين العاديين
    • تطبيقات المعلّمين والطلاب وغير ذلك
  • إضافة معرّف آخر لمستخدم على سبيل المثال، يمكن ربط مستخدم Firebase بمعرّف مستخدم مختلف في نظام آخر.

لنفترض أنّك تريد حظر الوصول إلى عقدة قاعدة البيانات "adminContent". يمكنك إجراء ذلك من خلال البحث في قاعدة البيانات عن قائمة بالمستخدمين المشرفين. ومع ذلك، يمكنك تحقيق الهدف نفسه بشكل أكثر كفاءة باستخدام مطالبة مستخدم مخصصة باسم admin مع قاعدة Realtime Database التالية:

{
  "rules": {
    "adminContent": {
      ".read": "auth.token.admin === true",
      ".write": "auth.token.admin === true",
    }
  }
}

يمكن الوصول إلى مطالبات المستخدمين المخصّصة من خلال الرموز المميّزة لمصادقة المستخدمين. في المثال أعلاه، سيتمكّن المستخدمون الذين تم ضبط admin على "صحيح" في مطالبة الرمز المميّز الخاصة بهم فقط من الحصول على إذن بالقراءة والتعديل في العقدة adminContent. بما أنّ رمز التعريف المميّز يحتوي على هذه التأكيدات، لا حاجة إلى إجراء أي معالجة أو بحث إضافي للتحقّق من أذونات المشرف. بالإضافة إلى ذلك، يُعدّ رمز التعريف المميّز آلية موثوقة لتقديم هذه المطالبات المخصّصة. يجب أن تتحقّق جميع عمليات الوصول التي تمت المصادقة عليها من رمز التعريف المميّز قبل معالجة الطلب المرتبط به.

تعتمد أمثلة الرموز البرمجية والحلول الموضّحة في هذه الصفحة على كل من واجهات برمجة التطبيقات الخاصة بمصادقة Firebase من جهة العميل وواجهات برمجة التطبيقات الخاصة بالمصادقة من جهة الخادم التي يوفّرها مدير SDK.

ضبط المطالبات المخصّصة للمستخدمين والتحقّق منها من خلال مدير SDK

يمكن أن تحتوي المطالبات المخصّصة على بيانات حسّاسة، لذا يجب ضبطها فقط من بيئة خادم مميّزة من خلال مدير SDK في Firebase.

Node.js

// Set admin privilege on the user corresponding to uid.

getAuth()
  .setCustomUserClaims(uid, { admin: true })
  .then(() => {
    // The new custom claims will propagate to the user's ID token the
    // next time a new one is issued.
  });

Java

// Set admin privilege on the user corresponding to uid.
Map<String, Object> claims = new HashMap<>();
claims.put("admin", true);
FirebaseAuth.getInstance().setCustomUserClaims(uid, claims);
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

Python

# Set admin privilege on the user corresponding to uid.
auth.set_custom_user_claims(uid, {'admin': True})
# The new custom claims will propagate to the user's ID token the
# next time a new one is issued.

متابعة

// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

// Set admin privilege on the user corresponding to uid.
claims := map[string]interface{}{"admin": true}
err = client.SetCustomUserClaims(ctx, uid, claims)
if err != nil {
	log.Fatalf("error setting custom claims %v\n", err)
}
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

#C

// Set admin privileges on the user corresponding to uid.
var claims = new Dictionary<string, object>()
{
    { "admin", true },
};
await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(uid, claims);
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

يجب ألا يحتوي عنصر المطالبات المخصّصة على أي أسماء مفاتيح محجوزة في OIDC أو أسماء محجوزة في Firebase. يجب ألا تتجاوز الحمولة 1000 بايت. يجب أن تكون المطالبات المخصّصة قابلة للتسلسل بتنسيق JSON. تشمل الأنواع المتوافقة السلاسل والأرقام والقيم المنطقية والمصفوفات والعناصر والقيم الفارغة. ستؤدي الأنواع غير المتوافقة، مثل التاريخ أو القيم غير المحدّدة أو الدوال أو القيم الأخرى غير المستندة إلى JSON، إلى حدوث أخطاء.

يمكن لرمز مميّز للمعرّف يتم إرساله إلى خادم خلفي تأكيد هوية المستخدم ومستوى وصوله باستخدام "مدير SDK" على النحو التالي:

Node.js

// Verify the ID token first.
getAuth()
  .verifyIdToken(idToken)
  .then((claims) => {
    if (claims.admin === true) {
      // Allow access to requested admin resource.
    }
  });

Java

// Verify the ID token first.
FirebaseToken decoded = FirebaseAuth.getInstance().verifyIdToken(idToken);
if (Boolean.TRUE.equals(decoded.getClaims().get("admin"))) {
  // Allow access to requested admin resource.
}

Python

# Verify the ID token first.
claims = auth.verify_id_token(id_token)
if claims['admin'] is True:
    # Allow access to requested admin resource.
    pass

متابعة

// Verify the ID token first.
token, err := client.VerifyIDToken(ctx, idToken)
if err != nil {
	log.Fatal(err)
}

claims := token.Claims
if admin, ok := claims["admin"]; ok {
	if admin.(bool) {
		//Allow access to requested admin resource.
	}
}

#C

// Verify the ID token first.
FirebaseToken decoded = await FirebaseAuth.DefaultInstance.VerifyIdTokenAsync(idToken);
object isAdmin;
if (decoded.Claims.TryGetValue("admin", out isAdmin))
{
    if ((bool)isAdmin)
    {
        // Allow access to requested admin resource.
    }
}

يمكنك أيضًا التحقّق من المطالبات المخصّصة الحالية للمستخدم، والتي تتوفّر كسمة في عنصر المستخدم:

Node.js

// Lookup the user associated with the specified uid.
getAuth()
  .getUser(uid)
  .then((userRecord) => {
    // The claims can be accessed on the user record.
    console.log(userRecord.customClaims['admin']);
  });

Java

// Lookup the user associated with the specified uid.
UserRecord user = FirebaseAuth.getInstance().getUser(uid);
System.out.println(user.getCustomClaims().get("admin"));

Python

# Lookup the user associated with the specified uid.
user = auth.get_user(uid)
# The claims can be accessed on the user record.
print(user.custom_claims.get('admin'))

متابعة

// Lookup the user associated with the specified uid.
user, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatal(err)
}
// The claims can be accessed on the user record.
if admin, ok := user.CustomClaims["admin"]; ok {
	if admin.(bool) {
		log.Println(admin)
	}
}

#C

// Lookup the user associated with the specified uid.
UserRecord user = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
Console.WriteLine(user.CustomClaims["admin"]);

يمكنك حذف المطالبات المخصّصة لمستخدم من خلال تمرير قيمة فارغة لـ customClaims.

نشر المطالبات المخصّصة إلى العميل

بعد تعديل المطالبات الجديدة لمستخدم من خلال Admin SDK، يتم نشرها إلى مستخدم تمت مصادقته من جهة العميل من خلال الرمز المميز للمعرّف بالطرق التالية:

  • يسجّل المستخدم الدخول أو يعيد المصادقة بعد تعديل المطالبات المخصّصة. سيحتوي رمز التعريف المميّز الذي تم إصداره نتيجةً لذلك على أحدث المطالبات.
  • يتم تحديث الرمز المميّز لرقم التعريف الخاص بجلسة مستخدم حالية بعد انتهاء صلاحية رمز مميّز قديم.
  • يتم فرض إعادة تحميل رمز مميّز للمعرّف من خلال طلب currentUser.getIdToken(true).

الوصول إلى المطالبات المخصّصة على العميل

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

بعد نشر أحدث المطالبات في رمز تعريف المستخدم، يمكنك الحصول عليها من خلال استرداد رمز التعريف:

JavaScript

import { getAuth } from "firebase/auth";
getAuth().currentUser?.getIdTokenResult()
  .then((idTokenResult) => {
     // Confirm the user is an Admin.
     if (!!idTokenResult.claims.admin) {
       // Show admin UI.
       showAdminUI();
     } else {
       // Show regular user UI.
       showRegularUI();
     }
  })
  .catch((error) => {
    console.log(error);
  });

Android

user.getIdToken(false).addOnSuccessListener(new OnSuccessListener<GetTokenResult>() {
  @Override
  public void onSuccess(GetTokenResult result) {
    boolean isAdmin = result.getClaims().get("admin");
    if (isAdmin) {
      // Show admin UI.
      showAdminUI();
    } else {
      // Show regular user UI.
      showRegularUI();
    }
  }
});

Swift

user.getIDTokenResult(completion: { (result, error) in
  guard let admin = result?.claims?["admin"] as? NSNumber else {
    // Show regular user UI.
    showRegularUI()
    return
  }
  if admin.boolValue {
    // Show admin UI.
    showAdminUI()
  } else {
    // Show regular user UI.
    showRegularUI()
  }
})

Objective-C

user.getIDTokenResultWithCompletion:^(FIRAuthTokenResult *result,
                                      NSError *error) {
  if (error != nil) {
    BOOL *admin = [result.claims[@"admin"] boolValue];
    if (admin) {
      // Show admin UI.
      [self showAdminUI];
    } else {
      // Show regular user UI.
      [self showRegularUI];
    }
  }
}];

أفضل الممارسات المتعلّقة بالمطالبات المخصّصة

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

  • استخدِم المطالبات المخصّصة لتخزين البيانات من أجل التحكّم في وصول المستخدمين فقط. ويجب تخزين جميع البيانات الأخرى بشكل منفصل من خلال قاعدة البيانات في الوقت الفعلي أو أي مساحة تخزين أخرى من جهة الخادم.
  • تكون المطالبات المخصّصة محدودة الحجم. سيؤدي تمرير حمولة بيانات مطالبات مخصّصة أكبر من 1000 بايت إلى ظهور خطأ.

أمثلة وحالات استخدام

توضّح الأمثلة التالية المطالبات المخصّصة في سياق حالات استخدام Firebase محدّدة.

تحديد الأدوار من خلال وظائف Firebase عند إنشاء المستخدمين

في هذا المثال، يتم ضبط المطالبات المخصّصة على مستخدم عند الإنشاء باستخدام Cloud Functions.

يمكن إضافة المطالبات المخصّصة باستخدام Cloud Functions، ونشرها على الفور باستخدام Realtime Database. يتم استدعاء الدالة فقط عند الاشتراك باستخدام مشغّل onCreate. بعد ضبط المطالبات المخصّصة، يتم نشرها في جميع الجلسات الحالية والمستقبلية. في المرة التالية التي يسجّل فيها المستخدم الدخول باستخدام بيانات الاعتماد، يحتوي الرمز المميّز على المطالبات المخصّصة.

التنفيذ من جهة العميل (JavaScript)

import { GoogleAuthProvider, signInWithPopup, getAuth, onAuthStateChanged } from "firebase/auth";
import { getDatabase, onValue, ref } from "firebase/database";

const auth = getAuth();
const database = getDatabase();

const provider = new GoogleAuthProvider();

signInWithPopup(auth, provider).catch(error => {
  console.log(error);
});

let unsubscribeFn = null;
let metadataRef = null;
onAuthStateChanged(auth, user => {
  // Remove previous listener.
  if (unsubscribeFn) {
    unsubscribeFn();
  }
  // On user login add new listener.
  if (user) {
    // Check if refresh is required.
    metadataRef = ref(database, 'metadata/' + user.uid + '/refreshTime');
    // Subscribe new listener to changes on that node.
    unsubscribeFn = onValue(metadataRef, async (snapshot) => {
      // Force refresh to pick up the latest custom claims changes.
      // Note this is always triggered on first call. Further optimization could be
      // added to avoid the initial trigger when the token is issued and already contains
      // the latest claims.
      user.getIdToken(true);
    });
  }
});

منطق Cloud Functions

تتم إضافة عقدة قاعدة بيانات جديدة (metadata/($uid)} مع تقييد القراءة/الكتابة على المستخدم الذي تمت مصادقته.

const functions = require('firebase-functions');
const { initializeApp } = require('firebase-admin/app');
const { getAuth } = require('firebase-admin/auth');
const { getDatabase } = require('firebase-admin/database');

initializeApp();

// On sign up.
exports.processSignUp = functions.auth.user().onCreate(async (user) => {
  // Check if user meets role criteria.
  if (
    user.email &&
    user.email.endsWith('@admin.example.com') &&
    user.emailVerified
  ) {
    const customClaims = {
      admin: true,
      accessLevel: 9
    };

    try {
      // Set custom user claims on this newly created user.
      await getAuth().setCustomUserClaims(user.uid, customClaims);

      // Update real-time database to notify client to force refresh.
      const metadataRef = getDatabase().ref('metadata/' + user.uid);

      // Set the refresh time to the current UTC timestamp.
      // This will be captured on the client to force a token refresh.
      await  metadataRef.set({refreshTime: new Date().getTime()});
    } catch (error) {
      console.log(error);
    }
  }
});

قواعد قاعدة البيانات

{
  "rules": {
    "metadata": {
      "$user_id": {
        // Read access only granted to the authenticated user.
        ".read": "$user_id === auth.uid",
        // Write access only via Admin SDK.
        ".write": false
      }
    }
  }
}

تحديد الأدوار من خلال طلب HTTP

يضبط المثال التالي مطالبات المستخدمين المخصّصة لمستخدم سجّل دخوله حديثًا من خلال طلب HTTP.

التنفيذ من جهة العميل (JavaScript)

import { GoogleAuthProvider, signInWithPopup, getAuth, onAuthStateChanged } from "firebase/auth";
import { getDatabase, onValue, ref } from "firebase/database";

const auth = getAuth();
const database = getDatabase();

const provider = new GoogleAuthProvider();

signInWithPopup(auth, provider)
.then((result) => {
  // User is signed in. Get the ID token.
  return result.user.getIdToken();
})
.then((idToken) => {
  // Pass the ID token to the server.
  $.post(
    '/setCustomClaims',
    {
      idToken: idToken
    },
    (data, status) => {
      // This is not required. You could just wait until the token is expired
      // and it proactively refreshes.
      if (status == 'success' && data) {
        const json = JSON.parse(data);
        if (json && json.status == 'success') {
          // Force token refresh. The token claims will contain the additional claims.
          auth.currentUser.getIdToken(true);
        }
      }
    });
}).catch((error) => {
  console.log(error);
});

التنفيذ في الخلفية (مدير SDK)

app.post('/setCustomClaims', async (req, res) => {
  // Get the ID token passed.
  const idToken = req.body.idToken;

  // Verify the ID token and decode its payload.
  const claims = await getAuth().verifyIdToken(idToken);

  // Verify user is eligible for additional privileges.
  if (
    typeof claims.email !== 'undefined' &&
    typeof claims.email_verified !== 'undefined' &&
    claims.email_verified &&
    claims.email.endsWith('@admin.example.com')
  ) {
    // Add custom claims for additional privileges.
    await getAuth().setCustomUserClaims(claims.sub, {
      admin: true
    });

    // Tell client to refresh token on user.
    res.end(JSON.stringify({
      status: 'success'
    }));
  } else {
    // Return nothing.
    res.end(JSON.stringify({ status: 'ineligible' }));
  }
});

يمكن استخدام المسار نفسه عند ترقية مستوى وصول مستخدم حالي. على سبيل المثال، إذا أجرى مستخدم مجاني ترقية إلى اشتراك مدفوع، يتم إرسال الرمز المميّز لرقم تعريف المستخدم مع معلومات الدفع إلى خادم الخلفية من خلال طلب HTTP. عند معالجة الدفعة بنجاح، يتم ضبط المستخدم كمشترك يدفع الرسوم من خلال Admin SDK. يتم إرجاع استجابة HTTP ناجحة إلى العميل لفرض إعادة تحميل الرمز المميّز.

تحديد الأدوار من خلال نص برمجي في الخلفية

يمكن ضبط نص برمجي متكرر (لم يتم بدؤه من العميل) ليتم تشغيله من أجل تحديث المطالبات المخصّصة للمستخدم:

Node.js

getAuth()
  .getUserByEmail('user@admin.example.com')
  .then((user) => {
    // Confirm user is verified.
    if (user.emailVerified) {
      // Add custom claims for additional privileges.
      // This will be picked up by the user on token refresh or next sign in on new device.
      return getAuth().setCustomUserClaims(user.uid, {
        admin: true,
      });
    }
  })
  .catch((error) => {
    console.log(error);
  });

Java

UserRecord user = FirebaseAuth.getInstance()
    .getUserByEmail("user@admin.example.com");
// Confirm user is verified.
if (user.isEmailVerified()) {
  Map<String, Object> claims = new HashMap<>();
  claims.put("admin", true);
  FirebaseAuth.getInstance().setCustomUserClaims(user.getUid(), claims);
}

Python

user = auth.get_user_by_email('user@admin.example.com')
# Confirm user is verified
if user.email_verified:
    # Add custom claims for additional privileges.
    # This will be picked up by the user on token refresh or next sign in on new device.
    auth.set_custom_user_claims(user.uid, {
        'admin': True
    })

متابعة

user, err := client.GetUserByEmail(ctx, "user@admin.example.com")
if err != nil {
	log.Fatal(err)
}
// Confirm user is verified
if user.EmailVerified {
	// Add custom claims for additional privileges.
	// This will be picked up by the user on token refresh or next sign in on new device.
	err := client.SetCustomUserClaims(ctx, user.UID, map[string]interface{}{"admin": true})
	if err != nil {
		log.Fatalf("error setting custom claims %v\n", err)
	}

}

#C

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("user@admin.example.com");
// Confirm user is verified.
if (user.EmailVerified)
{
    var claims = new Dictionary<string, object>()
    {
        { "admin", true },
    };
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}

يمكن أيضًا تعديل المطالبات المخصّصة بشكل تدريجي من خلال مدير SDK:

Node.js

getAuth()
  .getUserByEmail('user@admin.example.com')
  .then((user) => {
    // Add incremental custom claim without overwriting existing claims.
    const currentCustomClaims = user.customClaims;
    if (currentCustomClaims['admin']) {
      // Add level.
      currentCustomClaims['accessLevel'] = 10;
      // Add custom claims for additional privileges.
      return getAuth().setCustomUserClaims(user.uid, currentCustomClaims);
    }
  })
  .catch((error) => {
    console.log(error);
  });

Java

UserRecord user = FirebaseAuth.getInstance()
    .getUserByEmail("user@admin.example.com");
// Add incremental custom claim without overwriting the existing claims.
Map<String, Object> currentClaims = user.getCustomClaims();
if (Boolean.TRUE.equals(currentClaims.get("admin"))) {
  // Add level.
  currentClaims.put("level", 10);
  // Add custom claims for additional privileges.
  FirebaseAuth.getInstance().setCustomUserClaims(user.getUid(), currentClaims);
}

Python

user = auth.get_user_by_email('user@admin.example.com')
# Add incremental custom claim without overwriting existing claims.
current_custom_claims = user.custom_claims
if current_custom_claims.get('admin'):
    # Add level.
    current_custom_claims['accessLevel'] = 10
    # Add custom claims for additional privileges.
    auth.set_custom_user_claims(user.uid, current_custom_claims)

متابعة

user, err := client.GetUserByEmail(ctx, "user@admin.example.com")
if err != nil {
	log.Fatal(err)
}
// Add incremental custom claim without overwriting existing claims.
currentCustomClaims := user.CustomClaims
if currentCustomClaims == nil {
	currentCustomClaims = map[string]interface{}{}
}

if _, found := currentCustomClaims["admin"]; found {
	// Add level.
	currentCustomClaims["accessLevel"] = 10
	// Add custom claims for additional privileges.
	err := client.SetCustomUserClaims(ctx, user.UID, currentCustomClaims)
	if err != nil {
		log.Fatalf("error setting custom claims %v\n", err)
	}

}

#C

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("user@admin.example.com");
// Add incremental custom claims without overwriting the existing claims.
object isAdmin;
if (user.CustomClaims.TryGetValue("admin", out isAdmin) && (bool)isAdmin)
{
    var claims = user.CustomClaims.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
    // Add level.
    var level = 10;
    claims["level"] = level;
    // Add custom claims for additional privileges.
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}