Authentifier à l'aide d'OpenID Connect sur les plateformes Apple

Si vous avez effectué une mise à niveau vers l'authentification Firebase avec Identity Platform, vous pouvez authentifier vos utilisateurs avec Firebase à l'aide du fournisseur compatible OpenID Connect (OIDC) de votre choix. Cela permet d'utiliser des fournisseurs d'identité non pris en charge nativement par Firebase.

Avant que tu commences

Pour connecter des utilisateurs à l'aide d'un fournisseur OIDC, vous devez d'abord collecter certaines informations auprès du fournisseur :

  • ID client : une chaîne unique au fournisseur qui identifie votre application. Votre fournisseur peut vous attribuer un identifiant client différent pour chaque plateforme que vous prenez en charge. Il s'agit de l'une des valeurs de la revendication aud dans les jetons d'identification émis par votre fournisseur.

  • Secret client : une chaîne secrète que le fournisseur utilise pour confirmer la propriété d'un ID client. Pour chaque ID client, vous aurez besoin d’un secret client correspondant. (Cette valeur est obligatoire uniquement si vous utilisez le flux de code d'authentification , ce qui est fortement recommandé.)

  • Émetteur : une chaîne qui identifie votre fournisseur. Cette valeur doit être une URL qui, lorsqu'elle est ajoutée à /.well-known/openid-configuration , correspond à l'emplacement du document de découverte OIDC du fournisseur. Par exemple, si l'émetteur est https://auth.example.com , le document de découverte doit être disponible sur https://auth.example.com/.well-known/openid-configuration .

Une fois que vous disposez des informations ci-dessus, activez OpenID Connect en tant que fournisseur de connexion pour votre projet Firebase :

  1. Ajoutez Firebase à votre projet iOS .

  2. Si vous n'avez pas effectué la mise à niveau vers Firebase Authentication avec Identity Platform, faites-le. L'authentification OpenID Connect n'est disponible que dans les projets mis à niveau.

  3. Sur la page Fournisseurs de connexion de la console Firebase, cliquez sur Ajouter un nouveau fournisseur , puis cliquez sur OpenID Connect .

  4. Sélectionnez si vous utiliserez le flux de code d'autorisation ou le flux d'octroi implicite .

    Vous devez toujours utiliser le flux de code si votre fournisseur le prend en charge . Le flux implicite est moins sécurisé et son utilisation est fortement déconseillée.

  5. Donnez un nom à ce fournisseur. Notez l'ID du fournisseur généré : quelque chose comme oidc.example-provider . Vous aurez besoin de cet identifiant lorsque vous ajouterez un code de connexion à votre application.

  6. Spécifiez votre ID client et votre secret client, ainsi que la chaîne d'émetteur de votre fournisseur. Ces valeurs doivent correspondre exactement aux valeurs que votre fournisseur vous a attribuées.

  7. Enregistrez vos modifications.

Gérer le flux de connexion avec le SDK Firebase

Le moyen le plus simple d'authentifier vos utilisateurs auprès de Firebase à l'aide de votre fournisseur OIDC consiste à gérer l'intégralité du 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 que vous avez obtenu dans la console Firebase.

    Rapide

    var provider = OAuthProvider(providerID: "oidc.example-provider")

    Objectif c

    FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"oidc.example-provider"];

  3. Facultatif : Spécifiez les paramètres OAuth personnalisés supplémentaires que vous souhaitez envoyer avec la requête OAuth.

    Rapide

    provider.customParameters = [
  "login_hint": "user@example.com"
]

    Objectif c

    [provider setCustomParameters:@{@"login_hint": @"user@example.com"}];

    Vérifiez auprès de votre fournisseur les paramètres qu'il prend en charge. Notez que vous ne pouvez pas transmettre les paramètres requis par Firebase avec setCustomParameters . Ces paramètres sont client_id , response_type , redirect_uri , state , scope et response_mode .

  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.

    Rapide

    provider.scopes = ["mail.read", "calendars.read"]

    Objectif c

    [provider setScopes:@[@"mail.read", @"calendars.read"]];

    Vérifiez auprès de votre fournisseur les étendues qu'il prend en charge.

  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 .

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

    Rapide

    // If you created a custom class that conforms to AuthUIDelegate,
// pass it instead of nil:
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.
      // OAuth access token can also be retrieved:
      // (authResult.credential as? OAuthCredential)?.accessToken
      // OAuth ID token can also be retrieved:
      // (authResult.credential as? OAuthCredential)?.idToken
    }
  }
}

    Objectif c

    // If you created a custom class that conforms to AuthUIDelegate,
// pass it instead of nil:
[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.
      // OAuth access token can also be retrieved:
      // ((FIROAuthCredential *)authResult.credential).accessToken
      // OAuth ID token can also be retrieved:
      // ((FIROAuthCredential *)authResult.credential).idToken
    }];
  }
}];

  7. Bien que les exemples ci-dessus se concentrent sur les flux de connexion, vous avez également la possibilité de lier un fournisseur OIDC à un utilisateur existant à l'aide linkWithCredential . 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.
  }
  // OIDC credential is linked to the current user.
  // IdP data available in authResult.additionalUserInfo.profile.
  // OAuth access token can also be retrieved:
  // (authResult.credential as? OAuthCredential)?.accessToken
  // OAuth ID token can also be retrieved:
  // (authResult.credential as? OAuthCredential)?.idToken
}

    Objectif c

    [[FIRAuth auth].currentUser
    linkWithCredential:credential
            completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
  if (error) {
    // Handle error.
  }
  // OIDC credential is linked to the current user.
  // IdP data available in authResult.additionalUserInfo.profile.
  // OAuth access token can also be retrieved:
  // ((FIROAuthCredential *)authResult.credential).accessToken
  // OAuth ID token can also be retrieved:
  // ((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 can also be retrieved:
  // (authResult.credential as? OAuthCredential)?.accessToken
  // OAuth ID token can also be retrieved:
  // (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 can also be retrieved:
  // ((FIROAuthCredential *)authResult.credential).accessToken
  // OAuth ID token can also be retrieved:
  // ((FIROAuthCredential *)authResult.credential).idToken
}];

Gérer manuellement le flux de connexion

Si vous avez déjà implémenté le flux de connexion OpenID Connect dans votre application, vous pouvez utiliser le jeton d'ID directement pour vous authentifier auprès de Firebase :

Rapide

let credential = OAuthProvider.credential(
    withProviderID: "oidc.example-provider",  // As registered in Firebase console.
    idToken: idToken,  // ID token from OpenID Connect flow.
    rawNonce: nil
)
Auth.auth().signIn(with: credential) { authResult, error in
    if error {
        // Handle error.
        return
    }
    // User is signed in.
    // IdP data available in authResult?.additionalUserInfo?.profile
}

Objectif c

FIROAuthCredential *credential =
    [FIROAuthProvider credentialWithProviderID:@"oidc.example-provider"  // As registered in Firebase console.
                                       IDToken:idToken  // ID token from OpenID Connect flow.
                                      rawNonce:nil];
[[FIRAuth auth] signInWithCredential:credential
                          completion:^(FIRAuthDataResult * _Nullable authResult,
                                      NSError * _Nullable error) {
    if (error != nil) {
        // Handle error.
        return;
    }
    // User is signed in.
    // IdP data available in authResult.additionalUserInfo.profile
}];

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 .