यह गाइड, Firebase Security Rules भाषा के मुख्य सिंटैक्स के बारे में जानें गाइड पर आधारित है. इसमें Cloud Storage के लिए, Firebase Security Rules में शर्तें जोड़ने का तरीका बताया गया है.
Cloud Storage Security Rules का मुख्य बिल्डिंग ब्लॉक शर्त है. शर्त, एक बूलियन एक्सप्रेशन है. इससे यह तय होता है कि किसी कार्रवाई को अनुमति दी जानी चाहिए या नहीं. बुनियादी नियमों के लिए, true और false लिटरल को शर्तों के तौर पर इस्तेमाल करना सबसे सही रहता है. हालांकि, Cloud Storage के लिए Firebase Security Rules भाषा की मदद से, ज़्यादा जटिल शर्तें लिखी जा सकती हैं. इनसे ये काम किए जा सकते हैं:
- उपयोगकर्ता की पुष्टि की जांच करना
- इनकमिंग डेटा की पुष्टि करना
एआई असिस्टेंस के लिए एआई प्रॉम्प्ट
एआई की मदद पाने के लिए, नीचे दिए गए प्रॉम्प्ट को अपने एआई कोडिंग एजेंट (जैसे, Android Studio में Gemini, Antigravity, Claude Code, Codex, और Cursor) में कॉपी करें. प्रॉम्प्ट को अपनी पसंद के मुताबिक बनाया जा सकता है और एजेंट के साथ बातचीत की जा सकती है. इंस्टॉल करने के बारे में ज़्यादा जानकारी के लिए, Firebase एजेंट स्किल पर जाएं.
Help me use Firebase in my app.
1. Make sure that **Firebase agent skills** are installed and updated. For Claude Code, Codex, or Cursor agents, help me install the Firebase plugin. For other agents, run `npx skills add firebase/agent-skills`. Always try to use **Firebase agent skills** for Firebase-related tasks.
2. Help me write, validate, and deploy Firebase Security Rules to protect my app's Cloud Storage data.
पुष्टि करना
Cloud Storage के लिए Firebase Security Rules, Firebase Authentication के साथ इंटिग्रेट होता है, ताकि Cloud Storage को उपयोगकर्ता के आधार पर पुष्टि करने की बेहतर सुविधा मिल सके. इससे Firebase Authentication टोकन के दावों के आधार पर, ऐक्सेस कंट्रोल को बारीकी से कंट्रोल किया जा सकता है.
जब पुष्टि किया गया कोई उपयोगकर्ता Cloud Storage के लिए अनुरोध करता है, तो request.auth वैरिएबल में उपयोगकर्ता का uid (request.auth.uid) और Firebase Authentication JWT (request.auth.token) के दावे अपने-आप भर जाते हैं.
इसके अलावा, कस्टम ऑथेंटिकेशन का इस्तेमाल करने पर, request.auth.token फ़ील्ड में अतिरिक्त दावे दिखते हैं.
जब कोई ऐसा उपयोगकर्ता अनुरोध करता है जिसकी पुष्टि नहीं हुई है, तो request.auth वैरिएबल null होता है.
इस डेटा का इस्तेमाल करके, फ़ाइलों को सुरक्षित रखने के लिए पुष्टि करने के कई सामान्य तरीके हैं:
- सार्वजनिक:
request.authको अनदेखा करें - Authenticated private: check that
request.authis notnull - उपयोगकर्ता की निजी जानकारी: देखें कि
request.auth.uid, पाथuidके बराबर है या नहीं - निजी ग्रुप: कस्टम टोकन के दावों की जांच करके, चुने गए दावे से मैच करें या फ़ाइल का मेटाडेटा पढ़कर देखें कि मेटाडेटा फ़ील्ड मौजूद है या नहीं
सार्वजनिक
request.auth कॉन्टेक्स्ट को ध्यान में न रखने वाले किसी भी नियम को public नियम माना जा सकता है. ऐसा इसलिए, क्योंकि यह उपयोगकर्ता के ऑथेंटिकेशन कॉन्टेक्स्ट को ध्यान में नहीं रखता.
ये नियम, सार्वजनिक डेटा को दिखाने के लिए काम के हो सकते हैं. जैसे, गेम की ऐसेट, साउंड फ़ाइलें या अन्य स्टैटिक कॉन्टेंट.
// Anyone to read a public image if the file is less than 100kB // Anyone can upload a public file ending in '.txt' match /public/{imageId} { allow read: if resource.size < 100 * 1024; allow write: if imageId.matches(".*\\.txt"); }
पुष्टि की गई निजी जानकारी
कुछ मामलों में, हो सकता है कि आपको अपने ऐप्लिकेशन के उन उपयोगकर्ताओं को डेटा दिखाना हो जिनकी पुष्टि हो चुकी है. हालांकि, उन उपयोगकर्ताओं को डेटा न दिखाना हो जिनकी पुष्टि नहीं हुई है. request.auth वैरिएबल, पुष्टि नहीं किए गए सभी उपयोगकर्ताओं के लिए null है. इसलिए, पुष्टि करने के लिए आपको सिर्फ़ यह देखना होगा कि request.auth वैरिएबल मौजूद है या नहीं:
// Require authentication on all internal image reads match /internal/{imageId} { allow read: if request.auth != null; }
उपयोगकर्ता की निजी जानकारी
request.auth का सबसे आम इस्तेमाल, उपयोगकर्ताओं को उनकी फ़ाइलों पर अलग-अलग अनुमतियां देने के लिए किया जाएगा: प्रोफ़ाइल फ़ोटो अपलोड करने से लेकर निजी दस्तावेज़ों को पढ़ने तक.
Cloud Storage में मौजूद फ़ाइलों का पूरा "पाथ" होता है. इसलिए, किसी फ़ाइल को उपयोगकर्ता के कंट्रोल में रखने के लिए, फ़ाइल नाम के प्रीफ़िक्स में उपयोगकर्ता की पहचान ज़ाहिर करने वाली यूनीक जानकारी (जैसे, उपयोगकर्ता का uid) शामिल करना ज़रूरी है. नियम का आकलन करते समय, इस जानकारी की जांच की जा सकती है:
// Only a user can upload their profile picture, but anyone can view it match /users/{userId}/profilePicture.png { allow read; allow write: if request.auth.uid == userId; }
ग्रुप को निजी के तौर पर सेट करना
किसी ऑब्जेक्ट पर ग्रुप को अनुमतियां देने का इस्तेमाल भी आम तौर पर किया जाता है. जैसे, टीम के कई सदस्यों को शेयर किए गए दस्तावेज़ पर साथ मिलकर काम करने की अनुमति देना. ऐसा करने के कई तरीके हैं:
- Firebase Authentication कस्टम टोकन बनाएं. इसमें ग्रुप के सदस्य के बारे में अतिरिक्त जानकारी शामिल होती है. जैसे, ग्रुप आईडी
- फ़ाइल के मेटाडेटा में ग्रुप की जानकारी शामिल करें. जैसे, ग्रुप आईडी या अनुमति वाले
uidकी सूची
टोकन या फ़ाइल मेटाडेटा में यह डेटा सेव होने के बाद, इसे किसी नियम से रेफ़र किया जा सकता है:
// Allow reads if the group ID in your token matches the file metadata's `owner` property // Allow writes if the group ID is in the user's custom token match /files/{groupId}/{fileName} { allow read: if resource.metadata.owner == request.auth.token.groupId; allow write: if request.auth.token.groupId == groupId; }
आकलन का अनुरोध करना
अपलोड, डाउनलोड, मेटाडेटा में बदलाव, और मिटाए गए डेटा का आकलन, Cloud Storage को भेजे गए request का इस्तेमाल करके किया जाता है. उपयोगकर्ता के यूनीक आईडी और request.auth ऑब्जेक्ट में मौजूद Firebase Authentication पेलोड के अलावा, request वैरिएबल में उस फ़ाइल का पाथ होता है जहां अनुरोध किया जा रहा है. साथ ही, अनुरोध मिलने का समय और नई resource वैल्यू भी होती है. ऐसा तब होता है, जब अनुरोध लिखने के लिए किया गया हो.
request ऑब्जेक्ट में, उपयोगकर्ता का यूनीक आईडी और request.auth ऑब्जेक्ट में Firebase Authentication पेलोड भी शामिल होता है. इसके बारे में दस्तावेज़ों के उपयोगकर्ता के हिसाब से सुरक्षा सेक्शन में ज़्यादा जानकारी दी जाएगी.
request ऑब्जेक्ट में मौजूद प्रॉपर्टी की पूरी सूची यहां दी गई है:
| प्रॉपर्टी | टाइप | ब्यौरा |
|---|---|---|
auth |
map<string, string> | जब कोई उपयोगकर्ता लॉग इन करता है, तो uid, उपयोगकर्ता का यूनीक आईडी, और
token, Firebase Authentication जेडब्ल्यूटी दावों का मैप उपलब्ध कराता है. ऐसा न करने पर, यह null हो जाएगा. |
params |
map<string, string> | अनुरोध के क्वेरी पैरामीटर वाला मैप. |
path |
पाथ | path, जो उस पाथ को दिखाता है जिस पर अनुरोध किया जा रहा है. |
resource |
map<string, string> | संसाधन की नई वैल्यू, जो सिर्फ़ write अनुरोधों पर मौजूद होती है.
|
time |
timestamp | एक टाइमस्टैंप, जो सर्वर के उस समय को दिखाता है जब अनुरोध का आकलन किया जाता है. |
संसाधन का आकलन
नियमों का आकलन करते समय, आपको अपलोड, डाउनलोड, बदलाव या मिटाई जा रही फ़ाइल के मेटाडेटा का भी आकलन करना पड़ सकता है. इससे आपको जटिल और असरदार नियम बनाने में मदद मिलती है. जैसे, सिर्फ़ कुछ खास तरह के कॉन्टेंट वाली फ़ाइलों को अपलोड करने की अनुमति देना या सिर्फ़ तय साइज़ से बड़ी फ़ाइलों को मिटाना.
Cloud Storage के लिए Firebase Security Rules, resource ऑब्जेक्ट में फ़ाइल का मेटाडेटा उपलब्ध कराता है. इसमें Cloud Storage ऑब्जेक्ट में दिखाए गए मेटाडेटा के की/वैल्यू पेयर शामिल होते हैं. डेटा का रखरखाव सुनिश्चित करने के लिए, इन प्रॉपर्टी की जांच read या write अनुरोधों पर की जा सकती है.
write अनुरोधों (जैसे, अपलोड, मेटाडेटा अपडेट, और मिटाना) पर, resource ऑब्जेक्ट के अलावा, जिसमें अनुरोध पाथ पर मौजूद फ़ाइल के लिए फ़ाइल मेटाडेटा शामिल होता है, आपके पास request.resource ऑब्जेक्ट का इस्तेमाल करने की सुविधा भी होती है. इसमें फ़ाइल मेटाडेटा का सबसेट शामिल होता है, जिसे लिखने की अनुमति होने पर लिखा जा सकता है. इन दोनों वैल्यू का इस्तेमाल करके, डेटा की सुरक्षा को पक्का किया जा सकता है. इसके अलावा, ऐप्लिकेशन की पाबंदियां लागू की जा सकती हैं. जैसे, फ़ाइल टाइप या साइज़.
resource ऑब्जेक्ट में मौजूद प्रॉपर्टी की पूरी सूची यहां दी गई है:
| प्रॉपर्टी | टाइप | ब्यौरा |
|---|---|---|
name |
स्ट्रिंग | ऑब्जेक्ट का पूरा नाम |
bucket |
स्ट्रिंग | उस बकेट का नाम जिसमें यह ऑब्जेक्ट मौजूद है. |
generation |
int | इस ऑब्जेक्ट का Google Cloud Storage ऑब्जेक्ट जनरेशन. |
metageneration |
int | इस ऑब्जेक्ट का Google Cloud Storage ऑब्जेक्ट मेटाजनरेशन. |
size |
int | ऑब्जेक्ट का साइज़, बाइट में. |
timeCreated |
timestamp | कोई ऑब्जेक्ट बनाए जाने का टाइमस्टैंप. |
updated |
timestamp | यह एक टाइमस्टैंप है, जिससे पता चलता है कि किसी ऑब्जेक्ट को आखिरी बार कब अपडेट किया गया था. |
md5Hash |
स्ट्रिंग | ऑब्जेक्ट का MD5 हैश. |
crc32c |
स्ट्रिंग | ऑब्जेक्ट का crc32c हैश. |
etag |
स्ट्रिंग | इस ऑब्जेक्ट से जुड़ा etag. |
contentDisposition |
स्ट्रिंग | इस ऑब्जेक्ट से जुड़ा कॉन्टेंट डिस्पोज़िशन. |
contentEncoding |
स्ट्रिंग | इस ऑब्जेक्ट से जुड़ी कॉन्टेंट एन्कोडिंग. |
contentLanguage |
स्ट्रिंग | इस ऑब्जेक्ट से जुड़े कॉन्टेंट की भाषा. |
contentType |
स्ट्रिंग | इस ऑब्जेक्ट से जुड़ा कॉन्टेंट टाइप. |
metadata |
map<string, string> | डेवलपर के तय किए गए अतिरिक्त कस्टम मेटाडेटा के की/वैल्यू पेयर. |
request.resource में ये सभी शामिल हैं. हालांकि, इसमें generation, metageneration, etag, timeCreated, और updated शामिल नहीं हैं.
Cloud Firestore की मदद से बेहतर बनाएं
अनुमति देने की अन्य शर्तों का आकलन करने के लिए, Cloud Firestore में मौजूद दस्तावेज़ों को ऐक्सेस किया जा सकता है.
firestore.get() और firestore.exists() फ़ंक्शन का इस्तेमाल करके, आपके सुरक्षा नियम Cloud Firestore में मौजूद दस्तावेज़ों के हिसाब से, आने वाले अनुरोधों का आकलन कर सकते हैं.
firestore.get() और firestore.exists(), दोनों फ़ंक्शन के लिए दस्तावेज़ के पाथ की पूरी जानकारी देना ज़रूरी है. firestore.get() और firestore.exists() के लिए पाथ बनाने के लिए वैरिएबल का इस्तेमाल करते समय, आपको $(variable) सिंटैक्स का इस्तेमाल करके वैरिएबल को साफ़ तौर पर एस्केप करना होगा.
यहां दिए गए उदाहरण में, एक ऐसा नियम है जो फ़ाइलों को पढ़ने का ऐक्सेस सिर्फ़ उन उपयोगकर्ताओं को देता है जो किसी खास क्लब के सदस्य हैं.
service firebase.storage {
match /b/{bucket}/o {
match /users/{club}/files/{fileId} {
allow read: if club in
firestore.get(/databases/(default)/documents/users/$(request.auth.id)).data.memberships
}
}
}service firebase.storage {
match /b/{bucket}/o {
match /users/{userId}/photos/{fileId} {
allow read: if
firestore.exists(/databases/(default)/documents/users/$(userId)/friends/$(request.auth.id))
}
}
}इन Cloud Firestore फ़ंक्शन का इस्तेमाल करने वाले पहले Cloud Storage Security Rules को बनाने और सेव करने के बाद, आपको Firebase कंसोल या Firebase सीएलआई में, दोनों प्रॉडक्ट को कनेक्ट करने की अनुमतियां चालू करने के लिए कहा जाएगा.
Firebase Security Rules को मैनेज और डिप्लॉय करें में बताए गए तरीके से, आईएएम की भूमिका को हटाकर इस सुविधा को बंद किया जा सकता है.
डेटा की पुष्टि करना
Cloud Storage के लिए Firebase Security Rules का इस्तेमाल, डेटा की पुष्टि करने के लिए भी किया जा सकता है. इसमें फ़ाइल के नाम और पाथ के साथ-साथ, फ़ाइल के मेटाडेटा की प्रॉपर्टी, जैसे कि contentType और size की पुष्टि करना शामिल है.
service firebase.storage { match /b/{bucket}/o { match /images/{imageId} { // Only allow uploads of any image file that's less than 5MB allow write: if request.resource.size < 5 * 1024 * 1024 && request.resource.contentType.matches('image/.*'); } } }
कस्टम फ़ंक्शन
जैसे-जैसे आपके Firebase Security Rules ज़्यादा जटिल होते जाते हैं, वैसे-वैसे आपको शर्तों के सेट को फ़ंक्शन में रैप करना पड़ सकता है. इन फ़ंक्शन को अपने नियमों के सेट में फिर से इस्तेमाल किया जा सकता है. सुरक्षा के नियम, कस्टम फ़ंक्शन के साथ काम करते हैं. कस्टम फ़ंक्शन का सिंटैक्स, JavaScript जैसा ही होता है. हालांकि, Firebase Security Rules फ़ंक्शन, डोमेन के हिसाब से तय की गई भाषा में लिखे जाते हैं. इस भाषा की कुछ अहम सीमाएं हैं:
- फ़ंक्शन में सिर्फ़ एक
returnस्टेटमेंट हो सकता है. इनमें कोई अतिरिक्त लॉजिक नहीं हो सकता. उदाहरण के लिए, वे लूप को लागू नहीं कर सकते या बाहरी सेवाओं को कॉल नहीं कर सकते. - फ़ंक्शन, उस स्कोप से फ़ंक्शन और वैरिएबल को अपने-आप ऐक्सेस कर सकते हैं जिसमें उन्हें तय किया गया है. उदाहरण के लिए,
service firebase.storageस्कोप में तय किए गए फ़ंक्शन के पासresourceवैरिएबल का ऐक्सेस होता है. साथ ही, सिर्फ़ Cloud Firestore के लिए, पहले से मौजूद फ़ंक्शन का ऐक्सेस होता है, जैसे किget()औरexists(). - फ़ंक्शन, अन्य फ़ंक्शन को कॉल कर सकते हैं. हालांकि, वे बार-बार कॉल नहीं कर सकते. कॉल स्टैक की कुल डेप्थ 10 तक सीमित है.
rules2वर्शन में, फ़ंक्शनletकीवर्ड का इस्तेमाल करके वैरिएबल तय कर सकते हैं. फ़ंक्शन में कितने भी let बाइंडिंग हो सकते हैं. हालांकि, उन्हें रिटर्न स्टेटमेंट के साथ खत्म होना चाहिए.
किसी फ़ंक्शन को function कीवर्ड के साथ तय किया जाता है. इसमें शून्य या उससे ज़्यादा आर्ग्युमेंट होते हैं. उदाहरण के लिए, हो सकता है कि आप ऊपर दिए गए उदाहरणों में इस्तेमाल की गई दो तरह की शर्तों को एक ही फ़ंक्शन में जोड़ना चाहें:
service firebase.storage {
match /b/{bucket}/o {
// True if the user is signed in or the requested data is 'public'
function signedInOrPublic() {
return request.auth.uid != null || resource.data.visibility == 'public';
}
match /images/{imageId} {
allow read, write: if signedInOrPublic();
}
match /mp3s/{mp3Ids} {
allow read: if signedInOrPublic();
}
}
}
Firebase Security Rules में फ़ंक्शन इस्तेमाल करने से, उन्हें मैनेज करना आसान हो जाता है. ऐसा इसलिए, क्योंकि आपके नियम ज़्यादा जटिल हो जाते हैं.
अगले चरण
शर्तों के बारे में इस चर्चा के बाद, आपको नियमों के बारे में ज़्यादा जानकारी मिल गई है. अब आपके पास ये काम करने का विकल्प है:
मुख्य इस्तेमाल के उदाहरणों को मैनेज करने का तरीका जानें. साथ ही, नियमों को डेवलप करने, टेस्ट करने, और डिप्लॉय करने का वर्कफ़्लो जानें:
- सामान्य स्थितियों को ध्यान में रखकर नियम बनाएं.
- अपनी जानकारी को बेहतर बनाने के लिए, उन स्थितियों की समीक्षा करें जिनमें आपको असुरक्षित नियमों का पता लगाना और उनसे बचना ज़रूरी है.
- Cloud Storage एम्युलेटर और सुरक्षा नियमों की जांच करने वाली खास लाइब्रेरी का इस्तेमाल करके, नियमों की जांच करें.
- Security Rules को डिप्लॉय करने के लिए उपलब्ध तरीके देखें.