Ajoutez l'authentification multifacteur TOTP à votre application iOS

Si vous avez effectué une mise à niveau vers l'authentification Firebase avec Identity Platform, vous pouvez ajouter une authentification multifacteur (MFA) par mot de passe à usage unique (TOTP) basée sur le temps à votre application.

L'authentification Firebase avec Identity Platform vous permet d'utiliser un TOTP comme facteur supplémentaire pour l'AMF. Lorsque vous activez cette fonctionnalité, les utilisateurs qui tentent de se connecter à votre application voient une demande de TOTP. Pour le générer, ils doivent utiliser une application d'authentification capable de générer des codes TOTP valides, comme Google Authenticator .

Avant que tu commences

  1. Activez au moins un fournisseur prenant en charge MFA. Notez que tous les fournisseurs, à l'exception des suivants, prennent en charge MFA :

    • Authentification téléphonique
    • Authentification anonyme
    • Jetons d'authentification personnalisés
    • Centre de jeux Apple

  2. Assurez-vous que votre application vérifie les adresses e-mail des utilisateurs. MFA nécessite une vérification par e-mail. Cela empêche les acteurs malveillants de s'inscrire à un service avec une adresse e-mail qui ne leur appartient pas, puis de verrouiller le véritable propriétaire de l'adresse e-mail en ajoutant un deuxième facteur.

  3. Si vous ne l'avez pas déjà fait, installez le SDK Apple Firebase .

    TOTP MFA est uniquement pris en charge sur la version Apple SDK v10.12.0 et supérieure, et uniquement sur iOS.

Activer l'authentification multifacteur TOTP

Pour activer TOTP comme deuxième facteur, utilisez le SDK Admin ou appelez le point de terminaison REST de configuration du projet.

Pour utiliser le SDK Admin, procédez comme suit :

  1. Si vous ne l'avez pas déjà fait, installez le SDK Firebase Admin Node.js .

    TOTP MFA est uniquement pris en charge sur les versions 11.6.0 et supérieures du SDK Firebase Admin Node.js.

  2. Exécutez ce qui suit :

    import { getAuth } from 'firebase-admin/auth';

getAuth().projectConfigManager().updateProjectConfig(
{
      multiFactorConfig: {
          providerConfigs: [{
              state: "ENABLED",
              totpProviderConfig: {
                  adjacentIntervals: {
                      NUM_ADJ_INTERVALS
                  },
              }
          }]
      }
})

    Remplacez les éléments suivants :

    • NUM_ADJ_INTERVALS : nombre d'intervalles de fenêtre de temps adjacents à partir desquels accepter les TOTP, de zéro à dix. La valeur par défaut est cinq.

      Les TOTP fonctionnent en garantissant que lorsque deux parties (le prouveur et le validateur) génèrent des OTP dans la même fenêtre de temps (généralement 30 secondes), elles génèrent le même mot de passe. Toutefois, pour tenir compte de la dérive d'horloge entre les parties et du temps de réponse humain, vous pouvez configurer le service TOTP pour qu'il accepte également les TOTP des fenêtres adjacentes.

Pour activer TOTP MFA à l'aide de l'API REST, exécutez ce qui suit :

curl -X PATCH "https://identitytoolkit.googleapis.com/admin/v2/projects/PROJECT_ID/config?updateMask=mfa" \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Goog-User-Project: PROJECT_ID" \
    -d \
    '{
        "mfa": {
          "providerConfigs": [{
            "state": "ENABLED",
            "totpProviderConfig": {
              "adjacentIntervals": "NUM_ADJ_INTERVALS"
            }
          }]
       }
    }'

Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet.

  • NUM_ADJ_INTERVALS : le nombre d'intervalles de fenêtre temporelle, de zéro à dix. La valeur par défaut est cinq.

    Les TOTP fonctionnent en garantissant que lorsque deux parties (le prouveur et le validateur) génèrent des OTP dans la même fenêtre de temps (généralement 30 secondes), elles génèrent le même mot de passe. Toutefois, pour tenir compte de la dérive d'horloge entre les parties et du temps de réponse humain, vous pouvez configurer le service TOTP pour qu'il accepte également les TOTP des fenêtres adjacentes.

Choisissez un modèle d'inscription

Vous pouvez choisir si votre application nécessite une authentification multifacteur, ainsi que comment et quand inscrire vos utilisateurs. Certains modèles courants sont les suivants :

  • Inscrivez le deuxième facteur de l'utilisateur dans le cadre de l'inscription. Utilisez cette méthode si votre application nécessite une authentification multifacteur pour tous les utilisateurs.

  • Offrez une option désactivable pour inscrire un deuxième facteur lors de l’inscription. Si vous souhaitez encourager mais ne pas exiger l'authentification multifacteur dans votre application, vous pouvez utiliser cette approche.

  • Offrez la possibilité d'ajouter un deuxième facteur à partir de la page de gestion du compte ou du profil de l'utilisateur, au lieu de l'écran d'inscription. Cela minimise les frictions pendant le processus d'enregistrement, tout en rendant l'authentification multifacteur disponible pour les utilisateurs sensibles à la sécurité.

  • Exiger l'ajout d'un deuxième facteur de manière incrémentielle lorsque l'utilisateur souhaite accéder à des fonctionnalités présentant des exigences de sécurité accrues.

Inscrire des utilisateurs dans TOTP MFA

Après avoir activé TOTP MFA comme deuxième facteur pour votre application, implémentez une logique côté client pour inscrire les utilisateurs dans TOTP MFA :

  1. Réauthentifiez l'utilisateur.

  2. Générez un secret TOTP pour l'utilisateur authentifié :

    // Generate a TOTP secret.
guard let mfaSession = try? await currentUser.multiFactor.session() else { return }
guard let totpSecret = try? await TOTPMultiFactorGenerator.generateSecret(with: mfaSession) else { return }

// Display the secret to the user and prompt them to enter it into their
// authenticator app. (See the next step.)

  3. Affichez le secret à l'utilisateur et invitez-le à le saisir dans son application d'authentification :

    // Display this key:
let secret = totpSecret.sharedSecretKey()

    En plus d'afficher la clé secrète, vous pouvez tenter de l'ajouter automatiquement à l'application d'authentification par défaut de l'appareil. Pour ce faire, générez un URI de clé compatible avec Google Authenticator et transmettez-le à openInOTPApp(withQRCodeURL:) :

    let otpAuthUri = totpSecret.generateQRCodeURL(
    withAccountName: currentUser.email ?? "default account",
    issuer: "Your App Name")
totpSecret.openInOTPApp(withQRCodeURL: otpAuthUri)

    Une fois que l'utilisateur a ajouté son secret à son application d'authentification, celle-ci commencera à générer des TOTP.

  4. Invitez l'utilisateur à saisir le TOTP affiché par son application d'authentification et à l'utiliser pour finaliser l'inscription MFA :

    // Ask the user for a verification code from the authenticator app.
let verificationCode = // Code from user input.

// Finalize the enrollment.
let multiFactorAssertion = TOTPMultiFactorGenerator.assertionForEnrollment(
    with: totpSecret,
    oneTimePassword: verificationCode)
do {
    try await currentUser.multiFactor.enroll(
        with: multiFactorAssertion,
        displayName: "TOTP")
} catch {
    // Wrong or expired OTP. Re-prompt the user.
}

Connectez les utilisateurs avec un deuxième facteur

Pour connecter les utilisateurs avec TOTP MFA, utilisez le code suivant :

  1. Appelez l’une des méthodes signIn(with...:) - comme vous le feriez si vous n’utilisiez pas MFA (par exemple, signIn(withEmail:password:) ). Si la méthode renvoie une erreur avec le code secondFactorRequired , démarrez le flux MFA de votre application.

    do {
    let authResult = try await Auth.auth().signIn(withEmail: email, password: password)

    // If the user is not enrolled with a second factor and provided valid
    // credentials, sign-in succeeds.

    // (If your app requires MFA, this could be considered an error
    // condition, which you would resolve by forcing the user to enroll a
    // second factor.)

    // ...
} catch let error as AuthErrorCode where error.code == .secondFactorRequired {
    // Initiate your second factor sign-in flow. (See next step.)
    // ...
} catch {
    // Other auth error.
    throw error
}

  2. Le flux MFA de votre application doit d’abord inviter l’utilisateur à choisir le deuxième facteur qu’il souhaite utiliser. Vous pouvez obtenir une liste des seconds facteurs pris en charge en examinant la propriété hints d'une instance MultiFactorResolver :

    let mfaKey = AuthErrorUserInfoMultiFactorResolverKey
guard let resolver = error.userInfo[mfaKey] as? MultiFactorResolver else { return }
let enrolledFactors = resolver.hints.map(\.displayName)

  3. Si l'utilisateur choisit d'utiliser TOTP, invitez-le à saisir le TOTP affiché sur son application d'authentification et à l'utiliser pour se connecter :

    let multiFactorInfo = resolver.hints[selectedIndex]
switch multiFactorInfo.factorID {
case TOTPMultiFactorID:
    let otpFromAuthenticator = // OTP typed by the user.
    let assertion = TOTPMultiFactorGenerator.assertionForSignIn(
        withEnrollmentID: multiFactorInfo.uid,
        oneTimePassword: otpFromAuthenticator)
    do {
        let authResult = try await resolver.resolveSignIn(with: assertion)
    } catch {
        // Wrong or expired OTP. Re-prompt the user.
    }
default:
    return
}

Se désinscrire de TOTP MFA

Cette section décrit comment gérer la désinscription d'un utilisateur de TOTP MFA.

Si un utilisateur s'est inscrit à plusieurs options MFA et s'il se désinscrit de l'option la plus récemment activée, il reçoit un message auth/user-token-expired et est déconnecté. L'utilisateur doit se reconnecter et vérifier ses informations d'identification existantes, par exemple une adresse e-mail et un mot de passe.

Pour désinscrire l'utilisateur, gérer l'erreur et déclencher la réauthentification, utilisez le code suivant :

guard let currentUser = Auth.auth().currentUser else { return }

// Prompt the user to select a factor to unenroll, from this array:
currentUser.multiFactor.enrolledFactors

// ...

// Unenroll the second factor.
let multiFactorInfo = currentUser.multiFactor.enrolledFactors[selectedIndex]
do {
    try await currentUser.multiFactor.unenroll(with: multiFactorInfo)
} catch let error as AuthErrorCode where error.code == .invalidUserToken {
    // Second factor unenrolled, but the user was signed out. Re-authenticate
    // them.
}

Et après