Bắt đầu sử dụng tính năng Kiểm tra ứng dụng qua một nhà cung cấp tuỳ chỉnh 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 nhà cung cấp App Check tuỳ chỉnh. Khi bật 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 Firebase của dự án.

Nếu bạn muốn sử dụng App Check với nhà cung cấp Play Integrity mặc định, hãy xem bài viết Bật App Check bằng Play Integrity trên Android.

Trước khi bắt đầu

1. 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) trong 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:35.0.2"))

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

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.

(Cách khác)  Thêm 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 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, 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 rằng tất cả phiên bản đều tương thích. 

dependencies {
    // Add 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:20.0.0")
}

2. Triển khai giao diện App Check

Trước tiên, bạn cần tạo các lớp triển khai giao diện AppCheckProvider và AppCheckProviderFactory.

Lớp AppCheckProvider của bạn phải có phương thức getToken() để thu thập mọi thông tin mà nhà cung cấp App Check tuỳ chỉnh yêu cầu làm bằng chứng xác thực, đồng thời gửi thông tin đó đến dịch vụ thu nạp mã thông báo để đổi lấy mã thông báo App Check. SDK App Check xử lý việc lưu mã thông báo vào bộ nhớ đệm, vì vậy, hãy luôn lấy mã thông báo mới trong quá trình triển khai getToken().

Kotlin 

class YourCustomAppCheckToken(
    private val token: String,
    private val expiration: Long,
) : AppCheckToken() {
    override fun getToken(): String = token
    override fun getExpireTimeMillis(): Long = expiration
}

class YourCustomAppCheckProvider(firebaseApp: FirebaseApp) : AppCheckProvider {
    override fun getToken(): Task<AppCheckToken> {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        val expMillis = expirationFromServer * 1000L - 60000L

        // Create AppCheckToken object.
        val appCheckToken: AppCheckToken = YourCustomAppCheckToken(tokenFromServer, expMillis)
        return Tasks.forResult(appCheckToken)
    }
}

Java 

public class YourCustomAppCheckToken extends AppCheckToken {
    private String token;
    private long expiration;

    YourCustomAppCheckToken(String token, long expiration) {
        this.token = token;
        this.expiration = expiration;
    }

    @NonNull
    @Override
    public String getToken() {
        return token;
    }

    @Override
    public long getExpireTimeMillis() {
        return expiration;
    }
}

public class YourCustomAppCheckProvider implements AppCheckProvider {
    public YourCustomAppCheckProvider(FirebaseApp firebaseApp) {
        // ...
    }

    @NonNull
    @Override
    public Task<AppCheckToken> getToken() {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        long expMillis = expirationFromServer * 1000L - 60000L;

        // Create AppCheckToken object.
        AppCheckToken appCheckToken =
                new YourCustomAppCheckToken(tokenFromServer, expMillis);

        return Tasks.forResult(appCheckToken);
    }
}

Ngoài ra, hãy triển khai một lớp AppCheckProviderFactory để tạo các thực thể của quá trình triển khai AppCheckProvider:

Kotlin 

class YourCustomAppCheckProviderFactory : AppCheckProviderFactory {
    override fun create(firebaseApp: FirebaseApp): AppCheckProvider {
        // Create and return an AppCheckProvider object.
        return YourCustomAppCheckProvider(firebaseApp)
    }
}

Java 

public class YourCustomAppCheckProviderFactory implements AppCheckProviderFactory {
    @NonNull
    @Override
    public AppCheckProvider create(@NonNull FirebaseApp firebaseApp) {
        // Create and return an AppCheckProvider object.
        return new YourCustomAppCheckProvider(firebaseApp);
    }
}

3. Khởi chạy App Check

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

Kotlin 

Firebase.initialize(context)
Firebase.appCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory(),
)

Java 

FirebaseApp.initializeApp(/*context=*/ context);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        new YourCustomAppCheckProviderFactory());

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 của 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 chế độ 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 chế độ thực thi

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

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

Bật chế độ thực thi App Check

Khi hiểu rõ mức độ ảnh hưởng của App Check đối với người dùng và sẵn sàng tiếp tục, bạn có thể bật chế độ 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 dịch vụ chứng thực thực tế.

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