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

Bu sayfada, özel App Check sağlayıcınızı kullanarak bir Android uygulamasında App Check özelliğini nasıl etkinleştireceğiniz gösterilmektedir. App Check seçeneğini etkinleştirdiğinizde, projenizin Firebase kaynaklarına yalnızca uygulamanızın erişebilmesini sağlarsınız.

App Check uygulamasını varsayılan Play Integrity sağlayıcıyla kullanmak istiyorsanız Android'de Play Integrity ile App Check hizmetini etkinleştirme bölümüne göz atın.

Başlamadan önce

• Henüz yapmadıysanız Firebase'i Android projenize ekleyin.

• Özel App Check sağlayıcınızın sunucu tarafı mantığını uygulayın.

1. App Check kitaplığını uygulamanıza ekleme

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

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

Firebase Android BoM kullanıldığında uygulamanız Firebase Android kitaplıklarının daima uyumlu sürümlerini kullanır.

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. App Check arayüzlerini uygulayın

Öncelikle AppCheckProvider ve AppCheckProviderFactory arayüzlerini uygulayan sınıflar oluşturmanız gerekir.

AppCheckProvider sınıfınızda, özel App Check sağlayıcınızın özgünlük kanıtı olarak istediği bilgileri toplayan ve App Check jetonu karşılığında jeton edinme hizmetinize gönderen getToken() yöntemi bulunmalıdır. App Check SDK'sı, jeton önbelleğe alma işlemini gerçekleştirir. Bu nedenle, getToken() uygulamanızda her zaman yeni bir jeton edinin.

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

Ayrıca, AppCheckProvider uygulamanızın örneklerini oluşturan bir AppCheckProviderFactory sınıfı uygulayın:

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. App Check başlatılıyor

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

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

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

Sonraki adımlar

App Check 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 App Check jetonları göndermeye başlar. Ancak Firebase ürünleri, Firebase konsolunun App Check bölümünde yaptırımı etkinleştirmediğiniz sürece jetonların geçerli olmasını gerektirmez.

Metrikleri izleme ve yaptırımı etkinleştirme

Ancak yaptırımı etkinleştirmeden önce, bu işlemin mevcut meşru kullanıcılarınızın çalışmasını engellemeyeceğinden emin olmanız gerekir. Diğer yandan, uygulama kaynaklarınızın şüpheli bir şekilde kullanıldığını görüyorsanız yaptırımı daha erken etkinleştirmek isteyebilirsiniz.

Bu kararı vermenize yardımcı olmak için, kullandığınız hizmetlerdeki App Check metriklerine bakabilirsiniz:

• Realtime Database, Cloud Firestore, Cloud Storage, Authentication (beta) ve Vertex AI in Firebase için App Check istek metriklerini izleyin.
• Cloud Functions için App Check istek metriklerini izleyin.

App Check zorunlu kılmayı etkinleştir

App Check uygulamasının kullanıcılarınızı nasıl etkileyeceğini anladığınızda ve işleme devam etmeye hazır olduğunuzda App Check yaptırımını etkinleştirebilirsiniz:

• Realtime Database, Cloud Firestore, Cloud Storage, Authentication (beta) ve Vertex AI in Firebase için App Check yaptırımını etkinleştirin.
• Cloud Functions için App Check yaptırımını etkinleştirin.

Hata ayıklama ortamlarında App Check kullanın

Uygulamanızı App Check'e kaydettikten sonra, uygulamanızı App Check'in normalde geçerli olarak sınıflandırmayacağı bir ortamda (ör. geliştirme sırasındaki bir emülatör) veya sürekli entegrasyon (CI) ortamında çalıştırmak istiyorsanız gerçek bir doğrulama sağlayıcısı yerine App Check hata ayıklama sağlayıcısını kullanan uygulamanızın hata ayıklama derlemesini oluşturabilirsiniz.

Android'de hata ayıklama sağlayıcıyla App Check uygulamasını kullanma bölümüne bakın.