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 bạn cách bật App Check trong ứng dụng Android bằng trình cung cấp Tính toàn vẹn của Play tích hợp sẵn. Khi bật App Check, bạn 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 Firebase của dự án. Xem Tổng quan về tính năng này.

Hiện tại, trình cung cấp dịch vụ API Tính toàn vẹn của Play 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 App Check với nhà cung cấp tuỳ chỉnh của riêng bạn, hãy xem phần Triển khai nhà cung cấp App Check tuỳ chỉnh.

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

  1. Thêm Firebase vào dự án Android nếu bạn chưa thực hiện.

  2. 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 Bả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 API Tính toàn vẹn của Play 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 dự án Google Cloud. Dự án bạn chọn ở đây phải giống với dự án Firebase 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 để dùng App Check với nhà cung cấp API Tính toàn vẹn của Play trong mục App Check của bảng điều khiển Firebase. Bạn sẽ cần cung cấp vân tay số SHA-256 của chứng chỉ ký ứng dụng.

    Bạn thường cần đăng ký tất 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 đó.

  4. 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 App Check do nhà cung cấp cấp. 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 đánh đổi sau:

    • Bảo mật: TTL ngắn hơn mang lại khả năng bảo mật mạnh mẽ hơn vì giúp giảm khoảng thời gian mà mã thông báo bị rò rỉ hoặc bị chặn có thể bị kẻ tấn công lợi dụng.
    • Hiệu suất: TTL ngắn hơn nghĩa là ứng dụng sẽ thực hiện quy trình chứng thực thường xuyên hơn. Vì quy trình chứng thực ứng dụng làm tăng độ trễ cho các yêu cầu mạng mỗi khi quy trình này đượ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 giảm hạn mức của bạn nhanh hơn, đồng thời có thể làm tăng chi phí đối với các dịch vụ có tính phí. Xem 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 làm mới các mã thông báo trong khoảng thời gian khoảng một nửa thời lượng TTL.

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

Trong tệp Gradle (ở cấp ứng dụng) của mô-đun (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 cho thư viện App Check dành 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:33.5.1"))

    // 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 các phiên bản tương thích của thư viện Android trên Firebase.

(Phương án thay thế)  Thêm các phần phụ thuộc 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.

Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện, nhằm đảm bảo tất cả phiên bản đều 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:18.0.0")
}
 Bạn đang tìm kiếm mô-đun thư viện dành riêng cho Kotlin? Kể từ tháng 10 năm 2023 (Firebase BoM 32.5.0), cả nhà phát triển Kotlin và Java đều có thể phụ thuộc vào mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem Câu hỏi thường gặp về sáng kiến này).

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ỳ SDK Firebase nào khác:

Kotlin+KTX 

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à cho phép thực thi

Tuy nhiên, trước khi cho phép thực thi, bạn cầ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 lệ hiện tại của bạn. Mặt khác, nếu nhận thấy có hành vi sử dụng tài nguyên ứng dụng đáng ngờ, bạn nên bật tính năng thực thi sớm hơn.

Để đư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:

Cho phép thực thi App Check

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

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 một bản gỡ lỗi của ứng dụng sử dụng trình cung cấp dịch vụ gỡ lỗi App Check thay vì trình cung cấp chứng thực thực.

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