API anahtarınızın güvenliğini sağlamak için Uygulama Kontrolü'nü kullanma
Firebase Uygulama Kontrolü, uygulamanızdan Google Haritalar Platformu'na yapılan çağrıları korumak için meşru uygulamalar dışındaki kaynaklardan gelen trafiği engeller. Bunu, Play Integrity gibi bir onay sağlayıcıdan gelen jetonu kontrol ederek yapar. Uygulamalarınızı Uygulama Kontrolü ile entegre etmek, kötü amaçlı isteklere karşı korunmanıza yardımcı olur. Böylece yetkisiz API çağrıları için ücret ödemezsiniz.
Uygulama Kontrolü benim için uygun mu?
Uygulama Kontrolü çoğu durumda önerilir ancak aşağıdaki durumlarda Uygulama Kontrolü gerekli değildir veya desteklenmez:
- Orijinal Yerler SDK'sını kullanıyorsunuz. Uygulama Kontrolü yalnızca Yerler SDK'sı (Yeni) için desteklenir.
- Özel veya deneysel uygulamalar Uygulamanız herkese açık değilse Uygulama Kontrolü'ne gerek yoktur.
- Uygulamanız yalnızca sunucudan sunucuya kullanılıyorsa Uygulama Kontrolü gerekli değildir. Ancak GMP ile iletişim kuran sunucu herkese açık istemciler (ör. mobil uygulamalar) tarafından kullanılıyorsa GMP yerine bu sunucuyu korumak için Uygulama Kontrolü'nü kullanmayı düşünebilirsiniz.
- Uygulama Kontrolü'nün önerilen onay sağlayıcıları, onay sağlayıcınız tarafından güvenliği ihlal edilmiş veya güvenilir olmadığı düşünülen cihazlarda çalışmaz. Bu tür cihazları desteklemeniz gerekiyorsa özel bir onay hizmeti dağıtabilirsiniz. Daha fazla bilgi için talimatları inceleyin.
Uygulama adımlarına genel bakış
Uygulamanızı Uygulama Kontrolü ile entegre etmek için uygulamanız gereken adımlar şunlardır:
- Uygulamanıza Firebase'i ekleyin.
- App Check kitaplığını ekleyip başlatın.
- Jeton sağlayıcıyı ekleyin.
- Hata ayıklamayı etkinleştirin.
- Uygulama isteklerinizi izleyin ve yaptırım kararı verin.
Uygulama Kontrolü ile entegrasyonu tamamladıktan sonra Firebase konsolunda arka uç trafik metriklerini görebilirsiniz. Bu metrikler, isteklerin geçerli bir Uygulama Kontrolü jetonuyla birlikte gönderilip gönderilmediğine göre dökümünü sağlar. Daha fazla bilgi için Firebase Uygulama Kontrolü belgelerine bakın.
İsteklerin çoğunun meşru kaynaklardan geldiğinden ve kullanıcıların uygulamanızı Uygulama Kontrolü uygulamanızı içeren en yeni sürüme güncellediğinden emin olduğunuzda yaptırımı etkinleştirebilirsiniz. Yaptırım etkinleştirildikten sonra Uygulama Kontrolü, geçerli bir Uygulama Kontrolü jetonu olmayan tüm trafiği reddeder.
Uygulama Kontrolü entegrasyonu planlarken dikkat edilmesi gereken noktalar
Entegrasyonunuzu planlarken dikkat etmeniz gereken bazı noktalar şunlardır:
Önerdiğimiz onay sağlayıcı Play Integrity'nin Standart API kullanım katmanı için günlük çağrı sınırı vardır. Çağrı sınırları hakkında daha fazla bilgi için Google Play Integrity geliştirici belgelerindeki Kurulum sayfasını inceleyin.
Özel bir onay sağlayıcı kullanmayı da seçebilirsiniz ancak bu, ileri düzey bir kullanım alanıdır. Daha fazla bilgi için Özel bir Uygulama Kontrolü sağlayıcısı uygulama başlıklı makaleyi inceleyin.
-
Uygulamanızın kullanıcıları, başlatma sırasında bir miktar gecikme yaşayabilir. Ancak daha sonra, periyodik yeniden onaylama işlemleri arka planda gerçekleşir ve kullanıcılar artık herhangi bir gecikme yaşamaz. Başlatma sırasındaki gecikme süresi, seçtiğiniz onay sağlayıcıya bağlıdır.
Uygulama Kontrolü jetonunun geçerli olduğu süre (geçerlilik süresi veya TTL), yeniden onaylama sıklığını belirler. Bu süre Firebase konsolunda yapılandırılabilir. Yeniden onaylama, TTL'nin yaklaşık yarısı geçtiğinde gerçekleşir. Daha fazla bilgi için onay sağlayıcınızla ilgili Firebase belgelerine bakın.
Uygulamanızı Uygulama Kontrolü ile entegre etme
Ön koşullar ve şartlar
- Yerler SDK'sının 4.1 veya sonraki sürümlerinin entegre edildiği bir uygulama.
- Uygulamanızın SHA-256 parmak izi.
- Uygulamanızın paket adı.
- Cloud Console'da uygulamanın sahibi olmanız gerekir.
- Cloud Console'dan uygulamanın proje kimliğini almanız gerekir.
1. adım: Uygulamanıza Firebase'i ekleyin
Firebase'i uygulamanıza eklemek için Firebase geliştirici belgelerindeki talimatları uygulayın.
2. adım: Uygulama Kontrolü kitaplığını ekleyin ve Uygulama Kontrolü'nü başlatın
Varsayılan onay sağlayıcı olan Play Integrity'yi kullanma hakkında bilgi için Android'de Play Integrity ile Uygulama Kontrolü'nü kullanmaya başlama başlıklı makaleyi inceleyin.
- Henüz yapmadıysanız Yerler SDK'sını uygulamanıza entegre edin.
Ardından Uygulama Kontrolü'nü ve Places istemcisini başlatın.
// Initialize App Check FirebaseApp.initializeApp(/* context= */ this); FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance(); firebaseAppCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance()); // Initialize Places SDK Places.initializeWithNewPlacesApiEnabled(context, API_KEY); PlacesClient client = Places.createClient(context);.
3. adım: Jeton sağlayıcıyı ekleyin
Places API'yi başlattıktan sonra PlacesAppCheckTokenProvider değerini ayarlamak için setPlacesAppCheckTokenProvider() yöntemini çağırın.
Places.initializeWithNewPlacesApiEnabled(context, API_KEY); Places.setPlacesAppCheckTokenProvider(new TokenProvider()); PlacesClient client = Places.createClient(context);.
Aşağıda, jeton getirme arayüzünün örnek bir uygulaması verilmiştir:
/** Sample client implementation of App Check token fetcher interface. */ static class TokenProvider implements PlacesAppCheckTokenProvider { @Override public ListenableFuture<String> fetchAppCheckToken() { SettableFuture<String> future = SettableFuture.create(); FirebaseAppCheck.getInstance() .getAppCheckToken(false) .addOnSuccessListener( appCheckToken -> { future.set(appCheckToken.getToken()); }) .addOnFailureListener( ex -> { future.setException(ex); }); return future; } }
4. adım: Hata ayıklamayı etkinleştirme (isteğe bağlı)
Uygulamanızı yerel olarak geliştirip test etmek veya sürekli entegrasyon (CI) ortamında çalıştırmak istiyorsanız geçerli Uygulama Kontrolü jetonları almak için hata ayıklama gizli anahtarı kullanan bir hata ayıklama derlemesi oluşturabilirsiniz. Bu sayede, hata ayıklama derlemenizde gerçek onay sağlayıcıları kullanmaktan kaçınabilirsiniz.
Uygulamanızı bir emülatörde veya test cihazında çalıştırmak için:
- Uygulama Kontrolü kitaplığını
build.gradledosyanıza ekleyin. - Uygulama Kontrolü'nü, hata ayıklama derlemenizde hata ayıklama sağlayıcı fabrikasını kullanacak şekilde yapılandırın.
- Uygulamayı başlatın. Bu işlem, yerel bir hata ayıklama jetonu oluşturur. Bu jetonu Firebase konsoluna ekleyin.
- Daha fazla bilgi ve talimat için Uygulama Kontrolü belgelerini inceleyin.
Uygulamanızı bir CI ortamında çalıştırmak için:
- Firebase konsolunda bir hata ayıklama jetonu oluşturun ve bunu CI sisteminizin güvenli anahtar deposuna ekleyin.
- Uygulama Kontrolü kitaplığını
build.gradledosyanıza ekleyin. - CI derleme varyantınızı hata ayıklama jetonunu kullanacak şekilde yapılandırın.
- Test sınıflarınızda Uygulama Kontrolü jetonu gerektiren kodu
DebugAppCheckTestHelperile sarmalayın. - Daha fazla bilgi ve talimat için Uygulama Kontrolü belgelerini inceleyin.
5. adım: Uygulama isteklerinizi izleyin ve yaptırım kararı verin
Yaptırım uygulamaya başlamadan önce uygulamanızın meşru kullanıcılarını rahatsız etmeyeceğinizden emin olmanız gerekir. Bunun için Uygulama Kontrolü metrikleri ekranını ziyaret ederek uygulamanızın trafiğinin yüzde kaçının doğrulanmış, güncel olmayan veya gayrimeşru olduğunu görebilirsiniz. Trafiğinizin çoğunun doğrulandığını gördüğünüzde yaptırımı etkinleştirebilirsiniz.
Daha fazla bilgi ve talimat için Firebase Uygulama Kontrolü belgelerine bakın.