साथ मिलकर काम करने की सुविधा देने वाले कई ऐप्लिकेशन, उपयोगकर्ताओं को अनुमतियों के सेट के आधार पर, अलग-अलग डेटा को पढ़ने और उसमें बदलाव करने की अनुमति देते हैं. उदाहरण के लिए, दस्तावेज़ में बदलाव करने वाले ऐप्लिकेशन में, उपयोगकर्ता कुछ लोगों को अपने दस्तावेज़ पढ़ने और उनमें बदलाव करने की अनुमति दे सकते हैं. साथ ही, वे अनचाहे ऐक्सेस को ब्लॉक कर सकते हैं.
समाधान: रोल के हिसाब से ऐक्सेस कंट्रोल
अपने ऐप्लिकेशन में भूमिका के आधार पर ऐक्सेस कंट्रोल लागू करने के लिए, Cloud Firestore के डेटा मॉडल के साथ-साथ कस्टम सुरक्षा नियमों का फ़ायदा लिया जा सकता है.
मान लें कि आपने एक ऐसा ऐप्लिकेशन बनाया है जिसमें लोग मिलकर लिख सकते हैं. इसमें, उपयोगकर्ताओं को सुरक्षा से जुड़ी इन ज़रूरी शर्तों के साथ "स्टोरी" और "टिप्पणियां" बनाने की सुविधा मिलती है:
- हर कहानी का एक मालिक होता है. इसे "लेखकों", "टिप्पणी करने वालों", और "पाठकों" के साथ शेयर किया जा सकता है.
- पाठक सिर्फ़ स्टोरी और टिप्पणियां देख सकते हैं. वे किसी भी चीज़ में बदलाव नहीं कर सकते.
- टिप्पणी करने वाले लोगों के पास, स्टोरी में टिप्पणी करने का पूरा ऐक्सेस होता है. वे किसी स्टोरी में टिप्पणी भी कर सकते हैं.
- लेखकों के पास टिप्पणी करने वालों के सभी ऐक्सेस होते हैं. साथ ही, वे स्टोरी के कॉन्टेंट में भी बदलाव कर सकते हैं.
- मालिक, स्टोरी के किसी भी हिस्से में बदलाव कर सकते हैं. साथ ही, वे दूसरे उपयोगकर्ताओं के ऐक्सेस को कंट्रोल कर सकते हैं.
डेटा स्ट्रक्चर
मान लें कि आपके ऐप्लिकेशन में एक stories
कलेक्शन है, जिसमें हर दस्तावेज़ किसी कहानी को दिखाता है. हर कहानी का एक comments
सब-कलेक्शन भी होता है, जहां हर दस्तावेज़ उस स्टोरी पर की गई टिप्पणी होती है.
ऐक्सेस की भूमिकाओं को ट्रैक करने के लिए, roles
फ़ील्ड जोड़ें जो कि भूमिकाओं के यूज़र आईडी का मैप होता है:
/stories/{storyid}
{
title: "A Great Story",
content: "Once upon a time ...",
roles: {
alice: "owner",
bob: "reader",
david: "writer",
jane: "commenter"
// ...
}
}
टिप्पणियों में सिर्फ़ दो फ़ील्ड होते हैं: टिप्पणी करने वाले का उपयोगकर्ता आईडी और कुछ कॉन्टेंट:
/stories/{storyid}/comments/{commentid}
{
user: "alice",
content: "I think this is a great story!"
}
नियम
अब डेटाबेस में उपयोगकर्ताओं की भूमिकाएं रिकॉर्ड कर ली गई हैं. इसलिए, अब उनकी पुष्टि करने के लिए आपको सुरक्षा के नियम लिखने होंगे. इन नियमों में यह माना जाता है कि ऐप्लिकेशन
Firebase पुष्टि का इस्तेमाल करता है, ताकि request.auth.uid
वैरिएबल, उपयोगकर्ता का आईडी हो.
पहला चरण: नियमों की एक सामान्य फ़ाइल से शुरू करें, जिसमें स्टोरी और टिप्पणियों के लिए खाली नियम शामिल हों:
service cloud.firestore {
match /databases/{database}/documents {
match /stories/{story} {
// TODO: Story rules go here...
match /comments/{comment} {
// TODO: Comment rules go here...
}
}
}
}
दूसरा चरण: एक आसान write
नियम जोड़ें, जो मालिकों को स्टोरी पर पूरा कंट्रोल देता है. तय किए गए फ़ंक्शन से, उपयोगकर्ता की भूमिकाएं तय करने में मदद मिलती है. साथ ही, इनसे यह भी पता चलता है कि नए दस्तावेज़ मान्य हैं या नहीं:
service cloud.firestore {
match /databases/{database}/documents {
match /stories/{story} {
function isSignedIn() {
return request.auth != null;
}
function getRole(rsc) {
// Read from the "roles" map in the resource (rsc).
return rsc.data.roles[request.auth.uid];
}
function isOneOfRoles(rsc, array) {
// Determine if the user is one of an array of roles
return isSignedIn() && (getRole(rsc) in array);
}
function isValidNewStory() {
// Valid if story does not exist and the new story has the correct owner.
return resource == null && isOneOfRoles(request.resource, ['owner']);
}
// Owners can read, write, and delete stories
allow write: if isValidNewStory() || isOneOfRoles(resource, ['owner']);
match /comments/{comment} {
// ...
}
}
}
}
तीसरा चरण: ऐसे नियम लिखें जिनसे किसी भी भूमिका वाले उपयोगकर्ता को कहानियां और टिप्पणियां पढ़ने की अनुमति मिल सके. पिछले चरण में तय किए गए फ़ंक्शन का इस्तेमाल करने से, नियम कम शब्दों में और आसानी से पढ़े जा सकते हैं:
service cloud.firestore {
match /databases/{database}/documents {
match /stories/{story} {
function isSignedIn() {
return request.auth != null;
}
function getRole(rsc) {
return rsc.data.roles[request.auth.uid];
}
function isOneOfRoles(rsc, array) {
return isSignedIn() && (getRole(rsc) in array);
}
function isValidNewStory() {
return resource == null
&& request.resource.data.roles[request.auth.uid] == 'owner';
}
allow write: if isValidNewStory() || isOneOfRoles(resource, ['owner']);
// Any role can read stories.
allow read: if isOneOfRoles(resource, ['owner', 'writer', 'commenter', 'reader']);
match /comments/{comment} {
// Any role can read comments.
allow read: if isOneOfRoles(get(/databases/$(database)/documents/stories/$(story)),
['owner', 'writer', 'commenter', 'reader']);
}
}
}
}
चौथा चरण: कहानी के लेखकों, टिप्पणी करने वालों, और मालिकों को टिप्पणी करने की अनुमति दें.
ध्यान दें कि यह नियम इस बात की भी पुष्टि करता है कि टिप्पणी का owner
, अनुरोध करने वाले उपयोगकर्ता से मेल खाता है.
इससे उपयोगकर्ता एक-दूसरे की टिप्पणियों पर नहीं लिख सकते:
service cloud.firestore {
match /databases/{database}/documents {
match /stories/{story} {
function isSignedIn() {
return request.auth != null;
}
function getRole(rsc) {
return rsc.data.roles[request.auth.uid];
}
function isOneOfRoles(rsc, array) {
return isSignedIn() && (getRole(rsc) in array);
}
function isValidNewStory() {
return resource == null
&& request.resource.data.roles[request.auth.uid] == 'owner';
}
allow write: if isValidNewStory() || isOneOfRoles(resource, ['owner'])
allow read: if isOneOfRoles(resource, ['owner', 'writer', 'commenter', 'reader']);
match /comments/{comment} {
allow read: if isOneOfRoles(get(/databases/$(database)/documents/stories/$(story)),
['owner', 'writer', 'commenter', 'reader']);
// Owners, writers, and commenters can create comments. The
// user id in the comment document must match the requesting
// user's id.
//
// Note: we have to use get() here to retrieve the story
// document so that we can check the user's role.
allow create: if isOneOfRoles(get(/databases/$(database)/documents/stories/$(story)),
['owner', 'writer', 'commenter'])
&& request.resource.data.user == request.auth.uid;
}
}
}
}
पांचवां चरण: लेखकों को कहानी के कॉन्टेंट में बदलाव करने की अनुमति दें. हालांकि, उन्हें कहानी में भूमिकाओं में बदलाव करने या दस्तावेज़ की किसी अन्य प्रॉपर्टी में बदलाव करने की अनुमति न दें. इसके लिए, write
के नियमों को create
, update
, और delete
के लिए अलग-अलग नियमों में बांटना ज़रूरी है, क्योंकि लेखक सिर्फ़ खबरों को अपडेट कर सकते हैं:
service cloud.firestore {
match /databases/{database}/documents {
match /stories/{story} {
function isSignedIn() {
return request.auth != null;
}
function getRole(rsc) {
return rsc.data.roles[request.auth.uid];
}
function isOneOfRoles(rsc, array) {
return isSignedIn() && (getRole(rsc) in array);
}
function isValidNewStory() {
return request.resource.data.roles[request.auth.uid] == 'owner';
}
function onlyContentChanged() {
// Ensure that title and roles are unchanged and that no new
// fields are added to the document.
return request.resource.data.title == resource.data.title
&& request.resource.data.roles == resource.data.roles
&& request.resource.data.keys() == resource.data.keys();
}
// Split writing into creation, deletion, and updating. Only an
// owner can create or delete a story but a writer can update
// story content.
allow create: if isValidNewStory();
allow delete: if isOneOfRoles(resource, ['owner']);
allow update: if isOneOfRoles(resource, ['owner'])
|| (isOneOfRoles(resource, ['writer']) && onlyContentChanged());
allow read: if isOneOfRoles(resource, ['owner', 'writer', 'commenter', 'reader']);
match /comments/{comment} {
allow read: if isOneOfRoles(get(/databases/$(database)/documents/stories/$(story)),
['owner', 'writer', 'commenter', 'reader']);
allow create: if isOneOfRoles(get(/databases/$(database)/documents/stories/$(story)),
['owner', 'writer', 'commenter'])
&& request.resource.data.user == request.auth.uid;
}
}
}
}
सीमाएं
ऊपर दिए गए समाधान में, सुरक्षा नियमों का इस्तेमाल करके उपयोगकर्ता के डेटा को सुरक्षित करने का तरीका बताया गया है. हालांकि, आपको इन सीमाओं के बारे में पता होना चाहिए:
- ज़्यादा जानकारी: ऊपर दिए गए उदाहरण में, एक ही दस्तावेज़ के लिए, लेखक और मालिक की भूमिकाओं के लिए, लिखने का ऐक्सेस अलग-अलग है. ज़्यादा जटिल दस्तावेज़ों के साथ, इसे मैनेज करना मुश्किल हो सकता है. इसलिए, एक दस्तावेज़ को कई दस्तावेज़ों में बांटना बेहतर होगा.
- बड़े ग्रुप: अगर आपको बहुत बड़े या जटिल ग्रुप के साथ शेयर करना है, तो ऐसे सिस्टम का इस्तेमाल करें जहां भूमिकाएं, टारगेट दस्तावेज़ पर फ़ील्ड के तौर पर सेव होने के बजाय, अपने कलेक्शन में सेव होती हैं.