Điều kiện ghi cho Quy tắc bảo mật của Cloud Firestore

Hướng dẫn này dựa trên hướng dẫn sắp xếp các quy tắc bảo mật để cho biết cách thêm điều kiện vào Cloud Firestore Security Rules. Nếu bạn chưa quen với các kiến thức cơ bản về Cloud Firestore Security Rules, hãy xem hướng dẫn bắt đầu sử dụng.

Khối xây dựng chính của Cloud Firestore Security Rules là điều kiện. Điều kiện là một biểu thức boolean xác định xem một thao tác cụ thể có được cho phép hay bị từ chối. Sử dụng quy tắc bảo mật để viết các điều kiện kiểm tra quy trình xác thực người dùng, xác thực dữ liệu đến hoặc thậm chí truy cập vào các phần khác của cơ sở dữ liệu.

Xác thực

Một trong những mẫu quy tắc bảo mật phổ biến nhất là kiểm soát quyền truy cập dựa trên trạng thái xác thực của người dùng. Ví dụ: ứng dụng của bạn có thể chỉ cho phép người dùng đã đăng nhập ghi dữ liệu:

service cloud.firestore {
  match /databases/{database}/documents {
    // Allow the user to access documents in the "cities" collection
    // only if they are authenticated.
    match /cities/{city} {
      allow read, write: if request.auth != null;
    }
  }
}

Một mẫu phổ biến khác là đảm bảo người dùng chỉ có thể đọc và ghi dữ liệu của riêng họ:

service cloud.firestore {
  match /databases/{database}/documents {
    // Make sure the uid of the requesting user matches name of the user
    // document. The wildcard expression {userId} makes the userId variable
    // available in rules.
    match /users/{userId} {
      allow read, update, delete: if request.auth != null && request.auth.uid == userId;
      allow create: if request.auth != null;
    }
  }
}

Nếu ứng dụng của bạn sử dụng tính năng Xác thực Firebase hoặc Google Cloud Identity Platform, thì biến request.auth sẽ chứa thông tin xác thực cho ứng dụng khách yêu cầu dữ liệu. Để biết thêm thông tin về request.auth, hãy xem tài liệu tham khảo.

Xác thực dữ liệu

Nhiều ứng dụng lưu trữ thông tin kiểm soát quyền truy cập dưới dạng các trường trên tài liệu trong cơ sở dữ liệu. Cloud Firestore Security Rules có thể linh động cho phép hoặc từ chối quyền truy cập dựa trên dữ liệu tài liệu:

service cloud.firestore {
  match /databases/{database}/documents {
    // Allow the user to read data if the document has the 'visibility'
    // field set to 'public'
    match /cities/{city} {
      allow read: if resource.data.visibility == 'public';
    }
  }
}

Biến resource tham chiếu đến tài liệu được yêu cầu và resource.data là một bản đồ của tất cả các trường và giá trị được lưu trữ trong tài liệu. Để biết thêm thông tin về biến resource, hãy xem tài liệu tham khảo.

Khi ghi dữ liệu, bạn có thể muốn so sánh dữ liệu đến với dữ liệu hiện có. Trong trường hợp này, nếu quy tắc của bạn cho phép ghi đang chờ xử lý, thì biến request.resource sẽ chứa trạng thái tương lai của tài liệu. Đối với các thao tác update chỉ chỉnh sửa một tập hợp con của các trường tài liệu, biến request.resource sẽ chứa trạng thái tài liệu đang chờ xử lý sau thao tác. Bạn có thể kiểm tra các giá trị trường trong request.resource để ngăn chặn việc cập nhật dữ liệu không mong muốn hoặc không nhất quán:

service cloud.firestore {
  match /databases/{database}/documents {
    // Make sure all cities have a positive population and
    // the name is not changed
    match /cities/{city} {
      allow update: if request.resource.data.population > 0
                    && request.resource.data.name == resource.data.name;
    }
  }
}

Truy cập vào các tài liệu khác

Khi sử dụng các hàm get() và exists(), quy tắc bảo mật của bạn có thể đánh giá các yêu cầu đến dựa trên các tài liệu khác trong cơ sở dữ liệu. Cả hàm get() và exists() đều yêu cầu đường dẫn tài liệu được chỉ định đầy đủ. Khi sử dụng các biến để tạo đường dẫn cho get() và exists(), bạn cần thoát các biến một cách rõ ràng bằng cách sử dụng cú pháp $(variable).

Trong ví dụ bên dưới, biến database được thu thập bằng câu lệnh khớp match /databases/{database}/documents và được dùng để tạo đường dẫn:

service cloud.firestore {
  match /databases/{database}/documents {
    match /cities/{city} {
      // Make sure a 'users' document exists for the requesting user before
      // allowing any writes to the 'cities' collection
      allow create: if request.auth != null && exists(/databases/$(database)/documents/users/$(request.auth.uid));

      // Allow the user to delete cities if their user document has the
      // 'admin' field set to 'true'
      allow delete: if request.auth != null && get(/databases/$(database)/documents/users/$(request.auth.uid)).data.admin == true;
    }
  }
}

Đối với các hoạt động ghi, bạn có thể sử dụng hàm getAfter() để truy cập trạng thái của tài liệu sau khi một giao dịch hoặc lô ghi hoàn tất nhưng trước khi giao dịch hoặc lô ghi đó được xác nhận. Giống như get(), hàm getAfter() sẽ lấy một đường dẫn tài liệu được chỉ định đầy đủ. Bạn có thể sử dụng getAfter() để xác định các tập hợp ghi phải diễn ra cùng nhau dưới dạng một giao dịch hoặc lô.

Giới hạn cuộc gọi truy cập

Có giới hạn về số lệnh gọi truy cập tài liệu cho mỗi lần đánh giá bộ quy tắc:

  • 10 đối với yêu cầu về một tài liệu và yêu cầu truy vấn.

  • 20 đối với các hoạt động đọc, giao dịch và ghi hàng loạt nhiều tài liệu. Giới hạn trước đó là 10 cũng áp dụng cho từng thao tác.

    Ví dụ: giả sử bạn tạo một yêu cầu ghi hàng loạt với 3 thao tác ghi và quy tắc bảo mật của bạn sử dụng 2 lệnh gọi truy cập tài liệu để xác thực từng thao tác ghi. Trong trường hợp này, mỗi lệnh ghi sử dụng 2 trong số 10 lệnh gọi truy cập và yêu cầu ghi hàng loạt sử dụng 6 trong số 20 lệnh gọi truy cập.

Nếu vượt quá một trong hai giới hạn này, bạn sẽ gặp lỗi từ chối cấp quyền. Một số lệnh gọi truy cập tài liệu có thể được lưu vào bộ nhớ đệm và các lệnh gọi được lưu vào bộ nhớ đệm sẽ không được tính vào hạn mức.

Để biết nội dung giải thích chi tiết về mức độ ảnh hưởng của các giới hạn này đến giao dịch và các thao tác ghi hàng loạt, hãy xem hướng dẫn về cách bảo mật các thao tác nguyên tử.

Quyền truy cập vào cuộc gọi và giá

Việc sử dụng các hàm này sẽ thực thi một thao tác đọc trong cơ sở dữ liệu, nghĩa là bạn sẽ bị tính phí để đọc tài liệu ngay cả khi quy tắc của bạn từ chối yêu cầu. Hãy xem phần Giá Cloud Firestore để biết thêm thông tin cụ thể về việc thanh toán.

Hàm tuỳ chỉnh

Khi các quy tắc bảo mật trở nên phức tạp hơn, bạn nên gói các tập hợp điều kiện trong các hàm mà bạn có thể sử dụng lại trên quy tắc của mình. Quy tắc bảo mật hỗ trợ các hàm tuỳ chỉnh. Cú pháp cho các hàm tuỳ chỉnh hơi giống với JavaScript, nhưng các hàm quy tắc bảo mật được viết bằng ngôn ngữ dành riêng cho miền có một số hạn chế quan trọng:

  • Hàm chỉ có thể chứa một câu lệnh return. Các hàm này không thể chứa bất kỳ logic bổ sung nào. Ví dụ: các hàm này không thể thực thi vòng lặp hoặc gọi các dịch vụ bên ngoài.
  • Các hàm có thể tự động truy cập vào các hàm và biến từ phạm vi được xác định. Ví dụ: một hàm được xác định trong phạm vi service cloud.firestore có quyền truy cập vào biến resource và các hàm tích hợp sẵn như get() và exists().
  • Hàm có thể gọi các hàm khác nhưng không được đệ quy. Tổng chiều sâu ngăn xếp lệnh gọi được giới hạn ở mức 10.
  • Trong quy tắc phiên bản v2, các hàm có thể xác định biến bằng cách sử dụng từ khoá let. Hàm có thể có tối đa 10 liên kết let, nhưng phải kết thúc bằng câu lệnh trả về.

Hàm được xác định bằng từ khoá function và nhận từ 0 đến nhiều đối số. Ví dụ: bạn có thể muốn kết hợp hai loại điều kiện được sử dụng trong các ví dụ trên thành một hàm duy nhất:

service cloud.firestore {
  match /databases/{database}/documents {
    // True if the user is signed in or the requested data is 'public'
    function signedInOrPublic() {
      return request.auth.uid != null || resource.data.visibility == 'public';
    }

    match /cities/{city} {
      allow read, write: if signedInOrPublic();
    }

    match /users/{user} {
      allow read, write: if signedInOrPublic();
    }
  }
}

Việc sử dụng các hàm trong quy tắc bảo mật giúp bạn dễ bảo trì hơn khi quy tắc trở nên phức tạp hơn.

Quy tắc không phải là bộ lọc

Sau khi bạn bảo mật dữ liệu và bắt đầu viết truy vấn, hãy lưu ý rằng quy tắc bảo mật không phải là bộ lọc. Bạn không thể viết truy vấn cho tất cả tài liệu trong một tập hợp và mong đợi Cloud Firestore chỉ trả về những tài liệu mà ứng dụng hiện tại có quyền truy cập.

Ví dụ: hãy xem quy tắc bảo mật sau:

service cloud.firestore {
  match /databases/{database}/documents {
    // Allow the user to read data if the document has the 'visibility'
    // field set to 'public'
    match /cities/{city} {
      allow read: if resource.data.visibility == 'public';
    }
  }
}

Bị từ chối: Quy tắc này từ chối truy vấn sau đây vì tập hợp kết quả có thể bao gồm các tài liệu mà visibility không phải là public:

Web 
db.collection("cities").get()
    .then(function(querySnapshot) {
        querySnapshot.forEach(function(doc) {
            console.log(doc.id, " => ", doc.data());
    });
});

Được phép: Quy tắc này cho phép truy vấn sau đây vì mệnh đề where("visibility", "==", "public") đảm bảo rằng tập hợp kết quả đáp ứng điều kiện của quy tắc:

Web 
db.collection("cities").where("visibility", "==", "public").get()
    .then(function(querySnapshot) {
        querySnapshot.forEach(function(doc) {
            console.log(doc.id, " => ", doc.data());
        });
    });

Các quy tắc bảo mật Cloud Firestore đánh giá từng truy vấn dựa trên kết quả tiềm năng và từ chối yêu cầu nếu truy vấn có thể trả về một tài liệu mà ứng dụng không có quyền đọc. Truy vấn phải tuân theo các quy tắc ràng buộc do quy tắc bảo mật của bạn đặt ra. Để biết thêm về các quy tắc bảo mật và truy vấn, hãy xem phần truy vấn dữ liệu một cách an toàn.

Các bước tiếp theo