Firebase के सुरक्षा नियमों को मैनेज और डिप्लॉय करें

Firebase आपको Rules मैनेज करने के लिए कई टूल देता है. आपका हर टूल कुछ खास मामलों में फ़ायदेमंद हो. साथ ही, सब एक ही बैकएंड Firebase का इस्तेमाल करेंगे सुरक्षा नियम प्रबंधन एपीआई.

भले ही, इसे शुरू करने के लिए किसी भी टूल का इस्तेमाल किया जाए, मैनेजमेंट एपीआई:

  • नियम सोर्स शामिल करता है: नियमों का सेट, आम तौर पर एक कोड फ़ाइल होती है जिसमें Firebase Security Rules के स्टेटमेंट.
  • डेटा डाले गए सोर्स को ऐसे नियमसेट के तौर पर सेव करता है जिन्हें बदला नहीं जा सकता.
  • किसी रिलीज़ में हर नियमसेट के डिप्लॉयमेंट को ट्रैक करता है. Firebase सुरक्षा नियम वाली सेवाएं, हर अनुरोध का आकलन करने के लिए किसी प्रोजेक्ट की रिलीज़ देखती हैं के लिए साइन अप करते हैं.
  • यह किसी नियमसेट के वाक्य और वाक्य से जुड़े टेस्ट चलाने की सुविधा देता है.

Firebase सीएलआई का इस्तेमाल करें

Firebase सीएलआई के साथ, ये काम किए जा सकते हैं स्थानीय सोर्स अपलोड करना और रिलीज़ डिप्लॉय करना. सीएलआई का Firebase Local Emulator Suite की मदद से, सोर्स की पूरी तरह से स्थानीय जांच की जा सकती है.

सीएलआई का इस्तेमाल करके, अपने नियमों को वर्शन कंट्रोल में रखा जा सकता है. लागू करने के नियमों और शर्तों को पूरा करें.

कॉन्फ़िगरेशन फ़ाइल जनरेट करना

जब Firebase सीएलआई का इस्तेमाल करके Firebase प्रोजेक्ट कॉन्फ़िगर किया जाता है, तो आपकी प्रोजेक्ट डायरेक्ट्री में एक .rules कॉन्फ़िगरेशन फ़ाइल है. इनका इस्तेमाल करें कमांड:

Cloud Firestore 

// Set up Firestore in your project directory, creates a .rules file
firebase init firestore

Realtime Database 

// Set up Realtime Database in your project directory, creates a .rules file
firebase init database

Cloud Storage 

// Set up Storage in your project directory, creates a .rules file
firebase init storage

अपने नियमों में बदलाव करना और उन्हें अपडेट करना

.rules कॉन्फ़िगरेशन फ़ाइल में, सीधे अपने नियमों के सोर्स में बदलाव करें.

पक्का करें कि Firebase सीएलआई में किया गया कोई भी बदलाव, Firebase कंसोल है या यह कि आप इनमें से किसी एक का इस्तेमाल करके लगातार अपडेट करते रहते हैं Firebase कंसोल या Firebase सीएलआई. नहीं तो, आप किसी Firebase कंसोल में किए गए अपडेट.

अपडेट की जांच करें

Local Emulator Suite में ऐसे सभी सुरक्षा नियमों के लिए एम्युलेटर उपलब्ध होते हैं जिन पर सुरक्षा के नियम चालू हैं प्रॉडक्ट. हर एम्युलेटर के लिए, सुरक्षा के नियम वाला इंजन वाक्य-विन्यास दोनों का इस्तेमाल करता है और नियमों के वाक्यात्मक मूल्यांकन करते हैं, इसलिए वाक्यात्मक परीक्षण से सुरक्षा नियम प्रबंधन एपीआई के ऑफ़र.

अगर आप सीएलआई के साथ काम कर रहे हैं, तो यह सुइट Firebase Security Rules के लिए एक बेहतरीन टूल है टेस्टिंग हो रही है. अपने अपडेट की जांच करने के लिए, Local Emulator Suite का इस्तेमाल करें और पुष्टि करें कि आपके ऐप्लिकेशन का Rules आपका व्यवहार दिखाता है चाहते हैं.

अपने अपडेट डिप्लॉय करें

अपने Rules को अपडेट और टेस्ट करने के बाद, सोर्स को इन कामों के लिए डिप्लॉय करें प्रोडक्शन.

Cloud Firestore Security Rules के लिए, .rules फ़ाइलों को अपनी डिफ़ॉल्ट फ़ाइल और नाम वाले अतिरिक्त डेटाबेस की समीक्षा करके, firebase.json फ़ाइल.

अकेले अपने Rules को डिप्लॉय करने के लिए, नीचे दिए गए निर्देशों का इस्तेमाल करें या इन्हें अपनी सामान्य डिप्लॉयमेंट प्रोसेस में डिप्लॉय कर सकता है.

Cloud Firestore 

// Deploy rules for all databases configured in your firebase.json
firebase deploy --only firestore:rules

// Deploy rules for the specified database configured in your firebase.json
firebase deploy --only firestore:<databaseId>

Realtime Database 

// Deploy your .rules file
firebase deploy --only database

Cloud Storage 

// Deploy your .rules file
firebase deploy --only storage

Firebase कंसोल का इस्तेमाल करना

आपके पास Rules सोर्स में बदलाव करने और उन्हें यहां से रिलीज़ के तौर पर डिप्लॉय करने का विकल्प भी है Firebase कंसोल. वाक्यात्मक टेस्टिंग तब की जाती है, जब आप Firebase कंसोल यूज़र इंटरफ़ेस (यूआई) और सिमैंटिक टेस्टिंग Rules प्लेग्राउंड.

अपने नियमों में बदलाव करना और उन्हें अपडेट करना

  1. Firebase कंसोल खोलें और अपना प्रोजेक्ट चुनें.
  2. इसके बाद, Realtime Database, Cloud Firestore या स्टोरेज को यहां से चुनें इसके बाद, नियम पर क्लिक करके Rules एडिटर.
  3. सीधे एडिटर में जाकर, अपने नियमों में बदलाव करें.

अपडेट की जांच करें

एडिटर यूज़र इंटरफ़ेस (यूआई) में सिंटैक्स की जांच करने के अलावा, सिमैंटिक की भी जांच की जा सकती है Rules व्यवहार, आपके प्रोजेक्ट के डेटाबेस और स्टोरेज संसाधनों का इस्तेमाल करके, इसका इस्तेमाल करके, सीधे Firebase कंसोल में जा सकते हैं Rules प्लेग्राउंड. Rules Playground खोलें Rules एडिटर में, सेटिंग में बदलाव करें और Run पर क्लिक करें. एडिटर के सबसे ऊपर, पुष्टि करने वाला मैसेज देखें.

अपने अपडेट डिप्लॉय करें

जब आप संतुष्ट हो जाएं कि अपडेट आपकी उम्मीद के मुताबिक हैं, तो पब्लिश करें पर क्लिक करें.

'एडमिन SDK' का इस्तेमाल करना

Node.js के लिए Admin SDK का इस्तेमाल किया जा सकता है नियम सेट. प्रोग्राम के हिसाब से अपने-आप मिलने वाले इस ऐक्सेस की मदद से, ये काम किए जा सकते हैं:

  • नियमों को मैनेज करने के लिए, ज़रूरत के मुताबिक टूल, स्क्रिप्ट, डैशबोर्ड, और सीआई/सीडी पाइपलाइन का इस्तेमाल करें.
  • एक से ज़्यादा Firebase प्रोजेक्ट में नियमों को ज़्यादा आसानी से मैनेज करें.

प्रोग्राम के रूप में नियमों को अपडेट करते समय, अपने पिछले सेशन को उपयोगकर्ताओं की आपके ऐप्लिकेशन के ऐक्सेस कंट्रोल में अनचाहे बदलाव हुए हैं. अपना Admin SDK कोड सुरक्षा को सबसे ज़्यादा ध्यान में रखकर बनाया गया है, खास तौर पर नियमों को अपडेट या डिप्लॉय करते समय.

एक और ज़रूरी बात यह ध्यान में रखें कि Firebase Security Rules रिलीज़ में पूरी तरह से दिखने में कुछ मिनट लगते हैं. डिप्लॉय करने के लिए Admin SDK का इस्तेमाल करते समय के नियमों के तहत, ऐसी रेस स्थितियों से बचें जिनमें आपका ऐप्लिकेशन तुरंत जिनका डिप्लॉयमेंट अभी पूरा नहीं हुआ है. अगर आपके इस्तेमाल के उदाहरण के लिए ज़रूरी है ऐक्सेस कंट्रोल के नियमों को बार-बार अपडेट करने की सुविधा मिलती है. Cloud Firestore का इस्तेमाल करके इसे हल करने के बारे में सोचें, जिसे बार-बार अपडेट होने के बावजूद, रेस की स्थितियों को कम करने के लिए डिज़ाइन किया गया है.

इन सीमाओं पर भी ध्यान दें:

  • क्रम से लगाए जाने पर, नियमों को UTF-8 कोड में बदले गए टेक्स्ट के 256 केआईबी से कम होना चाहिए.
  • किसी प्रोजेक्ट में ज़्यादा से ज़्यादा 2,500 नियमसेट लागू किए जा सकते हैं. यह सीमा तय होने के बाद , तो नए नियम बनाने से पहले आपको कुछ पुराने नियम हटाने होंगे.

Cloud Storage या Cloud Firestore रूलसेट बनाएं और डिप्लॉय करें

Admin SDK की मदद से सुरक्षा के नियमों को मैनेज करने के लिए, एक सामान्य वर्कफ़्लो में ये चीज़ें शामिल हो सकती हैं तीन अलग-अलग चरण:

  1. नियम वाली फ़ाइल का सोर्स बनाना (ज़रूरी नहीं)
  2. नियमसेट बनाएं
  3. नया नियमसेट रिलीज़ या डिप्लॉय करें

SDK टूल, इन चरणों को एक ही एपीआई कॉल में जोड़ने का तरीका उपलब्ध कराता है Cloud Storage और Cloud Firestore सुरक्षा नियम. उदाहरण के लिए:

    const source = `service cloud.firestore {
      match /databases/{database}/documents {
        match /carts/{cartID} {
          allow create: if request.auth != null && request.auth.uid == request.resource.data.ownerUID;
          allow read, update, delete: if request.auth != null && request.auth.uid == resource.data.ownerUID;
        }
      }
    }`;
    // Alternatively, load rules from a file
    // const fs = require('fs');
    // const source = fs.readFileSync('path/to/firestore.rules', 'utf8');

    await admin.securityRules().releaseFirestoreRulesetFromSource(source);

यही पैटर्न, releaseFirestoreRulesetFromSource() वाले Cloud Storage नियमों पर काम करता है.

इसके अलावा, नियमों वाली फ़ाइल को मेमोरी में मौजूद ऑब्जेक्ट के तौर पर भी बनाया जा सकता है. इसके लिए, नियमसेट देख सकता है और इन इवेंट को बारीकी से कंट्रोल करने के लिए, नियमसेट अलग से डिप्लॉय कर सकता है. उदाहरण के लिए:

    const rf = admin.securityRules().createRulesFileFromSource('firestore.rules', source);
    const rs = await admin.securityRules().createRuleset(rf);
    await admin.securityRules().releaseFirestoreRuleset(rs);

Realtime Database नियमसेट अपडेट करें

Admin SDK की मदद से Realtime Database नियमसेट अपडेट करने के लिए, getRules() का इस्तेमाल करें और admin.database के setRules() तरीके. JSON में रूलसेट वापस पाए जा सकते हैं फ़ॉर्मैट या स्ट्रिंग के तौर पर शामिल करें.

नियमसेट अपडेट करने के लिए:

    const source = `{
      "rules": {
        "scores": {
          ".indexOn": "score",
          "$uid": {
            ".read": "$uid == auth.uid",
            ".write": "$uid == auth.uid"
          }
        }
      }
    }`;
    await admin.database().setRules(source);

नियमसेट मैनेज करें

बड़े नियमों के सेट को मैनेज करने के लिए, Admin SDK आपको सभी मौजूदा नियमों की सूची बनाने का विकल्प देता है admin.securityRules().listRulesetMetadata के साथ. उदाहरण के लिए:

    const allRulesets = [];
    let pageToken = null;
    while (true) {
      const result = await admin.securityRules().listRulesetMetadata(pageToken: pageToken);
      allRulesets.push(...result.rulesets);
      pageToken = result.nextPageToken;
      if (!pageToken) {
        break;
      }
    }

बहुत बड़े डिप्लॉयमेंट के लिए, जो समय के साथ 2,500 नियमों की सीमा तक पहुंच जाते हैं किसी तय टाइम साइकल में सबसे पुराने नियमों को मिटाने के लिए लॉजिक बनाएं. उदाहरण के लिए, 30 दिनों से ज़्यादा समय के लिए डिप्लॉय किए गए सभी नियमों को मिटाएं:

    const thirtyDays = new Date(Date.now() - THIRTY_DAYS_IN_MILLIS);
    const promises = [];
    allRulesets.forEach((rs) => {
      if (new Date(rs.createTime) < thirtyDays) {
        promises.push(admin.securityRules().deleteRuleset(rs.name));
      }
    });
    await Promise.all(promises);
    console.log(`Deleted ${promises.length} rulesets.`);

REST API का इस्तेमाल करना

ऊपर बताए गए टूल अलग-अलग वर्कफ़्लो के हिसाब से सही हैं. जैसे, आपके प्रोजेक्ट में कई Cloud Firestore डेटाबेस के लिए, Firebase Security Rules का मैनेजमेंट, हालांकि, मैनेजमेंट एपीआई का इस्तेमाल करके भी Firebase Security Rules को मैनेज और डिप्लॉय किया जा सकता है. Management API से आपको बेहतरीन सुविधाएं मिलती हैं.

इन सीमाओं पर भी ध्यान दें:

  • क्रम से लगाए जाने पर, नियमों को UTF-8 कोड में बदले गए टेक्स्ट के 256 केआईबी से कम होना चाहिए.
  • किसी प्रोजेक्ट में ज़्यादा से ज़्यादा 2,500 नियमसेट लागू किए जा सकते हैं. यह सीमा तय होने के बाद , तो नए नियम बनाने से पहले आपको कुछ पुराने नियम हटाने होंगे.

REST के साथ Cloud Firestore या Cloud Storage रूलसेट बनाएं और डिप्लॉय करें

इस सेक्शन में दिए गए उदाहरणों में Firestore Rules का इस्तेमाल किया गया है. हालांकि, ये इन पर लागू होते हैं Cloud Storage Rules भी.

उदाहरणों में एपीआई कॉल करने के लिए, CURL का भी इस्तेमाल किया गया है. खाता सेट अप करने और उसे पास करने का तरीका पुष्टि करने वाले टोकन शामिल नहीं किए जाते. इस एपीआई के साथ एक्सपेरिमेंट करने के लिए, API एक्सप्लोरर को देखें.

मैनेजमेंट एपीआई का इस्तेमाल करके, रूलसेट बनाने और उसे डिप्लॉय करने के कुछ सामान्य तरीके ये हैं:

  1. नियम वाली फ़ाइल के सोर्स बनाएं
  2. नियमसेट बनाएं
  3. नया नियमसेट रिलीज़ (डिप्लॉय) करें.

सोर्स बनाना

मान लें कि आप अपने secure_commerce Firebase प्रोजेक्ट पर काम कर रहे हैं और लॉक-डाउन Cloud Firestore Rules को आपके डेटाबेस में डिप्लॉय करने के लिए east_store नाम का प्रोजेक्ट.

आप इन नियमों को firestore.rules में लागू कर सकते हैं फ़ाइल से लिए जाते हैं.

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if false;
    }
  }
}

नियमसेट बनाएं

अब इस फ़ाइल के लिए, base64 कोड में बदला गया फ़िंगरप्रिंट जनरेट करें. इसके बाद, इस फ़ाइल में स्रोत projects.rulesets.create रेस्ट कॉल. यहां, इन आइटम को शामिल करने के लिए, cat निर्देश का इस्तेमाल करें firestore.rules की सामग्री को REST पेलोड में डालें.

ट्रैकिंग के लिए, इसे अपने east_store डेटाबेस से जोड़ने के लिए, attachment_point को east_store पर सेट करें.

curl -X POST -d '{
  "source": {
    "files": [
      {
        "content": "' $(cat storage.rules) '",
        "name": "firestore.rules",
        "fingerprint": <sha fingerprint>
      },
    "attachment_point": "firestore.googleapis.com/databases/east_store"
    ]
  }
}' 'https://firebaserules.googleapis.com/v1/projects/secure_commerce/rulesets'

उदाहरण के लिए, एपीआई से पुष्टि का रिस्पॉन्स और रूलसेट का नाम मिलता है projects/secure_commerce/rulesets/uuid123.

नियमसेट रिलीज़ (डिप्लॉय) करें

अगर नियमसेट मान्य है, तो आखिरी चरण है नाम वाले रिलीज़.

curl -X POST -d '{
  "name": "projects/secure_commerce/releases/cloud.firestore/east_store"  ,
  "rulesetName": "projects/secure_commerce/rulesets/uuid123"
}' 'https://firebaserules.googleapis.com/v1/projects/secure_commerce/releases'

ध्यान रखें कि Firebase Security Rules की रिलीज़ को पूरा होने में कुछ मिनट लग सकते हैं लागू करें. डिप्लॉयमेंट के लिए मैनेजमेंट REST API का इस्तेमाल करते समय, पक्का करें कि रेस न हो जिन स्थितियों में आपका ऐप्लिकेशन उन नियमों पर तुरंत निर्भर हो जाता है जिनका डिप्लॉयमेंट अभी पूरा हुआ है.

REST के साथ Realtime Database रूलसेट अपडेट करें

Rules को मैनेज करने के लिए, Realtime Database अपना REST इंटरफ़ेस उपलब्ध कराता है. यहां जाएं: REST के ज़रिए Firebase Realtime Database Rules को मैनेज करना.

REST की मदद से, रूलसेट मैनेज करें

बड़े नियमों के डिप्लॉयमेंट को मैनेज करने में मदद करने के लिए, नियमसेट और रिलीज़ बनाते समय, मैनेजमेंट एपीआई ये काम करने के तरीके उपलब्ध कराता है:

  • नियम की सूची बनाएं, पाएं, और मिटाएं
  • रिलीज़ के नियमों की सूची बनाना, उन्हें पाना, और मिटाना

बहुत बड़े डिप्लॉयमेंट के लिए, जो समय के साथ 2,500 नियमों की सीमा तक पहुंच जाते हैं किसी तय टाइम साइकल में सबसे पुराने नियमों को मिटाने के लिए लॉजिक बनाएं. उदाहरण के लिए, 30 दिनों से ज़्यादा समय के लिए डिप्लॉय किए गए सभी नियमों को हटाने के लिए, आप projects.rulesets.list तरीके का इस्तेमाल करके, Ruleset ऑब्जेक्ट की JSON सूची को पार्स करें अपनी createTime कुंजियों को रजिस्टर करें, फिर project.rulesets.delete को इस नंबर पर कॉल करें: ruleset_id तक संबंधित नियमसेट.

REST के साथ अपने अपडेट की जांच करें

आखिर में, Management API की मदद से आपके प्रोडक्शन में Cloud Firestore और Cloud Storage संसाधन हैं प्रोजेक्ट.

के बारे में हमारी गाइड देखें.

एपीआई के इस कॉम्पोनेंट के साथ टेस्टिंग में ये शामिल हैं:

  1. TestCase ऑब्जेक्ट के सेट को दिखाने के लिए, TestSuite JSON ऑब्जेक्ट तय किया जा रहा है
  2. TestSuite सबमिट किया जा रहा है
  3. पार्स करने में TestResult ऑब्जेक्ट मिले

आइए, एक TestCase के साथ TestSuite ऑब्जेक्ट के बारे में testcase.json फ़ाइल. इस उदाहरण में, हमने Rules REST पेलोड के साथ भाषा सोर्स इनलाइन. इसे चलाने के लिए, टेस्ट सुइट के साथ-साथ लागू करने के लिए प्रोत्साहित करते हैं. हम नियमों के आकलन की उम्मीद और क्लाइंट की जानकारी देते हैं वह अनुरोध जिसके ख़िलाफ़ नियमसेट की जांच की जानी है. यह भी बताया जा सकता है कि "FULL" वैल्यू का इस्तेमाल करके, टेस्ट रिपोर्ट को पूरा करें सभी के लिए परिणाम इंगित करने के लिए रिपोर्ट में Rules भाषा के एक्सप्रेशन शामिल किए जाने चाहिए. इनमें ये भी शामिल हैं वे एक्सप्रेशन जो अनुरोध से मेल नहीं खाते.

 {
  "source":
  {
    "files":
    [
      {
        "name": "firestore.rules",
        "content": "service cloud.firestore {
          match /databases/{database}/documents {
            match /users/{userId}{
              allow read: if (request.auth.uid == userId);
            }
            function doc(subpath) {
              return get(/databases/$(database)/documents/$(subpath)).data;
            }
            function isAccountOwner(accountId) {
              return request.auth.uid == accountId 
                  || doc(/users/$(request.auth.uid)).accountId == accountId;
            }
            match /licenses/{accountId} {
              allow read: if isAccountOwner(accountId);
            }
          }
        }"
      }
    ]
  },
  "testSuite":
  {
    "testCases":
    [
      {
        "expectation": "ALLOW",
        "request": {
           "auth": {"uid": "123"},
           "path": "/databases/(default)/documents/licenses/abcd",
           "method": "get"},
        "functionMocks": [
            {
            "function": "get",
            "args": [{"exact_value": "/databases/(default)/documents/users/123"}],
            "result": {"value": {"data": {"accountId": "abcd"}}}
            }
          ]
      }
    ]
  }
}

इसके बाद, हम इस TestSuite को समीक्षा के लिए, projects.test की मदद से सबमिट कर सकते हैं तरीका.

curl -X POST -d '{
    ' $(cat testcase.json) '
}' 'https://firebaserules.googleapis.com/v1/projects/secure_commerce/rulesets/uuid123:test'

वापस लौटाए गए TestReport (जिसमें परीक्षण सफल/असफल स्थिति शामिल है, इसकी सूचियां डीबग मैसेज, देखे गए नियम एक्सप्रेशन की सूचियां, और उनकी इवैलुएशन रिपोर्ट) यह पुष्टि की जाएगी कि ऐक्सेस सही तरीके से दिया गया है.

क्रॉस-सर्विस Cloud Storage Security Rules के लिए अनुमतियां मैनेज करें

अगर आपने Cloud Storage Security Rules बनाया है, जो Cloud Firestore दस्तावेज़ के कॉन्टेंट का इस्तेमाल करता है सुरक्षा की स्थितियों का आकलन करने के लिए, चालू करने के लिए, आपको Firebase कंसोल या Firebase सीएलआई में कहा जाएगा दोनों प्रॉडक्ट को कनेक्ट करने की अनुमतियां दी होती हैं.

अगर ऐसी क्रॉस-सर्विस सुरक्षा को बंद करना है, तो:

  1. सबसे पहले, इस सुविधा को बंद करने से पहले, अपने नियमों में बदलाव करें और सभी को हटाएं Cloud Firestore को ऐक्सेस करने के लिए Rules फ़ंक्शन का इस्तेमाल करने वाले स्टेटमेंट. ऐसा न करने पर, सुविधा बंद होने के बाद, Rules आकलन करेगा इसकी वजह से, स्टोरेज बढ़ाने के आपके अनुरोध नहीं हो पाएंगे.

  2. "Firebase" को मिटाने के लिए, Google Cloud Console में आईएएम पेज का इस्तेमाल करें नियमों के हिसाब से, Firestore सर्विस एजेंट" भूमिका असाइन करने के लिए, Cloud गाइड का इस्तेमाल करें वापस लेने वाली भूमिकाओं को ऐक्सेस नहीं कर पाएंगे.

अगली बार सेव करने पर आपको इस सुविधा को फिर से चालू करने के लिए कहा जाएगा Firebase सीएलआई या Firebase कंसोल से क्रॉस-सेवा नियम.