Admin Database SDK के बारे में जानकारी

Admin SDK की मदद से, Realtime Database के डेटा को एडमिन के सभी अधिकारों के साथ पढ़ा और लिखा जा सकता है. इसके अलावा, सीमित अधिकारों के साथ भी ऐसा किया जा सकता है. इस दस्तावेज़ में, हम आपको Firebase Realtime Database को ऐक्सेस करने के लिए, अपने प्रोजेक्ट में Firebase Admin SDK जोड़ने का तरीका बताएंगे.

Admin SDK का सेटअप

अपने सर्वर पर Firebase रीयलटाइम डेटाबेस का इस्तेमाल शुरू करने के लिए, आपको सबसे पहले अपनी चुनी हुई भाषा में Firebase Admin SDK सेट अप करना होगा.

Admin SDK की पुष्टि करना

Firebase Admin SDK का इस्तेमाल करके, सर्वर से Firebase Realtime Database को ऐक्सेस करने से पहले, आपको अपने सर्वर की पुष्टि Firebase से करनी होगी. क्लाइंट ऐप्लिकेशन में, उपयोगकर्ता खाते की क्रेडेंशियल से साइन इन करने के बजाय, सर्वर की पुष्टि करने के लिए सेवा खाते का इस्तेमाल किया जाता है. इससे Firebase को आपके सर्वर की पहचान मिलती है.

Firebase Admin SDK का इस्तेमाल करके पुष्टि करने पर, आपको दो अलग-अलग लेवल का ऐक्सेस मिल सकता है:

Firebase Admin SDK के लिए पुष्टि करने के ऐक्सेस लेवल
एडमिन के अधिकार किसी प्रोजेक्ट के Realtime Database को पढ़ने और लिखने का पूरा ऐक्सेस. डेटा माइग्रेशन या रीस्ट्रक्चरिंग जैसे एडमिन के टास्क पूरे करने के लिए, इसका इस्तेमाल सावधानी से करें. इन टास्क के लिए, आपके प्रोजेक्ट के संसाधनों का बिना किसी पाबंदी के ऐक्सेस ज़रूरी होता है.
सीमित अधिकार किसी प्रोजेक्ट के Realtime Database का ऐक्सेस. यह ऐक्सेस सिर्फ़ उन संसाधनों तक सीमित होता है जिनकी आपके सर्वर को ज़रूरत होती है. एडमिन के ऐसे टास्क पूरे करने के लिए इस लेवल का इस्तेमाल करें जिनके लिए, ऐक्सेस की ज़रूरी शर्तें तय की गई हैं उदाहरण के लिए, डेटा को सारांशित करने वाला कोई ऐसा काम करते समय जिसमें पूरे डेटाबेस से डेटा पढ़ा जाता है, सिर्फ़ पढ़ने की अनुमति देने वाला सुरक्षा नियम सेट करके, गलती से डेटा लिखने से रोका जा सकता है. इसके बाद, Admin SDK को उन अधिकारों के साथ शुरू किया जा सकता है जो उस नियम के तहत सीमित हैं.

एडमिन के अधिकारों के साथ पुष्टि करना

जब Firebase Admin SDK को, आपके Firebase प्रोजेक्ट पर एडिटर की भूमिका वाले सेवा खाते की क्रेडेंशियल के साथ शुरू किया जाता है, तो उस इंस्टेंस के पास आपके प्रोजेक्ट के Realtime Database को पढ़ने और लिखने का पूरा ऐक्सेस होता है.

Java
// Initialize the SDK with Application Default Credentials
FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    // 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
import { initializeApp } from 'firebase-admin/app';
import { getDatabase } from 'firebase-admin/database';

// Initialize the app with Application Default Credentials, granting admin privileges
initializeApp({
  // 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
const db = getDatabase();
const ref = db.ref("restricted_access/secret_document");
ref.once("value", (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)

सीमित अधिकारों के साथ पुष्टि करना

सबसे सही तरीका यह है कि किसी सेवा के पास सिर्फ़ उन संसाधनों का ऐक्सेस होना चाहिए जिनकी उसे ज़रूरत है. 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
// 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 = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    // 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
import { initializeApp } from 'firebase-admin/app';
import { getDatabase } from 'firebase-admin/database';

// Initialize the app with a custom auth variable, limiting the server's access
initializeApp({
  // 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
const db = getDatabase();
const ref = db.ref("/some_resource");
ref.once("value", (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 SDK को बिना पुष्टि किए क्लाइंट के तौर पर काम करने के लिए, उसके स्कोप को कम करना पड़ सकता है. डेटाबेस के पुष्टि करने वाले वैरिएबल को बदलने के लिए, null वैल्यू देकर ऐसा किया जा सकता है.

Java
// Initialize the app with Application Default Credentials
FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    // 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
import { initializeApp } from 'firebase-admin/app';
import { getDatabase } from 'firebase-admin/database';

// Initialize the app with a null auth variable, limiting the server's access
initializeApp({
  // 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
const db = getDatabase();
const ref = db.ref("/public_resource");
ref.once("value", (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)

अगले चरण