Bu sayfada, App Check özel App Check sağlayıcı. App Check özelliğini etkinleştirdiğinizde, projenizin Firebase kaynaklarına yalnızca uygulamanızın erişmesini sağlayabilirsiniz.
App Check uygulamasını varsayılan Play Integrity sağlayıcıyla kullanmak istiyorsanız şuraya göz atın: Android'de Play Integrity ile App Check uygulamasını etkinleştirin.
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
Modül (uygulama düzeyinde) Gradle dosyanızda (genellikle<project>/<app-module>/build.gradle.kts
veya
<project>/<app-module>/build.gradle
),
Android için App Check kitaplığına bağımlılığı ekleyin. Kitaplık sürümlendirmesini kontrol etmek için Firebase Android BoM simgesini kullanmanızı öneririz.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.4.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") }
Firebase Android BoM kullanıldığında, Uygulamanız her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanacaktır.
(Alternatif) Firebase kitaplığı bağımlılıklarını kullanmadan BoM
Firebase BoM kullanmamayı seçerseniz her Firebase kitaplık sürümünü bağımlılık satırında belirtmeniz gerekir.
Uygulamanızda birden fazla Firebase kitaplığı kullanıyorsanız kitaplık sürümlerini yönetmek için BoM'ı kullanmanızı önemle tavsiye ederiz. Bu, tüm sürümlerin uyumlu olmasını sağlar.
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üz.
AppCheckProvider
sınıfınızda, özel App Check sağlayıcınızın kimlik doğrulama kanıtı olarak ihtiyaç duyduğu tüm bilgileri toplayan ve App Check jetonu karşılığında jeton edinme hizmetinize gönderen bir getToken()
yöntemi olmalıdır. App Check SDK'sı jeton önbelleğe alma işlemini gerçekleştirir, bu nedenle her zaman
getToken()
uygulamanızda yeni bir jeton.
Kotlin+KTX
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) } }
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 { 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); } }
Ayrıca, AppCheckProviderFactory
AppCheckProvider
uygulaması:
Kotlin+KTX
class YourCustomAppCheckProviderFactory : AppCheckProviderFactory { override fun create(firebaseApp: FirebaseApp): AppCheckProvider { // Create and return an AppCheckProvider object. return YourCustomAppCheckProvider(firebaseApp) } }
Java
public class YourCustomAppCheckProviderFactory implements AppCheckProviderFactory { @NonNull @Override public AppCheckProvider create(@NonNull FirebaseApp firebaseApp) { // Create and return an AppCheckProvider object. return new YourCustomAppCheckProvider(firebaseApp); } }
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:
Kotlin+KTX
Firebase.initialize(context) Firebase.appCheck.installAppCheckProviderFactory( YourCustomAppCheckProviderFactory(), )
Java
FirebaseApp.initializeApp(/*context=*/ context); FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance(); firebaseAppCheck.installAppCheckProviderFactory( new YourCustomAppCheckProviderFactory());
Sonraki adımlar
App Check kitaplığı uygulamanıza yüklendikten sonra güncellenmiş uygulamayı kullanıcılarınıza dağıtmaya başlayın.
Güncellenen istemci uygulaması, App Check jeton göndermeye başlayacak. Firebase'e istek gönderir, ancak Firebase ürünleri için jeton gerekmez App Check Firebase konsolu.
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ı olması için kullandığınız hizmetlerle ilgili App Check metriklerini inceleyebilirsiniz:
- Realtime Database, Cloud Firestore, Cloud Storage, Firebase Data Connect (Önizleme), Authentication (beta) ve Vertex AI in Firebase (Önizleme) için App Check istek metriklerini izleyin.
- Cloud Functions için App Check istek metriklerini izleyin.
App Check yaptırımını etkinleştirme
App Check'ün kullanıcılarınızı nasıl etkileyeceğini anladıktan ve devam etmeye hazır olduğunuzda App Check yaptırımını etkinleştirebilirsiniz:
- Şunun için App Check yaptırımını etkinleştir: Realtime Database, Cloud Firestore, Cloud Storage, Firebase Data Connect (Önizleme), Authentication (beta) ve Vertex AI in Firebase (Önizleme).
- Cloud Functions için App Check yaptırımını etkinleştirin.
Hata ayıklama ortamlarında App Check kullanma
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ısıyla App Check'i kullanma başlıklı makaleyi inceleyin.