Bật tính năng Kiểm tra ứng dụng với tính toàn vẹn của Play trên Android

Trang này chỉ cho bạn cách bật Kiểm tra ứng dụng trong ứng dụng Android, bằng cách sử dụng nhà cung cấp Play Integrity được tích hợp sẵn. Khi bật Kiểm tra ứng dụng, bạn sẽ giúp đảm bảo rằng chỉ ứng dụng của bạn mới có thể truy cập tài nguyên Firebase của dự án. Xem Tổng quan về tính năng này.

Hiện tại, nhà cung cấp Play Integrity tích hợp sẵn chỉ hỗ trợ các ứng dụng Android do Google Play phân phối. Để sử dụng các tính năng ngoài Play của Play Integrity hoặc sử dụng Kiểm tra ứng dụng với nhà cung cấp tùy chỉnh của riêng bạn, hãy xem Triển khai nhà cung cấp Kiểm tra ứng dụng tùy chỉnh .

1. Thiết lập dự án Firebase của bạn

  1. Thêm Firebase vào dự án Android của bạn nếu bạn chưa làm như vậy.

  2. Bật API tính toàn vẹn của Play:

    1. Trong Google Play Console , chọn ứng dụng của bạn hoặc thêm ứng dụng nếu bạn chưa làm như vậy.

    2. Trong phần Phát hành , nhấp vào Thiết lập> Tính toàn vẹn của ứng dụng .

    3. Trên trang Integrity API , nhấp vào Liên kết dự án , sau đó chọn dự án Firebase của bạn từ danh sách các dự án Google Cloud.

      Dự án bạn chọn ở đây phải giống dự án Firebase với dự án mà bạn đăng ký ứng dụng của mình (xem bước tiếp theo).

  3. Đăng ký ứng dụng của bạn để sử dụng Kiểm tra ứng dụng với nhà cung cấp Play Integrity trong phần Kiểm tra ứng dụng của bảng điều khiển Firebase. Bạn sẽ cần cung cấp tệp tham chiếu SHA-256 của chứng chỉ ký ứng dụng của mình.

    Bạn thường cần đăng ký tất cả các ứng dụng trong dự án của mình, vì sau khi bạn bật chế độ thực thi cho sản phẩm Firebase, chỉ những ứng dụng đã đăng ký mới có thể truy cập vào tài nguyên phụ trợ của sản phẩm.

  4. Tùy chọn : Trong cài đặt đăng ký ứng dụng, hãy đặt thời gian tồn tại (TTL) tùy chỉnh cho mã thông báo Kiểm tra ứng dụng do nhà cung cấp phát hành. Bạn có thể đặt TTL thành bất kỳ giá trị nào trong khoảng thời gian từ 30 phút đến 7 ngày. Khi thay đổi giá trị này, hãy lưu ý những đánh đổi sau:

    • Bảo mật: TTL ngắn hơn cung cấp bảo mật mạnh hơn, vì nó làm giảm cửa sổ mà mã thông báo bị rò rỉ hoặc bị chặn có thể bị kẻ tấn công lạm dụng.
    • Hiệu suất: TTL ngắn hơn có nghĩa là ứng dụng của bạn sẽ thực hiện chứng thực thường xuyên hơn. Vì quá trình chứng thực ứng dụng thêm độ trễ cho các yêu cầu mạng mỗi khi nó được thực hiện, một TTL ngắn có thể ảnh hưởng đến hiệu suất của ứng dụng của bạn.
    • Hạn ngạch và chi phí: TTL ngắn hơn và xác thực lại thường xuyên làm cạn kiệt hạn ngạch của bạn nhanh hơn và đối với các dịch vụ phải trả phí, có khả năng chi phí cao hơn. Xem Hạn ngạch & giới hạn .

    TTL mặc định là 1 giờ là hợp lý cho hầu hết các ứng dụng. Lưu ý rằng thư viện Kiểm tra ứng dụng làm mới mã thông báo ở khoảng một nửa thời lượng TTL.

2. Thêm thư viện Kiểm tra ứng dụng vào ứng dụng của bạn

Sử dụng Firebase Android BoM , khai báo sự phụ thuộc cho thư viện App Check Android trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là app/build.gradle ).

Java

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:30.3.1')

    // Declare the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

Bằng cách sử dụng Firebase Android BoM , ứng dụng của bạn sẽ luôn sử dụng các phiên bản tương thích của thư viện Firebase Android.

(Thay thế) Khai báo các phụ thuộc thư viện Firebase mà không cần sử dụng BoM

Nếu bạn chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc của nó.

Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đảm bảo rằng tất cả các phiên bản đều tương thích.

dependencies {
    // Declare the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.0.0'
}

Kotlin+KTX

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:30.3.1')

    // Declare the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

Bằng cách sử dụng Firebase Android BoM , ứng dụng của bạn sẽ luôn sử dụng các phiên bản tương thích của thư viện Firebase Android.

(Thay thế) Khai báo các phụ thuộc thư viện Firebase mà không cần sử dụng BoM

Nếu bạn chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc của nó.

Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đảm bảo rằng tất cả các phiên bản đều tương thích.

dependencies {
    // Declare the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.0.0'
}

3. Khởi tạo Kiểm tra ứng dụng

Thêm mã khởi tạo sau vào ứng dụng của bạn để ứng dụng chạy trước khi bạn sử dụng bất kỳ SDK Firebase nào khác:

Java

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());

Kotlin+KTX

FirebaseApp.initializeApp(/*context=*/this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance()
)

Sau khi thư viện Kiểm tra ứng dụng được cài đặt trong ứng dụng của bạn, hãy bắt đầu phân phối ứng dụng đã cập nhật cho người dùng của bạn.

Ứng dụng khách được cập nhật sẽ bắt đầu gửi mã thông báo Kiểm tra ứng dụng cùng với mọi yêu cầu mà ứng dụng đưa ra cho Firebase, nhưng các sản phẩm của Firebase sẽ không yêu cầu mã thông báo hợp lệ cho đến khi bạn bật thực thi trong phần Kiểm tra ứng dụng của bảng điều khiển Firebase. Xem hai phần tiếp theo để biết chi tiết.

4. Theo dõi số liệu yêu cầu

Giờ đây, ứng dụng cập nhật của bạn đã có trong tay người dùng, bạn có thể bật tính năng Thực thi Kiểm tra ứng dụng cho các sản phẩm Firebase mà bạn sử dụng. Tuy nhiên, trước khi làm như vậy, bạn nên đảm bảo rằng làm như vậy sẽ không làm gián đoạn những người dùng hợp pháp hiện có của bạn.

Cơ sở dữ liệu thời gian thực, Cloud Firestore và Cloud Storage

Một công cụ quan trọng mà bạn có thể sử dụng để đưa ra quyết định này cho Cơ sở dữ liệu thời gian thực, Cloud Firestore và Cloud Storage là màn hình số liệu yêu cầu Kiểm tra ứng dụng.

Để xem các chỉ số yêu cầu Kiểm tra ứng dụng cho một sản phẩm, hãy mở phần Kiểm tra ứng dụng của bảng điều khiển Firebase. Ví dụ:

Ảnh chụp màn hình trang chỉ số Kiểm tra ứng dụng

Các chỉ số yêu cầu cho mỗi sản phẩm được chia thành bốn loại:

  • Yêu cầu đã xác minh là những yêu cầu có mã thông báo Kiểm tra ứng dụng hợp lệ. Sau khi bạn bật thực thi Kiểm tra ứng dụng, chỉ các yêu cầu trong danh mục này mới thành công.

  • Yêu cầu khách hàng lỗi thời là những yêu cầu thiếu mã thông báo Kiểm tra ứng dụng. Các yêu cầu này có thể đến từ phiên bản SDK Firebase cũ hơn trước khi App Check được đưa vào ứng dụng.

  • Yêu cầu có nguồn gốc không xác định là những yêu cầu thiếu mã thông báo Kiểm tra ứng dụng và có vẻ như chúng không đến từ SDK Firebase. Đây có thể là từ các yêu cầu được thực hiện bằng khóa API bị đánh cắp hoặc các yêu cầu giả mạo được thực hiện mà không có SDK Firebase.

  • Yêu cầu không hợp lệ là những yêu cầu có mã thông báo Kiểm tra ứng dụng không hợp lệ, có thể là từ một ứng dụng khách không xác thực đang cố gắng mạo danh ứng dụng của bạn hoặc từ các môi trường giả lập.

Việc phân phối các danh mục này cho ứng dụng của bạn sẽ thông báo khi bạn quyết định bật chế độ thực thi. Dưới đây là một số nguyên tắc:

  • Nếu hầu hết tất cả các yêu cầu gần đây là từ các ứng dụng khách đã được xác minh, hãy xem xét cho phép thực thi để bắt đầu bảo vệ các tài nguyên phụ trợ của bạn.

  • Nếu một phần đáng kể các yêu cầu gần đây là từ các ứng dụng khách có khả năng đã lỗi thời, để tránh làm gián đoạn người dùng, hãy cân nhắc đợi nhiều người dùng hơn cập nhật ứng dụng của bạn trước khi cho phép thực thi. Việc thực thi Kiểm tra ứng dụng trên một ứng dụng đã phát hành sẽ phá vỡ các phiên bản ứng dụng trước đó không được tích hợp với SDK Kiểm tra ứng dụng.

  • Nếu ứng dụng của bạn chưa ra mắt, bạn nên bật thực thi Kiểm tra ứng dụng ngay lập tức, vì không có bất kỳ ứng dụng lỗi thời nào được sử dụng.

Chức năng đám mây

Đối với Chức năng đám mây, bạn có thể nhận số liệu Kiểm tra ứng dụng bằng cách kiểm tra nhật ký các chức năng của bạn. Mọi lệnh gọi của một hàm có thể gọi đều phát ra một mục nhập nhật ký có cấu trúc như ví dụ sau:

{
  "severity": "INFO",    // INFO, WARNING, or ERROR
  "logging.googleapis.com/labels": {"firebase-log-type": "callable-request-verification"},
  "jsonPayload": {
    "message": "Callable header verifications passed.",
    "verifications": {
      // ...
      "app": "MISSING",  // VALID, INVALID, or MISSING
    }
  }
}

Bạn có thể phân tích các chỉ số này trong Google Cloud Console bằng cách tạo chỉ số truy cập dựa trên nhật ký với bộ lọc số liệu sau:

resource.type="cloud_function"
resource.labels.function_name="YOUR_CLOUD_FUNCTION"
resource.labels.region="us-central1"
labels.firebase-log-type="callable-request-verification"

Gắn nhãn số liệu bằng trường jsonPayload.verifications.appCheck .

5. Cho phép thực thi

Để cho phép thực thi, hãy làm theo hướng dẫn cho từng sản phẩm bên dưới. Sau khi bạn bật thực thi cho một sản phẩm, tất cả các yêu cầu chưa được xác minh đối với sản phẩm đó sẽ bị từ chối.

Cơ sở dữ liệu thời gian thực, Cloud Firestore và Cloud Storage

Để cho phép thực thi Cơ sở dữ liệu thời gian thực, Cloud Firestore (iOS và Android) và Bộ nhớ đám mây:

  1. Mở phần Kiểm tra ứng dụng của bảng điều khiển Firebase.

  2. Mở rộng chế độ xem chỉ số của sản phẩm mà bạn muốn cho phép thực thi.

  3. Nhấp vào Thực thi và xác nhận lựa chọn của bạn.

Lưu ý rằng có thể mất đến 15 phút sau khi bạn bật chế độ thực thi để nó có hiệu lực.

Chức năng đám mây

Xem Bật thực thi Kiểm tra ứng dụng cho Chức năng đám mây .

Bước tiếp theo

Nếu sau khi đăng ký ứng dụng của mình để Kiểm tra ứng dụng, bạn muốn chạy ứng dụng của mình trong môi trường mà Kiểm tra ứng dụng thường không được phân loại là hợp lệ, chẳng hạn như trình giả lập trong quá trình phát triển hoặc từ môi trường tích hợp liên tục (CI), bạn có thể tạo một phiên bản gỡ lỗi của ứng dụng của bạn sử dụng nhà cung cấp gỡ lỗi Kiểm tra ứng dụng thay vì nhà cung cấp chứng thực thực sự.

Xem Sử dụng ứng dụng Kiểm tra với nhà cung cấp gỡ lỗi trên Android .