रीयलटाइम डेटाबेस सुरक्षा नियमों में शर्तों का उपयोग करें

यह मार्गदर्शिका आपके फ़ायरबेस रीयलटाइम डेटाबेस सुरक्षा नियमों में शर्तों को जोड़ने का तरीका दिखाने के लिए मुख्य फ़ायरबेस सुरक्षा नियम भाषा मार्गदर्शिका को सीखती है ।

रीयलटाइम डेटाबेस सुरक्षा नियमों का प्राथमिक निर्माण खंड शर्त है। एक शर्त एक बूलियन अभिव्यक्ति है जो यह निर्धारित करती है कि किसी विशेष ऑपरेशन की अनुमति दी जानी चाहिए या अस्वीकार किया जाना चाहिए। बुनियादी नियमों के लिए, शर्तों के रूप में true और false अक्षर का उपयोग करना पूरी तरह से अच्छी तरह से काम करता है। लेकिन रीयलटाइम डेटाबेस सुरक्षा नियम भाषा आपको अधिक जटिल स्थितियों को लिखने के तरीके प्रदान करती है:

  • उपयोगकर्ता प्रमाणीकरण की जाँच करें
  • नए सबमिट किए गए डेटा के विरुद्ध मौजूदा डेटा का मूल्यांकन करें
  • अपने डेटाबेस के विभिन्न हिस्सों तक पहुंचें और तुलना करें
  • आने वाले डेटा को मान्य करें
  • सुरक्षा तर्क के लिए आने वाली क्वेरी की संरचना का उपयोग करें

पथ खंडों को कैप्चर करने के लिए $ वेरिएबल्स का उपयोग करना

आप $ उपसर्ग के साथ कैप्चर वेरिएबल घोषित करके पढ़ने या लिखने के लिए पथ के कुछ हिस्सों को कैप्चर कर सकते हैं। यह एक वाइल्ड कार्ड के रूप में कार्य करता है, और नियम शर्तों के अंदर उपयोग के लिए उस कुंजी के मूल्य को संग्रहीत करता है:

{
  "rules": {
    "rooms": {
      // this rule applies to any child of /rooms/, the key for each room id
      // is stored inside $room_id variable for reference
      "$room_id": {
        "topic": {
          // the room's topic can be changed if the room id has "public" in it
          ".write": "$room_id.contains('public')"
        }
      }
    }
  }
}

गतिशील $ चर का उपयोग स्थिर पथ नामों के समानांतर भी किया जा सकता है। इस उदाहरण में, हम एक .validate नियम घोषित करने के लिए $other वेरिएबल का उपयोग कर रहे हैं जो यह सुनिश्चित करता है कि widget में title और color के अलावा कोई संतान नहीं है। कोई भी लेखन जिसके परिणामस्वरूप अतिरिक्त बच्चे पैदा होंगे, विफल हो जाएगा।

{
  "rules": {
    "widget": {
      // a widget can have a title or color attribute
      "title": { ".validate": true },
      "color": { ".validate": true },

      // but no other child paths are allowed
      // in this case, $other means any key excluding "title" and "color"
      "$other": { ".validate": false }
    }
  }
}

प्रमाणीकरण

सबसे आम सुरक्षा नियम पैटर्न में से एक उपयोगकर्ता की प्रमाणीकरण स्थिति के आधार पर पहुंच को नियंत्रित करना है। उदाहरण के लिए, आपका ऐप केवल साइन-इन किए गए उपयोगकर्ताओं को डेटा लिखने की अनुमति देना चाह सकता है।

यदि आपका ऐप फायरबेस प्रमाणीकरण का उपयोग करता है, तो request.auth वैरिएबल में डेटा का अनुरोध करने वाले क्लाइंट के लिए प्रमाणीकरण जानकारी होती है। request.auth के बारे में अधिक जानकारी के लिए, संदर्भ दस्तावेज़ देखें।

फायरबेस प्रमाणीकरण फायरबेस रीयलटाइम डेटाबेस के साथ एकीकृत होता है ताकि आप शर्तों का उपयोग करके प्रति-उपयोगकर्ता आधार पर डेटा एक्सेस को नियंत्रित कर सकें। एक बार जब कोई उपयोगकर्ता प्रमाणित कर देता है, तो आपके रीयलटाइम डेटाबेस सुरक्षा नियम नियमों में auth वैरिएबल उपयोगकर्ता की जानकारी से भर जाएगा। इस जानकारी में उनके विशिष्ट पहचानकर्ता ( uid ) के साथ-साथ लिंक किया गया खाता डेटा, जैसे फेसबुक आईडी या ईमेल पता और अन्य जानकारी शामिल है। यदि आप एक कस्टम ऑथ प्रदाता लागू करते हैं, तो आप अपने उपयोगकर्ता के ऑथ पेलोड में अपने स्वयं के फ़ील्ड जोड़ सकते हैं।

यह अनुभाग बताता है कि फायरबेस रीयलटाइम डेटाबेस सुरक्षा नियम भाषा को अपने उपयोगकर्ताओं के बारे में प्रमाणीकरण जानकारी के साथ कैसे संयोजित किया जाए। इन दो अवधारणाओं को मिलाकर, आप उपयोगकर्ता की पहचान के आधार पर डेटा तक पहुंच को नियंत्रित कर सकते हैं।

auth वेरिएबल

प्रमाणीकरण होने से पहले नियमों में पूर्वनिर्धारित auth चर शून्य है।

एक बार जब कोई उपयोगकर्ता फ़ायरबेस प्रमाणीकरण से प्रमाणित हो जाता है तो इसमें निम्नलिखित विशेषताएँ शामिल होंगी:

प्रदाता प्रयुक्त प्रमाणीकरण विधि ("पासवर्ड", "गुमनाम", "फेसबुक", "जीथब", "गूगल", या "ट्विटर")।
यूआईडी एक अद्वितीय उपयोगकर्ता आईडी, सभी प्रदाताओं के लिए अद्वितीय होने की गारंटी।
टोकन फायरबेस ऑथ आईडी टोकन की सामग्री। अधिक विवरण के लिए auth.token के लिए संदर्भ दस्तावेज़ देखें।

यहां एक उदाहरण नियम है जो यह सुनिश्चित करने के लिए auth वैरिएबल का उपयोग करता है कि प्रत्येक उपयोगकर्ता केवल उपयोगकर्ता-विशिष्ट पथ पर लिख सकता है:

{
  "rules": {
    "users": {
      "$user_id": {
        // grants write access to the owner of this user account
        // whose uid must exactly match the key ($user_id)
        ".write": "$user_id === auth.uid"
      }
    }
  }
}

प्रमाणीकरण शर्तों का समर्थन करने के लिए अपने डेटाबेस की संरचना करना

यह आमतौर पर आपके डेटाबेस को इस तरह से संरचित करने में सहायक होता है जिससे नियम लिखना आसान हो जाता है। रीयलटाइम डेटाबेस में उपयोगकर्ता डेटा संग्रहीत करने का एक सामान्य पैटर्न आपके सभी उपयोगकर्ताओं को एक एकल users नोड में संग्रहीत करना है जिनके बच्चे प्रत्येक उपयोगकर्ता के लिए uid मान हैं। यदि आप इस डेटा तक पहुंच को इस तरह प्रतिबंधित करना चाहते हैं कि केवल लॉग-इन किया हुआ उपयोगकर्ता ही अपना डेटा देख सके, तो आपके नियम कुछ इस तरह दिखेंगे।

{
  "rules": {
    "users": {
      "$uid": {
        ".read": "auth !== null && auth.uid === $uid"
      }
    }
  }
}

प्रमाणीकरण कस्टम दावों के साथ कार्य करना

उन ऐप्स के लिए जिन्हें विभिन्न उपयोगकर्ताओं के लिए कस्टम एक्सेस नियंत्रण की आवश्यकता होती है, फायरबेस प्रमाणीकरण डेवलपर्स को फायरबेस उपयोगकर्ता पर दावे सेट करने की अनुमति देता है। ये दावे आपके नियमों में auth.token वैरिएबल में पहुंच योग्य हैं। यहां उन नियमों का एक उदाहरण दिया गया है जो hasEmergencyTowel कस्टम दावे का उपयोग करते हैं:

{
  "rules": {
    "frood": {
      // A towel is about the most massively useful thing an interstellar
      // hitchhiker can have
      ".read": "auth.token.hasEmergencyTowel === true"
    }
  }
}

अपने स्वयं के कस्टम प्रमाणीकरण टोकन बनाने वाले डेवलपर्स वैकल्पिक रूप से इन टोकन में दावे जोड़ सकते हैं। ये दावे आपके नियमों में auth.token वैरिएबल पर उपलब्ध हैं।

मौजूदा डेटा बनाम नया डेटा

पूर्वनिर्धारित data वेरिएबल का उपयोग लिखने की कार्रवाई से पहले डेटा को संदर्भित करने के लिए किया जाता है। इसके विपरीत, newData वैरिएबल में नया डेटा होता है जो राइट ऑपरेशन सफल होने पर मौजूद रहेगा। newData लिखे जा रहे नए डेटा और मौजूदा डेटा के मर्ज किए गए परिणाम का प्रतिनिधित्व करता है।

उदाहरण के लिए, यह नियम हमें नए रिकॉर्ड बनाने या मौजूदा रिकॉर्ड हटाने की अनुमति देगा, लेकिन मौजूदा गैर-शून्य डेटा में परिवर्तन करने की अनुमति नहीं देगा:

// we can write as long as old data or new data does not exist
// in other words, if this is a delete or a create, but not an update
".write": "!data.exists() || !newData.exists()"

अन्य पथों में डेटा का संदर्भ देना

किसी भी डेटा को नियमों के लिए मानदंड के रूप में उपयोग किया जा सकता है। पूर्वनिर्धारित वेरिएबल root , data और newData का उपयोग करके, हम किसी भी पथ तक पहुंच सकते हैं क्योंकि यह एक लेखन घटना से पहले या बाद में मौजूद होगा।

इस उदाहरण पर विचार करें, जो तब तक लेखन संचालन की अनुमति देता है जब तक /allow_writes/ नोड का मान true है, मूल नोड में readOnly ध्वज सेट नहीं है, और नए लिखे गए डेटा में foo नाम का एक बच्चा है:

".write": "root.child('allow_writes').val() === true &&
          !data.parent().child('readOnly').exists() &&
          newData.child('foo').exists()"

डेटा का सत्यापन

डेटा संरचनाओं को लागू करना और डेटा के प्रारूप और सामग्री को मान्य करना .validate नियमों का उपयोग करके किया जाना चाहिए, जो केवल .write नियम द्वारा पहुंच प्रदान करने में सफल होने के बाद ही चलाए जाते हैं। नीचे एक नमूना .validate नियम परिभाषा है जो केवल वर्ष 1900-2099 के बीच YYYY-MM-DD प्रारूप में तारीखों की अनुमति देता है, जिसे एक नियमित अभिव्यक्ति का उपयोग करके जांचा जाता है।

".validate": "newData.isString() &&
              newData.val().matches(/^(19|20)[0-9][0-9][-\\/. ](0[1-9]|1[012])[-\\/. ](0[1-9]|[12][0-9]|3[01])$/)"

.validate नियम एकमात्र प्रकार के सुरक्षा नियम हैं जो कैस्केड नहीं होते हैं। यदि कोई सत्यापन नियम किसी चाइल्ड रिकॉर्ड पर विफल रहता है, तो संपूर्ण लेखन कार्रवाई अस्वीकार कर दी जाएगी। इसके अतिरिक्त, जब डेटा हटा दिया जाता है तो मान्य परिभाषाओं को नजरअंदाज कर दिया जाता है (अर्थात, जब लिखा जा रहा नया मान null है)।

ये मामूली बिंदु लग सकते हैं, लेकिन वास्तव में शक्तिशाली फायरबेस रीयलटाइम डेटाबेस सुरक्षा नियम लिखने के लिए महत्वपूर्ण विशेषताएं हैं। निम्नलिखित नियमों पर विचार करें:

{
  "rules": {
    // write is allowed for all paths
    ".write": true,
    "widget": {
      // a valid widget must have attributes "color" and "size"
      // allows deleting widgets (since .validate is not applied to delete rules)
      ".validate": "newData.hasChildren(['color', 'size'])",
      "size": {
        // the value of "size" must be a number between 0 and 99
        ".validate": "newData.isNumber() &&
                      newData.val() >= 0 &&
                      newData.val() <= 99"
      },
      "color": {
        // the value of "color" must exist as a key in our mythical
        // /valid_colors/ index
        ".validate": "root.child('valid_colors/' + newData.val()).exists()"
      }
    }
  }
}

इस प्रकार को ध्यान में रखते हुए, निम्नलिखित लेखन कार्यों के परिणामों को देखें:

जावास्क्रिप्ट
var ref = db.ref("/widget");

// PERMISSION_DENIED: does not have children color and size
ref.set('foo');

// PERMISSION DENIED: does not have child color
ref.set({size: 22});

// PERMISSION_DENIED: size is not a number
ref.set({ size: 'foo', color: 'red' });

// SUCCESS (assuming 'blue' appears in our colors list)
ref.set({ size: 21, color: 'blue'});

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child('size').set(99);
उद्देश्य सी
नोट: यह फायरबेस उत्पाद ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
FIRDatabaseReference *ref = [[[FIRDatabase database] reference] child: @"widget"];

// PERMISSION_DENIED: does not have children color and size
[ref setValue: @"foo"];

// PERMISSION DENIED: does not have child color
[ref setValue: @{ @"size": @"foo" }];

// PERMISSION_DENIED: size is not a number
[ref setValue: @{ @"size": @"foo", @"color": @"red" }];

// SUCCESS (assuming 'blue' appears in our colors list)
[ref setValue: @{ @"size": @21, @"color": @"blue" }];

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
[[ref child:@"size"] setValue: @99];
तीव्र
नोट: यह फायरबेस उत्पाद ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
var ref = FIRDatabase.database().reference().child("widget")

// PERMISSION_DENIED: does not have children color and size
ref.setValue("foo")

// PERMISSION DENIED: does not have child color
ref.setValue(["size": "foo"])

// PERMISSION_DENIED: size is not a number
ref.setValue(["size": "foo", "color": "red"])

// SUCCESS (assuming 'blue' appears in our colors list)
ref.setValue(["size": 21, "color": "blue"])

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child("size").setValue(99);
जावा
FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("widget");

// PERMISSION_DENIED: does not have children color and size
ref.setValue("foo");

// PERMISSION DENIED: does not have child color
ref.child("size").setValue(22);

// PERMISSION_DENIED: size is not a number
Map<String,Object> map = new HashMap<String, Object>();
map.put("size","foo");
map.put("color","red");
ref.setValue(map);

// SUCCESS (assuming 'blue' appears in our colors list)
map = new HashMap<String, Object>();
map.put("size", 21);
map.put("color","blue");
ref.setValue(map);

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child("size").setValue(99);
आराम
# PERMISSION_DENIED: does not have children color and size
curl -X PUT -d 'foo' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# PERMISSION DENIED: does not have child color
curl -X PUT -d '{"size": 22}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# PERMISSION_DENIED: size is not a number
curl -X PUT -d '{"size": "foo", "color": "red"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# SUCCESS (assuming 'blue' appears in our colors list)
curl -X PUT -d '{"size": 21, "color": "blue"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# If the record already exists and has a color, this will
# succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
# will fail to validate
curl -X PUT -d '99' \
https://docs-examples.firebaseio.com/rest/securing-data/example/size.json

आइए अब उसी संरचना को देखें, लेकिन .validate के बजाय .write नियमों का उपयोग करें:

{
  "rules": {
    // this variant will NOT allow deleting records (since .write would be disallowed)
    "widget": {
      // a widget must have 'color' and 'size' in order to be written to this path
      ".write": "newData.hasChildren(['color', 'size'])",
      "size": {
        // the value of "size" must be a number between 0 and 99, ONLY IF WE WRITE DIRECTLY TO SIZE
        ".write": "newData.isNumber() && newData.val() >= 0 && newData.val() <= 99"
      },
      "color": {
        // the value of "color" must exist as a key in our mythical valid_colors/ index
        // BUT ONLY IF WE WRITE DIRECTLY TO COLOR
        ".write": "root.child('valid_colors/'+newData.val()).exists()"
      }
    }
  }
}

इस संस्करण में, निम्नलिखित में से कोई भी ऑपरेशन सफल होगा:

जावास्क्रिप्ट
var ref = new Firebase(URL + "/widget");

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
ref.set({size: 99999, color: 'red'});

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.child('size').set(99);
उद्देश्य सी
नोट: यह फायरबेस उत्पाद ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
Firebase *ref = [[Firebase alloc] initWithUrl:URL];

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
[ref setValue: @{ @"size": @9999, @"color": @"red" }];

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
[[ref childByAppendingPath:@"size"] setValue: @99];
तीव्र
नोट: यह फायरबेस उत्पाद ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
var ref = Firebase(url:URL)

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
ref.setValue(["size": 9999, "color": "red"])

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.childByAppendingPath("size").setValue(99)
जावा
Firebase ref = new Firebase(URL + "/widget");

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
Map<String,Object> map = new HashMap<String, Object>();
map.put("size", 99999);
map.put("color", "red");
ref.setValue(map);

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.child("size").setValue(99);
आराम
# ALLOWED? Even though size is invalid, widget has children color and size,
# so write is allowed and the .write rule under color is ignored
curl -X PUT -d '{size: 99999, color: "red"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# ALLOWED? Works even if widget does not exist, allowing us to create a widget
# which is invalid and does not have a valid color.
# (allowed by the write rule under "color")
curl -X PUT -d '99' \
https://docs-examples.firebaseio.com/rest/securing-data/example/size.json

यह .write और .validate नियमों के बीच अंतर को दर्शाता है। जैसा कि दिखाया गया है, इन सभी नियमों को newData.hasChildren() नियम के संभावित अपवाद के साथ .validate उपयोग करके लिखा जाना चाहिए, जो इस बात पर निर्भर करेगा कि विलोपन की अनुमति दी जानी चाहिए या नहीं।

क्वेरी-आधारित नियम

यद्यपि आप नियमों को फ़िल्टर के रूप में उपयोग नहीं कर सकते हैं , आप अपने नियमों में क्वेरी पैरामीटर का उपयोग करके डेटा के सबसेट तक पहुंच सीमित कर सकते हैं। query. क्वेरी पैरामीटर के आधार पर पढ़ने या लिखने की पहुंच प्रदान करने के लिए आपके नियमों में अभिव्यक्तियाँ।

उदाहरण के लिए, निम्नलिखित क्वेरी-आधारित नियम baskets संग्रह में डेटा तक पहुंच को केवल सक्रिय उपयोगकर्ता के स्वामित्व वाले शॉपिंग बास्केट तक सीमित करने के लिए उपयोगकर्ता-आधारित सुरक्षा नियमों और क्वेरी-आधारित नियमों का उपयोग करता है:

"baskets": {
  ".read": "auth.uid !== null &&
            query.orderByChild === 'owner' &&
            query.equalTo === auth.uid" // restrict basket access to owner of basket
}

निम्नलिखित क्वेरी, जिसमें नियम में क्वेरी पैरामीटर शामिल हैं, सफल होगी:

db.ref("baskets").orderByChild("owner")
                 .equalTo(auth.currentUser.uid)
                 .on("value", cb)                 // Would succeed

हालाँकि, नियम में पैरामीटर शामिल नहीं करने वाली क्वेरीज़ PermissionDenied त्रुटि के साथ विफल हो जाएंगी:

db.ref("baskets").on("value", cb)                 // Would fail with PermissionDenied

आप रीड ऑपरेशन के माध्यम से क्लाइंट द्वारा डाउनलोड किए जाने वाले डेटा की मात्रा को सीमित करने के लिए क्वेरी-आधारित नियमों का भी उपयोग कर सकते हैं।

उदाहरण के लिए, निम्नलिखित नियम किसी क्वेरी के केवल पहले 1000 परिणामों तक पढ़ने की पहुंच को सीमित करता है, जैसा कि प्राथमिकता के आधार पर दिया गया है:

messages: {
  ".read": "query.orderByKey &&
            query.limitToFirst <= 1000"
}

// Example queries:

db.ref("messages").on("value", cb)                // Would fail with PermissionDenied

db.ref("messages").limitToFirst(1000)
                  .on("value", cb)                // Would succeed (default order by key)

निम्नलिखित query. अभिव्यक्तियाँ रीयलटाइम डेटाबेस सुरक्षा नियमों में उपलब्ध हैं।

क्वेरी-आधारित नियम अभिव्यक्तियाँ
अभिव्यक्ति प्रकार विवरण
query.orderByKey
query.orderByPriority
query.orderByValue		 बूलियन कुंजी, प्राथमिकता या मान के आधार पर क्रमित प्रश्नों के लिए सही है। अन्यथा मिथ्या।
query.orderByChild डोरी
व्यर्थ		 चाइल्ड नोड के सापेक्ष पथ का प्रतिनिधित्व करने के लिए एक स्ट्रिंग का उपयोग करें। उदाहरण के लिए, query.orderByChild === "address/zip" । यदि क्वेरी चाइल्ड नोड द्वारा ऑर्डर नहीं की गई है, तो यह मान शून्य है।
query.startAt
query.endAt
query.equalTo		 डोरी
संख्या
बूलियन
व्यर्थ		 निष्पादित क्वेरी की सीमाएँ पुनः प्राप्त करता है, या यदि कोई बाउंड सेट नहीं है तो शून्य लौटाता है।
query.limitToFirst
query.limitToLast		 संख्या
व्यर्थ		 निष्पादित क्वेरी पर सीमा प्राप्त करता है, या यदि कोई सीमा निर्धारित नहीं है तो शून्य लौटाता है।

अगले कदम

शर्तों की इस चर्चा के बाद, आपको नियमों की अधिक परिष्कृत समझ मिल गई है और आप इसके लिए तैयार हैं:

जानें कि मुख्य उपयोग के मामलों को कैसे संभालना है, और नियमों के विकास, परीक्षण और तैनाती के लिए वर्कफ़्लो सीखें:

उन नियम सुविधाओं को जानें जो रीयलटाइम डेटाबेस के लिए विशिष्ट हैं: