Bắt đầu sử dụng tính năng Kiểm tra ứng dụng bằng API Tính toàn vẹn của Play trên Android

Trang này hướng dẫn cách bật tính năng App Check trong một ứng dụng Android bằng nhà cung cấp Play Integrity tích hợp sẵn. Khi bật tính năng App Check, 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 vào tài nguyên phụ trợ của dự án. Xem phần Tổng quan về tính năng này.

Nhà cung cấp Play Integrity hỗ trợ các ứng dụng Android được phát hành trên Google Play, bên ngoài Google Play hoặc cả hai. Nếu trường hợp sử dụng của bạn yêu cầu các tính năng của Play Integrity mà App Check chưa triển khai hoặc nếu bạn muốn sử dụng App Check với nhà cung cấp tuỳ chỉnh của riêng mình, hãy xem bài viết Triển khai nhà cung cấp tuỳ chỉnh cho App Check.

1. Thiết lập dự án Firebase

Thêm Firebase vào dự án Android nếu bạn chưa thêm.
Bật API Tính toàn vẹn của Play:
1. Trong Google Play Console, hãy chọn ứng dụng của bạn hoặc thêm ứng dụng nếu bạn chưa thêm.
2. Trong phần Phát hành, hãy nhấp vào Tính toàn vẹn của ứng dụng.
3. Chuyển đến phần Play Integrity API trên trang, nhấp vào Liên kết dự án trên Cloud, sau đó chọn dự án Firebase của bạn trong danh sách các Google Cloud dự án. Dự án bạn chọn ở đây phải là cùng một dự án Firebase mà bạn đăng ký ứng dụng (xem bước tiếp theo).
  
  Bạn phải là Chủ sở hữu của dự án mà bạn muốn liên kết. Xin lưu ý rằng việc là thành viên của một nhóm được chỉ định vai trò Chủ sở hữu là không đủ.
Trong bảng điều khiển Firebase, hãy chuyển đến Bảo mật > Kiểm tra ứng dụng.
Trong thẻ Ứng dụng, hãy đăng ký ứng dụng của bạn để sử dụng App Check với nhà cung cấp Play Integrity. Bạn cần cung cấp dấu vân tay SHA-256 của chứng chỉ ký ứng dụng.

Bạn thường cần đăng ký tất cả các ứng dụng của dự án, vì sau khi bạn bật tính năng thực thi cho một 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 đó.
Không bắt buộc: Trong phần cài đặt đăng ký ứng dụng, hãy đặt thời gian tồn tại (TTL) tuỳ chỉnh cho mã thông báo do nhà cung cấp phát hành.App Check Bạn có thể đặt TTL thành bất kỳ giá trị nào trong khoảng từ 30 phút đến 7 ngày. Khi thay đổi giá trị này, hãy lưu ý đến những điểm đánh đổi sau:
- Bảo mật: TTL ngắn hơn sẽ mang lại khả năng bảo mật mạnh mẽ hơn, vì điều này giúp giảm khoảng thời gian mà kẻ tấn công có thể lợi dụng mã thông báo bị rò rỉ hoặc bị chặn.
- 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ì quy trình chứng thực ứng dụng sẽ thêm độ trễ vào các yêu cầu mạng mỗi khi được thực hiện, nên TTL ngắn có thể ảnh hưởng đến hiệu suất của ứng dụng.
- Hạn mức và chi phí: TTL ngắn hơn và việc chứng thực lại thường xuyên sẽ làm cạn kiệt hạn mức nhanh hơn và đối với các dịch vụ trả phí, có thể tốn kém hơn. Xem phần Hạn mức và giới hạn.
TTL mặc định là 1 giờ là hợp lý đối với hầu hết các ứng dụng. Xin lưu ý rằng thư viện App Check sẽ làm mới mã thông báo ở khoảng một nửa thời lượng TTL.

Định cấu hình các chế độ cài đặt nâng cao (không bắt buộc)

App Check cung cấp một số chế độ cài đặt để hỗ trợ các trường hợp sử dụng nâng cao, bao gồm cả việc phân phối ứng dụng của bạn bên ngoài Google Play. Đối với mỗi ứng dụng Android đã đăng ký, bạn có thể định cấu hình các chế độ cài đặt này trong thẻ App Check > Ứng dụng của bảng điều khiển Firebase. Bạn nên định cấu hình các chế độ cài đặt này theo bảng sau khi đăng ký ứng dụng lần đầu tiên.

Kênh phân phối của ứng dụng	PLAY_RECOGNIZED	LICENSED	Mức tính toàn vẹn tối thiểu được chấp nhận của thiết bị
Chỉ trên Google Play	Bắt buộc	Bắt buộc	Không kiểm tra rõ ràng mức tính toàn vẹn của thiết bị
Chỉ bên ngoài Google Play	Không bắt buộc	Không bắt buộc	Tính toàn vẹn của thiết bị
Trên Google Play và bên ngoài Google Play	Bắt buộc	Không bắt buộc	Không kiểm tra rõ ràng mức tính toàn vẹn của thiết bị

Thông tin chi tiết

Mỗi chế độ cài đặt nâng cao tương ứng với một nhãn kết quả về tính toàn vẹn của Play Integrity. Hãy tham khảo tài liệu về Play Integrity để biết thêm thông tin chi tiết.

Theo mặc định, App Check yêu cầu nhãn nhận dạng ứng dụng.PLAY_RECOGNIZED Các ứng dụng không được phát hành trên Google Play không đủ điều kiện nhận nhãn này.
Theo mặc định, App Check không yêu cầu nhãn cấp phép ứng dụng.LICENSED Chỉ những người dùng đã cài đặt hoặc cập nhật ứng dụng của bạn trực tiếp từ Google Play mới đủ điều kiện nhận nhãn này.
Theo mặc định, App Check không kiểm tra rõ ràng kết quả về tính toàn vẹn của thiết bị. App Check hỗ trợ kiểm tra rõ ràng 3 mức tính toàn vẹn của thiết bị sau đây, được liệt kê theo thứ tự tăng dần tính toàn vẹn của thiết bị.

Lưu ý: Play Integrity có thể ngầm thực hiện các bước kiểm tra bổ sung về tính toàn vẹn của thiết bị trong quá trình đánh giá các kết quả về tính toàn vẹn khác; bạn không thể kiểm soát trực tiếp các bước kiểm tra ngầm này và chúng không bị ảnh hưởng bởi chế độ cài đặt này.
- Tính toàn vẹn cơ bản. Yêu cầu App Check phải có nhãn nhận dạng thiết bị.MEETS_BASIC_INTEGRITY Để ứng dụng của bạn đủ điều kiện nhận nhãn không bắt buộc này, trước tiên, bạn phải chọn tham gia trong Google Play Console.
  
  Cảnh báo: Vì những người dùng Android 13 trở lên không cài đặt hoặc cập nhật ứng dụng của bạn từ Google Play không đủ điều kiện nhận nhãn này, nên họ sẽ bị từ chối quyền truy cập nếu không đáp ứng được các yêu cầu đối với nhãn mạnh hơn MEETS_DEVICE_INTEGRITY. Chỉ cân nhắc sử dụng chế độ cài đặt này như một công cụ để nới lỏng các yêu cầu về tính toàn vẹn của thiết bị đối với những người dùng cài đặt hoặc cập nhật ứng dụng của bạn từ Google Play. Để biết thêm thông tin chi tiết, hãy xem tài liệu về Play Integrity .
- Tính toàn vẹn của thiết bị. Yêu cầu App Check phải có nhãn nhận dạng thiết bị.MEETS_DEVICE_INTEGRITY Tất cả ứng dụng đều tự động đủ điều kiện nhận nhãn này.
- Tính toàn vẹn mạnh mẽ. Yêu cầu App Check phải có MEETS_STRONG_INTEGRITY nhãn nhận dạng thiết bị. Để ứng dụng của bạn đủ điều kiện nhận nhãn không bắt buộc này, trước tiên, bạn phải chọn tham gia trong Google Play Console.
  
  Cảnh báo: Vì những người dùng Android 13 trở lên không cài đặt hoặc cập nhật ứng dụng của bạn từ Google Play không đủ điều kiện nhận nhãn này, nên bạn chỉ nên cân nhắc sử dụng chế độ cài đặt này nếu ứng dụng của bạn được phân phối độc quyền bằng Google Play. Để biết thêm thông tin chi tiết, hãy xem tài liệu về Play Integrity .

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

Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc của thư viện App Check cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc tạo phiên bản thư viện.

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

    // Add the dependencies for the App Check libraries
    // 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 những phiên bản tương thích của thư viện Android trên Firebase.

(Phương án thay thế) Thêm phần phụ thuộc của thư viện Firebase mà không sử dụng BoM

Nếu 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ần phụ thuộc của phiên bản đó.

Xin lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng, thì 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 có khả năng tương thích.

dependencies {
    // Add the dependencies for the App Check libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-playintegrity:19.0.2")
}

3. Khởi chạy App Check

Thêm mã khởi chạy 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ỳ Firebase SDK nào khác:

Kotlin

Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance(),
)MainActivity.kt

Java

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

Các bước tiếp theo

Sau khi cài đặt thư viện App Check trong ứng dụng, hãy bắt đầu phân phối ứng dụng đã cập nhật cho người dùng.

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

Theo dõi các chỉ số và bật tính năng thực thi

Tuy nhiên, trước khi bật tính năng thực thi, bạn nên đảm bảo rằng việc này sẽ không làm gián đoạn những người dùng hợp pháp hiện có. Mặt khác, nếu thấy có hành vi sử dụng đáng ngờ đối với tài nguyên ứng dụng, bạn có thể muốn bật tính năng thực thi sớm hơn.

Để giúp đưa ra quyết định này, bạn có thể xem các chỉ số App Check cho các dịch vụ mà bạn sử dụng:

Theo dõi App Check chỉ số yêu cầu cho Firebase AI Logic, Data Connect, Realtime Database, Cloud Firestore, Cloud Storage, Authentication, Google Identity cho iOS, Maps JavaScript API và Places API (Mới).
Theo dõi các chỉ số yêu cầu App Check cho Cloud Functions.

Bật tính năng thực thi App Check

Khi hiểu rõ cách App Check sẽ ảnh hưởng đến người dùng và bạn đã sẵn sàng tiếp tục, bạn có thể bật tính năng thực thi App Check:

Bật tính năng thực thi cho Firebase AI Logic, Data Connect, Realtime Database, Cloud Firestore, Cloud Storage, Authentication, Google Identity cho iOS, Maps JavaScript API và Places API (Mới).App Check
Bật tính năng thực thi App Check cho Cloud Functions.

Sử dụng App Check trong môi trường gỡ lỗi

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

Xem phần Sử dụng App Check với nhà cung cấp gỡ lỗi trên Android.