इस गाइड में, Firebase के सुरक्षा नियमों की मुख्य भाषा के बारे में जानें गाइड के आधार पर, Firebase के रीयल टाइम डेटाबेस के सुरक्षा नियमों में शर्तें जोड़ने का तरीका बताया गया है.
रीयलटाइम डेटाबेस के सुरक्षा नियमों का मुख्य बिल्डिंग ब्लॉक शर्त है. शर्त एक बूलियन एक्सप्रेशन है. इससे यह तय होता है कि किसी खास कार्रवाई को अनुमति दी जानी चाहिए या नहीं. बुनियादी नियमों के लिए, शर्तों के तौर पर 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')" } } } } }
डाइनैमिक $
वैरिएबल का इस्तेमाल, कॉन्स्टेंट पाथ के नामों के साथ भी किया जा सकता है. इस उदाहरण में, हम $other
वैरिएबल का इस्तेमाल करके, .validate
नियम तय कर रहे हैं. इससे यह पक्का होता है कि 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 } } } }
पुष्टि करना
सुरक्षा नियम के सबसे सामान्य पैटर्न में से एक, उपयोगकर्ता की पुष्टि की स्थिति के आधार पर ऐक्सेस को कंट्रोल करना है. उदाहरण के लिए, हो सकता है कि आपका ऐप्लिकेशन सिर्फ़ साइन इन किए हुए उपयोगकर्ताओं को डेटा लिखने की अनुमति देना चाहे.
अगर आपका ऐप्लिकेशन Firebase Authentication का इस्तेमाल करता है, तो request.auth
वैरिएबल में, डेटा का अनुरोध करने वाले क्लाइंट के लिए पुष्टि करने की जानकारी होती है.
request.auth
के बारे में ज़्यादा जानकारी के लिए, रेफ़रंस दस्तावेज़ देखें.
Firebase Authentication, Firebase Realtime Database के साथ इंटिग्रेट होता है, ताकि आप शर्तों का इस्तेमाल करके, हर उपयोगकर्ता के हिसाब से डेटा ऐक्सेस को कंट्रोल कर सकें. जब कोई उपयोगकर्ता पुष्टि कर लेगा, तो आपके रीयलटाइम डेटाबेस के सुरक्षा नियमों में मौजूद auth
वैरिएबल में उपयोगकर्ता की जानकारी अपने-आप भर जाएगी. इस जानकारी में, उपयोगकर्ता का यूनीक आइडेंटिफ़ायर (uid
) और लिंक किए गए खाते का डेटा शामिल होता है. जैसे, Facebook आईडी या ईमेल पता और अन्य जानकारी. अगर आपने उपयोगकर्ता की पुष्टि करने के लिए, पसंद के मुताबिक पुष्टि करने वाला कोई प्रोवाइडर लागू किया है, तो उपयोगकर्ता के पुष्टि करने वाले पेलोड में अपने फ़ील्ड जोड़े जा सकते हैं.
इस सेक्शन में, Firebase रीयल टाइम डेटाबेस के सुरक्षा नियमों की भाषा को, उपयोगकर्ताओं की पुष्टि करने से जुड़ी जानकारी के साथ जोड़ने का तरीका बताया गया है. इन दो सिद्धांतों को जोड़कर, उपयोगकर्ता की पहचान के आधार पर डेटा के ऐक्सेस को कंट्रोल किया जा सकता है.
auth
वैरिएबल
पुष्टि करने से पहले, नियमों में पहले से तय auth
वैरिएबल शून्य होता है.
Firebase Authentication की मदद से उपयोगकर्ता की पुष्टि हो जाने के बाद, उसमें ये एट्रिब्यूट शामिल होंगे:
कंपनी | पुष्टि करने के लिए इस्तेमाल किया गया तरीका ("password", "बिना पहचान वाला", "facebook", "GitHub", "google" या "twitter". |
यूआईडी | यूनीक यूज़र आईडी, जो सभी प्रोवाइडर के लिए यूनीक होता है. |
टोकन |
Firebase 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" } } } }
पुष्टि करने की शर्तों के साथ काम करने के लिए, अपने डेटाबेस को व्यवस्थित करना
आम तौर पर, अपने डेटाबेस को इस तरह से व्यवस्थित करना मददगार होता है कि Rules लिखना आसान हो. Realtime Database में उपयोगकर्ता का डेटा सेव करने का एक सामान्य तरीका यह है कि आप अपने सभी उपयोगकर्ताओं को एक ही users
नोड में सेव करें. इस नोड के चाइल्ड, हर उपयोगकर्ता के लिए uid
वैल्यू होते हैं. अगर आपको इस डेटा के ऐक्सेस पर पाबंदी लगानी है, ताकि सिर्फ़ लॉग इन करने वाला उपयोगकर्ता अपना डेटा देख सके, तो आपके नियम कुछ इस तरह के होंगे.
{ "rules": { "users": { "$uid": { ".read": "auth !== null && auth.uid === $uid" } } } }
पुष्टि करने के लिए कस्टम दावों के साथ काम करना
जिन ऐप्लिकेशन को अलग-अलग उपयोगकर्ताओं के लिए कस्टम ऐक्सेस कंट्रोल की ज़रूरत होती है उनके लिए Firebase Authentication, डेवलपर को Firebase उपयोगकर्ता पर दावे सेट करने की अनुमति देता है.
इन दावों को आपके नियमों में 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
नियम की परिभाषा का एक सैंपल दिया गया है. इसमें सिर्फ़ YYYY-MM-DD फ़ॉर्मैट में तारीखें डाली जा सकती हैं. ये तारीखें 1900 से 2099 के बीच की होनी चाहिए. इसकी जांच रेगुलर एक्सप्रेशन का इस्तेमाल करके की जाती है.
".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
लिखी जा रही हो.
ये बातें मामूली लग सकती हैं, लेकिन असल में ये Firebase रीयलटाइम डेटाबेस के बेहतर सुरक्षा नियम लिखने के लिए अहम सुविधाएं हैं. इन नियमों का पालन करें:
{ "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()" } } } }
इस वैरिएंट को ध्यान में रखते हुए, नीचे दिए गए लिखने के ऑपरेशन के नतीजे देखें:
JavaScript
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);
Objective-C
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];
Swift
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);
Java
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);
REST
# 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()" } } } }
इस वैरिएंट में, इनमें से कोई भी कार्रवाई पूरी हो जाएगी:
JavaScript
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);
Objective-C
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];
Swift
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)
Java
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);
REST
# 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
नियमों के बीच के अंतर को दिखाया गया है.
जैसा कि दिखाया गया है, इन सभी नियमों को .validate
का इस्तेमाल करके लिखा जाना चाहिए. हालांकि, newData.hasChildren()
नियम के लिए ऐसा करना ज़रूरी नहीं है. यह इस बात पर निर्भर करेगा कि डेटा मिटाने की अनुमति है या नहीं.
क्वेरी पर आधारित नियम
हालांकि, नियमों को फ़िल्टर के तौर पर इस्तेमाल नहीं किया जा सकता. हालांकि, अपने नियमों में क्वेरी पैरामीटर का इस्तेमाल करके, डेटा के सबसेट का ऐक्सेस सीमित किया जा सकता है.
क्वेरी पैरामीटर के आधार पर पढ़ने या लिखने का ऐक्सेस देने के लिए, अपने नियमों में 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
क्वेरी पर आधारित नियमों का इस्तेमाल करके भी यह तय किया जा सकता है कि कोई क्लाइंट, पढ़ने के ऑपरेशन के ज़रिए कितना डेटा डाउनलोड करे.
उदाहरण के लिए, नीचे दिया गया नियम, किसी क्वेरी के पहले 1,000 नतीजों के लिए ही रीड ऐक्सेस की सीमा तय करता है. यह सीमा, प्राथमिकता के हिसाब से तय की जाती है:
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 |
बूलियन | यह वैल्यू, कीवर्ड, प्राथमिकता या वैल्यू के हिसाब से क्रम में लगाई गई क्वेरी के लिए True होती है. अगर ऐसा नहीं है, तो गलत. |
query.orderByChild | string null |
चाइल्ड नोड का रिलेटिव पाथ दिखाने के लिए, स्ट्रिंग का इस्तेमाल करें. उदाहरण के लिए,
query.orderByChild === "address/zip" . अगर क्वेरी को चाइल्ड नोड के हिसाब से क्रम में नहीं लगाया गया है, तो यह वैल्यू शून्य होती है.
|
query.startAt query.endAt query.equalTo |
स्ट्रिंग नंबर बूलियन शून्य |
यह, चल रही क्वेरी के सीमाओं को वापस लाता है. अगर कोई सीमा सेट नहीं है, तो यह शून्य दिखाता है. |
query.limitToFirst query.limitToLast |
number null |
यह फ़ंक्शन, चल रही क्वेरी की सीमा दिखाता है. अगर कोई सीमा सेट नहीं है, तो यह वैल्यू के तौर पर null दिखाता है. |
अगले चरण
शर्तों पर चर्चा करने के बाद, आपके पास Rules के बारे में ज़्यादा बेहतर जानकारी है और आप ये करने के लिए तैयार हैं:
इस्तेमाल के मुख्य उदाहरणों को मैनेज करने का तरीका जानें. साथ ही, Rules को डेवलप करने, टेस्ट करने, और डिप्लॉय करने का वर्कफ़्लो जानें:
- पहले से तय किए गए Rules उन वैरिएबल के पूरे सेट के बारे में जानें जिनका इस्तेमाल शर्तें बनाने के लिए किया जा सकता है.
- ऐसे नियम लिखें जो सामान्य स्थितियों को हल करते हों.
- अपनी जानकारी बढ़ाने के लिए, उन स्थितियों की समीक्षा करें जिनमें आपको असुरक्षित नियमों को पहचानना और उनसे बचना होगा.
- Firebase Local Emulator Suite के बारे में जानें. साथ ही, यह भी जानें कि Rules की जांच करने के लिए, इसका इस्तेमाल कैसे किया जा सकता है.
- Rules को डिप्लॉय करने के लिए उपलब्ध तरीकों की समीक्षा करें.
Realtime Database के लिए खास तौर पर उपलब्ध Rules की सुविधाओं के बारे में जानें:
- अपने Realtime Database को इंडेक्स करने का तरीका जानें.
- Rules को डिप्लॉय करने के लिए REST API देखें.