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 cho bạn biết cách bật App Check trong ứng dụng Android bằng nhà cung cấp App Check tuỳ chỉnh. Khi bạn 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 nhà cung cấp API Tính toàn vẹn của Play mặc định, hãy xem 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 của bạn nếu bạn chưa thêm đã làm như vậy.

• 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 của bạn

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.2.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")
}

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.

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 AppCheckProvider và Giao diện AppCheckProviderFactory.

Lớp AppCheckProvider của bạn phải có một phương thức getToken() để thu thập bất kỳ thông tin nào 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ề xác thực và gửi mã đó đến dịch vụ thu thập mã thông báo của bạn để đổ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ã 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 lớp AppCheckProviderFactory để tạo các bản sao của Cách 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 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:

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 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:

• Theo dõi các chỉ số về yêu cầu App Check trong Realtime Database, Cloud Firestore, Cloud Storage và Authentication (thử nghiệm).
• Theo dõi chỉ số về yêu cầu App Check cho Cloud Functions.

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:

• Bật chế độ thực thi App Check cho Realtime Database, Cloud Firestore, Cloud Storage và Authentication (thử nghiệm).
• Cho phép thực thi App Check đối với 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ừ 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.