Bật Kiểm tra ứng dụng với nhà cung cấp tùy chỉnh trên Android

Trang này hướng dẫn bạn cách bật Kiểm tra ứng dụng trong ứng dụng Android bằng cách sử dụng nhà cung cấp Kiểm tra ứng dụng tùy chỉnh của bạn . Khi bật Kiểm tra ứng dụng, 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 tài nguyên Firebase của dự án.

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

Trước khi bắt đầu

1. Thêm thư viện Kiểm tra ứng dụng vào ứng dụng của bạn

Trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là app/build.gradle ), hãy khai báo phần phụ thuộc cho thư viện App Check Android:

Java

dependencies {
    implementation 'com.google.firebase:firebase-appcheck:16.0.0'
}

Kotlin+KTX

dependencies {
    implementation 'com.google.firebase:firebase-appcheck:16.0.0'
}

2. Triển khai các giao diện Kiểm tra ứng dụng

Đầu tiên, bạn cần tạo các lớp triển khai giao diện AppCheckProviderAppCheckProviderFactory .

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

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 {
    @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 * 1000 - 60000;

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

        return appCheckToken;
    }
}

Kotlin+KTX

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

    override fun getExpireTimeMillis(): Long {
        return expiration
    }
}

class YourCustomAppCheckProvider : AppCheckProvider {
    val token: Task<AppCheckToken>
        get() {
            // Logic to exchange proof of authenticity for an App Check token.
            // ...

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

            // Create AppCheckToken object.
            val appCheckToken: AppCheckToken =
                    YourCustomAppCheckToken(tokenFromServer, expMillis)

            return appCheckToken!
        }
}

Ngoài ra, hãy triển khai một lớp AppCheckProviderFactory tạo các phiên bản triển khai AppCheckProvider của bạn:

Java

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

Kotlin+KTX

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

3. Khởi tạo Kiểm tra ứng dụng

Thêm mã khởi tạo 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:

Java

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

Kotlin+KTX

FirebaseApp.initializeApp(/*context=*/ this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory.getInstance())

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

Ứng dụng khách được cập nhật sẽ bắt đầu gửi mã thông báo Kiểm tra ứng dụng cùng với mọi yêu cầu mà ứng dụng đưa ra cho Firebase, nhưng các sản phẩm của Firebase sẽ không yêu cầu mã thông báo hợp lệ cho đến khi bạn bật thực thi trong phần Kiểm tra ứng dụng của bảng điều khiển Firebase. Xem hai phần tiếp theo để biết chi tiết.

4. Theo dõi số liệu yêu cầu

Giờ đây, ứng dụng cập nhật của bạn đã đến tay người dùng, bạn có thể bật tính năng Thực thi Kiểm tra ứng dụng cho các sản phẩm Firebase mà bạn sử dụng. Tuy nhiên, trước khi làm như vậy, bạn nên đảm bảo rằng làm như vậy sẽ không làm gián đoạn những người dùng hợp pháp hiện có của bạn.

Cơ sở dữ liệu thời gian thực, Cloud Firestore và Cloud Storage

Một công cụ quan trọng mà bạn có thể sử dụng để đưa ra quyết định này cho Cơ sở dữ liệu thời gian thực, Cloud Firestore và Cloud Storage là màn hình số liệu yêu cầu Kiểm tra ứng dụng.

Để xem các chỉ số yêu cầu Kiểm tra ứng dụng cho một sản phẩm, hãy mở phần Kiểm tra ứng dụng của bảng điều khiển Firebase. Ví dụ:

Ảnh chụp màn hình trang chỉ số Kiểm tra ứng dụng

Các chỉ số yêu cầu cho từng sản phẩm được chia thành bốn loại:

  • Yêu cầu đã xác minh là những yêu cầu có mã thông báo Kiểm tra ứng dụng hợp lệ. Sau khi bạn bật thực thi Kiểm tra ứng dụng, chỉ các yêu cầu trong danh mục này mới thành công.

  • Yêu cầu khách hàng lỗi thời là những yêu cầu thiếu mã thông báo Kiểm tra ứng dụng. Những yêu cầu này có thể là từ phiên bản SDK Firebase cũ hơn trước khi App Check được đưa vào ứng dụng.

  • Yêu cầu có nguồn gốc không xác định là những yêu cầu thiếu mã thông báo Kiểm tra ứng dụng và có vẻ như chúng không đến từ SDK Firebase. Đây có thể là từ các yêu cầu được thực hiện bằng khóa API bị đánh cắp hoặc các yêu cầu giả mạo được thực hiện mà không có SDK Firebase.

  • Yêu cầu không hợp lệ là những yêu cầu có mã thông báo Kiểm tra ứng dụng không hợp lệ, có thể là từ một ứng dụng khách không xác thực đang cố gắng mạo danh ứng dụng của bạn hoặc từ các môi trường giả lập.

Việc phân phối các danh mục này cho ứng dụng của bạn sẽ thông báo khi bạn quyết định bật thực thi. Dưới đây là một số nguyên tắc:

  • Nếu hầu hết tất cả các yêu cầu gần đây là từ các ứng dụng khách đã được xác minh, hãy cân nhắc cho phép thực thi để bắt đầu bảo vệ tài nguyên phụ trợ của bạn.

  • Nếu một phần đáng kể các yêu cầu gần đây là từ các ứng dụng khách có khả năng đã lỗi thời, để tránh làm gián đoạn người dùng, hãy cân nhắc đợi nhiều người dùng hơn cập nhật ứng dụng của bạn trước khi cho phép thực thi. Việc thực thi Kiểm tra ứng dụng trên một ứng dụng đã phát hành sẽ phá vỡ các phiên bản ứng dụng trước đó không được tích hợp với SDK kiểm tra ứng dụng.

  • Nếu ứng dụng của bạn chưa khởi chạy, bạn nên bật thực thi Kiểm tra ứng dụng ngay lập tức, vì không có bất kỳ ứng dụng lỗi thời nào được sử dụng.

Chức năng đám mây

Đối với Chức năng đám mây, bạn có thể nhận số liệu Kiểm tra ứng dụng bằng cách kiểm tra nhật ký các chức năng của bạn. Mọi lệnh gọi của một hàm có thể gọi đều phát ra một mục nhật ký có cấu trúc như ví dụ sau:

{
  "severity": "INFO",    // INFO, WARNING, or ERROR
  "logging.googleapis.com/labels": {"firebase-log-type": "callable-request-verification"},
  "jsonPayload": {
    "message": "Callable header verifications passed.",
    "verifications": {
      // ...
      "app": "MISSING",  // VALID, INVALID, or MISSING
    }
  }
}

Bạn có thể phân tích các chỉ số này trong Google Cloud Console bằng cách tạo chỉ số truy cập dựa trên nhật ký với bộ lọc chỉ số sau:

resource.type="cloud_function"
resource.labels.function_name="YOUR_CLOUD_FUNCTION"
resource.labels.region="us-central1"
labels.firebase-log-type="callable-request-verification"

Gắn nhãn số liệu bằng trường jsonPayload.verifications.appCheck .

5. Cho phép thực thi

Để cho phép thực thi, hãy làm theo hướng dẫn cho từng sản phẩm bên dưới. Sau khi bạn bật tính năng thực thi cho một sản phẩm, tất cả các yêu cầu chưa được xác minh đối với sản phẩm đó sẽ bị từ chối.

Cơ sở dữ liệu thời gian thực, Cloud Firestore và Cloud Storage

Để cho phép thực thi Cơ sở dữ liệu thời gian thực, Cloud Firestore (iOS và Android) và Lưu trữ đám mây:

  1. Mở phần Kiểm tra ứng dụng của bảng điều khiển Firebase.

  2. Mở rộng chế độ xem chỉ số của sản phẩm mà bạn muốn cho phép thực thi.

  3. Nhấp vào Thực thi và xác nhận lựa chọn của bạn.

Lưu ý rằng có thể mất đến 15 phút sau khi bạn bật chế độ thực thi để nó có hiệu lực.

Chức năng đám mây

Xem Bật thực thi Kiểm tra ứng dụng cho Chức năng đám mây .