Check out what’s new from Firebase at Google I/O 2022. Learn more

Kullanıcılar ve gruplar için güvenli veri erişimi

Birçok ortak çalışma uygulaması, kullanıcıların bir dizi izin temelinde farklı veri parçalarını okumasına ve yazmasına olanak tanır. Örneğin, bir belge düzenleme uygulamasında kullanıcılar, istenmeyen erişimi engellerken birkaç kullanıcının belgelerini okumasına ve yazmasına izin vermek isteyebilir.

Çözüm: Rol Tabanlı Erişim Kontrolü

Uygulamanızda rol tabanlı erişim denetimi uygulamak için Cloud Firestore'un veri modelinden ve özel güvenlik kurallarından yararlanabilirsiniz.

Kullanıcıların aşağıdaki güvenlik gereksinimleriyle "hikayeler" ve "yorumlar" oluşturabilecekleri ortak bir yazma uygulaması oluşturduğunuzu varsayalım:

  • Her hikayenin bir sahibi vardır ve "yazarlar", "yorumcular" ve "okuyucularla" paylaşılabilir.
  • Okuyucular yalnızca hikayeleri ve yorumları görebilir. Hiçbir şeyi düzenleyemezler.
  • Yorum yapanlar , okuyucuların tüm erişimine sahiptir ve ayrıca bir hikayeye yorum ekleyebilirler.
  • Yazarlar , yorum yapanların tüm erişimine sahiptir ve ayrıca hikaye içeriğini de düzenleyebilirler.
  • Sahipler , bir hikayenin herhangi bir bölümünü düzenleyebilir ve diğer kullanıcıların erişimini kontrol edebilir.

Veri yapısı

Uygulamanızın, her belgenin bir hikayeyi temsil ettiği bir stories koleksiyonu olduğunu varsayalım. Her hikayenin ayrıca, her belgenin o hikaye hakkında bir yorum olduğu bir comments alt koleksiyonu vardır.

Erişim rollerini takip etmek için, rollere kullanıcı kimliklerinin haritası olan bir roles alanı ekleyin:

/hikayeler/{storyid}

{
  title: "A Great Story",
  content: "Once upon a time ...",
  roles: {
    alice: "owner",
    bob: "reader",
    david: "writer",
    jane: "commenter"
    // ...
  }
}

Yorumlar, yazarın kullanıcı kimliği ve bazı içerikler olmak üzere yalnızca iki alan içerir:

/stories/{storyid}/comments/{commentid}

{
  user: "alice",
  content: "I think this is a great story!"
}

Tüzük

Artık veritabanında kayıtlı kullanıcı rolleriniz olduğuna göre, bunları doğrulamak için Güvenlik Kuralları yazmanız gerekir. Bu kurallar, uygulamanın Firebase Auth kullandığını varsayar, böylece request.auth.uid değişkeni kullanıcının kimliği olur.

Adım 1 : Hikayeler ve yorumlar için boş kurallar içeren bir temel kurallar dosyasıyla başlayın:

service cloud.firestore {
   match /databases/{database}/documents {
     match /stories/{story} {
         // TODO: Story rules go here...

         match /comments/{comment} {
            // TODO: Comment rules go here...
         }
     }
   }
}

Adım 2 : Sahiplere hikayeler üzerinde tam kontrol sağlayan basit bir write kuralı ekleyin. Tanımlanan işlevler, bir kullanıcının rollerini ve yeni belgelerin geçerli olup olmadığını belirlemeye yardımcı olur:

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} {
            // ...
         }
     }
   }
}

3. Adım : Herhangi bir roldeki bir kullanıcının hikayeleri ve yorumları okumasına izin veren kurallar yazın. Önceki adımda tanımlanan işlevlerin kullanılması, kuralların kısa ve öz olmasını ve okunabilir olmasını sağlar:

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']);
        }
     }
   }
}

Adım 4 : Hikaye yazarlarının, yorum yapanların ve sahiplerin yorum göndermesine izin verin. Bu kuralın ayrıca, yorumun owner istekte bulunan kullanıcıyla eşleştiğini doğruladığını ve bu da kullanıcıların birbirlerinin yorumları üzerine yazmalarını engellediğini unutmayın:

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;
        }
     }
   }
}

Adım 5 : Yazarlara hikaye içeriğini düzenleme yeteneği verin, ancak hikaye rollerini düzenleme veya belgenin diğer özelliklerini değiştirme yeteneği vermeyin. Yazarlar yalnızca hikayeleri güncelleyebildiğinden, bu, hikaye write kuralını create , update ve delete için ayrı kurallara bölmeyi gerektirir:

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;
        }
     }
   }
}

sınırlamalar

Yukarıda gösterilen çözüm, Güvenlik Kuralları kullanılarak kullanıcı verilerinin güvenliğinin sağlandığını göstermektedir, ancak aşağıdaki sınırlamaların farkında olmalısınız:

  • Ayrıntı düzeyi : Yukarıdaki örnekte, birden çok rol (yazar ve sahip), aynı belgeye farklı sınırlamalarla yazma erişimine sahiptir. Daha karmaşık belgelerle bunu yönetmek zor olabilir ve tek belgeleri, her biri tek bir role ait birden çok belgeye bölmek daha iyi olabilir.
  • Büyük Gruplar : Çok büyük veya karmaşık gruplarla paylaşmanız gerekiyorsa, rollerin hedef belgedeki bir alan yerine kendi koleksiyonlarında depolandığı bir sistem düşünün.