Quản lý và triển khai Quy tắc bảo mật của Firebase

Firebase cung cấp cho bạn một số công cụ để quản lý Security Rules, mỗi công cụ đều hữu ích trong các trường hợp cụ thể và mỗi công cụ đều sử dụng cùng một API quản lý Quy tắc bảo mật Firebase phụ trợ.

Bất kể bạn dùng công cụ nào để gọi, API quản lý đều:

  • Nhập nguồn Quy tắc: một tập hợp các quy tắc, thường là một tệp mã chứa các câu lệnh Firebase Security Rules.
  • Lưu trữ nguồn đã nhập dưới dạng ruleset không thể thay đổi.
  • Theo dõi quá trình triển khai từng nhóm quy tắc trong một bản phát hành. Các dịch vụ hỗ trợ Quy tắc bảo mật của Firebase sẽ tra cứu bản phát hành cho một dự án để đánh giá từng yêu cầu đối với tài nguyên được bảo mật.
  • Cung cấp khả năng chạy các bài kiểm thử cú pháp và ngữ nghĩa của một bộ quy tắc.

Sử dụng CLI Firebase

Với Firebase CLI, bạn có thể tải nguồn cục bộ lên và triển khai bản phát hành. Firebase Local Emulator Suite của CLI cho phép bạn thực hiện kiểm thử cục bộ đầy đủ cho nguồn.

Việc sử dụng CLI cho phép bạn giữ các quy tắc của mình trong chế độ quản lý phiên bản bằng mã xử lý ứng dụng và triển khai các quy tắc trong quy trình triển khai hiện có.

Tạo tệp cấu hình

Khi định cấu hình dự án Firebase bằng CLI Firebase, bạn sẽ tạo một tệp cấu hình .rules trong thư mục dự án. Sử dụng lệnh sau để bắt đầu định cấu hình dự án Firebase:

Cloud Firestore

// Set up Firestore in your project directory, creates a .rules file
firebase init firestore

Realtime Database

// Set up Realtime Database in your project directory, creates a .rules file
firebase init database

Cloud Storage

// Set up Storage in your project directory, creates a .rules file
firebase init storage

Chỉnh sửa và cập nhật quy tắc

Chỉnh sửa trực tiếp nguồn quy tắc trong tệp cấu hình .rules.

Đảm bảo rằng mọi nội dung chỉnh sửa bạn thực hiện trong CLI Firebase đều được phản ánh trong bảng điều khiển Firebase hoặc bạn luôn cập nhật bằng bảng điều khiển Firebase hoặc CLI Firebase. Nếu không, bạn có thể ghi đè mọi nội dung cập nhật được thực hiện trong bảng điều khiển Firebase.

Kiểm thử bản cập nhật

Local Emulator Suite cung cấp trình mô phỏng cho tất cả các sản phẩm có bật Quy tắc bảo mật. Công cụ Quy tắc bảo mật cho mỗi trình mô phỏng thực hiện cả việc đánh giá cú pháp và ngữ nghĩa của các quy tắc, do đó vượt quá khả năng kiểm thử cú pháp mà API quản lý Quy tắc bảo mật cung cấp.

Nếu bạn đang làm việc với CLI, thì Bộ công cụ này là một công cụ tuyệt vời để Firebase Security Rules thử nghiệm. Sử dụng Local Emulator Suite để kiểm thử các bản cập nhật trên thiết bị của bạn và xác nhận rằng Security Rules của ứng dụng thể hiện hành vi mà bạn muốn.

Triển khai bản cập nhật

Sau khi bạn cập nhật và kiểm thử Security Rules, hãy triển khai các nguồn cho môi trường thực tế.

Đối với Cloud Firestore Security Rules, hãy liên kết các tệp .rules với cơ sở dữ liệu mặc định và cơ sở dữ liệu có tên bổ sung bằng cách xem lại và cập nhật tệp firebase.json.

Sử dụng các lệnh sau để triển khai riêng Security Rules hoặc triển khai trong quy trình triển khai thông thường.

Cloud Firestore

// Deploy rules for all databases configured in your firebase.json
firebase deploy --only firestore:rules
// Deploy rules for the specified database configured in your firebase.json firebase deploy --only firestore:<databaseId>

Realtime Database

// Deploy your .rules file
firebase deploy --only database

Cloud Storage

// Deploy your .rules file
firebase deploy --only storage

Sử dụng bảng điều khiển Firebase

Bạn cũng có thể chỉnh sửa Security Rules nguồn và triển khai chúng dưới dạng bản phát hành từ bảng điều khiển Firebase. Kiểm thử cú pháp được thực hiện khi bạn chỉnh sửa trong giao diện người dùng của bảng điều khiển Firebase, còn kiểm thử ngữ nghĩa được thực hiện bằng cách sử dụng Playground của Security Rules.

Chỉnh sửa và cập nhật quy tắc

  1. Mở bảng điều khiển Firebase rồi chọn dự án của bạn.
  2. Sau đó, chọn Realtime Database, Cloud Firestore hoặc Storage (Bộ nhớ) trong bảng điều hướng sản phẩm, rồi nhấp vào Rules (Quy tắc) để chuyển đến trình chỉnh sửa Security Rules.
  3. Chỉnh sửa quy tắc ngay trong trình chỉnh sửa.

Kiểm thử bản cập nhật

Ngoài việc kiểm thử cú pháp trong giao diện người dùng của trình chỉnh sửa, bạn có thể kiểm thử hành vi ngữ nghĩa của Security Rules bằng cách sử dụng tài nguyên lưu trữ và cơ sở dữ liệu của dự án, ngay trong bảng điều khiển Firebase, bằng cách sử dụng Security Rules Playground. Mở màn hình Rules Playground (Sân chơi quy tắc) trong trình chỉnh sửa Security Rules, sửa đổi chế độ cài đặt rồi nhấp vào Run (Chạy). Tìm thông báo xác nhận ở đầu trình chỉnh sửa.

Triển khai bản cập nhật

Khi bạn đã hài lòng với nội dung cập nhật, hãy nhấp vào Xuất bản.

Sử dụng SDK dành cho quản trị viên

Bạn có thể sử dụng Admin SDK cho Node.js rulesets. Với quyền truy cập có lập trình này, bạn có thể:

  • Triển khai các công cụ, tập lệnh, trang tổng quan và quy trình CI/CD tuỳ chỉnh để quản lý các quy tắc.
  • Quản lý các quy tắc dễ dàng hơn trên nhiều dự án Firebase.

Khi cập nhật các quy tắc theo phương thức lập trình, điều quan trọng là bạn phải tránh thực hiện các thay đổi ngoài ý muốn đối với chế độ kiểm soát quyền truy cập cho ứng dụng của mình. Hãy viết Admin SDK mã của bạn với ưu tiên hàng đầu là bảo mật, đặc biệt là khi cập nhật hoặc triển khai các quy tắc.

Một điều quan trọng khác cần lưu ý là các bản phát hành Firebase Security Rules mất vài phút để truyền tải đầy đủ. Khi sử dụng Admin SDK để triển khai các quy tắc, hãy nhớ tránh tình huống tương tranh, trong đó ứng dụng của bạn ngay lập tức dựa vào các quy tắc chưa hoàn tất quá trình triển khai. Nếu trường hợp sử dụng của bạn yêu cầu cập nhật thường xuyên các quy tắc kiểm soát quyền truy cập, hãy cân nhắc các giải pháp sử dụng Cloud Firestore, được thiết kế để giảm tình trạng tương tranh mặc dù cập nhật thường xuyên.

Ngoài ra, hãy lưu ý các giới hạn sau:

  • Quy tắc phải nhỏ hơn 256 KiB văn bản được mã hoá UTF-8 khi được chuyển đổi tuần tự.
  • Một dự án có thể có tổng cộng tối đa 2.500 bộ quy tắc được triển khai. Khi đạt đến giới hạn này, bạn phải xoá một số bộ quy tắc cũ trước khi tạo bộ quy tắc mới.

Tạo và triển khai bộ quy tắc Cloud Storage hoặc Cloud Firestore

Quy trình thông thường để quản lý quy tắc bảo mật bằng Admin SDK có thể bao gồm 3 bước riêng biệt:

  1. Tạo nguồn tệp quy tắc (không bắt buộc)
  2. Tạo một nhóm quy tắc
  3. Phát hành hoặc triển khai bộ quy tắc mới

SDK cung cấp một phương thức để kết hợp các bước này thành một lệnh gọi API duy nhất cho các quy tắc bảo mật Cloud Storage và Cloud Firestore. Ví dụ:

    const source = `service cloud.firestore {
      match /databases/{database}/documents {
        match /carts/{cartID} {
          allow create: if request.auth != null && request.auth.uid == request.resource.data.ownerUID;
          allow read, update, delete: if request.auth != null && request.auth.uid == resource.data.ownerUID;
        }
      }
    }`;
    // Alternatively, load rules from a file
    // const fs = require('fs');
    // const source = fs.readFileSync('path/to/firestore.rules', 'utf8');

    await admin.securityRules().releaseFirestoreRulesetFromSource(source);

Mẫu tương tự này áp dụng cho các quy tắc Cloud Storage có releaseFirestoreRulesetFromSource().

Ngoài ra, bạn có thể tạo tệp quy tắc dưới dạng đối tượng trong bộ nhớ, tạo bộ quy tắc và triển khai bộ quy tắc riêng biệt để kiểm soát chặt chẽ hơn các sự kiện này. Ví dụ:

    const rf = admin.securityRules().createRulesFileFromSource('firestore.rules', source);
    const rs = await admin.securityRules().createRuleset(rf);
    await admin.securityRules().releaseFirestoreRuleset(rs);

Cập nhật Realtime Database bộ quy tắc

Để cập nhật các nhóm quy tắc Realtime Database bằng Admin SDK, hãy sử dụng các phương thức getRules() và setRules() của admin.database. Bạn có thể truy xuất các nhóm quy tắc ở định dạng JSON hoặc dưới dạng chuỗi có kèm theo nhận xét.

Cách cập nhật một nhóm quy tắc:

    const source = `{
      "rules": {
        "scores": {
          ".indexOn": "score",
          "$uid": {
            ".read": "$uid == auth.uid",
            ".write": "$uid == auth.uid"
          }
        }
      }
    }`;
    await admin.database().setRules(source);

Quản lý bộ quy tắc

Để giúp quản lý các bộ quy tắc lớn, Admin SDK cho phép bạn liệt kê tất cả quy tắc hiện có bằng admin.securityRules().listRulesetMetadata. Ví dụ:

    const allRulesets = [];
    let pageToken = null;
    while (true) {
      const result = await admin.securityRules().listRulesetMetadata(pageToken: pageToken);
      allRulesets.push(...result.rulesets);
      pageToken = result.nextPageToken;
      if (!pageToken) {
        break;
      }
    }

Đối với các hoạt động triển khai rất lớn đạt đến giới hạn 2.500 bộ quy tắc theo thời gian, bạn có thể tạo logic để xoá các quy tắc cũ nhất theo chu kỳ thời gian cố định. Ví dụ: để xoá tất cả bộ quy tắc được triển khai trong hơn 30 ngày:

    const thirtyDays = new Date(Date.now() - THIRTY_DAYS_IN_MILLIS);
    const promises = [];
    allRulesets.forEach((rs) => {
      if (new Date(rs.createTime) < thirtyDays) {
        promises.push(admin.securityRules().deleteRuleset(rs.name));
      }
    });
    await Promise.all(promises);
    console.log(`Deleted ${promises.length} rulesets.`);

Sử dụng API REST

Các công cụ được mô tả ở trên rất phù hợp với nhiều quy trình công việc, bao gồm cả việc quản lý Firebase Security Rules cho nhiều cơ sở dữ liệu Cloud Firestore trong dự án của bạn, nhưng bạn có thể muốn quản lý và triển khai Firebase Security Rules bằng chính API quản lý. API quản lý mang lại cho bạn sự linh hoạt tối đa.

Ngoài ra, hãy lưu ý các giới hạn sau:

  • Quy tắc phải nhỏ hơn 256 KiB văn bản được mã hoá UTF-8 khi được chuyển đổi tuần tự.
  • Một dự án có thể có tổng cộng tối đa 2.500 bộ quy tắc được triển khai. Khi đạt đến giới hạn này, bạn phải xoá một số bộ quy tắc cũ trước khi tạo bộ quy tắc mới.

Tạo và triển khai bộ quy tắc Cloud Firestore hoặc Cloud Storage bằng REST

Các ví dụ trong phần này sử dụng Security Rules của Firestore, mặc dù chúng cũng áp dụng cho Cloud Storage Security Rules.

Các ví dụ này cũng sử dụng cURL để thực hiện lệnh gọi API. Các bước thiết lập và truyền mã xác thực sẽ được bỏ qua. Bạn có thể thử nghiệm API này bằng cách sử dụng Trình khám phá API được tích hợp với tài liệu tham khảo.

Các bước thông thường để tạo và triển khai một bộ quy tắc bằng API quản lý là:

  1. Tạo nguồn tệp quy tắc
  2. Tạo một nhóm quy tắc
  3. Phát hành (triển khai) bộ quy tắc mới.

Tạo nguồn

Giả sử bạn đang làm việc trên dự án Firebase secure_commerce và muốn triển khai Cloud Firestore Security Rules bị khoá cho một cơ sở dữ liệu trong dự án có tên là east_store.

Bạn có thể triển khai các quy tắc này trong tệp firestore.rules.

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if false;
    }
  }
}

Tạo một nhóm quy tắc

Bây giờ, hãy tạo một vân tay số được mã hoá base64 cho tệp này. Sau đó, bạn có thể sử dụng nguồn trong tệp này để điền tải trọng cần thiết nhằm tạo một bộ quy tắc bằng lệnh gọi REST projects.rulesets.create. Tại đây, hãy sử dụng lệnh cat để chèn nội dung của firestore.rules vào tải trọng REST.

Để theo dõi, nhằm liên kết thông tin này với cơ sở dữ liệu east_store của bạn, hãy đặt attachment_point thành east_store.

curl -X POST -d '{
  "source": {
    "files": [
      {
        "content": "' $(cat storage.rules) '",
        "name": "firestore.rules",
        "fingerprint": <sha fingerprint>
      },
    "attachment_point": "firestore.googleapis.com/databases/east_store"
    ]
  }
}' 'https://firebaserules.googleapis.com/v1/projects/secure_commerce/rulesets'

API này trả về một phản hồi xác thực và tên của một nhóm quy tắc, ví dụ: projects/secure_commerce/rulesets/uuid123.

Phát hành (triển khai) một bộ quy tắc

Nếu bộ quy tắc hợp lệ, bước cuối cùng là triển khai bộ quy tắc mới trong một bản phát hành có tên.

curl -X POST -d '{
  "name": "projects/secure_commerce/releases/cloud.firestore/east_store"  ,
  "rulesetName": "projects/secure_commerce/rulesets/uuid123"
}' 'https://firebaserules.googleapis.com/v1/projects/secure_commerce/releases'

Xin lưu ý rằng các bản phát hành Firebase Security Rules sẽ mất vài phút để triển khai đầy đủ. Khi sử dụng API REST quản lý để triển khai, hãy nhớ tránh tình huống tương tranh, trong đó ứng dụng của bạn ngay lập tức dựa vào các quy tắc chưa hoàn tất quá trình triển khai.

Cập nhật bộ quy tắc Realtime Database bằng REST

Realtime Database cung cấp giao diện REST riêng để quản lý Security Rules. Xem bài viết Quản lý Realtime Database Security Rules của Firebase thông qua REST.

Quản lý bộ quy tắc bằng REST

Để giúp quản lý các hoạt động triển khai quy tắc lớn, ngoài phương thức REST để tạo bộ quy tắc và bản phát hành, API quản lý còn cung cấp các phương thức để:

  • liệt kê, lấy và xoá bộ quy tắc
  • liệt kê, lấy và xoá bản phát hành của quy tắc

Đối với các hoạt động triển khai rất lớn đạt đến giới hạn 2.500 bộ quy tắc theo thời gian, bạn có thể tạo logic để xoá các quy tắc cũ nhất theo chu kỳ thời gian cố định. Ví dụ: để xoá tất cả bộ quy tắc được triển khai trong hơn 30 ngày, bạn có thể gọi phương thức projects.rulesets.list, phân tích cú pháp danh sách JSON của các đối tượng Ruleset trên khoá createTime, sau đó gọi project.rulesets.delete trên các bộ quy tắc tương ứng theo ruleset_id.

Kiểm thử nội dung cập nhật bằng REST

Cuối cùng, API quản lý cho phép bạn chạy các kiểm thử cú pháp và ngữ nghĩa trên tài nguyên Cloud Firestore và Cloud Storage trong các dự án phát hành công khai.

Việc kiểm thử với thành phần này của API bao gồm:

  1. Xác định một đối tượng JSON TestSuite để biểu thị một tập hợp các đối tượng TestCase
  2. Gửi TestSuite
  3. Phân tích cú pháp đã trả về TestResult đối tượng

Hãy xác định một đối tượng TestSuite có một TestCase duy nhất trong tệp testcase.json. Trong ví dụ này, chúng ta truyền nguồn ngôn ngữ Security Rules cùng dòng với tải trọng REST, cùng với bộ kiểm thử để chạy trên các quy tắc đó. Chúng tôi chỉ định một kỳ vọng đánh giá Quy tắc và yêu cầu của ứng dụng khách mà bộ quy tắc sẽ được kiểm thử. Bạn cũng có thể chỉ định mức độ hoàn chỉnh của báo cáo thử nghiệm, bằng cách sử dụng giá trị "FULL" để cho biết kết quả của tất cả biểu thức ngôn ngữ Security Rules phải được đưa vào báo cáo, bao gồm cả những biểu thức không khớp với yêu cầu.

 {
  "source":
  {
    "files":
    [
      {
        "name": "firestore.rules",
        "content": "service cloud.firestore {
          match /databases/{database}/documents {
            match /users/{userId}{
              allow read: if (request.auth.uid == userId);
            }
            function doc(subpath) {
              return get(/databases/$(database)/documents/$(subpath)).data;
            }
            function isAccountOwner(accountId) {
              return request.auth.uid == accountId 
                  || doc(/users/$(request.auth.uid)).accountId == accountId;
            }
            match /licenses/{accountId} {
              allow read: if isAccountOwner(accountId);
            }
          }
        }"
      }
    ]
  },
  "testSuite":
  {
    "testCases":
    [
      {
        "expectation": "ALLOW",
        "request": {
           "auth": {"uid": "123"},
           "path": "/databases/(default)/documents/licenses/abcd",
           "method": "get"},
        "functionMocks": [
            {
            "function": "get",
            "args": [{"exact_value": "/databases/(default)/documents/users/123"}],
            "result": {"value": {"data": {"accountId": "abcd"}}}
            }
          ]
      }
    ]
  }
}

Sau đó, chúng ta có thể gửi TestSuite này để đánh giá bằng phương thức projects.test.

curl -X POST -d '{
    ' $(cat testcase.json) '
}' 'https://firebaserules.googleapis.com/v1/projects/secure_commerce/rulesets/uuid123:test'

TestReport được trả về (chứa trạng thái THÀNH CÔNG/THẤT BẠI của kiểm thử, danh sách thông báo gỡ lỗi, danh sách biểu thức Quy tắc đã truy cập và báo cáo đánh giá của các biểu thức đó) sẽ xác nhận bằng trạng thái THÀNH CÔNG rằng quyền truy cập được cho phép đúng cách.

Quản lý quyền cho Cloud Storage Security Rules giữa các dịch vụ

Nếu bạn tạo Cloud Storage Security Rules sử dụng nội dung tài liệu Cloud Firestore để đánh giá các điều kiện bảo mật, bạn sẽ được nhắc trong bảng điều khiển Firebase hoặc CLI Firebase để bật quyền kết nối hai sản phẩm.

Nếu bạn quyết định tắt tính năng bảo mật trên nhiều dịch vụ:

  1. Trước tiên, trước khi tắt tính năng này, hãy chỉnh sửa các quy tắc của bạn, xoá tất cả các câu lệnh sử dụng hàm Security Rules để truy cập vào Cloud Firestore. Nếu không, sau khi tính năng này bị tắt, các hoạt động đánh giá Security Rules sẽ khiến các yêu cầu về Storage của bạn không thành công.

  2. Sử dụng trang IAM trong Google Cloud Console để xoá vai trò "Firebase Rules Firestore Service Agent" (Tác nhân dịch vụ Firestore của Quy tắc Firebase) bằng cách làm theo hướng dẫn của Cloud về cách thu hồi vai trò.

Bạn sẽ được nhắc bật lại tính năng này vào lần tiếp theo bạn lưu Quy tắc liên dịch vụ từ CLI Firebase hoặc bảng điều khiển Firebase.