Добавьте многофакторную аутентификацию в свое веб-приложение

Если вы перешли на Firebase Authentication with Identity Platform, вы можете добавить многофакторную аутентификацию по SMS в свое веб-приложение.

Многофакторная аутентификация повышает безопасность вашего приложения. В то время как злоумышленники часто компрометируют пароли и учетные записи социальных сетей, перехватить текстовое сообщение сложнее.

Прежде чем вы начнете

  1. Включите хотя бы одного провайдера, поддерживающего многофакторную аутентификацию. Все провайдеры поддерживают MFA, кроме аутентификации по телефону, анонимной аутентификации и Apple Game Center.

  2. Убедитесь, что ваше приложение проверяет электронную почту пользователей. MFA требует подтверждения электронной почты. Это не позволяет злоумышленникам зарегистрироваться в службе с адресом электронной почты, которым они не владеют, а затем заблокировать реального владельца, добавив второй фактор.

Использование мультитенантности

Если вы включаете многофакторную аутентификацию для использования в многопользовательской среде, обязательно выполните следующие шаги (в дополнение к остальным инструкциям в этом документе):

  1. В консоли GCP выберите арендатора, с которым вы хотите работать.

  2. В своем коде задайте в поле tenantId экземпляра Auth идентификатор вашего клиента. Например:

    Модульный веб-API

    import { getAuth } from "firebase/auth";

const auth = getAuth(app);
auth.tenantId = "myTenantId1";

    Веб-API с пространством имен

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

Включение многофакторной аутентификации

  1. Откройте страницу Аутентификация > Способ входа в консоль Firebase.

  2. В разделе «Дополнительно» включите Многофакторную аутентификацию по SMS .

    Вам также следует ввести номера телефонов, с которыми вы будете тестировать свое приложение. Хотя это и необязательно, регистрация тестовых номеров телефонов настоятельно рекомендуется, чтобы избежать ограничений во время разработки.

  3. Если вы еще не авторизовали домен своего приложения, добавьте его в список разрешенных на странице Аутентификация > Настройки консоли Firebase.

Выбор схемы регистрации

Вы можете выбрать, требует ли ваше приложение многофакторную аутентификацию, а также как и когда регистрировать пользователей. Некоторые распространенные шаблоны включают в себя:

  • Зарегистрируйте второй фактор пользователя как часть регистрации. Используйте этот метод, если вашему приложению требуется многофакторная проверка подлинности для всех пользователей.

  • Предложите вариант с возможностью пропуска для регистрации второго фактора во время регистрации. Приложения, которые хотят поощрять, но не требуют многофакторную аутентификацию, могут предпочесть этот подход.

  • Предоставьте возможность добавить второй фактор со страницы управления учетной записью или профилем пользователя, а не с экрана регистрации. Это сводит к минимуму трения в процессе регистрации, в то же время делая многофакторную аутентификацию доступной для чувствительных к безопасности пользователей.

  • Требовать постепенного добавления второго фактора, когда пользователь хочет получить доступ к функциям с повышенными требованиями к безопасности.

Настройка верификатора reCAPTCHA

Прежде чем вы сможете отправлять SMS-коды, вам необходимо настроить верификатор reCAPTCHA. Firebase использует reCAPTCHA для предотвращения злоупотреблений, гарантируя, что запросы на подтверждение номера телефона поступают с одного из разрешенных доменов вашего приложения.

Вам не нужно вручную настраивать клиент reCAPTCHA; объект RecaptchaVerifier клиентского SDK автоматически создает и инициализирует все необходимые клиентские ключи и секреты.

Использование невидимой reCAPTCHA

Объект RecaptchaVerifier поддерживает невидимую reCAPTCHA , которая часто может проверить пользователя без какого-либо взаимодействия. Чтобы использовать невидимую reCAPTCHA, создайте RecaptchaVerifier с параметром size , установленным на invisible , и укажите идентификатор элемента пользовательского интерфейса, который запускает многофакторную регистрацию:

Модульный веб-API

import { RecaptchaVerifier } from "firebase/auth";

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

Веб-API с пространством имен

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

Использование виджета reCAPTCHA

Чтобы использовать видимый виджет reCAPTCHA, создайте элемент HTML, содержащий виджет, затем создайте объект RecaptchaVerifier с идентификатором контейнера пользовательского интерфейса. Вы также можете дополнительно установить обратные вызовы, которые вызываются, когда reCAPTCHA решена или истекает:

Модульный веб-API

import { RecaptchaVerifier } from "firebase/auth";

const recaptchaVerifier = new 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.
        // ...
      }
    }, auth
);

Веб-API с пространством имен

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.
      // ...
    }
  });

Предварительный рендеринг reCAPTCHA

При желании вы можете выполнить предварительную визуализацию reCAPTCHA перед началом двухфакторной регистрации:

Модульный веб-API

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

Веб-API с пространством имен

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

После разрешения render() вы получаете идентификатор виджета reCAPTCHA, который вы можете использовать для вызовов API reCAPTCHA :

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

RecaptchaVerifier абстрагирует эту логику с помощью метода verify , поэтому вам не нужно напрямую обрабатывать переменную grecaptcha .

Регистрация второго фактора

Чтобы зарегистрировать новый вторичный фактор для пользователя:

  1. Повторно аутентифицируйте пользователя.

  2. Попросите пользователя ввести свой номер телефона.

  3. Инициализируйте верификатор reCAPTCHA, как показано в предыдущем разделе. Пропустите этот шаг, если экземпляр RecaptchaVerifier уже настроен:

    Модульный веб-API

    import { RecaptchaVerifier } from "firebase/auth";

const recaptchaVerifier = new RecaptchaVerifier('recaptcha-container-id', undefined, auth);

    Веб-API с пространством имен

    var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container-id');

  4. Получите многофакторную сессию для пользователя:

    Модульный веб-API

    import { multiFactor } from "firebase/auth";

multiFactor(user).getSession().then(function (multiFactorSession) {
    // ...
});

    Веб-API с пространством имен

    user.multiFactor.getSession().then(function(multiFactorSession) {
  // ...
})

  5. Инициализируйте объект PhoneInfoOptions с номером телефона пользователя и многофакторным сеансом:

    Модульный веб-API

    // Specify the phone number and pass the MFA session.
const phoneInfoOptions = {
  phoneNumber: phoneNumber,
  session: multiFactorSession
};

    Веб-API с пространством имен

    // Specify the phone number and pass the MFA session.
var phoneInfoOptions = {
  phoneNumber: phoneNumber,
  session: multiFactorSession
};

  6. Отправьте проверочное сообщение на телефон пользователя:

    Модульный веб-API

    import { PhoneAuthProvider } from "firebase/auth";

const phoneAuthProvider = new PhoneAuthProvider(auth);
phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
    .then(function (verificationId) {
        // verificationId will be needed to complete enrollment.
    });

    Веб-API с пространством имен

    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.
  })

    Хотя это и не требуется, рекомендуется заранее информировать пользователей о том, что они получат SMS-сообщение и что применяются стандартные тарифы.

  7. Если запрос не выполнен, сбросьте reCAPTCHA, затем повторите предыдущий шаг, чтобы пользователь мог повторить попытку. Обратите внимание, что verifyPhoneNumber() автоматически сбрасывает reCAPTCHA, когда выдает ошибку, поскольку токены reCAPTCHA используются только один раз.

    Модульный веб-API

    recaptchaVerifier.clear();

    Веб-API с пространством имен

    recaptchaVerifier.clear();

  8. После отправки SMS-кода попросите пользователя подтвердить код:

    Модульный веб-API

    // Ask user for the verification code. Then:
const cred = PhoneAuthProvider.credential(verificationId, verificationCode);

    Веб-API с пространством имен

    // Ask user for the verification code. Then:
var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);

  9. Инициализируйте объект MultiFactorAssertion с помощью PhoneAuthCredential :

    Модульный веб-API

    import { PhoneMultiFactorGenerator } from "firebase/auth";

const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(cred);

    Веб-API с пространством имен

    var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);

  10. Завершите регистрацию. При желании вы можете указать отображаемое имя для второго фактора. Это полезно для пользователей с несколькими секундными факторами, поскольку номер телефона маскируется во время процесса аутентификации (например, +1******1234).

    Модульный веб-API

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

    Веб-API с пространством имен

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

Код ниже показывает полный пример регистрации второго фактора:

Модульный веб-API

import {
    multiFactor, PhoneAuthProvider, PhoneMultiFactorGenerator,
    RecaptchaVerifier
} from "firebase/auth";

const recaptchaVerifier = new RecaptchaVerifier('recaptcha-container-id', undefined, auth);
multiFactor(user).getSession()
    .then(function (multiFactorSession) {
        // Specify the phone number and pass the MFA session.
        const phoneInfoOptions = {
            phoneNumber: phoneNumber,
            session: multiFactorSession
        };

        const phoneAuthProvider = new PhoneAuthProvider(auth);

        // Send SMS verification code.
        return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier);
    }).then(function (verificationId) {
        // Ask user for the verification code. Then:
        const cred = PhoneAuthProvider.credential(verificationId, verificationCode);
        const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(cred);

        // Complete enrollment.
        return multiFactor(user).enroll(multiFactorAssertion, mfaDisplayName);
    });

Веб-API с пространством имен

var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container-id');
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);
});

Поздравляем! Вы успешно зарегистрировали второй фактор аутентификации для пользователя.

Вход пользователей с помощью второго фактора

Чтобы войти в систему с двухфакторной SMS-верификацией:

  1. Войдите в систему с помощью первого фактора, а затем поймайте ошибку auth/multi-factor-auth-required . Эта ошибка содержит преобразователь, подсказки о зарегистрированных вторых факторах и базовый сеанс, подтверждающий, что пользователь успешно прошел проверку подлинности с помощью первого фактора.

    Например, если первым фактором пользователя был адрес электронной почты и пароль:

    Модульный веб-API

    import { getAuth, getMultiFactorResolver} from "firebase/auth";

const auth = getAuth();
signInWithEmailAndPassword(auth, 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 = getMultiFactorResolver(auth, error);
            // ...
        } else if (error.code == 'auth/wrong-password') {
            // Handle other errors such as wrong password.
        }
});

    Веб-API с пространством имен

    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.
    } ...
  });

    Если первым фактором пользователя является федеративный поставщик, такой как OAuth, SAML или OIDC, перехватите ошибку после вызова signInWithPopup() или signInWithRedirect() .

  2. Если у пользователя есть несколько зарегистрированных вторичных факторов, спросите их, какой из них использовать:

    Модульный веб-API

    // 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 ===
    PhoneMultiFactorGenerator.FACTOR_ID) {
    // User selected a phone second factor.
    // ...
} else if (resolver.hints[selectedIndex].factorId ===
           TotpMultiFactorGenerator.FACTOR_ID) {
    // User selected a TOTP second factor.
    // ...
} else {
    // Unsupported second factor.
}

    Веб-API с пространством имен

    // 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 if (resolver.hints[selectedIndex].factorId === firebase.auth.TotpMultiFactorGenerator.FACTOR_ID) {
  // User selected a TOTP second factor.
  // ...
} else {
  // Unsupported second factor.
}

  3. Инициализируйте верификатор reCAPTCHA, как показано в предыдущем разделе. Пропустите этот шаг, если экземпляр RecaptchaVerifier уже настроен:

    Модульный веб-API

    import { RecaptchaVerifier } from "firebase/auth";

recaptchaVerifier = new RecaptchaVerifier('recaptcha-container-id', undefined, auth);

    Веб-API с пространством имен

    var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container-id');

  4. Инициализируйте объект PhoneInfoOptions с номером телефона пользователя и многофакторным сеансом. Эти значения содержатся в объекте resolver , переданном в ошибку auth/multi-factor-auth-required :

    Модульный веб-API

    const phoneInfoOptions = {
    multiFactorHint: resolver.hints[selectedIndex],
    session: resolver.session
};

    Веб-API с пространством имен

    var phoneInfoOptions = {
  multiFactorHint: resolver.hints[selectedIndex],
  session: resolver.session
};

  5. Отправьте проверочное сообщение на телефон пользователя:

    Модульный веб-API

    // Send SMS verification code.
const phoneAuthProvider = new PhoneAuthProvider(auth);
phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
    .then(function (verificationId) {
        // verificationId will be needed for sign-in completion.
    });

    Веб-API с пространством имен

    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. Если запрос не выполнен, сбросьте reCAPTCHA, затем повторите предыдущий шаг, чтобы пользователь мог повторить попытку:

    Модульный веб-API

    recaptchaVerifier.clear();

    Веб-API с пространством имен

    recaptchaVerifier.clear();

  7. После отправки SMS-кода попросите пользователя подтвердить код:

    Модульный веб-API

    const cred = PhoneAuthProvider.credential(verificationId, verificationCode);

    Веб-API с пространством имен

    // Ask user for the verification code. Then:
var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);

  8. Инициализируйте объект MultiFactorAssertion с помощью PhoneAuthCredential :

    Модульный веб-API

    const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(cred);

    Веб-API с пространством имен

    var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);

  9. Вызовите resolver.resolveSignIn() для завершения вторичной аутентификации. Затем вы можете получить доступ к исходному результату входа, который включает стандартные данные для конкретного поставщика и учетные данные для аутентификации:

    Модульный веб-API

    // 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.
    });

    Веб-API с пространством имен

    // 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.
  });

В приведенном ниже коде показан полный пример входа многофакторного пользователя:

Модульный веб-API

import {
    getAuth,
    getMultiFactorResolver,
    PhoneAuthProvider,
    PhoneMultiFactorGenerator,
    RecaptchaVerifier,
    signInWithEmailAndPassword
} from "firebase/auth";

const recaptchaVerifier = new RecaptchaVerifier('recaptcha-container-id', undefined, auth);

const auth = getAuth();
signInWithEmailAndPassword(auth, 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') {
            const resolver = getMultiFactorResolver(auth, error);
            // Ask user which second factor to use.
            if (resolver.hints[selectedIndex].factorId ===
                PhoneMultiFactorGenerator.FACTOR_ID) {
                const phoneInfoOptions = {
                    multiFactorHint: resolver.hints[selectedIndex],
                    session: resolver.session
                };
                const phoneAuthProvider = new PhoneAuthProvider(auth);
                // Send SMS verification code
                return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
                    .then(function (verificationId) {
                        // Ask user for the SMS verification code. Then:
                        const cred = PhoneAuthProvider.credential(
                            verificationId, verificationCode);
                        const multiFactorAssertion =
                            PhoneMultiFactorGenerator.assertion(cred);
                        // Complete sign-in.
                        return resolver.resolveSignIn(multiFactorAssertion)
                    })
                    .then(function (userCredential) {
                        // User successfully signed in with the second factor phone number.
                    });
            } else if (resolver.hints[selectedIndex].factorId ===
                       TotpMultiFactorGenerator.FACTOR_ID) {
                // Handle TOTP MFA.
                // ...
            } else {
                // Unsupported second factor.
            }
        } else if (error.code == 'auth/wrong-password') {
            // Handle other errors such as wrong password.
        }
    });

Веб-API с пространством имен

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 if (resolver.hints[selectedIndex].factorId ===
        firebase.auth.TotpMultiFactorGenerator.FACTOR_ID) {
        // Handle TOTP MFA.
        // ...
      } else {
        // Unsupported second factor.
      }
    } else if (error.code == 'auth/wrong-password') {
      // Handle other errors such as wrong password.
    } ...
  });

Поздравляем! Вы успешно вошли в систему с помощью многофакторной аутентификации.

Что дальше