Authentifier à l'aide de GitHub sur les plates-formes Apple

Vous pouvez permettre à vos utilisateurs de s'authentifier auprès de Firebase à l'aide de fournisseurs OAuth tels que GitHub en intégrant la connexion OAuth générique 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 :

Utilisez Swift Package Manager pour installer et gérer les dépendances Firebase.

  1. Dans Xcode, avec votre projet d'application ouvert, accédez à File > Add Packages .
  2. Lorsque vous y êtes invité, ajoutez le référentiel SDK des plates-formes Apple Firebase :
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Choisissez la bibliothèque d'authentification Firebase.
  5. Ajoutez l'indicateur -ObjC à la section Autres indicateurs de l'éditeur de liens des paramètres de construction de votre cible.
  6. Une fois terminé, Xcode commencera automatiquement à résoudre et à télécharger vos dépendances en arrière-plan.

Maintenant, effectuez quelques étapes de configuration :

  1. Dans la console Firebase , ouvrez la section Auth .
  2. Dans l’onglet Méthode de connexion , activez le fournisseur GitHub .
  3. Ajoutez l' ID client et le secret client de la console de développement de ce fournisseur à la configuration du fournisseur :
    1. Enregistrez votre application en tant qu'application de développement 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 dans la configuration de votre application GitHub .
  4. Cliquez sur Enregistrer .

Gérer le flux de connexion avec le SDK Firebase

Pour gérer le flux de connexion avec le SDK Firebase pour les plates-formes Apple, procédez comme suit :

  1. Ajoutez des schémas d'URL personnalisés à votre projet Xcode :

    1. Ouvrez la configuration de votre projet : double-cliquez sur le nom du projet dans l'arborescence de gauche. Sélectionnez votre application dans la section CIBLES , puis sélectionnez l'onglet Informations et développez la section Types d'URL .
    2. Cliquez sur le bouton + et ajoutez votre identifiant d'application codé en tant que schéma d'URL. Vous pouvez trouver votre identifiant d'application codé sur la page Paramètres généraux de la console Firebase, dans la section relative à votre application iOS. Laissez les autres champs vides.

      Une fois terminée, votre configuration devrait ressembler à ce qui suit (mais avec les valeurs spécifiques à votre application) :

      Capture d'écran de l'interface de configuration du schéma d'URL personnalisé de Xcode

  2. Créez une instance d' OAuthProvider à l'aide de l'ID de fournisseur github.com .

    Rapide

        var provider = OAuthProvider(providerID: "github.com")
        

    Objectif c

        FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"github.com"];
        
  3. Facultatif : Spécifiez les paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.

    Rapide

        provider.customParameters = [
          "allow_signup": "false"
        ]
        

    Objectif c

        [provider setCustomParameters:@{@"allow_signup": @"false"}];
        

    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 Firebase avec setCustomParameters . Ces paramètres sont client_id , redirect_uri , response_type , scope et state .

  4. 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 l'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 API dans la console du développeur GitHub. Les étendues OAuth demandées doivent correspondre exactement à celles préconfigurées dans les autorisations API de l'application.

    Rapide

        // Request read access to a user's email addresses.
        // This must be preconfigured in the app's API permissions.
        provider.scopes = ["user:email"]
        

    Objectif c

        // Request read access to a user's email addresses.
        // This must be preconfigured in the app's API permissions.
        [provider setScopes:@[@"user:email"]];
        

    Pour en savoir plus, reportez-vous à la documentation des étendues GitHub .

  5. Facultatif : si vous souhaitez personnaliser la façon dont votre application présente SFSafariViewController ou UIWebView lors de l'affichage du reCAPTCHA à l'utilisateur, créez une classe personnalisée conforme au protocole AuthUIDelegate et transmettez-la à credentialWithUIDelegate .

  6. Authentifiez-vous auprès de Firebase à l'aide de l'objet fournisseur OAuth.

    Rapide

        provider.getCredentialWith(nil) { credential, error in
          if error != nil {
            // Handle error.
          }
          if credential != nil {
            Auth().signIn(with: credential) { authResult, error in
              if error != nil {
                // Handle error.
              }
              // User is signed in.
              // IdP data available in authResult.additionalUserInfo.profile.
    
              guard let oauthCredential = authResult.credential as? OAuthCredential else { return }
              // GitHub OAuth access token can also be retrieved by:
              // oauthCredential.accessToken
              // GitHub OAuth ID token can be retrieved by calling:
              // oauthCredential.idToken
            }
          }
        }
        

    Objectif c

        [provider getCredentialWithUIDelegate:nil
                                   completion:^(FIRAuthCredential *_Nullable credential,
                                                NSError *_Nullable error) {
          if (error) {
           // Handle error.
          }
          if (credential) {
            [[FIRAuth auth] signInWithCredential:credential
                                      completion:^(FIRAuthDataResult *_Nullable authResult,
                                                NSError *_Nullable error) {
              if (error) {
                // Handle error.
              }
              // User is signed in.
              // IdP data available in authResult.additionalUserInfo.profile.
    
              FIROAuthCredential *oauthCredential = (FIROAuthCredential *)authResult.credential;
              // GitHub OAuth access token can also be retrieved by:
              // oauthCredential.accessToken
              // GitHub OAuth ID token can be retrieved by calling:
              // oauthCredential.idToken
            }];
          }
        }];
        

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

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

    https://api.github.com/user
    
  7. Bien 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. Par exemple, vous pouvez associer plusieurs fournisseurs au même utilisateur, leur permettant de se connecter avec l'un ou l'autre.

    Rapide

        Auth().currentUser.link(withCredential: credential) { authResult, error in
          if error != nil {
            // Handle error.
          }
          // GitHub credential is linked to the current user.
          // IdP data available in authResult.additionalUserInfo.profile.
          // GitHub OAuth access token can also be retrieved by:
          // (authResult.credential as? OAuthCredential)?.accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // (authResult.credential as? OAuthCredential)?.idToken
        }
        

    Objectif c

        [[FIRAuth auth].currentUser
            linkWithCredential:credential
                    completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
          if (error) {
            // Handle error.
          }
          // GitHub credential is linked to the current user.
          // IdP data available in authResult.additionalUserInfo.profile.
          // GitHub OAuth access token is can also be retrieved by:
          // ((FIROAuthCredential *)authResult.credential).accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // ((FIROAuthCredential *)authResult.credential).idToken
        }];
        
  8. Le même modèle peut être utilisé avec reauthenticateWithCredential qui peut être utilisé pour récupérer de nouvelles informations d'identification pour les opérations sensibles nécessitant une connexion récente.

    Rapide

        Auth().currentUser.reauthenticateWithCredential(withCredential: credential) { authResult, error in
          if error != nil {
            // Handle error.
          }
          // User is re-authenticated with fresh tokens minted and
          // should be able to perform sensitive operations like account
          // deletion and email or password update.
          // IdP data available in result.additionalUserInfo.profile.
          // Additional OAuth access token is can also be retrieved by:
          // (authResult.credential as? OAuthCredential)?.accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // (authResult.credential as? OAuthCredential)?.idToken
        }
        

    Objectif c

        [[FIRAuth auth].currentUser
            reauthenticateWithCredential:credential
                              completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
          if (error) {
            // Handle error.
          }
          // User is re-authenticated with fresh tokens minted and
          // should be able to perform sensitive operations like account
          // deletion and email or password update.
          // IdP data available in result.additionalUserInfo.profile.
          // Additional OAuth access token is can also be retrieved by:
          // ((FIROAuthCredential *)authResult.credential).accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // ((FIROAuthCredential *)authResult.credential).idToken
        }];
        

Prochaines étapes

Après qu'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 base du profil de l'utilisateur à partir de l'objet User . 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 associant les informations d'identification du fournisseur d'authentification à un compte utilisateur existant.

Pour déconnecter un utilisateur, appelez signOut: .

Rapide

let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print("Error signing out: %@", signOutError)
}

Objectif c

NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

Vous souhaiterez peut-être également ajouter un code de gestion des erreurs pour la gamme complète des erreurs d'authentification. Voir Gérer les erreurs .