Hướng dẫn này dựa trên hướng dẫn tìm hiểu ngôn ngữ cốt lõi của Quy tắc bảo mật Firebase để hướng dẫn cách thêm điều kiện vào Quy tắc bảo mật của Cơ sở dữ liệu thời gian thực Firebase.
Thành phần chính của Quy tắc bảo mật cơ sở dữ liệu theo thời gian thực 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. Đối với các quy tắc cơ bản, việc sử dụng giá trị cố định true
và false
làm điều kiện sẽ hoạt động rất hiệu quả. Tuy nhiên, ngôn ngữ của Quy tắc bảo mật cơ sở dữ liệu theo thời gian thực cung cấp cho bạn các cách viết những điều kiện phức tạp hơn, có thể:
- Kiểm tra quy trình xác thực người dùng
- Đánh giá dữ liệu hiện có dựa trên dữ liệu mới gửi
- Truy cập và so sánh các phần khác nhau của cơ sở dữ liệu
- Xác thực dữ liệu đến
- Sử dụng cấu trúc của truy vấn đến cho logic bảo mật
Sử dụng biến $ để ghi lại các phân đoạn đường dẫn
Bạn có thể ghi lại các phần của đường dẫn để đọc hoặc ghi bằng cách khai báo các biến thu thập bằng tiền tố $
.
Đây là ký tự đại diện và lưu trữ giá trị của khoá đó để sử dụng bên trong các điều kiện quy tắc:
{ "rules": { "rooms": { // this rule applies to any child of /rooms/, the key for each room id // is stored inside $room_id variable for reference "$room_id": { "topic": { // the room's topic can be changed if the room id has "public" in it ".write": "$room_id.contains('public')" } } } } }
Bạn cũng có thể sử dụng song song các biến $
động với tên đường dẫn hằng số. Trong ví dụ này, chúng ta đang sử dụng biến $other
để khai báo quy tắc .validate
nhằm đảm bảo rằng widget
không có phần tử con nào khác ngoài title
và color
.
Mọi thao tác ghi dẫn đến việc tạo thêm phần tử con sẽ không thành công.
{ "rules": { "widget": { // a widget can have a title or color attribute "title": { ".validate": true }, "color": { ".validate": true }, // but no other child paths are allowed // in this case, $other means any key excluding "title" and "color" "$other": { ".validate": false } } } }
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.
Nếu ứng dụng của bạn sử dụng tính năng Xác thực Firebase, 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.
Firebase Authentication tích hợp với Firebase Realtime Database để cho phép bạn kiểm soát quyền truy cập vào dữ liệu trên cơ sở từng người dùng bằng các điều kiện. Sau khi người dùng xác thực, biến auth
trong quy tắc Quy tắc bảo mật cơ sở dữ liệu theo thời gian thực sẽ được điền thông tin của người dùng. Thông tin này bao gồm giá trị nhận dạng duy nhất của họ (uid
) cũng như dữ liệu tài khoản được liên kết, chẳng hạn như mã nhận dạng trên Facebook hoặc địa chỉ email và các thông tin khác. Nếu triển khai trình cung cấp xác thực tuỳ chỉnh, bạn có thể thêm các trường của riêng mình vào tải trọng xác thực của người dùng.
Phần này giải thích cách kết hợp ngôn ngữ của Quy tắc bảo mật cơ sở dữ liệu theo thời gian thực Firebase với thông tin xác thực về người dùng của bạn. Bằng cách kết hợp hai khái niệm này, bạn có thể kiểm soát quyền truy cập vào dữ liệu dựa trên danh tính của người dùng.
Biến auth
Biến auth
được xác định trước trong các quy tắc sẽ có giá trị rỗng trước khi quá trình xác thực diễn ra.
Sau khi người dùng được xác thực bằng Xác thực Firebase, mã thông báo sẽ chứa các thuộc tính sau:
nhà cung cấp | Phương thức xác thực được sử dụng ("matkhau", "anonymous", "facebook", "github", "google", hoặc "twitter"). |
uid | Mã nhận dạng người dùng duy nhất, được đảm bảo là duy nhất trên tất cả các nhà cung cấp. |
mã thông báo |
Nội dung của mã thông báo Firebase Auth ID. Hãy xem tài liệu tham khảo cho
auth.token để biết thêm thông tin.
|
Dưới đây là quy tắc mẫu sử dụng biến auth
để đảm bảo rằng mỗi người dùng chỉ có thể ghi vào một đường dẫn dành riêng cho người dùng:
{ "rules": { "users": { "$user_id": { // grants write access to the owner of this user account // whose uid must exactly match the key ($user_id) ".write": "$user_id === auth.uid" } } } }
Xây dựng cơ sở dữ liệu để hỗ trợ các điều kiện xác thực
Thông thường, bạn nên xây dựng cấu trúc cơ sở dữ liệu theo cách giúp việc viết
Rules trở nên dễ dàng hơn. Một mẫu phổ biến để lưu trữ dữ liệu người dùng trong Realtime Database là lưu trữ tất cả người dùng trong một nút users
duy nhất có các phần tử con là giá trị uid
cho mọi người dùng. Nếu bạn muốn hạn chế quyền truy cập vào dữ liệu này để chỉ người dùng đã đăng nhập mới có thể xem dữ liệu của họ, thì các quy tắc của bạn sẽ có dạng như sau.
{ "rules": { "users": { "$uid": { ".read": "auth !== null && auth.uid === $uid" } } } }
Làm việc với Thông báo xác thực tuỳ chỉnh
Đối với các ứng dụng yêu cầu kiểm soát quyền truy cập tuỳ chỉnh cho nhiều người dùng, Firebase Authentication cho phép nhà phát triển đặt tuyên bố xác nhận quyền sở hữu trên người dùng Firebase.
Bạn có thể truy cập các tuyên bố này trong biếnauth.token
trong quy tắc của mình.
Dưới đây là ví dụ về các quy tắc sử dụng thông báo xác nhận quyền sở hữu tuỳ chỉnh hasEmergencyTowel
:
{ "rules": { "frood": { // A towel is about the most massively useful thing an interstellar // hitchhiker can have ".read": "auth.token.hasEmergencyTowel === true" } } }
Nhà phát triển tạo mã xác thực tuỳ chỉnh của riêng mình có thể tuỳ ý thêm thông báo xác nhận vào các mã này. Các xác nhận quyền sở hữu này có sẵn trên biến auth.token
trong quy tắc của bạn.
Dữ liệu hiện có so với dữ liệu mới
Biến data
xác định trước được dùng để tham chiếu đến dữ liệu trước khi
thực hiện thao tác ghi. Ngược lại, biến newData
chứa dữ liệu mới sẽ tồn tại nếu thao tác ghi thành công.
newData
đại diện cho kết quả hợp nhất của dữ liệu mới đang được ghi và dữ liệu hiện có.
Để minh hoạ, quy tắc này sẽ cho phép chúng tôi tạo bản ghi mới hoặc xoá các bản ghi hiện có, nhưng không thực hiện thay đổi đối với dữ liệu không rỗng hiện có:
// we can write as long as old data or new data does not exist // in other words, if this is a delete or a create, but not an update ".write": "!data.exists() || !newData.exists()"
Tham chiếu dữ liệu trong các đường dẫn khác
Có thể sử dụng bất kỳ dữ liệu nào làm tiêu chí cho các quy tắc. Bằng cách sử dụng các biến được xác định trước root
, data
và newData
, chúng ta có thể truy cập vào bất kỳ đường dẫn nào vì đường dẫn đó sẽ tồn tại trước hoặc sau sự kiện ghi.
Hãy xem xét ví dụ này, cho phép các thao tác ghi miễn là giá trị của nút /allow_writes/
là true
, nút mẹ không có cờ readOnly
và có một nút con tên là foo
trong dữ liệu mới ghi:
".write": "root.child('allow_writes').val() === true && !data.parent().child('readOnly').exists() && newData.child('foo').exists()"
Xác thực dữ liệu
Bạn nên thực thi cấu trúc dữ liệu và xác thực định dạng cũng như nội dung của dữ liệu bằng cách sử dụng các quy tắc .validate
. Các quy tắc này chỉ chạy sau khi quy tắc .write
cấp quyền truy cập thành công. Dưới đây là định nghĩa quy tắc .validate
mẫu chỉ cho phép ngày ở định dạng YYYY-MM-DD trong khoảng thời gian 1900-2099. Định nghĩa này được kiểm tra bằng một biểu thức chính quy.
".validate": "newData.isString() && newData.val().matches(/^(19|20)[0-9][0-9][-\\/. ](0[1-9]|1[012])[-\\/. ](0[1-9]|[12][0-9]|3[01])$/)"
Quy tắc .validate
là loại quy tắc bảo mật duy nhất không có hiệu lực lũy tiến. Nếu bất kỳ quy tắc xác thực nào không thành công trên bất kỳ bản ghi con nào, thì toàn bộ thao tác ghi sẽ bị từ chối.
Ngoài ra, các định nghĩa xác thực sẽ bị bỏ qua khi dữ liệu bị xoá (tức là khi giá trị mới được ghi là null
).
Những điều này có vẻ như không quan trọng, nhưng thực tế là những tính năng quan trọng để viết Quy tắc bảo mật mạnh mẽ cho Cơ sở dữ liệu thời gian thực Firebase. Hãy xem xét các quy tắc sau:
{ "rules": { // write is allowed for all paths ".write": true, "widget": { // a valid widget must have attributes "color" and "size" // allows deleting widgets (since .validate is not applied to delete rules) ".validate": "newData.hasChildren(['color', 'size'])", "size": { // the value of "size" must be a number between 0 and 99 ".validate": "newData.isNumber() && newData.val() >= 0 && newData.val() <= 99" }, "color": { // the value of "color" must exist as a key in our mythical // /valid_colors/ index ".validate": "root.child('valid_colors/' + newData.val()).exists()" } } } }
Với biến thể này, hãy xem kết quả của các thao tác ghi sau:
JavaScript
var ref = db.ref("/widget"); // PERMISSION_DENIED: does not have children color and size ref.set('foo'); // PERMISSION DENIED: does not have child color ref.set({size: 22}); // PERMISSION_DENIED: size is not a number ref.set({ size: 'foo', color: 'red' }); // SUCCESS (assuming 'blue' appears in our colors list) ref.set({ size: 21, color: 'blue'}); // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate ref.child('size').set(99);
Objective-C
FIRDatabaseReference *ref = [[[FIRDatabase database] reference] child: @"widget"]; // PERMISSION_DENIED: does not have children color and size [ref setValue: @"foo"]; // PERMISSION DENIED: does not have child color [ref setValue: @{ @"size": @"foo" }]; // PERMISSION_DENIED: size is not a number [ref setValue: @{ @"size": @"foo", @"color": @"red" }]; // SUCCESS (assuming 'blue' appears in our colors list) [ref setValue: @{ @"size": @21, @"color": @"blue" }]; // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate [[ref child:@"size"] setValue: @99];
Swift
var ref = FIRDatabase.database().reference().child("widget") // PERMISSION_DENIED: does not have children color and size ref.setValue("foo") // PERMISSION DENIED: does not have child color ref.setValue(["size": "foo"]) // PERMISSION_DENIED: size is not a number ref.setValue(["size": "foo", "color": "red"]) // SUCCESS (assuming 'blue' appears in our colors list) ref.setValue(["size": 21, "color": "blue"]) // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate ref.child("size").setValue(99);
Java
FirebaseDatabase database = FirebaseDatabase.getInstance(); DatabaseReference ref = database.getReference("widget"); // PERMISSION_DENIED: does not have children color and size ref.setValue("foo"); // PERMISSION DENIED: does not have child color ref.child("size").setValue(22); // PERMISSION_DENIED: size is not a number Map<String,Object> map = new HashMap<String, Object>(); map.put("size","foo"); map.put("color","red"); ref.setValue(map); // SUCCESS (assuming 'blue' appears in our colors list) map = new HashMap<String, Object>(); map.put("size", 21); map.put("color","blue"); ref.setValue(map); // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate ref.child("size").setValue(99);
Kiến trúc chuyển trạng thái đại diện (REST)
# PERMISSION_DENIED: does not have children color and size curl -X PUT -d 'foo' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # PERMISSION DENIED: does not have child color curl -X PUT -d '{"size": 22}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # PERMISSION_DENIED: size is not a number curl -X PUT -d '{"size": "foo", "color": "red"}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # SUCCESS (assuming 'blue' appears in our colors list) curl -X PUT -d '{"size": 21, "color": "blue"}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # If the record already exists and has a color, this will # succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) # will fail to validate curl -X PUT -d '99' \ https://docs-examples.firebaseio.com/rest/securing-data/example/size.json
Bây giờ, hãy xem cấu trúc tương tự, nhưng sử dụng quy tắc .write
thay vì .validate
:
{ "rules": { // this variant will NOT allow deleting records (since .write would be disallowed) "widget": { // a widget must have 'color' and 'size' in order to be written to this path ".write": "newData.hasChildren(['color', 'size'])", "size": { // the value of "size" must be a number between 0 and 99, ONLY IF WE WRITE DIRECTLY TO SIZE ".write": "newData.isNumber() && newData.val() >= 0 && newData.val() <= 99" }, "color": { // the value of "color" must exist as a key in our mythical valid_colors/ index // BUT ONLY IF WE WRITE DIRECTLY TO COLOR ".write": "root.child('valid_colors/'+newData.val()).exists()" } } } }
Trong biến thể này, mọi thao tác sau đây đều thành công:
JavaScript
var ref = new Firebase(URL + "/widget"); // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored ref.set({size: 99999, color: 'red'}); // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") ref.child('size').set(99);
Objective-C
Firebase *ref = [[Firebase alloc] initWithUrl:URL]; // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored [ref setValue: @{ @"size": @9999, @"color": @"red" }]; // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") [[ref childByAppendingPath:@"size"] setValue: @99];
Swift
var ref = Firebase(url:URL) // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored ref.setValue(["size": 9999, "color": "red"]) // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") ref.childByAppendingPath("size").setValue(99)
Java
Firebase ref = new Firebase(URL + "/widget"); // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored Map<String,Object> map = new HashMap<String, Object>(); map.put("size", 99999); map.put("color", "red"); ref.setValue(map); // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") ref.child("size").setValue(99);
Kiến trúc chuyển trạng thái đại diện (REST)
# ALLOWED? Even though size is invalid, widget has children color and size, # so write is allowed and the .write rule under color is ignored curl -X PUT -d '{size: 99999, color: "red"}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # ALLOWED? Works even if widget does not exist, allowing us to create a widget # which is invalid and does not have a valid color. # (allowed by the write rule under "color") curl -X PUT -d '99' \ https://docs-examples.firebaseio.com/rest/securing-data/example/size.json
Hình này minh hoạ sự khác biệt giữa quy tắc .write
và .validate
.
Như đã minh hoạ, bạn phải viết tất cả các quy tắc này bằng .validate
, với trường hợp ngoại lệ có thể xảy ra là quy tắc newData.hasChildren()
, điều này phụ thuộc vào việc có nên cho phép xoá hay không.
Quy tắc dựa trên cụm từ tìm kiếm
Mặc dù không thể sử dụng quy tắc làm bộ lọc, nhưng bạn có thể giới hạn quyền truy cập vào các nhóm nhỏ dữ liệu bằng cách sử dụng các thông số truy vấn trong quy tắc.
Sử dụng biểu thức query.
trong quy tắc để cấp quyền đọc hoặc ghi dựa trên các tham số truy vấn.
Ví dụ: quy tắc dựa trên truy vấn sau đây sử dụng các quy tắc bảo mật dựa trên người dùng và các quy tắc dựa trên truy vấn để chỉ cho phép những giỏ hàng mà người dùng đang hoạt động sở hữu truy cập vào dữ liệu trong tập hợp baskets
:
"baskets": {
".read": "auth.uid !== null &&
query.orderByChild === 'owner' &&
query.equalTo === auth.uid" // restrict basket access to owner of basket
}
Truy vấn sau đây, bao gồm các tham số truy vấn trong quy tắc, sẽ thành công:
db.ref("baskets").orderByChild("owner")
.equalTo(auth.currentUser.uid)
.on("value", cb) // Would succeed
Tuy nhiên, các truy vấn không bao gồm các tham số trong quy tắc sẽ không thành công kèm theo lỗi PermissionDenied
:
db.ref("baskets").on("value", cb) // Would fail with PermissionDenied
Bạn cũng có thể sử dụng các quy tắc dựa trên truy vấn để giới hạn lượng dữ liệu mà ứng dụng tải xuống thông qua các thao tác đọc.
Ví dụ: quy tắc sau đây chỉ giới hạn quyền đọc đối với 1.000 kết quả đầu tiên của một truy vấn, được sắp xếp theo mức độ ưu tiên:
messages: {
".read": "query.orderByKey &&
query.limitToFirst <= 1000"
}
// Example queries:
db.ref("messages").on("value", cb) // Would fail with PermissionDenied
db.ref("messages").limitToFirst(1000)
.on("value", cb) // Would succeed (default order by key)
Biểu thức query.
sau đây có trong Quy tắc bảo mật cơ sở dữ liệu theo thời gian thực.
Biểu thức quy tắc dựa trên truy vấn | ||
---|---|---|
Biểu thức | Loại | Nội dung mô tả |
query.orderByKey query.orderByPriority query.orderByValue |
boolean | Đúng đối với các truy vấn được sắp xếp theo khoá, mức độ ưu tiên hoặc giá trị. Nếu không thì giá trị sẽ là false. |
query.orderByChild | string null |
Sử dụng một chuỗi để biểu thị đường dẫn tương đối đến một nút con. Ví dụ: query.orderByChild === "address/zip" . Nếu truy vấn không được sắp xếp theo nút con, thì giá trị này sẽ rỗng.
|
query.startAt query.endAt query.equalTo |
chuỗi số boolean rỗng |
Truy xuất các giới hạn của truy vấn đang thực thi hoặc trả về giá trị rỗng nếu không có giới hạn nào được đặt. |
query.limitToFirst query.limitToLast |
số rỗng |
Truy xuất giới hạn trên truy vấn đang thực thi hoặc trả về giá trị rỗng nếu không có giới hạn nào được đặt. |
Các bước tiếp theo
Sau cuộc thảo luận về các điều kiện này, bạn đã hiểu rõ hơn về Rules và sẵn sàng:
Tìm hiểu cách xử lý các trường hợp sử dụng cốt lõi và tìm hiểu quy trình làm việc để phát triển, kiểm thử và triển khai Rules:
- Tìm hiểu về tập hợp đầy đủ các biến Rules được xác định trước mà bạn có thể sử dụng để tạo điều kiện.
- Viết các quy tắc giải quyết các trường hợp phổ biến.
- Hãy củng cố kiến thức của bạn bằng cách xem xét những tình huống mà bạn phải phát hiện và tránh các Quy tắc không an toàn.
- Tìm hiểu về Bộ mô phỏng cục bộ của Firebase và cách bạn có thể sử dụng bộ công cụ này để kiểm thử Rules.
- Xem lại các phương thức có sẵn để triển khai Rules.
Tìm hiểu các tính năng Rules dành riêng cho Realtime Database:
- Tìm hiểu cách lập chỉ mục Realtime Database.
- Xem API REST để triển khai Rules.