Cette page a été traduite par l'API Cloud Translation.

S'authentifier à l'aide de GitHub sur Android

Vous pouvez autoriser vos utilisateurs à s'authentifier auprès de Firebase à l'aide de leurs comptes GitHub en intégrant la connexion OAuth générique 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 à votre projet Firebase:

Si ce n'est pas déjà fait, Ajoutez Firebase à votre projet Android.
Dans la console Firebase, ouvrez la section Authentification.
Dans l'onglet Mode de connexion, activez le fournisseur GitHub.
Ajoutez l'ID client et le code secret du client de la console pour développeur de ce fournisseur au configuration du fournisseur: <ph type="x-smartling-placeholder">
1. Enregistrer votre application en tant qu'application de développement sur GitHub et obtenir son ID client OAuth 2.0. et Code secret du client.
2. Assurez-vous que votre URI de redirection OAuth Firebase (par exemple, my-app-12345.firebaseapp.com/__/auth/handler) est définie comme URL de rappel d'autorisation sur la page des paramètres de votre application sur votre Configuration de l'application GitHub
Cliquez sur Enregistrer.
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 Firebase Android BoM pour contrôler la gestion des versions des bibliothèques.
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.2.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 Firebase Android BoM, votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.
(Alternative) Ajouter des dépendances de la bibliothèque Firebase sans utiliser l'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, recommandent d'utiliser BoM pour gérer les versions de la bibliothèque, 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:23.0.0")
}
```
Vous recherchez un module de bibliothèque spécifique à Kotlin ? À partir d'octobre 2023 (Firebase BoM 32.5.0), les développeurs Kotlin et Java peuvent dépendre du module de bibliothèque principal (pour en savoir plus, consultez les questions fréquentes sur cette initiative).
Si vous n'avez pas encore spécifié l'empreinte SHA-1 de votre application, faites-le à partir de la Page des paramètres de la console Firebase. Consultez Authentifier votre client pour savoir comment obtenir l'empreinte SHA-1 de votre application.

Gérer le flux de connexion avec le SDK Firebase

Si vous développez une application Android, le moyen le plus simple d'authentifier vos utilisateurs avec Firebase à l'aide de leurs comptes GitHub est de gérer l'intégralité de la connexion avec le SDK Firebase pour Android.

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

Créez une instance d'un objet OAuthProvider à l'aide de son Builder avec le paramètre ID du fournisseur github.com

Kotlin+KTX

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

Java

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

Facultatif : spécifiez des paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.
Kotlin+KTX
```
// 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 OAuth sur GitHub 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.
Facultatif: spécifiez des champs d'application OAuth 2.0 supplémentaires en plus du profil de base pour lequel que vous souhaitez demander au fournisseur d'authentification. Si votre application nécessite un accès aux données utilisateur privées des API GitHub, vous devez demander des autorisations d'accès aux API GitHub sous Autorisations des API dans le console pour les développeurs GitHub. Les champs d'application OAuth demandés doivent correspondre exactement à préconfigurés dans les autorisations d’API de l’application.
Kotlin+KTX
```
// 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
```

Authentifiez-vous auprès de Firebase à l'aide de l'objet du fournisseur OAuth. Notez que contrairement d'autres FirebaseAuth des opérations, celui-ci prendra le contrôle de votre interface utilisateur en affichant Onglet Chrome personnalisé. Par conséquent, ne faites pas référence à votre activité dans OnSuccessListener. et OnFailureListener que vous joignez, car ils se dissocient immédiatement l'opération démarre l'UI.

Commencez par vérifier si vous avez déjà reçu une réponse. Connexion via cette méthode place votre activité en arrière-plan, ce qui signifie qu'elle peut être récupérées par le système lors du processus de connexion. Pour vous assurer de ne pas demander à l'utilisateur de 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+KTX

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 lancer le flux de connexion, appelez startActivityForSignInWithProvider:

Kotlin+KTX

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é.

Avec le jeton d'accès OAuth, vous pouvez appeler la méthode 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:

Si les exemples ci-dessus se concentrent sur les procédures de connexion, possibilité d'associer un fournisseur GitHub à un utilisateur existant à l'aide de startActivityForLinkWithProvider Par exemple, vous pouvez associer plusieurs au même utilisateur, ce qui leur permet de se connecter avec l'un ou l'autre.

Kotlin+KTX

// 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

Le même modèle peut être utilisé avec startActivityForReauthenticateWithProvider, qui permet de récupérer De nouveaux identifiants pour les opérations sensibles nécessitant une connexion récente

Kotlin+KTX

// 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 l'utilisateur s'est connecté. Ce nouveau compte est stocké dans votre projet Firebase et peut être utilisé pour identifier un utilisateur dans toutes les applications de votre projet, quelle que soit la manière dont il se connecte.

Dans vos applications, vous pouvez obtenir les informations de base du profil de l'utilisateur à partir des FirebaseUser. Voir <ph type="x-smartling-placeholder"></ph> 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 appli à l'aide de plusieurs authentifications fournisseurs en associant leurs identifiants compte utilisateur existant.

Pour déconnecter un utilisateur, appelez . signOut:

Kotlin+KTX

Firebase.auth.signOut()MainActivity.kt

Java

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