Android'de özel bir sağlayıcıyla Uygulama Kontrolünü etkinleştirin

Bu sayfa, özel Uygulama Kontrolü sağlayıcınızı kullanarak bir Android uygulamasında Uygulama Kontrolü'nü nasıl etkinleştireceğinizi gösterir. Uygulama Kontrolü'nü etkinleştirdiğinizde, projenizin Firebase kaynaklarına yalnızca uygulamanızın erişebilmesini sağlamaya yardımcı olursunuz.

Uygulama Kontrolü'nü varsayılan Play Integrity sağlayıcısıyla kullanmak istiyorsanız , Android'de Play Integrity ile Uygulama Kontrolünü Etkinleştirme konusuna bakın.

Sen başlamadan önce

1. Uygulama Kontrolü kitaplığını uygulamanıza ekleyin

Modülünüzde (app-level) Gradle dosyanızda (genellikle app/build.gradle ), App Check Android kitaplığının bağımlılığını bildirin:

Java

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

Kotlin+KTX

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

2. Uygulama Kontrolü arayüzlerini uygulayın

İlk olarak, AppCheckProvider ve AppCheckProviderFactory arabirimlerini uygulayan sınıflar oluşturmanız gerekir.

AppCheckProvider sınıfınız, özel Uygulama Kontrolü sağlayıcınızın özgünlük kanıtı olarak ihtiyaç duyduğu her türlü bilgiyi toplayan ve bir Uygulama Kontrolü belirteci karşılığında belirteç edinme hizmetinize gönderen bir getToken getToken() yöntemine sahip olmalıdır. Uygulama Kontrolü SDK'sı belirteç önbelleğe almayı işler, bu nedenle getToken() uygulamanızda her zaman yeni bir belirteç edinin.

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!
        }
}

Ayrıca, AppCheckProvider uygulamanızın örneklerini oluşturan bir AppCheckProviderFactory sınıfı uygulayı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. Uygulama Kontrolünü Başlatın

Diğer Firebase SDK'larını kullanmadan önce çalışması için uygulamanıza aşağıdaki başlatma kodunu ekleyin:

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())

Uygulama Kontrolü kitaplığı uygulamanıza yüklendikten sonra, güncellenen uygulamayı kullanıcılarınıza dağıtmaya başlayın.

Güncellenen istemci uygulaması, Firebase'e yaptığı her istekle birlikte Uygulama Kontrolü belirteçleri göndermeye başlayacak, ancak Firebase ürünleri, Firebase konsolunun Uygulama Kontrolü bölümünde zorlamayı etkinleştirene kadar belirteçlerin geçerli olmasını gerektirmeyecek. Ayrıntılar için sonraki iki bölüme bakın.

4. İstek metriklerini izleyin

Güncellenen uygulamanız artık kullanıcıların elinde olduğuna göre, kullandığınız Firebase ürünleri için Uygulama Kontrolü'nün uygulanmasını etkinleştirebilirsiniz. Ancak bunu yapmadan önce, bunu yapmanın mevcut meşru kullanıcılarınızı kesintiye uğratmayacağından emin olmalısınız.

Gerçek Zamanlı Veritabanı, Bulut Firestore ve Bulut Depolama

Realtime Database, Cloud Firestore ve Cloud Storage için bu kararı vermek için kullanabileceğiniz önemli bir araç, Uygulama Kontrolü istek ölçümleri ekranıdır.

Bir ürün için Uygulama Kontrolü istek metriklerini görüntülemek için Firebase konsolunun Uygulama Kontrolü bölümünü açın. Örneğin:

Uygulama Kontrolü metrikleri sayfasının ekran görüntüsü

Her ürün için istek metrikleri dört kategoriye ayrılmıştır:

  • Doğrulanmış istekler, geçerli bir Uygulama Kontrolü belirtecine sahip isteklerdir. Uygulama Kontrolü zorlamasını etkinleştirdikten sonra yalnızca bu kategorideki istekler başarılı olur.

  • Güncel olmayan istemci istekleri, Uygulama Kontrolü belirtecinin eksik olduğu isteklerdir. Bu istekler, Uygulama Kontrolü uygulamaya dahil edilmeden önce Firebase SDK'nın daha eski bir sürümünden olabilir.

  • Bilinmeyen kaynak istekleri, bir Uygulama Kontrolü belirtecinin eksik olduğu isteklerdir ve Firebase SDK'sından gelmemiş gibi görünürler. Bunlar, çalınan API anahtarlarıyla yapılan isteklerden veya Firebase SDK'sı olmadan yapılan sahte isteklerden olabilir.

  • Geçersiz istekler, uygulamanızın kimliğine bürünmeye çalışan orijinal olmayan bir istemciden veya öykünülmüş ortamlardan gelen geçersiz Uygulama Kontrolü belirtecine sahip isteklerdir.

Uygulamanız için bu kategorilerin dağılımı, yaptırımı etkinleştirmeye karar verdiğinizde bilgi vermelidir. İşte bazı yönergeler:

  • Son isteklerin neredeyse tamamı doğrulanmış istemcilerden geliyorsa, arka uç kaynaklarınızı korumaya başlamak için yaptırımı etkinleştirmeyi düşünün.

  • Son isteklerin önemli bir kısmı muhtemelen eski müşterilerden geliyorsa, kullanıcıları rahatsız etmemek için yaptırımı etkinleştirmeden önce daha fazla kullanıcının uygulamanızı güncellemesini beklemeyi düşünün. Yayınlanan bir uygulamada Uygulama Kontrolü'nün zorunlu kılınması, Uygulama Kontrolü SDK'sı ile entegre olmayan önceki uygulama sürümlerini bozacaktır.

  • Uygulamanız henüz başlatılmadıysa, kullanımda olan herhangi bir eski istemci olmadığından Uygulama Kontrolü zorlamasını hemen etkinleştirmelisiniz.

Bulut İşlevleri

Cloud Functions için, işlevlerinizin günlüklerini inceleyerek Uygulama Kontrolü ölçümlerini alabilirsiniz. Çağrılabilir bir işlevin her çağrısı, aşağıdaki örnekte olduğu gibi yapılandırılmış bir günlük girişi yayar:

{
  "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
    }
  }
}

Aşağıdaki metrik filtresiyle günlüklere dayalı bir sayaç metriği oluşturarak bu metrikleri Google Cloud Console'da analiz edebilirsiniz:

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

jsonPayload.verifications.appCheck alanını kullanarak metriği etiketleyin.

5. Zorlamayı etkinleştirin

Zorlamayı etkinleştirmek için her bir ürün için aşağıdaki talimatları izleyin. Bir ürün için yaptırımı etkinleştirdiğinizde, o ürüne yönelik tüm doğrulanmamış istekler reddedilir.

Gerçek Zamanlı Veritabanı, Bulut Firestore ve Bulut Depolama

Realtime Database, Cloud Firestore (iOS ve Android) ve Cloud Storage için zorlamayı etkinleştirmek için:

  1. Firebase konsolunun Uygulama Kontrolü bölümünü açın.

  2. Zorlamayı etkinleştirmek istediğiniz ürünün metrik görünümünü genişletin.

  3. Zorla'yı tıklayın ve seçiminizi onaylayın.

Zorunluluğu etkinleştirdikten sonra yürürlüğe girmesinin 15 dakika kadar sürebileceğini unutmayın.

Bulut İşlevleri

Bulut İşlevleri için Uygulama Kontrolü zorlamasını etkinleştirme bölümüne bakın.