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

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

אפשר להגדיר תפקידי משתמשים במקרים הנפוצים הבאים:

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

נניח שאתם רוצים להגביל את הגישה לצומת adminContent במסד הנתונים. אפשר לעשות את זה באמצעות חיפוש במסד נתונים ברשימה של משתמשים עם הרשאת אדמין. עם זאת, אפשר להשיג את אותה מטרה בצורה יעילה יותר באמצעות הצהרה מותאמת אישית על משתמש בשם admin עם הכלל הבא של Realtime Database:

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

אפשר לגשת להצהרות מותאמות אישית של משתמשים באמצעות אסימוני האימות של המשתמשים. בדוגמה שלמעלה, רק למשתמשים שהערך של admin מוגדר כ-true ב-token claim שלהם תהיה גישת קריאה/כתיבה לצומת adminContent. מכיוון שהטענות האלה כבר כלולות בטוקן של המזהה, לא צריך לבצע עיבוד או חיפוש נוספים כדי לבדוק אם יש הרשאות אדמין. בנוסף, טוקן של מזהה הוא מנגנון מהימן להעברת ההצהרות המותאמות אישית האלה. בכל גישה מאומתת, צריך לאמת את טוקן של מזהה לפני שמעבדים את הבקשה המשויכת.

הדוגמאות של הקוד והפתרונות שמתוארים בדף הזה מבוססים על ממשקי ה-API של אימות ב-Firebase בצד הלקוח ועל ממשקי ה-API של אימות בצד השרת שסופקו על ידי ה-SDK לאדמינים.

הגדרה ואימות של טענות נכונות (claims) מותאמות אישית של משתמשים באמצעות 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.

Go

// 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. המטען הייעודי (payload) לא יכול לחרוג מ-1,000 בייטים. הצהרות מותאמות אישית חייבות להיות ניתנות לסריאליזציה של 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

Go

// 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'))

Go

// 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"]);

כדי למחוק את ההצהרות המותאמות אישית של משתמש, אפשר להעביר ערך null עבור customClaims.

הפצת הצהרות מותאמות אישית ללקוח

אחרי שמשנים את ההצהרות החדשות של משתמש באמצעות 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 שתואם למשתמש שמחובר לחשבון.

  • השתמשו בהצהרות מותאמות אישית כדי לאחסן נתונים לשליטה בגישה של משתמשים בלבד. כל שאר הנתונים צריכים להיות מאוחסנים בנפרד באמצעות מסד הנתונים בזמן אמת או אחסון אחר בצד השרת.
  • הגודל של הצהרות בהתאמה אישית מוגבל. העברת מטען ייעודי (payload) של הצהרות מותאמות אישית שגדול מ-1,000 בייטים תגרום לשגיאה.

דוגמאות ותרחישים לדוגמה

הדוגמאות הבאות ממחישות טענות נכונות בהתאמה אישית בהקשר של תרחישים ספציפיים לשימוש ב-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. כשהתשלום מעובד בהצלחה, המשתמש מוגדר כמנוי בתשלום באמצעות 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
    })

Go

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);
}

אפשר גם לשנות טענות נכונות (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)

Go

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);
}