Android'de GitHub'ı Kullanarak Kimlik Doğrulama

Uçtan uca oturum açma akışını gerçekleştirmek için Firebase SDK'sını kullanarak web tabanlı genel OAuth girişini uygulamanıza entegre ederek kullanıcılarınızın GitHub hesaplarıyla Firebase'de kimlik doğrulaması yapmasına izin verebilirsiniz.

Başlamadan önce

Kullanıcıların GitHub hesaplarını kullanarak oturum açabilmesi için öncelikle Firebase projenizde oturum açma sağlayıcısı olarak GitHub'ı etkinleştirmeniz gerekir:

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

2. Firebase konsolunda Güvenlik > Kimlik doğrulama'ya gidin.
3. Sign-in method (Oturum açma yöntemi) sekmesinde GitHub oturum açma sağlayıcısını etkinleştirin.
4. İlgili sağlayıcının geliştirici konsolundaki İstemci Kimliği ve İstemci Gizli Anahtarı'nı sağlayıcı yapılandırmasına ekleyin:
   1. GitHub'da uygulamanızı geliştirici uygulaması olarak kaydedin ve uygulamanızın OAuth 2.0 istemci kimliğini ve istemci gizli anahtarını alın.
   2. Firebase OAuth yönlendirme URI'nizin (ör. my-app-12345.firebaseapp.com/__/auth/handler) GitHub uygulamanızın yapılandırmasındaki uygulama ayarları sayfasında Yetkilendirme geri çağırma URL'si olarak ayarlandığından emin olun.
5. Kaydet'i tıklayın.

6. Modülünüzün (uygulama düzeyinde) Gradle dosyasında (genellikle <project>/<app-module>/build.gradle.kts veya <project>/<app-module>/build.gradle) Android için Firebase Authentication kitaplığına olan bağımlılığı ekleyin. Kitaplık sürümünü kontrol etmek için Firebase Android BoM kullanmanızı öneririz.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:35.1.0"))
   
       // Add the dependency for the Firebase Authentication library
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-auth")
   }

   Firebase Android BoM kullanarak uygulamanızın her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanmasını sağlayabilirsiniz.

   (Alternatif)  BoM kullanmadan Firebase kitaplığı bağımlılıklarını ekleme

   Firebase BoM kullanmamayı tercih ederseniz her Firebase kitaplığı sürümünü kendi 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 sayede tüm sürümlerin uyumlu olmasını sağlayabilirsiniz.

   dependencies {
       // Add the dependency for the Firebase Authentication library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-auth:25.0.0")
   }

7. Henüz yapmadıysanız uygulamanızın SHA-1 parmak izini belirtin.

   1. Firebase konsolunda Ayarlar > Genel sekmesine gidin.

   2. Uygulamalarınız kartına gidin, Android uygulamanızı seçin ve SHA sertifikası parmak izleri alanına SHA-1 parmak izinizi ekleyin.

   Uygulamanızın SHA parmak izini nasıl alacağınızla ilgili ayrıntılar için İstemcinizin Kimliğini Doğrulama başlıklı makaleyi inceleyin.

Firebase SDK'sı ile oturum açma akışını yönetme

Android uygulaması geliştiriyorsanız kullanıcılarınızın GitHub hesaplarını kullanarak Firebase ile kimliklerini doğrulamanın en kolay yolu, tüm oturum açma akışını Firebase Android SDK'sı ile yönetmektir.

Firebase Android SDK'sı ile oturum açma akışını yönetmek için aşağıdaki adımları uygulayın:

1. github.com sağlayıcı kimliğiyle Builder'ı kullanarak bir OAuthProvider örneği oluşturun.

   Kotlin

   val provider = OAuthProvider.newBuilder("github.com")
   GenericIdpActivity.kt

   Java

   OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
   GenericIdpActivity.java

2. İsteğe bağlı: OAuth isteğiyle göndermek istediğiniz ek özel OAuth parametrelerini belirtin.

   Kotlin

   // Target specific email with login hint.
   provider.addCustomParameter("login", "[e-mail]")
   GenericIdpActivity.kt

   Java

   // Target specific email with login hint.
   provider.addCustomParameter("login", "[e-mail]");
   GenericIdpActivity.java

   GitHub'ın desteklediği parametreler için GitHub OAuth belgelerine bakın. Firebase için gerekli parametreleri setCustomParameters() ile iletemeyeceğinizi unutmayın. Bu parametreler client_id, response_type, redirect_uri, state, scope ve response_mode'dur.

3. İsteğe bağlı: Kimlik doğrulama sağlayıcısından istemek istediğiniz, temel profilin dışındaki ek OAuth 2.0 kapsamlarını belirtin. Uygulamanızın GitHub API'lerinden özel kullanıcı verilerine erişmesi gerekiyorsa GitHub geliştirici konsolundaki API İzinleri bölümünde GitHub API'lerine erişim izni istemeniz gerekir. İstenen OAuth kapsamları, uygulamanın API izinlerinde önceden yapılandırılmış olanlarla tam olarak eşleşmelidir.

   Kotlin

   // Request read access to a user's email addresses.
   // This must be preconfigured in the app's API permissions.
   provider.scopes = listOf("user:email")
   GenericIdpActivity.kt

   Java

   // Request read access to a user's email addresses.
   // This must be preconfigured in the app's API permissions.
   List<String> scopes =
           new ArrayList<String>() {
               {
                   add("user:email");
               }
           };
   provider.setScopes(scopes);
   GenericIdpActivity.java

4. OAuth sağlayıcı nesnesini kullanarak Firebase ile kimlik doğrulama Diğer FirebaseAuth işlemlerinden farklı olarak bu işlem, bir Özel Chrome Sekmesi açarak kullanıcı arayüzünüzün kontrolünü ele alır. Bu nedenle, eklediğiniz OnSuccessListener ve OnFailureListener öğelerinde etkinliğinize referans vermeyin. İşlem, kullanıcı arayüzünü başlattığında bu öğeler hemen ayrılır.

   Öncelikle yanıt alıp almadığınızı kontrol etmeniz gerekir. Bu yöntemle oturum açtığınızda etkinliğiniz arka plana alınır. Bu nedenle, oturum açma akışı sırasında sistem tarafından geri alınabilir. Bu durumda kullanıcının tekrar denemesini önlemek için bir sonucun zaten mevcut olup olmadığını kontrol etmeniz gerekir.

   Bekleyen bir sonuç olup olmadığını kontrol etmek için getPendingAuthResult yöntemini çağırın:

   Kotlin

   val pendingResultTask = firebaseAuth.pendingAuthResult
   if (pendingResultTask != null) {
       // There's something already here! Finish the sign-in for your user.
       pendingResultTask
           .addOnSuccessListener {
               // User is signed in.
               // IdP data available in
               // authResult.getAdditionalUserInfo().getProfile().
               // The OAuth access token can also be retrieved:
               // ((OAuthCredential)authResult.getCredential()).getAccessToken().
               // The OAuth secret can be retrieved by calling:
               // ((OAuthCredential)authResult.getCredential()).getSecret().
           }
           .addOnFailureListener {
               // Handle failure.
           }
   } else {
       // There's no pending result so you need to start the sign-in flow.
       // See below.
   }
   GenericIdpActivity.kt

   Java

   Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult();
   if (pendingResultTask != null) {
       // There's something already here! Finish the sign-in for your user.
       pendingResultTask
               .addOnSuccessListener(
                       new OnSuccessListener<AuthResult>() {
                           @Override
                           public void onSuccess(AuthResult authResult) {
                               // User is signed in.
                               // IdP data available in
                               // authResult.getAdditionalUserInfo().getProfile().
                               // The OAuth access token can also be retrieved:
                               // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                               // The OAuth secret can be retrieved by calling:
                               // ((OAuthCredential)authResult.getCredential()).getSecret().
                           }
                       })
               .addOnFailureListener(
                       new OnFailureListener() {
                           @Override
                           public void onFailure(@NonNull Exception e) {
                               // Handle failure.
                           }
                       });
   } else {
       // There's no pending result so you need to start the sign-in flow.
       // See below.
   }
   GenericIdpActivity.java

   Oturum açma akışını başlatmak için startActivityForSignInWithProvider yöntemini çağırın:

   Kotlin

   firebaseAuth
       .startActivityForSignInWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // User is signed in.
           // IdP data available in
           // authResult.getAdditionalUserInfo().getProfile().
           // The OAuth access token can also be retrieved:
           // ((OAuthCredential)authResult.getCredential()).getAccessToken().
           // The OAuth secret can be retrieved by calling:
           // ((OAuthCredential)authResult.getCredential()).getSecret().
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   firebaseAuth
           .startActivityForSignInWithProvider(/* activity= */ this, provider.build())
           .addOnSuccessListener(
                   new OnSuccessListener<AuthResult>() {
                       @Override
                       public void onSuccess(AuthResult authResult) {
                           // User is signed in.
                           // IdP data available in
                           // authResult.getAdditionalUserInfo().getProfile().
                           // The OAuth access token can also be retrieved:
                           // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                           // The OAuth secret can be retrieved by calling:
                           // ((OAuthCredential)authResult.getCredential()).getSecret().
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

   İşlem başarıyla tamamlandığında, sağlayıcıyla ilişkili OAuth erişim jetonu, döndürülen OAuthCredential nesnesinden alınabilir.

   OAuth erişim jetonunu kullanarak GitHub API'yi çağırabilirsiniz.

   Örneğin, temel profil bilgilerini almak için REST API'yi çağırabilir ve erişim jetonunu Authorization üstbilgisinde iletebilirsiniz:

5. Yukarıdaki örneklerde oturum açma akışları ele alınmış olsa da startActivityForLinkWithProvider kullanarak bir GitHub sağlayıcısını mevcut bir kullanıcıya bağlayabilirsiniz. Örneğin, birden fazla sağlayıcıyı aynı kullanıcıya bağlayarak kullanıcının her ikisiyle de oturum açmasına izin verebilirsiniz.

   Kotlin

   // The user is already signed-in.
   val firebaseUser = firebaseAuth.currentUser!!
   firebaseUser
       .startActivityForLinkWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // Provider credential is linked to the current user.
           // IdP data available in
           // authResult.getAdditionalUserInfo().getProfile().
           // The OAuth access token can also be retrieved:
           // authResult.getCredential().getAccessToken().
           // The OAuth secret can be retrieved by calling:
           // authResult.getCredential().getSecret().
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   // The user is already signed-in.
   FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
   
   firebaseUser
           .startActivityForLinkWithProvider(/* activity= */ this, provider.build())
           .addOnSuccessListener(
                   new OnSuccessListener<AuthResult>() {
                       @Override
                       public void onSuccess(AuthResult authResult) {
                           // Provider credential is linked to the current user.
                           // IdP data available in
                           // authResult.getAdditionalUserInfo().getProfile().
                           // The OAuth access token can also be retrieved:
                           // authResult.getCredential().getAccessToken().
                           // The OAuth secret can be retrieved by calling:
                           // authResult.getCredential().getSecret().
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

6. Aynı kalıp, yakın zamanda giriş yapılmasını gerektiren hassas işlemler için yeni kimlik bilgilerini almak üzere kullanılabilecek startActivityForReauthenticateWithProvider ile de kullanılabilir.

   Kotlin

   // The user is already signed-in.
   val firebaseUser = firebaseAuth.currentUser!!
   firebaseUser
       .startActivityForReauthenticateWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // User is re-authenticated with fresh tokens and
           // should be able to perform sensitive operations
           // like account deletion and email or password
           // update.
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   // The user is already signed-in.
   FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
   
   firebaseUser
           .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
           .addOnSuccessListener(
                   new OnSuccessListener<AuthResult>() {
                       @Override
                       public void onSuccess(AuthResult authResult) {
                           // User is re-authenticated with fresh tokens and
                           // should be able to perform sensitive operations
                           // like account deletion and email or password
                           // update.
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

Sonraki adımlar

Kullanıcı ilk kez oturum açtıktan sonra yeni bir kullanıcı hesabı oluşturulur ve kullanıcının oturum açarken kullandığı kimlik bilgilerine (kullanıcı adı ve şifre, telefon numarası veya kimlik doğrulama sağlayıcı bilgileri) bağlanır. Bu yeni hesap, Firebase projenizin bir parçası olarak depolanır ve kullanıcının nasıl oturum açtığından bağımsız olarak projenizdeki her uygulamada kullanıcıyı tanımlamak için kullanılabilir.

• Uygulamalarınızda, kullanıcının temel profil bilgilerini FirebaseUser nesnesinden alabilirsiniz. Kullanıcıları yönetme başlıklı makaleyi inceleyin.

• Firebase Realtime Database ve Cloud Storage Güvenlik Kurallarınızda, oturum açmış kullanıcının benzersiz kullanıcı kimliğini auth değişkeninden alabilir ve kullanıcının hangi verilere erişebileceğini kontrol etmek için kullanabilirsiniz.

Kimlik doğrulama sağlayıcı kimlik bilgilerini mevcut bir kullanıcı hesabına bağlayarak kullanıcıların birden fazla kimlik doğrulama sağlayıcı kullanarak uygulamanızda oturum açmasına izin verebilirsiniz.

Bir kullanıcının oturumunu kapatmak için signOut yöntemini çağırın:

Kotlin

Firebase.auth.signOut()
MainActivity.kt

Java

FirebaseAuth.getInstance().signOut();
MainActivity.java