S'authentifier à l'aide de GitHub sur Android

Vous pouvez permettre à vos utilisateurs de s'authentifier auprès de Firebase à l'aide de leurs comptes GitHub en intégrant une connexion OAuth générique basée sur le Web à votre application à l'aide du SDK Firebase pour effectuer le flux de connexion de bout en bout.

Avant de commencer

Pour connecter des utilisateurs à l'aide de comptes GitHub, vous devez d'abord activer GitHub en tant que fournisseur de connexion pour votre projet Firebase :

1. Si ce n'est pas déjà fait, ajoutez Firebase à votre projet Android.

2. Dans la Firebase console, ouvrez la section Auth.
3. Dans l'onglet Méthode de connexion, activez le fournisseur GitHub.
4. Ajoutez l'ID client et le code secret du client de la console de développeur de ce fournisseur à la configuration du fournisseur :
   1. Enregistrez votre application en tant qu'application de développeur sur GitHub et obtenez l'ID client et le code secret du client OAuth 2.0 de votre application.
   2. Assurez-vous que l'URI de redirection OAuth de votre application Firebase (par exemple, my-app-12345.firebaseapp.com/__/auth/handler) est défini comme URL de rappel d'autorisation dans la page des paramètres de votre application dans la configuration de votre application GitHub.
5. Cliquez sur Enregistrer.

6. Dans le fichier Gradle de votre module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), ajoutez la dépendance pour la bibliothèque Firebase Authentication pour Android. Nous vous recommandons d'utiliser la Firebase Android BoM pour contrôler la gestion des versions de la bibliothèque.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:34.10.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")
   }

   En utilisant les Firebase Android BoM, votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.

   (Autre solution)  Ajouter des dépendances de bibliothèque Firebase sans utiliser la BoM

   Si vous choisissez de ne pas utiliser la Firebase BoM, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.

   Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons vivement d'utiliser la BoM pour gérer les versions des bibliothèques, ce qui garantit que toutes les versions sont compatibles.

   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:24.0.1")
   }

7. Si vous n'avez pas encore spécifié l'empreinte SHA-1 de votre application, faites-le depuis la page "Paramètres" de la Firebase console. Pour savoir comment obtenir l'empreinte SHA-1 de votre application, consultez Authentifier votre client.

Gérer le flux de connexion avec le SDK Firebase

Si vous créez une application Android, le moyen le plus simple d'authentifier vos utilisateurs auprès de Firebase à l'aide de leurs comptes GitHub consiste à gérer l'intégralité du flux de connexion avec le SDK Firebase Android.

Pour gérer le flux de connexion avec le SDK Firebase Android, procédez comme suit :

1. Créez une instance d'OAuthProvider à l'aide de son compilateur avec l' ID de fournisseur github.com.

   Kotlin

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

   Java

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

2. Facultatif : spécifiez des paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.

   Kotlin

   // Target specific email with login hint.
   provider.addCustomParameter("login", "your-email@gmail.com")
   GenericIdpActivity.kt

   Java

   // Target specific email with login hint.
   provider.addCustomParameter("login", "your-email@gmail.com");
   GenericIdpActivity.java

   Pour connaître les paramètres compatibles avec GitHub, consultez la documentation GitHub OAuth. Notez que vous ne pouvez pas transmettre de paramètres requis par Firebase avec setCustomParameters(). Ces paramètres sont client_id, response_type, redirect_uri, state, scope et response_mode.

3. Facultatif : spécifiez des champs d'application OAuth 2.0 supplémentaires au-delà du profil de base que vous souhaitez demander au fournisseur d'authentification. Si votre application nécessite d'accéder à des données utilisateur privées à partir des API GitHub, vous devez demander des autorisations d'accès aux API GitHub sous Autorisations API dans la console de développeur GitHub. Les champs d'application OAuth demandés doivent correspondre exactement à ceux préconfigurés dans les autorisations API de l'application.

   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. Authentifiez-vous auprès de Firebase à l'aide de l'objet fournisseur OAuth. Notez que, contrairement à d'autres opérations FirebaseAuth , cela prendra le contrôle de votre UI en affichant un onglet Chrome personnalisé. Par conséquent, ne faites pas référence à votre activité dans les OnSuccessListener et OnFailureListener que vous associez, car ils seront immédiatement dissociés lorsque l'opération démarrera l'UI.

   Vous devez d'abord vérifier si vous avez déjà reçu une réponse. La connexion via cette méthode place votre activité en arrière-plan, ce qui signifie qu'elle peut être récupérée par le système pendant le flux de connexion. Pour vous assurer que l'utilisateur n'a pas à réessayer si cela se produit, vous devez vérifier si un résultat est déjà présent.

   Pour vérifier si un résultat est en attente, appelez getPendingAuthResult :

   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

   Pour démarrer le flux de connexion, appelez startActivityForSignInWithProvider :

   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

   Une fois l'opération terminée, le jeton d'accès OAuth associé au fournisseur peut être récupéré à partir de l'objet OAuthCredential renvoyé.

   À l'aide du jeton d'accès OAuth, vous pouvez appeler l' API GitHub.

   Par exemple, pour obtenir des informations de profil de base, vous pouvez appeler l'API REST, en transmettant le jeton d'accès dans l'en-tête Authorization :

5. Bien que les exemples ci-dessus se concentrent sur les flux de connexion, vous avez également la possibilité d'associer un fournisseur GitHub à un utilisateur existant à l'aide de startActivityForLinkWithProvider. Par exemple, vous pouvez associer plusieurs fournisseurs au même utilisateur, ce qui lui permet de se connecter avec l'un ou l'autre.

   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. Le même modèle peut être utilisé avec startActivityForReauthenticateWithProvider qui permet de récupérer des identifiants récents pour les opérations sensibles nécessitant une connexion récente.

   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

Étapes suivantes

Lorsqu'un utilisateur se connecte pour la première fois, un compte utilisateur est créé et associé aux identifiants (nom d'utilisateur et mot de passe, numéro de téléphone ou informations du fournisseur d'authentification) avec lesquels il s'est connecté. Ce nouveau compte est stocké dans votre projet Firebase et peut être utilisé pour identifier un utilisateur dans chaque application de votre projet, quelle que soit la méthode de connexion utilisée.

• Dans vos applications, vous pouvez obtenir les informations de profil de base de l'utilisateur à partir de l' FirebaseUser objet. Consultez Gérer les utilisateurs.

• Dans vos Firebase Realtime Database et Cloud Storage règles de sécurité, vous pouvez obtenir l'ID utilisateur unique de l'utilisateur connecté à partir de la variable auth, et l'utiliser pour contrôler les données auxquelles un utilisateur peut accéder.

Vous pouvez autoriser les utilisateurs à se connecter à votre application à l'aide de plusieurs fournisseurs d'authentification en associant les identifiants du fournisseur d'authentification à un compte utilisateur existant.

Pour déconnecter un utilisateur, appelez signOut :

Firebase.auth.signOut()
MainActivity.kt

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