Agrega la autenticación de varios factores a una app para Android

Si actualizaste a Firebase Authentication con Identity Platform, puedes agregar la autenticación de varios factores mediante SMS a tu app para Android.

La autenticación de varios factores aumenta la seguridad de tu app. Si bien los atacantes a menudo hackean las contraseñas y las cuentas de redes sociales, interceptar un mensaje de texto es más difícil.

Antes de comenzar

Habilita al menos un proveedor que admita la autenticación de varios factores. Todos los proveedores admiten la MFA, excepto la autenticación por teléfono, la autenticación anónima y Game Center de Apple.
Asegúrate de que en tu app se verifiquen los correos electrónicos de los usuarios. La MFA requiere la verificación por correo electrónico. Esto evita que los actores maliciosos se registren en un servicio con un correo electrónico que no les pertenece y, luego, bloqueen al propietario real agregando un segundo factor.
Registra el hash SHA‑1 de tu app en Firebase console (los cambios se transferirán automáticamente a Firebase de Google Cloud).
1. Sigue los pasos que se indican en Autentica tu cliente para obtener el hash SHA‑1 de la app.
2. Abre Firebase console.
3. Navega hasta Configuración de proyecto.
4. En Tus apps, haz clic en el ícono de Android.
5. Sigue los pasos guiados para agregar el hash SHA‑1.

Habilita la autenticación de varios factores

Abre la página Autenticación > Método de acceso de Firebase console.
En la sección Opciones avanzadas, habilita la Autenticación de varios factores mediante SMS.

También debes ingresar los números de teléfono con los que probarás la app. Si bien es opcional, se recomienda registrar los números de teléfono de prueba para evitar los límites durante el desarrollo.
Si aún no autorizas el dominio de tu app, agrégalo a la lista de entidades permitidas en la página Autenticación > Configuración de Firebase console.

Elige un patrón de inscripción

Puedes elegir si tu app requerirá una autenticación de varios factores, además de cómo y cuándo inscribir a tus usuarios. Entre los patrones comunes, se incluyen los siguientes:

Inscribir el segundo factor del usuario como parte del registro. Usa este método si tu app requiere la autenticación de varios factores para todos los usuarios.
Ofrecer una opción que se puede omitir para inscribir un segundo factor durante el registro. Es posible que las apps que quieran fomentar el proceso de autenticación de varios factores, pero que no lo requieran, prefieran este enfoque.
Proporcionar la capacidad de agregar un segundo factor desde la página de administración de la cuenta o el perfil del usuario, en lugar de la pantalla de registro. Esto minimiza la fricción durante el proceso de registro y, a la vez, permite que la autenticación de varios factores esté disponible para los usuarios sensibles a la seguridad.
Requiere agregar un segundo factor de manera incremental cuando el usuario quiera acceder a las funciones con requisitos de seguridad mayores.

Inscribe un segundo factor

Si quieres inscribir un nuevo factor secundario para un usuario, haz lo siguiente:

Vuelve a autenticar al usuario.
Pídele al usuario que ingrese su número de teléfono.

Nota: Google almacena y usa números de teléfono para mejorar la prevención del abuso y el spam en todos los servicios de Google. Asegúrate de obtener el consentimiento adecuado de los usuarios antes de enviar sus números de teléfono a Firebase.

Obtén una sesión de varios factores para el usuario:

Kotlin+KTX

user.multiFactor.session.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val multiFactorSession: MultiFactorSession? = task.result
    }
}

Java

user.getMultiFactor().getSession()
  .addOnCompleteListener(
      new OnCompleteListener<MultiFactorSession>() {
      @Override
      public void onComplete(@NonNull Task<MultiFactorSession> task) {
        if (task.isSuccessful()) {
          MultiFactorSession multiFactorSession = task.getResult();
        }
      }
      });

Compila un objeto OnVerificationStateChangedCallbacks para manejar diferentes eventos en el proceso de verificación:

Kotlin+KTX

val callbacks = object : OnVerificationStateChangedCallbacks() {
    override fun onVerificationCompleted(credential: PhoneAuthCredential) {
        // This callback will be invoked in two situations:
        // 1) Instant verification. In some cases, the phone number can be
        //    instantly verified without needing to send or enter a verification
        //    code. You can disable this feature by calling
        //    PhoneAuthOptions.builder#requireSmsValidation(true) when building
        //    the options to pass to PhoneAuthProvider#verifyPhoneNumber().
        // 2) Auto-retrieval. On some devices, Google Play services can
        //    automatically detect the incoming verification SMS and perform
        //    verification without user action.
        [email protected] = credential
    }

    override fun onVerificationFailed(e: FirebaseException) {
        // This callback is invoked in response to invalid requests for
        // verification, like an incorrect phone number.
        if (e is FirebaseAuthInvalidCredentialsException) {
            // Invalid request
            // ...
        } else if (e is FirebaseTooManyRequestsException) {
            // The SMS quota for the project has been exceeded
            // ...
        }
        // Show a message and update the UI
        // ...
    }

    override fun onCodeSent(
        verificationId: String, forceResendingToken: ForceResendingToken
    ) {
        // The SMS verification code has been sent to the provided phone number.
        // We now need to ask the user to enter the code and then construct a
        // credential by combining the code with a verification ID.
        // Save the verification ID and resending token for later use.
        [email protected] = verificationId
        [email protected] = forceResendingToken
        // ...
    }
}

Java

OnVerificationStateChangedCallbacks callbacks =
new OnVerificationStateChangedCallbacks() {
  @Override
  public void onVerificationCompleted(PhoneAuthCredential credential) {
    // This callback will be invoked in two situations:
    // 1) Instant verification. In some cases, the phone number can be
    //    instantly verified without needing to send or enter a verification
    //    code. You can disable this feature by calling
    //    PhoneAuthOptions.builder#requireSmsValidation(true) when building
    //    the options to pass to PhoneAuthProvider#verifyPhoneNumber().
    // 2) Auto-retrieval. On some devices, Google Play services can
    //    automatically detect the incoming verification SMS and perform
    //    verification without user action.
    this.credential = credential;
  }
  @Override
  public void onVerificationFailed(FirebaseException e) {
    // This callback is invoked in response to invalid requests for
    // verification, like an incorrect phone number.
    if (e instanceof FirebaseAuthInvalidCredentialsException) {
    // Invalid request
    // ...
    } else if (e instanceof FirebaseTooManyRequestsException) {
    // The SMS quota for the project has been exceeded
    // ...
    }
    // Show a message and update the UI
    // ...
  }
  @Override
  public void onCodeSent(
    String verificationId, PhoneAuthProvider.ForceResendingToken token) {
    // The SMS verification code has been sent to the provided phone number.
    // We now need to ask the user to enter the code and then construct a
    // credential by combining the code with a verification ID.
    // Save the verification ID and resending token for later use.
    this.verificationId = verificationId;
    this.forceResendingToken = token;
    // ...
  }
};

Inicializa un objeto PhoneInfoOptions con el número de teléfono del usuario, la sesión de varios factores y tus devoluciones de llamada:

Kotlin+KTX

val phoneAuthOptions = PhoneAuthOptions.newBuilder()
    .setPhoneNumber(phoneNumber)
    .setTimeout(30L, TimeUnit.SECONDS)
    .setMultiFactorSession(MultiFactorSession)
    .setCallbacks(callbacks)
    .build()

Java

PhoneAuthOptions phoneAuthOptions =
  PhoneAuthOptions.newBuilder()
      .setPhoneNumber(phoneNumber)
      .setTimeout(30L, TimeUnit.SECONDS)
      .setMultiFactorSession(multiFactorSession)
      .setCallbacks(callbacks)
      .build();

De forma predeterminada, la verificación instantánea se encuentra habilitada. Para inhabilitarla, agrega una llamada a requireSmsValidation(true).

Envía un mensaje de verificación al teléfono del usuario:
Kotlin+KTX
```
PhoneAuthProvider.verifyPhoneNumber(phoneAuthOptions)
```
Java
```
PhoneAuthProvider.verifyPhoneNumber(phoneAuthOptions);
```
Si bien no es obligatorio, se recomienda informar con anticipación a los usuarios que recibirán un mensaje SMS y que se aplicarán las tarifas estándar.

Después de que se envíe el código SMS, pídele al usuario que lo verifique:

Kotlin+KTX

// Ask user for the verification code.
val credential = PhoneAuthProvider.getCredential(verificationId, verificationCode)

Java

// Ask user for the verification code.
PhoneAuthCredential credential
  = PhoneAuthProvider.getCredential(verificationId, verificationCode);

Inicializa un objeto MultiFactorAssertion con la PhoneAuthCredential:

Kotlin+KTX

val multiFactorAssertion
  = PhoneMultiFactorGenerator.getAssertion(credential)

Java

MultiFactorAssertion multiFactorAssertion
  = PhoneMultiFactorGenerator.getAssertion(credential);

Completa la inscripción. De manera opcional, puedes especificar un nombre visible para el segundo factor. Esto resulta útil para usuarios con múltiples segundos factores, ya que el número de teléfono se enmascara durante el flujo de autenticación (por ejemplo, +1******1234).

Kotlin+KTX

// Complete enrollment. This will update the underlying tokens
// and trigger ID token change listener.
FirebaseAuth.getInstance()
    .currentUser
    ?.multiFactor
    ?.enroll(multiFactorAssertion, "My personal phone number")
    ?.addOnCompleteListener {
        // ...
    }

Java

// Complete enrollment. This will update the underlying tokens
// and trigger ID token change listener.
FirebaseAuth.getInstance()
  .getCurrentUser()
  .getMultiFactor()
  .enroll(multiFactorAssertion, "My personal phone number")
  .addOnCompleteListener(
      new OnCompleteListener<Void>() {
      @Override
      public void onComplete(@NonNull Task<Void> task) {
        // ...
      }
      });

En el siguiente código, se muestra un ejemplo completo de la inscripción de un segundo factor:

Kotlin+KTX

val multiFactorAssertion = PhoneMultiFactorGenerator.getAssertion(credential)
user.multiFactor.session
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            val multiFactorSession = task.result
            val phoneAuthOptions = PhoneAuthOptions.newBuilder()
                .setPhoneNumber(phoneNumber)
                .setTimeout(30L, TimeUnit.SECONDS)
                .setMultiFactorSession(multiFactorSession)
                .setCallbacks(callbacks)
                .build()
            // Send SMS verification code.
            PhoneAuthProvider.verifyPhoneNumber(phoneAuthOptions)
        }
    }

// Ask user for the verification code.
val credential = PhoneAuthProvider.getCredential(verificationId, verificationCode)

val multiFactorAssertion = PhoneMultiFactorGenerator.getAssertion(credential)

// Complete enrollment.
FirebaseAuth.getInstance()
    .currentUser
    ?.multiFactor
    ?.enroll(multiFactorAssertion, "My personal phone number")
    ?.addOnCompleteListener {
        // ...
    }

Java

MultiFactorAssertion multiFactorAssertion = PhoneMultiFactorGenerator.getAssertion(credential);
user.getMultiFactor().getSession()
  .addOnCompleteListener(
      new OnCompleteListener<MultiFactorSession>() {
      @Override
      public void onComplete(@NonNull Task<MultiFactorSession> task) {
        if (task.isSuccessful()) {
          MultiFactorSession multiFactorSession = task.getResult();
          PhoneAuthOptions phoneAuthOptions =
            PhoneAuthOptions.newBuilder()
                .setPhoneNumber(phoneNumber)
                .setTimeout(30L, TimeUnit.SECONDS)
                .setMultiFactorSession(multiFactorSession)
                .setCallbacks(callbacks)
                .build();
          // Send SMS verification code.
          PhoneAuthProvider.verifyPhoneNumber(phoneAuthOptions);
        }
      }
      });

// Ask user for the verification code.
PhoneAuthCredential credential =
  PhoneAuthProvider.getCredential(verificationId, verificationCode);

MultiFactorAssertion multiFactorAssertion = PhoneMultiFactorGenerator.getAssertion(credential);
// Complete enrollment.
FirebaseAuth.getInstance()
  .getCurrentUser()
  .getMultiFactor()
  .enroll(multiFactorAssertion, "My personal phone number")
  .addOnCompleteListener(
      new OnCompleteListener<Void>() {
      @Override
      public void onComplete(@NonNull Task<Void> task) {
        // ...
      }
      });

¡Felicitaciones! Registraste correctamente un segundo factor de autenticación para un usuario.

Permite que los usuarios accedan con un segundo factor

Para que un usuario acceda con la verificación mediante SMS de dos factores, haz lo siguiente:

Haz que el usuario acceda con el primer factor y, luego, detecta la excepción FirebaseAuthMultiFactorException. Este error contiene un agente de resolución, que puedes usar para obtener los segundos factores inscritos del usuario. También contiene una sesión subyacente que demuestra que el usuario se autenticó correctamente con su primer factor.

Por ejemplo, si el primer factor del usuario era un correo electrónico y una contraseña, haz lo siguiente:

Kotlin+KTX

FirebaseAuth.getInstance()
    .signInWithEmailAndPassword(email, password)
    .addOnCompleteListener(
        OnCompleteListener { task ->
            if (task.isSuccessful) {
                // User is not enrolled with a second factor and is successfully
                // signed in.
                // ...
                return@OnCompleteListener
            }
            if (task.exception is FirebaseAuthMultiFactorException) {
                // The user is a multi-factor user. Second factor challenge is
                // required.
                val multiFactorResolver =
                    (task.exception as FirebaseAuthMultiFactorException).resolver
                // ...
            } else {
                // Handle other errors, such as wrong password.
            }
        })

Java

FirebaseAuth.getInstance()
  .signInWithEmailAndPassword(email, password)
  .addOnCompleteListener(
      new OnCompleteListener<AuthResult>() {
      @Override
      public void onComplete(@NonNull Task<AuthResult> task) {
        if (task.isSuccessful()) {
          // User is not enrolled with a second factor and is successfully
          // signed in.
          // ...
          return;
        }
        if (task.getException() instanceof FirebaseAuthMultiFactorException) {
          // The user is a multi-factor user. Second factor challenge is
          // required.
          MultiFactorResolver multiFactorResolver = task.getException().getResolver();
          // ...
        } else {
          // Handle other errors such as wrong password.
        }
      }
      });

Si el primer factor del usuario es un proveedor federado, como OAuth, detecta el error después de llamar a startActivityForSignInWithProvider().

Si el usuario tiene múltiples factores secundarios inscritos, pregúntale cuál usará:

Kotlin+KTX

// Ask user which second factor to use.
// You can get the list of enrolled second factors using
//   multiFactorResolver.hints

// Check the selected factor:
if (multiFactorResolver.hints[selectedIndex].factorId
    === PhoneMultiFactorGenerator.FACTOR_ID
) {
    // User selected a phone second factor.
    val selectedHint =
        multiFactorResolver.hints[selectedIndex] as PhoneMultiFactorInfo
} else if (multiFactorResolver.hints[selectedIndex].factorId
    === TotpMultiFactorGenerator.FACTOR_ID) {
    // User selected a TOTP second factor.
} else {
    // Unsupported second factor.
}

Java

// Ask user which second factor to use.
// You can get the masked phone number using
// resolver.getHints().get(selectedIndex).getPhoneNumber()
// You can get the display name using
// resolver.getHints().get(selectedIndex).getDisplayName()
if ( resolver.getHints()
               .get(selectedIndex)
               .getFactorId()
               .equals( PhoneMultiFactorGenerator.FACTOR_ID ) ) {
// User selected a phone second factor.
MultiFactorInfo selectedHint =
  multiFactorResolver.getHints().get(selectedIndex);
} else if ( resolver
              .getHints()
              .get(selectedIndex)
              .getFactorId()
              .equals(TotpMultiFactorGenerator.FACTOR_ID ) ) {
  // User selected a TOTP second factor.
} else {
// Unsupported second factor.
}

Inicializa un objeto PhoneAuthOptions con la sugerencia y la sesión de varios factores. Estos valores se encuentran en el agente de resolución adjunto a FirebaseAuthMultiFactorException.

Kotlin+KTX

val phoneAuthOptions = PhoneAuthOptions.newBuilder()
    .setMultiFactorHint(selectedHint)
    .setTimeout(30L, TimeUnit.SECONDS)
    .setMultiFactorSession(multiFactorResolver.session)
    .setCallbacks(callbacks) // Optionally disable instant verification.
    // .requireSmsValidation(true)
    .build()

Java

PhoneAuthOptions phoneAuthOptions =
  PhoneAuthOptions.newBuilder()
      .setMultiFactorHint(selectedHint)
      .setTimeout(30L, TimeUnit.SECONDS)
      .setMultiFactorSession(multiFactorResolver.getSession())
      .setCallbacks(callbacks)
      // Optionally disable instant verification.
      // .requireSmsValidation(true)
      .build();

Envía un mensaje de verificación al teléfono del usuario:

Kotlin+KTX

// Send SMS verification code
PhoneAuthProvider.verifyPhoneNumber(phoneAuthOptions)

Java

// Send SMS verification code
PhoneAuthProvider.verifyPhoneNumber(phoneAuthOptions);

Después de que se envíe el código SMS, pídele al usuario que lo verifique:

Kotlin+KTX

// Ask user for the verification code. Then, pass it to getCredential:
val credential =
    PhoneAuthProvider.getCredential(verificationId, verificationCode)

Java

// Ask user for the verification code. Then, pass it to getCredential:
PhoneAuthCredential credential
    = PhoneAuthProvider.getCredential(verificationId, verificationCode);

Inicializa un objeto MultiFactorAssertion con la PhoneAuthCredential:

Kotlin+KTX

val multiFactorAssertion = PhoneMultiFactorGenerator.getAssertion(credential)

Java

MultiFactorAssertion multiFactorAssertion
    = PhoneMultiFactorGenerator.getAssertion(credential);

Llama a resolver.resolveSignIn() para completar la autenticación secundaria. Luego, puedes acceder al resultado del acceso original, en el que se incluyen los datos específicos del proveedor y las credenciales de autenticación estándar:

Kotlin+KTX

multiFactorResolver
    .resolveSignIn(multiFactorAssertion)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            val authResult = task.result
            // AuthResult will also contain the user, additionalUserInfo,
            // and an optional credential (null for email/password)
            // associated with the first factor sign-in.

            // For example, if the user signed in with Google as a first
            // factor, authResult.getAdditionalUserInfo() will contain data
            // related to Google provider that the user signed in with;
            // authResult.getCredential() will contain the Google OAuth
            //   credential;
            // authResult.getCredential().getAccessToken() will contain the
            //   Google OAuth access token;
            // authResult.getCredential().getIdToken() contains the Google
            //   OAuth ID token.
        }
    }

Java

multiFactorResolver
  .resolveSignIn(multiFactorAssertion)
  .addOnCompleteListener(
      new OnCompleteListener<AuthResult>() {
      @Override
      public void onComplete(@NonNull Task<AuthResult> task) {
        if (task.isSuccessful()) {
          AuthResult authResult = task.getResult();
          // AuthResult will also contain the user, additionalUserInfo,
          // and an optional credential (null for email/password)
          // associated with the first factor sign-in.
          // For example, if the user signed in with Google as a first
          // factor, authResult.getAdditionalUserInfo() will contain data
          // related to Google provider that the user signed in with.
          // authResult.getCredential() will contain the Google OAuth
          // credential.
          // authResult.getCredential().getAccessToken() will contain the
          // Google OAuth access token.
          // authResult.getCredential().getIdToken() contains the Google
          // OAuth ID token.
        }
      }
      });

En el siguiente código, se muestra un ejemplo completo de acceso de un usuario de varios factores:

Kotlin+KTX

FirebaseAuth.getInstance()
    .signInWithEmailAndPassword(email, password)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            // User is not enrolled with a second factor and is successfully
            // signed in.
            // ...
            return@addOnCompleteListener
        }
        if (task.exception is FirebaseAuthMultiFactorException) {
            val multiFactorResolver =
                (task.exception as FirebaseAuthMultiFactorException).resolver

            // Ask user which second factor to use. Then, get
            // the selected hint:
            val selectedHint =
                multiFactorResolver.hints[selectedIndex] as PhoneMultiFactorInfo

            // Send the SMS verification code.
            PhoneAuthProvider.verifyPhoneNumber(
                PhoneAuthOptions.newBuilder()
                    .setActivity(this)
                    .setMultiFactorSession(multiFactorResolver.session)
                    .setMultiFactorHint(selectedHint)
                    .setCallbacks(generateCallbacks())
                    .setTimeout(30L, TimeUnit.SECONDS)
                    .build()
            )

            // Ask user for the SMS verification code, then use it to get
            // a PhoneAuthCredential:
            val credential =
                PhoneAuthProvider.getCredential(verificationId, verificationCode)

            // Initialize a MultiFactorAssertion object with the
            // PhoneAuthCredential.
            val multiFactorAssertion: MultiFactorAssertion =
                PhoneMultiFactorGenerator.getAssertion(credential)

            // Complete sign-in.
            multiFactorResolver
                .resolveSignIn(multiFactorAssertion)
                .addOnCompleteListener { task ->
                    if (task.isSuccessful) {
                        // User successfully signed in with the
                        // second factor phone number.
                    }
                    // ...
                }
        } else {
            // Handle other errors such as wrong password.
        }
    }

Java

FirebaseAuth.getInstance()
  .signInWithEmailAndPassword(email, password)
  .addOnCompleteListener(
      new OnCompleteListener<AuthResult>() {
      @Override
      public void onComplete(@NonNull Task<AuthResult> task) {
        if (task.isSuccessful()) {
          // User is not enrolled with a second factor and is successfully
          // signed in.
          // ...
          return;
        }
        if (task.getException() instanceof FirebaseAuthMultiFactorException) {
          FirebaseAuthMultiFactorException e =
            (FirebaseAuthMultiFactorException) task.getException();

          MultiFactorResolver multiFactorResolver = e.getResolver();

          // Ask user which second factor to use.
          MultiFactorInfo selectedHint =
            multiFactorResolver.getHints().get(selectedIndex);

          // Send the SMS verification code.
          PhoneAuthProvider.verifyPhoneNumber(
            PhoneAuthOptions.newBuilder()
                .setActivity(this)
                .setMultiFactorSession(multiFactorResolver.getSession())
                .setMultiFactorHint(selectedHint)
                .setCallbacks(generateCallbacks())
                .setTimeout(30L, TimeUnit.SECONDS)
                .build());

          // Ask user for the SMS verification code.
          PhoneAuthCredential credential =
            PhoneAuthProvider.getCredential(verificationId, verificationCode);

          // Initialize a MultiFactorAssertion object with the
          // PhoneAuthCredential.
          MultiFactorAssertion multiFactorAssertion =
            PhoneMultiFactorGenerator.getAssertion(credential);

          // Complete sign-in.
          multiFactorResolver
            .resolveSignIn(multiFactorAssertion)
            .addOnCompleteListener(
                new OnCompleteListener<AuthResult>() {
                  @Override
                  public void onComplete(@NonNull Task<AuthResult> task) {
                  if (task.isSuccessful()) {
                    // User successfully signed in with the
                    // second factor phone number.
                  }
                  // ...
                  }
                });
        } else {
          // Handle other errors such as wrong password.
        }
      }
      });

¡Felicitaciones! Permitiste acceder a un usuario correctamente mediante la autenticación de varios factores.

Próximos pasos

Administra usuarios de varios factores de manera programática con el SDK de Admin.