Esta página foi traduzida pela API Cloud Translation.
Switch to English

Como adicionar a autenticação multifator ao seu app da Web

Este documento mostra como adicionar a autenticação multifator por SMS ao seu app da Web.

A autenticação multifator aumenta a segurança do aplicativo. Os invasores costumam comprometer as senhas e contas de redes sociais, mas é mais difícil interceptar uma mensagem de texto.

Antes de começar

  1. Ative um provedor que seja compatível com a autenticação multifator. São eles:

    • E-mail e senha
    • Enviar link por e-mail
    • Google
    • Facebook
    • Twitter
    • GitHub
    • Microsoft
    • Yahoo
    • LinkedIn
    • SAML
    • OIDC
  2. Confirme se o app está verificando os e-mails do usuário. A autenticação multifator (MFA) requer verificação de e-mail. Isso impede que agentes mal-intencionados se registrem em um serviço com um e-mail que não tenham e bloqueiem o proprietário real adicionando um segundo fator.

Como usar multilocação

Se você estiver ativando a autenticação multifator para uso em um ambiente de multilocação, conclua as etapas a seguir (além das demais instruções deste documento):

  • No Console do Cloud, selecione o locatário com que você quer trabalhar.

  • No código, defina o campo tenantId na instância Auth como o ID do locatário. Exemplo:

    firebase.auth().tenantId = 'myTenantId1';
    

Como ativar a autenticação multifator

  1. Acesse a página Identity Platform MFA no Console do Cloud.
    Acessar a página MFA

  2. Na caixa Autenticação de vários fatores baseada em SMS, clique em Ativar.

  3. Insira os números de telefone com os quais você testará seu aplicativo. Ainda que seja opcional, é altamente recomendável registrar números de telefone de teste para evitar a limitação durante o desenvolvimento.

  4. Se você ainda não autorizou o domínio do seu aplicativo, adicione-o à lista de permissões clicando em Adicionar domínio à direita.

  5. Clique em Save.

Como escolher um padrão de inscrição

Você pode escolher se o app requer autenticação multifator e como e quando inscrever os usuários. Alguns padrões comuns incluem:

  • Inscrever o segundo fator do usuário como parte do registro. Use esse método se o aplicativo exigir autenticação multifator para todos os usuários.

  • Ofereça uma opção pulável para inscrever um segundo fator durante o registro. Os apps que quiserem incentivar, mas não exigirem, a autenticação multifator terão essa abordagem.

  • Ofereça a capacidade de adicionar um segundo fator da página de gerenciamento da conta ou do perfil do usuário, em vez da tela de inscrição. Isso minimiza o atrito durante o processo de registro, enquanto disponibilizando a autenticação multifator para usuários sensíveis à segurança.

  • Exija a adição de um segundo fator de maneira incremental quando o usuário quiser acessar recursos com requisitos de segurança aprimorados.

Como configurar o verificador reCAPTCHA

Antes de enviar códigos SMS, é necessário configurar um verificador reCAPTCHA. O Identity Platform usa o reCAPTCHA para evitar abusos, garantindo que as solicitações de verificação de número de telefone sejam provenientes de um dos domínios permitidos do app.

Não é preciso configurar manualmente um cliente reCAPTCHA. O objeto RecaptchaVerifier do SDK do cliente cria e inicializa automaticamente todos secrets e chaves de cliente necessárias.

Como usar o reCAPTCHA invisível

O objeto RecaptchaVerifier é compatível com reCAPTCHA invisível, que geralmente verifica o usuário sem exigir nenhuma interação. Para usar um reCAPTCHA invisível, crie um RecaptchaVerifier com o parâmetro size definido como invisible e especifique o ID do elemento da IU que inicia a inscrição de vários fatores:

var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('sign-in-button', {
 'size': 'invisible',
 'callback': function(response) {
   // reCAPTCHA solved, you can proceed with phoneAuthProvider.verifyPhoneNumber(...).
   onSolvedRecaptcha();
 }
});

Como usar o widget reCAPTCHA

Para usar um widget reCAPTCHA visível, crie um elemento HTML para conter o widget e, em seguida, crie um objeto RecaptchaVerifier com o ID do contêiner da IU. Também é possível definir callbacks que são invocados quando o reCAPTCHA é resolvido ou expira:

var recaptchaVerifier = new firebase.auth.RecaptchaVerifier(
  'recaptcha-container',
  // Optional reCAPTCHA parameters.
  {
    'size': 'normal',
    'callback': function(response) {
      // reCAPTCHA solved, you can proceed with phoneAuthProvider.verifyPhoneNumber(...).
      // ...
      onSolvedRecaptcha();
    },
    'expired-callback': function() {
      // Response expired. Ask user to solve reCAPTCHA again.
      // ...
    }
  });

Pré-renderizar o reCAPTCHA

Como opção, você pode pré-renderizar o reCAPTCHA antes de iniciar a inscrição de dois fatores:

recaptchaVerifier.render()
  .then(function(widgetId) {
    window.recaptchaWidgetId = widgetId;
  });

Quando render() é resolvido, você recebe o ID do widget do reCAPTCHA, que pode ser usado para fazer chamadas para a API reCAPTCHA:

var recaptchaResponse = grecaptcha.getResponse(window.recaptchaWidgetId);

Como inscrever um segundo fator

Para inscrever um novo fator secundário para um usuário:

  1. Re-autentique o usuário.

  2. Peça ao usuário para inserir o número de telefone.

  3. Inicialize o verificador reCAPTCHA conforme ilustrado na seção anterior. Pule esta etapa se uma instância do RecaptchaVerifier já estiver configurada:

    var recaptchaVerifier = new firebase.auth.RecaptchaVerifier(container);
    
  4. Receba uma sessão de vários fatores para o usuário:

    user.multiFactor.getSession().then(function(multiFactorSession) {
      // ...
    })
    
  5. Inicialize um objeto PhoneInfoOptions com o número de telefone do usuário e a sessão de vários fatores:

    // Specify the phone number and pass the MFA session.
    var phoneInfoOptions = {
      phoneNumber: phoneNumber,
      session: multiFactorSession
    };
    
  6. Enviar uma mensagem de verificação para o telefone do usuário:

    var phoneAuthProvider = new firebase.auth.PhoneAuthProvider();
    // Send SMS verification code.
    return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
      .then(function(verificationId) {
        // verificationId will be needed for enrollment completion.
      })
    

    Ainda que não seja obrigatório, é uma prática recomendada informar aos usuários antecipadamente que eles receberão uma mensagem SMS e quais taxas padrão serão aplicadas.

  7. Se a solicitação falhar, redefina o reCAPTCHA e repita a etapa anterior para que o usuário possa tentar novamente. Observe que verifyPhoneNumber() redefinirá o reCAPTCHA automaticamente ao gerar um erro, já que os tokens de reCAPTCHA são usados apenas uma vez.

    grecaptcha.reset(window.recaptchaWidgetId);
    
    // Or, if you haven't stored the widget ID:
    recaptchaVerifier.render()
      .then(function(widgetId) {
        grecaptcha.reset(widgetId);
      });
    
  8. Depois que o código SMS for enviado, peça ao usuário para verificar o código:

    // Ask user for the verification code.
    var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);
    
  9. Inicialize um objeto MultiFactorAssertion com o PhoneAuthCredential:

    var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);
    
  10. Conclua a inscrição. Se quiser, é possível especificar um nome de exibição para o segundo fator. Isso é útil para usuários com vários fatores, já que o número de telefone é mascarado durante o fluxo de autenticação (por exemplo, +1******1234).

    // Complete enrollment. This will update the underlying tokens
    // and trigger ID token change listener.
    user.multiFactor.enroll(multiFactorAssertion, 'My personal phone number');
    

O código abaixo mostra um exemplo completo de inscrição de um segundo fator:

var recaptchaVerifier = new firebase.auth.RecaptchaVerifier(container);
user.multiFactor.getSession().then(function(multiFactorSession) {
  // Specify the phone number and pass the MFA session.
  var phoneInfoOptions = {
    phoneNumber: phoneNumber,
    session: multiFactorSession
  };
  var phoneAuthProvider = new firebase.auth.PhoneAuthProvider();
  // Send SMS verification code.
  return phoneAuthProvider.verifyPhoneNumber(
      phoneInfoOptions, recaptchaVerifier);
})
.then(function(verificationId) {
  // Ask user for the verification code.
  var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);
  var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);
  // Complete enrollment.
  return user.multiFactor.enroll(multiFactorAssertion, mfaDisplayName);
});

Parabéns! Você registrou um segundo fator de autenticação para um usuário.

Como fazer login dos usuários com um segundo fator

Para fazer login de um usuário com verificação por SMS de dois fatores:

  1. Faça login do usuário com o primeiro fator e detecte o erro auth/multi-factor-auth-required. Esse erro contém um resolvedor, dicas sobre os dois fatores registrados e uma sessão subjacente que mostra que o usuário foi autenticado com êxito com o primeiro fator.

    Por exemplo, se o primeiro fator do usuário for um e-mail e uma senha:

    firebase.auth().signInWithEmailAndPassword(email, password)
      .then(function(userCredential) {
        // User successfully signed in and is not enrolled with a second factor.
      })
      .catch(function(error) {
        if (error.code == 'auth/multi-factor-auth-required') {
          // The user is a multi-factor user. Second factor challenge is required.
          resolver = error.resolver;
          // ...
        } else if (error.code == 'auth/wrong-password') {
          // Handle other errors such as wrong password.
        } ...
      });
    

    Se o primeiro fator do usuário for um provedor federado, como OAuth, SAML ou OIDC, capture o erro depois de chamar signInWithPopup() ou signInWithRedirect().

  2. Se o usuário tiver vários fatores secundários registrados, pergunte a ele qual usar:

    // Ask user which second factor to use.
    // You can get the masked phone number via resolver.hints[selectedIndex].phoneNumber
    // You can get the display name via resolver.hints[selectedIndex].displayName
    if (resolver.hints[selectedIndex].factorId === firebase.auth.PhoneMultiFactorGenerator.FACTOR_ID) {
      // User selected a phone second factor.
      // ...
    } else {
      // Unsupported second factor.
      // Note that only phone second factors are currently supported.
    }
    
  3. Inicialize o verificador reCAPTCHA conforme ilustrado na seção anterior. Pule esta etapa se uma instância do RecaptchaVerifier já estiver configurada:

    var recaptchaVerifier = new firebase.auth.RecaptchaVerifier(container);
    
  4. Inicialize um objeto PhoneInfoOptions com o número de telefone do usuário e a sessão de vários fatores. Esses valores estão contidos no objeto resolver passado ao erro auth/multi-factor-auth-required:

    var phoneInfoOptions = {
      multiFactorHint: resolver.hints[selectedIndex],
      session: resolver.session
    };
    
  5. Enviar uma mensagem de verificação para o telefone do usuário:

    var phoneAuthProvider = new firebase.auth.PhoneAuthProvider();
    // Send SMS verification code.
    return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
      .then(function(verificationId) {
        // verificationId will be needed for sign-in completion.
      })
    
  6. Se a solicitação falhar, redefina o reCAPTCHA e repita a etapa anterior para que o usuário possa tentar novamente:

    grecaptcha.reset(window.recaptchaWidgetId);
    
    // Or, if you haven't stored the widget ID:
    recaptchaVerifier.render()
      .then(function(widgetId) {
        grecaptcha.reset(widgetId);
      });
    
  7. Quando o código SMS for enviado, peça ao usuário para verificar o código:

    // Ask user for the verification code.
    var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);
    
  8. Inicialize um objeto MultiFactorAssertion com o PhoneAuthCredential:

    var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);
    
  9. Chame resolver.resolverSignIn() para concluir a autenticação secundária. É possível acessar o resultado de login original, que inclui as credenciais padrão de autenticação e dados específicos do provedor:

    // Complete sign-in. This will also trigger the Auth state listeners.
    resolver.resolveSignIn(multiFactorAssertion)
      .then(function(userCredential) {
        // userCredential will also contain the user, additionalUserInfo, 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,
        // userCredential.additionalUserInfo will contain data related to Google provider that
        // the user signed in with.
        // user.credential contains the Google OAuth credential.
        // user.credential.accessToken contains the Google OAuth access token.
        // user.credential.idToken contains the Google OAuth ID token.
      });
    

O código abaixo mostra um exemplo completo de login em um usuário de vários fatores:

var resolver;
firebase.auth().signInWithEmailAndPassword(email, password)
  .then(function(userCredential) {
    // User is not enrolled with a second factor and is successfully signed in.
    // ...
  })
  .catch(function(error) {
    if (error.code == 'auth/multi-factor-auth-required') {
      resolver = error.resolver;
      // Ask user which second factor to use.
      if (resolver.hints[selectedIndex].factorId ===
          firebase.auth.PhoneMultiFactorGenerator.FACTOR_ID) {
        var phoneInfoOptions = {
          multiFactorHint: resolver.hints[selectedIndex],
          session: resolver.session
        };
        var phoneAuthProvider = new firebase.auth.PhoneAuthProvider();
        // Send SMS verification code
        return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
          .then(function(verificationId) {
            // Ask user for the SMS verification code.
            var cred = firebase.auth.PhoneAuthProvider.credential(
                verificationId, verificationCode);
            var multiFactorAssertion =
                firebase.auth.PhoneMultiFactorGenerator.assertion(cred);
            // Complete sign-in.
            return resolver.resolveSignIn(multiFactorAssertion)
          })
          .then(function(userCredential) {
            // User successfully signed in with the second factor phone number.
          });
      } else {
        // Unsupported second factor.
      }
    } else if (error.code == 'auth/wrong-password') {
      // Handle other errors such as wrong password.
    } ...
  });

Parabéns! Você fez login com sucesso usando uma autenticação multifator.

A seguir