Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

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 dans votre application à l'aide du SDK Firebase pour effectuer le flux de connexion de bout en bout.

Avant que tu commences

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 vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet Android .

  2. Dans la console Firebase , ouvrez la section Auth .
  3. Dans l'onglet Méthode de connexion, activez le fournisseur GitHub .
  4. Ajoutez l' ID client et le secret client de la console 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 OAuth 2.0 et le secret client de votre application.
    2. Assurez-vous que votre URI de redirection Firebase OAuth (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 sur la configuration de votre application GitHub .
  5. Cliquez sur Enregistrer .
  6. À l'aide de Firebase Android BoM , déclarez la dépendance de la bibliothèque Firebase Authentication Android dans le fichier Gradle de votre module (au niveau de l'application) (généralement app/build.gradle ).

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:26.6.0')
    
        // Declare 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 Firebase Android BoM , votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.

    (Alternative) Déclarez les dépendances de la bibliothèque Firebase sans utiliser BoM

    Si vous choisissez de ne pas utiliser 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 BoM pour gérer les versions de bibliothèque, ce qui garantit que toutes les versions sont compatibles.

    dependencies {
        // Declare 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:20.0.3'
    }
    

    Kotlin + KTX

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

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

    (Alternative) Déclarez les dépendances de la bibliothèque Firebase sans utiliser BoM

    Si vous choisissez de ne pas utiliser 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 BoM pour gérer les versions de bibliothèque, ce qui garantit que toutes les versions sont compatibles.

    dependencies {
        // Declare 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-ktx:20.0.3'
    }
    

  7. Si vous n'avez pas encore spécifié l'empreinte digitale SHA-1 de votre application, faites-le à partir de la page Paramètres de la console Firebase. Reportez-vous à Authentification de votre client pour plus de détails sur la façon d'obtenir l'empreinte digitale SHA-1 de votre application.

Gérez le flux de connexion avec le SDK Firebase

Si vous créez une application Android, le moyen le plus simple d'authentifier vos utilisateurs avec 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. Construire une instance d'un OAuthProvider en utilisant son constructeur avec l'ID de fournisseur github.com

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
    
  2. Facultatif : spécifiez les paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.

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

    Pour les paramètres pris en charge par GitHub, consultez la documentation GitHub OAuth . Notez que vous ne pouvez pas transmettre les paramètres requis par setCustomParameters() avec setCustomParameters() . Ces paramètres sont client_id , response_type , redirect_uri , state , scope et response_mode .

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

    // 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);
    
  4. Authentifiez-vous auprès de Firebase à l'aide de l'objet fournisseur OAuth. Notez que contrairement aux autres opérations FirebaseAuth, cela prendra le contrôle de votre interface utilisateur en ouvrant un onglet Chrome personnalisé . Par conséquent, ne référencez pas votre activité dans l' OnSuccessListener et l' OnFailureListener que vous attachez car ils se détacheront immédiatement lorsque l'opération démarre l'interface utilisateur.

    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 lors du flux de connexion. Afin de vous assurer de ne pas obliger l'utilisateur à réessayer si cela se produit, vous devez vérifier si un résultat est déjà présent.

    Pour vérifier s'il y a un résultat en attente, appelez getPendingAuthResult :

    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:
                  // authResult.getCredential().getAccessToken().
                }
              })
          .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.
    }
    

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

    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:
                // authResult.getCredential().getAccessToken().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    

    En cas de réussite, 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 passant le jeton d'accès dans l'en-tête Authorization :

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

    // 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) {
                // GitHub 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().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    
    
  6. Le même modèle peut être utilisé avec startActivityForReauthenticateWithProvider qui peut être utilisé pour récupérer de nouvelles informations d'identification pour les opérations sensibles qui nécessitent une connexion récente.

    // 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.
              }
            });
    

Prochaines étapes

Lorsqu'un utilisateur se connecte pour la première fois, un nouveau compte utilisateur est créé et lié aux informations d'identification (c'est-à-dire le nom d'utilisateur et le mot de passe, le numéro de téléphone ou les informations du fournisseur d'authentification) avec lesquels l'utilisateur s'est connecté. Ce nouveau compte est stocké dans le cadre de votre projet Firebase et peut être utilisé pour identifier un utilisateur dans chaque application de votre projet, quelle que soit la manière dont l'utilisateur se connecte.

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

  • Dans vos règles de sécurité Firebase Realtime Database et Cloud Storage, 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 liant les informations d'identification du fournisseur d'authentification à un compte d'utilisateur existant.

Pour déconnecter un utilisateur, appelez l' signOut

Java

FirebaseAuth.getInstance().signOut();

Kotlin + KTX

Firebase.auth.signOut()