Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

क्लाउड स्टोरेज भाषा के लिए फायरबेस सुरक्षा नियमों के मूल सिंटैक्स को जानें

संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.

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

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

सेवा और डेटाबेस घोषणा

क्लाउड स्टोरेज के लिए फायरबेस सुरक्षा नियम हमेशा निम्नलिखित घोषणा के साथ शुरू होते हैं:

service firebase.storage {
    // ...
}

service firebase.storage घोषणा नियमों को क्लाउड स्टोरेज तक सीमित करती है, क्लाउड स्टोरेज सुरक्षा नियमों और क्लाउड फायरस्टोर जैसे अन्य उत्पादों के नियमों के बीच टकराव को रोकती है।

बुनियादी पढ़ने/लिखने के नियम

बुनियादी नियमों में क्लाउड स्टोरेज बकेट की पहचान करने वाला match स्टेटमेंट, फ़ाइल नाम निर्दिष्ट करने वाला मैच स्टेटमेंट और निर्दिष्ट डेटा को पढ़ने की allow वाले एक्सप्रेशन का विवरण शामिल है। allow अभिव्यक्ति में शामिल एक्सेस विधियों (जैसे, पढ़ना, लिखना) निर्दिष्ट करें, और ऐसी शर्तें जिनके तहत एक्सेस की अनुमति है या अस्वीकार है।

आपके डिफ़ॉल्ट नियमसेट में, आपके प्रोजेक्ट में सभी बकेट पर लागू होने वाले नियमों को इंगित करने के लिए पहला match स्टेटमेंट {bucket} वाइल्डकार्ड एक्सप्रेशन का उपयोग करता है। हम अगले भाग में वाइल्डकार्ड मिलानों के बारे में अधिक चर्चा करेंगे।

service firebase.storage {
  // The {bucket} wildcard indicates we match files in all Cloud Storage buckets
  match /b/{bucket}/o {
    // Match filename
    match /filename {
      allow read: if <condition>;
      allow write: if <condition>;
    }
  }
}

सभी मैच स्टेटमेंट फाइलों की ओर इशारा करते हैं। मिलान विवरण किसी विशिष्ट फ़ाइल की ओर इशारा कर सकता है, जैसा कि match /images/profilePhoto.png में है।

वाइल्डकार्ड का मिलान करें

एकल फ़ाइल की ओर इशारा करने के अलावा, नियम वाइल्डकार्ड का उपयोग किसी भी फ़ाइल को उसके नाम में दिए गए स्ट्रिंग उपसर्ग के साथ इंगित करने के लिए कर सकते हैं, जिसमें स्लैश भी शामिल है, जैसा कि match /images/{imageId} में है।

उपरोक्त उदाहरण में, मिलान विवरण {imageId} वाइल्डकार्ड सिंटैक्स का उपयोग करता है। इसका मतलब यह है कि नियम किसी भी फ़ाइल पर लागू होता है जिसके नाम के शुरू में /images/ होता है, जैसे कि /images/profilePhoto.png या /images/croppedProfilePhoto.png । जब मिलान विवरण में allow अभिव्यक्ति का मूल्यांकन किया जाता है, तो imageId चर छवि फ़ाइल नाम, जैसे कि profilePhoto.png या croppedProfilePhoto.png को हल करेगा।

फ़ाइल नाम या पथ प्राधिकरण प्रदान करने के लिए वाइल्डकार्ड चर को match के भीतर से संदर्भित किया जा सकता है:

// Another way to restrict the name of a file
match /images/{imageId} {
  allow read: if imageId == "profilePhoto.png";
}

पदानुक्रमित डेटा

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

उन फ़ाइलों के सेट की स्थिति पर विचार करें जिनके नाम सभी /images/ स्टेम से शुरू होते हैं। फायरबेस सुरक्षा नियम केवल मिलान किए गए फ़ाइल नाम पर लागू होते हैं, इसलिए /images/ स्टेम पर परिभाषित अभिगम नियंत्रण /mp3s/ स्टेम पर लागू नहीं होते हैं। इसके बजाय, अलग-अलग फ़ाइल नाम पैटर्न से मेल खाने वाले स्पष्ट नियम लिखें:

service firebase.storage {
  match /b/{bucket}/o {
    match /images/{imageId} {
      allow read, write: if <condition>;
    }

    // Explicitly define rules for the 'mp3s' pattern
    match /mp3s/{mp3Id} {
      allow read, write: if <condition>;
    }
  }
}

match स्टेटमेंट्स को नेस्ट करते समय, इनर match स्टेटमेंट का पाथ हमेशा बाहरी match स्टेटमेंट के पाथ में जोड़ा जाता है। निम्नलिखित दो नियम सेट इसलिए समकक्ष हैं:

service firebase.storage {
  match /b/{bucket}/o {
    match /images {
      // Exact match for "images/profilePhoto.png"
      match /profilePhoto.png {
        allow write: if <condition>;
      }
    }
  }
}
service firebase.storage {
  match /b/{bucket}/o {
    // Exact match for "images/profilePhoto.png"
    match /images/profilePhoto.png {
      allow write: if <condition>;
      }
  }
}

रिकर्सिव मैच वाइल्डकार्ड

फ़ाइल नाम के अंत में मेल खाने वाले और रिटर्न स्ट्रिंग वाले वाइल्डकार्ड के अलावा, वाइल्डकार्ड नाम में =** जोड़कर अधिक जटिल मिलान के लिए एक बहु खंड वाइल्डकार्ड घोषित किया जा सकता है, जैसे {path=**} :

// Partial match for files that start with "images"
match /images {

  // Exact match for "images/**"
  // e.g. images/users/user:12345/profilePhoto.png is matched
  // images/profilePhoto.png is also matched!
  match /{allImages=**} {
    // This rule matches one or more path segments (**)
    // allImages is a path that contains all segments matched
    allow read: if <other_condition>;
  }
}

यदि एकाधिक नियम एक फ़ाइल से मेल खाते हैं, तो परिणाम सभी नियमों के मूल्यांकन के परिणाम का OR होता है। यही है, यदि कोई नियम फ़ाइल से मेल खाता है तो true का मूल्यांकन करता है, तो परिणाम true होता है।

ऊपर दिए गए नियमों में, फ़ाइल "images/profilePhoto.png" को पढ़ा जा सकता है यदि कोई condition या other_condition सही है, जबकि फ़ाइल "images/users/user:12345/profilePhoto.png" केवल other_condition के परिणाम के अधीन है .

क्लाउड स्टोरेज सुरक्षा नियम कैस्केड नहीं करते हैं, और नियमों का मूल्यांकन केवल तभी किया जाता है जब अनुरोध पथ निर्दिष्ट नियमों वाले पथ से मेल खाता हो।

संस्करण 1

फायरबेस सुरक्षा नियम डिफ़ॉल्ट रूप से संस्करण 1 का उपयोग करते हैं। संस्करण 1 में, पुनरावर्ती वाइल्डकार्ड एक या अधिक फ़ाइलनाम तत्वों से मेल खाते हैं, शून्य या अधिक तत्वों से नहीं। इस प्रकार, match /images/{filenamePrefixWildcard}/{imageFilename=**} मिलान /images/profilePics/profile.png जैसे फ़ाइल नाम से मेल खाता है, लेकिन /images/badge.png से नहीं। इसके बजाय /images/{imagePrefixorFilename=**} का प्रयोग करें।

पुनरावर्ती वाइल्डकार्ड मैच विवरण के अंत में आने चाहिए।

हम अनुशंसा करते हैं कि आप इसकी अधिक शक्तिशाली सुविधाओं के लिए संस्करण 2 का उपयोग करें।

संस्करण 2

फायरबेस सुरक्षा नियमों के संस्करण 2 में, पुनरावर्ती वाइल्डकार्ड शून्य या अधिक पथ आइटम से मेल खाते हैं। इस प्रकार, /images/{filenamePrefixWildcard}/{imageFilename=**} फ़ाइल नाम /images/profilePics/profile.png और /images/badge.png से मेल खाता है।

आपको rules_version = '2'; जोड़कर संस्करण 2 में ऑप्ट-इन करना होगा। आपके सुरक्षा नियमों के शीर्ष पर:

rules_version = '2';
service cloud.storage {
  match /b/{bucket}/o {
   ...
 }
}

आपके पास प्रति मैच विवरण में अधिकतम एक पुनरावर्ती वाइल्डकार्ड हो सकता है, लेकिन संस्करण 2 में, आप इस वाइल्डकार्ड को मैच विवरण में कहीं भी रख सकते हैं। उदाहरण के लिए:

rules_version = '2';
service firebase.storage {
 match /b/{bucket}/o {
   // Matches any file in a songs "subdirectory" under the
   // top level of your Cloud Storage bucket.
   match /{prefixSegment=**}/songs/{mp3filenames} {
     allow read, write: if <condition>;
   }
  }
}

दानेदार संचालन

कुछ स्थितियों में, read और write को अधिक बारीक संचालन में तोड़ना उपयोगी होता है। उदाहरण के लिए, आपका ऐप फ़ाइल हटाने की तुलना में फ़ाइल निर्माण पर अलग-अलग शर्तों को लागू करना चाह सकता है।

read ऑपरेशन को get और list में तोड़ा जा सकता है।

एक write नियम को create , update करने और delete में तोड़ा जा सकता है:

service firebase.storage {
  match /b/{bucket}/o {
    // A read rule can be divided into read and list rules
    match /images/{imageId} {
      // Applies to single file read requests
      allow get: if <condition>;
      // Applies to list and listAll requests (Rules Version 2)
      allow list: if <condition>;

    // A write rule can be divided into create, update, and delete rules
    match /images/{imageId} {
      // Applies to writes to file contents
      allow create: if <condition>;

      // Applies to updates to (pre-existing) file metadata
      allow update: if <condition>;

      // Applies to delete operations
      allow delete: if <condition>;
    }
  }
 }
}

ओवरलैपिंग मैच स्टेटमेंट

एक फ़ाइल नाम के लिए एक से अधिक match स्टेटमेंट से मेल खाना संभव है। ऐसे मामले में जहां कई allow भाव एक अनुरोध से मेल खाते हैं, यदि कोई भी शर्त true है तो पहुंच की अनुमति है:

service firebase.storage {
  match b/{bucket}/o {
    // Matches file names directly inside of '/images/'.
    match /images/{imageId} {
      allow read, write: if false;
    }

    // Matches file names anywhere under `/images/`
    match /images/{imageId=**} {
      allow read, write: if true;
    }
  }
}

ऊपर दिए गए उदाहरण में, उन सभी फ़ाइलों को पढ़ने और लिखने की अनुमति है जिनका नाम /images/ से शुरू होता है क्योंकि दूसरा नियम हमेशा true होता है, भले ही पहला नियम false

नियम फ़िल्टर नहीं हैं

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

उदाहरण के लिए, निम्नलिखित सुरक्षा नियम लें:

service firebase.storage {
  match /b/{bucket}/o {
    // Allow the client to read files with contentType 'image/png'
    match /aFileNamePrefix/{aFileName} {
      allow read: if resource.contentType == 'image/png';
    }
  }
}

अस्वीकृत : यह नियम निम्नलिखित अनुरोध को अस्वीकार करता है क्योंकि परिणाम सेट में ऐसी फाइलें शामिल हो सकती हैं जहां सामग्री प्रकार image/png contentType है:

वेब
filesRef = storage.ref().child("aFilenamePrefix");

filesRef.listAll()
    .then(function(result) {
      console.log("Success: ", result.items);
    })
});

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

अगले कदम

आप क्लाउड स्टोरेज के लिए फायरबेस सुरक्षा नियमों की अपनी समझ को और गहरा कर सकते हैं:

आप क्लाउड स्टोरेज के लिए विशिष्ट फायरबेस सुरक्षा नियमों का उपयोग मामलों का पता लगा सकते हैं: