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 cho bạn biết cách bật App Check trong ứng dụng Android bằng nhà cung cấp API Tính toàn vẹn của Play được 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, nhà cung cấp 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 của API Tính toàn vẹn của Play ngoài Play hoặc để sử dụng App Check bằng nhà cung cấp tuỳ chỉnh của riêng bạn, hãy xem Triển khai trì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 của bạn nếu bạn chưa thêm đã 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 chọn.

    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 mục API Tính toàn vẹn của Play trên trang này, nhấp vào Liên kết dự án trên đám mây, rồi chọn dự án Firebase của bạn trong danh sách các dự án Google Cloud. Dự án bạn chọn ở đây phải giống với dự án Firebase nơi 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 App Check với nhà cung cấp API Tính toàn vẹn của Play trong phần 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ý của ứng dụng.

    Thông thường, bạn cần đăng ký tất cả các ứng dụng trong dự án của mình, vì một khi bạn cho phép thực thi cho một sản phẩm Firebase, thì 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 tuỳ chỉnh (TTL) 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 cũng cần lưu ý những yếu tố đá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 trong đó một 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 kẻ tấn công.
    • Hiệu suất: TTL ngắn hơn đồng nghĩa với việc ứng dụng của bạn sẽ thực hiện quy trình chứng thực nhiều hơn thường xuyên. Vì quy trình chứng thực ứng dụng sẽ làm tăng độ trễ của mạng mỗi khi được thực hiện, thì một TTL ngắn có thể ảnh hưởng đến hiệu suất ứng dụng của bạn.
    • 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 tài nguyên hạn mức nhanh hơn. Còn đối với các dịch vụ có tính phí, chi phí có thể cao hơn. Xem phần Hạn mức và .

    TTL mặc định của 1 giờ là hợp lý với hầu hết các ứng dụng. Lưu ý rằng thư viện App Check sẽ làm mới mã thông báo với thời lượng 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 mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), thêm phần phụ thuộc cho 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:33.1.2"))

    // 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")
}

Khi 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 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ụ thuộc.

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ự bạn nên sử dụng BoM để quản lý các phiên bản thư viện. Việc này đảm bảo rằng tất cả cá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 một mô-đun thư viện dành riêng cho Kotlin? Bắt đầu sau 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 động sau đây vào ứng dụng để chạy trước khi bạn sử dụng bất kỳ Firebase SDK nào khác:

Kotlin KTX

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

Java

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

Các bước tiếp theo

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

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

Theo dõi các chỉ số và cho phép 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 bật chế độ thực thi sẽ không làm gián đoạn những người dùng hợp lệ hiện tại. Mặt khác, nếu bạn thấy sử dụng tài nguyên ứng dụng của bạn một cách đáng ngờ, bạn có thể muốn cho phép thực thi sớm hơn.

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

Cho phép thực thi App Check

Khi bạn hiểu được App Check sẽ ảnh hưởng như thế nào đến người dùng của mình 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:

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ừ quá trình tích hợp liên tục (CI) 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 gỡ lỗi App Check thay vì một nhà cung cấp dịch vụ 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.