Безопасный доступ к данным для пользователей и групп

Многие приложения для совместной работы позволяют пользователям читать и записывать различные фрагменты данных на основе набора разрешений. Например, в приложении для редактирования документов пользователи могут разрешить нескольким пользователям читать и писать свои документы, блокируя нежелательный доступ.

Решение: управление доступом на основе ролей

Вы можете использовать модель данных 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 Auth, поэтому переменная request.auth.uid – это идентификатор пользователя.

Шаг 1. Начните с базового файла правил, который включает пустые правила для историй и комментариев:

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

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

Шаг 2. Добавьте простое правило 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} {
            // ...
         }
     }
   }
}

Шаг 3. Напишите правила, которые позволят пользователю с любой ролью читать истории и комментарии. Использование функций, определенных на предыдущем шаге, позволяет сделать правила краткими и понятными:

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. Разрешите авторам, комментаторам и владельцам историй публиковать комментарии. Обратите внимание, что это правило также проверяет, соответствует ли 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;
        }
     }
   }
}

Шаг 5. Предоставьте авторам возможность редактировать контент, но не роли или другие свойства документа. Для этого нужно разделить правило 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;
        }
     }
   }
}

Ограничения

Решение, показанное выше, демонстрирует защиту пользовательских данных с помощью правил безопасности, но вы должны знать о следующих ограничениях:

  • Детализация. В примере выше несколько ролей (автор и владелец) имеют доступ на запись к одному и тому же документу, но с разными ограничениями. В случае со сложными документами это может быть неудобно, поэтому лучше разделить один документ на несколько, каждый из которых будет принадлежать одной роли.
  • Большие группы. Если вам нужно поделиться с очень большими или сложными группами, рассмотрите систему, в которой роли хранятся в собственной коллекции, а не в виде поля в целевом документе.