מבוא ל-Admin Database API

באמצעות Admin SDK אפשר לקרוא ולכתוב נתונים ב-Realtime Database עם הרשאות אדמין מלאות, או עם הרשאות מוגבלות ברמת פירוט גבוהה יותר. במסמך הזה נסביר איך מוסיפים את Firebase Admin SDK לפרויקט כדי לגשת ל-Firebase Realtime Database.

אפשר ליצור מכונות Realtime Database באזורים גיאוגרפיים שונים, עם סכמות נפרדות של כתובות URL מסוג firebaseio.com ו-firebasedatabase.app. Admin SDK methods להגדרת כתובות URL יכולות להשתמש בכל אחת מהסכימות. כדי לבדוק אילו אזורים וסכימות של כתובות URL נתמכים כרגע, אפשר לעיין במאמר בחירת מיקומים בפרויקטים ב-Firebase.

הגדרת Admin SDK

כדי להתחיל להשתמש ב-Firebase Realtime Database בשרת, צריך קודם להגדיר את Firebase Admin SDK בשפה הרצויה.

אם אתם רוצים להשתמש ב-SDK של Node.js כלקוח לגישה של משתמשי קצה (לדוגמה, באפליקציית Node.js למחשב או ל-IoT), בניגוד לגישה של אדמין מסביבה בעלת הרשאות (כמו שרת), עליכם לפעול לפי ההוראות להגדרת ה-SDK של JavaScript ללקוח.

אימות של Admin SDK

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

כשמבצעים אימות באמצעות Firebase Admin SDK, אפשר לקבל שתי רמות גישה שונות:

רמות גישה לאימות ב-Firebase Admin SDK
הרשאות אדמין	הרשאת קריאה וכתיבה מלאה ל-Realtime Database של פרויקט. מומלץ להשתמש בהם בזהירות כדי לבצע משימות ניהוליות כמו העברת נתונים או ארגון מחדש, שדורשות גישה בלתי מוגבלת למשאבים של הפרויקט.
הרשאות מוגבלות	גישה ל-Realtime Database של פרויקט, מוגבלת רק למשאבים שדרושים לשרת. משתמשים ברמה הזו כדי לבצע משימות ניהוליות עם דרישות גישה מוגדרות היטב. לדוגמה, כשמריצים משימה של סיכום שקוראת נתונים מכל מסד הנתונים, אפשר להגן מפני שגיאות כתיבה על ידי הגדרת כלל אבטחה לקריאה בלבד, ולאחר מכן לאתחל את Admin SDK עם הרשאות מוגבלות לפי הכלל הזה.

אימות באמצעות הרשאות אדמין

כשמאתחלים את Firebase Admin SDK באמצעות פרטי הכניסה של חשבון שירות עם התפקיד עריכה בפרויקט Firebase, למכונה הזו תהיה גישה מלאה לקריאה ולכתיבה ב-Realtime Database של הפרויקט.

Java

// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccount.json");

// Initialize the app with a service account, granting admin privileges
FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.fromStream(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .build();
FirebaseApp.initializeApp(options);

// As an admin, the app has access to read and write all data, regardless of Security Rules
DatabaseReference ref = FirebaseDatabase.getInstance()
    .getReference("restricted_access/secret_document");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot dataSnapshot) {
    Object document = dataSnapshot.getValue();
    System.out.println(document);
  }

  @Override
  public void onCancelled(DatabaseError error) {
  }
});

Node.js

var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a service account, granting admin privileges
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com"
});

// As an admin, the app has access to read and write all data, regardless of Security Rules
var db = admin.database();
var ref = db.ref("restricted_access/secret_document");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});

Python

import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a service account, granting admin privileges
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com'
})

# As an admin, the app has access to read and write all data, regradless of Security Rules
ref = db.reference('restricted_access/secret_document')
print(ref.get())

Go

ctx := context.Background()
conf := &firebase.Config{
	DatabaseURL: "https://databaseName.firebaseio.com",
}
// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

// Initialize the app with a service account, granting admin privileges
app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// As an admin, the app has access to read and write all data, regradless of Security Rules
ref := client.NewRef("restricted_access/secret_document")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

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

אימות עם הרשאות מוגבלות

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

{
  "rules": {
    "public_resource": {
      ".read": true,
      ".write": true
    },
    "some_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": false
    },
    "another_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": "auth.uid === 'my-service-worker'"
    }
  }
}

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

Java

// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

// Initialize the app with a custom auth variable, limiting the server's access
Map<String, Object> auth = new HashMap<String, Object>();
auth.put("uid", "my-service-worker");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .setDatabaseAuthVariableOverride(auth)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/some_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});

Node.js

var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a custom auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com",
  databaseAuthVariableOverride: {
    uid: "my-service-worker"
  }
});

// The app only has access as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/some_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});

Python

import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a custom auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': {
        'uid': 'my-service-worker'
    }
})

# The app only has access as defined in the Security Rules
ref = db.reference('/some_resource')
print(ref.get())

Go

ctx := context.Background()
// Initialize the app with a custom auth variable, limiting the server's access
ao := map[string]interface{}{"uid": "my-service-worker"}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &ao,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

במקרים מסוימים, כדאי לצמצם את ההיקף של Admin SDKs כדי לפעול כלקוח לא מאומת. כדי לעשות זאת, צריך לספק ערך של null לשינוי הערך שמוגדר כברירת מחדל במשתנה האימות של מסד הנתונים.

Java

// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .setDatabaseAuthVariableOverride(null)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access to public data as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/public_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});

Node.js

var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a null auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com",
  databaseAuthVariableOverride: null
});

// The app only has access to public data as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/public_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});

Python

import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a None auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': None
})

# The app only has access to public data as defined in the Security Rules
ref = db.reference('/public_resource')
print(ref.get())

Go

ctx := context.Background()
// Initialize the app with a nil auth variable, limiting the server's access
var nilMap map[string]interface{}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &nilMap,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access to public data as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

השלבים הבאים

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