Kullanıcılar ve gruplar için veri erişimini güvenli hale getirin

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

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

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 koşullarıyla "hikayeler" ve "yorumlar" oluşturabileceği ortak bir yazma uygulaması geliştirdiğinizi varsayalım:

  • Her hikayenin bir sahibi vardır ve hikayeler "yazarlar", "yorumcular" ve "okuyucular" ile paylaşılabilir.
  • Okuyucular yalnızca hikayeleri ve yorumları görebilir. Hiçbir öğeyi düzenleyemezler.
  • Yorumcular, okuyucuların tüm erişim haklarına sahiptir ve hikayelere yorum ekleyebilir.
  • Yazarlar, yorumcuların sahip olduğu tüm erişim haklarına sahiptir ve haber içeriğini de düzenleyebilir.
  • 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ızda her belgenin bir hikayeyi temsil ettiği bir stories koleksiyonu olduğunu varsayalım. Her hikayenin ayrıca bir comments alt koleksiyonu vardır. Bu alt koleksiyondaki her doküman, ilgili hikayeyle ilgili bir yorumdur.

Erişim rollerini takip etmek için kullanıcı kimliklerini rollerle eşleyen bir roles alanı ekleyin:

/stories/{storyid}

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

Yorumlar yalnızca iki alan içerir: yazarın kullanıcı kimliği ve içerik:

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

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

Kurallar

Kullanıcıların rollerini veritabanına kaydettiğinize 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.

1. adım: Hikayeler ve yorumlar için boş kurallar içeren temel bir kural 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...
         }
     }
   }
}

2. adım: Sahiplere hikayeler üzerinde tam kontrol sağlayan basit bir write kuralı ekleyin. Tanımlanan işlevler, 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 role sahip kullanıcıların hikayeleri ve yorumları okumasına izin veren kurallar yazın. Önceki adımda tanımlanan işlevleri kullanmak, kuralları kısa ve okunabilir tutar:

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

4. adım: Hikaye yazarlarının, yorumcuların ve sahiplerinin yorum yayınlamasına izin verin. Bu kuralın, yorumun owner değerinin istekte bulunan kullanıcıyla eşleştiğini de doğruladığını ve böylece kullanıcıların birbirlerinin yorumlarının üzerine yazması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;
        }
     }
   }
}

5. adım: Yazarlara hikaye içeriğini düzenleme yetkisi verin ancak hikaye rollerini düzenleme veya dokümanın diğer özelliklerini değiştirme yetkisi vermeyin. Yazarlar yalnızca hikayeleri güncelleyebildiğinden, hikayeler write kuralının create, update ve delete için ayrı kurallara bölünmesi gerekir:

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, kullanıcı verilerinin güvenlik kuralları kullanılarak nasıl güvence altına alınacağını gösterir ancak aşağıdaki sınırlamalara dikkat etmeniz gerekir:

  • Ayrıntı düzeyi: Yukarıdaki örnekte, birden fazla rol (yazar ve sahip) aynı dokümana yazma erişimine sahiptir ancak farklı sınırlamalar vardır. Bu durum, daha karmaşık belgelerde yönetimi zorlaştırabilir. Bu nedenle, tek bir belgeyi her biri tek bir role ait olan birden fazla belgeye bölmek daha iyi olabilir.
  • Büyük Gruplar: Çok büyük veya karmaşık gruplarla paylaşım yapmanız gerekiyorsa rollerin hedef dokümanda bir alan olarak değil, kendi koleksiyonlarında depolandığı bir sistem kullanabilirsiniz.