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 cách sử dụng trình cung cấp App Check tuỳ chỉnh. 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.

Nếu bạn muốn sử dụng App Check với trình cung cấp API Tính toàn vẹn của Play mặc định, hãy xem phần Bật App Check bằng API Tính toàn vẹn của Play trên Android.

Trước khi bắt đầu

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

• Triển khai logic phía máy chủ của trình cung cấp App Check tuỳ chỉnh.

1. Thêm thư viện App Check vào ứng dụng

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

    // 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.

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:18.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 phải có phương thức getToken(). Phương thức này thu thập mọi thông tin mà nhà cung cấp App Check tuỳ chỉnh của bạn yêu cầu làm bằng chứng về tính xác thực và 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 nhận được một mã thông báo mới trong quá trình triển khai getToken().

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)
    }
}
CustomProvider.kt

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);
    }
}
CustomProvider.java

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:

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

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

3. Khởi động 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:

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

FirebaseApp.initializeApp(/*context=*/ context);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        new YourCustomAppCheckProviderFactory());
CustomProvider.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 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 gây gián đoạn cho những người dùng hợp pháp hiện tại. 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.

Để 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 các chỉ số yêu cầu App Check cho Realtime Database, Cloud Firestore, Cloud Storage, Authentication (thử nghiệm) và Vertex AI in Firebase.
• 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õ ả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 tính năng thực thi App Check:

• Bật tính năng thực thi App Check cho Realtime Database, Cloud Firestore, Cloud Storage, Authentication (thử nghiệm) và Vertex AI in Firebase.
• 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), 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ì 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.