Как пройти аутентификацию в Firebase с помощью номера телефона, используя JavaScript

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

Проще всего добавить в приложение вход по номеру телефона с помощью FirebaseUI. В нем есть виджет, который позволяет реализовать вход по номеру телефона, паролю и федеративный вход. В этом документе описывается, как реализовать вход по номеру телефона с помощью Firebase SDK.

Подготовка

Если вы ещё этого не сделали, скопируйте фрагмент инициализации из консоли Firebase в свой проект, как описано в статье Как добавить Firebase в проект JavaScript.

Проблемы с безопасностью

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

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

Как включить вход по номеру телефона в проекте Firebase

Чтобы пользователи могли входить в систему с помощью SMS, сначала необходимо включить способ входа по номеру телефона для проекта Firebase:

  1. В консоли Firebase выберите Безопасность > Аутентификация.
  2. На вкладке Sign-in method (Способ входа) включите поставщика входа Phone (Телефон).
  3. Задайте правило для регионов, в которые вы хотите разрешить или запретить отправку SMS. Настройка правил для регионов SMS помогает защитить приложения от злоупотреблений, связанных с SMS. Для новых проектов правило по умолчанию не разрешает ни один регион.
    1. В консоли Firebase выберите Security (Безопасность) > Authentication (Аутентификация) > Settings (Настройки).
    2. В разделе Правила в отношении регионов для SMS настройте правила.
  4. Если вы этого ещё не сделали, авторизуйте домен приложения:
    1. В консоли Firebase выберите Security (Безопасность) > Authentication (Аутентификация) > Settings (Настройки).
    2. В разделе Авторизованные домены нажмите Добавить домен и укажите свой домен.

    Обратите внимание, что localhost не может быть размещенным доменом для аутентификации по номеру телефона.

Как настроить проверку reCAPTCHA

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

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

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

Базовую отрисованную reCAPTCHA можно локализовать в соответствии с предпочтениями пользователя, обновив код языка в экземпляре Auth перед отрисовкой reCAPTCHA. Вышеупомянутая локализация также будет применяться к SMS-сообщению, отправленному пользователю и содержащему код подтверждения.

Web

import { getAuth } from "firebase/auth";

const auth = getAuth();
auth.languageCode = 'it';
// To apply the default browser preference instead of explicitly setting it.
// auth.useDeviceLanguage();

Web

firebase.auth().languageCode = 'it';
// To apply the default browser preference instead of explicitly setting it.
// firebase.auth().useDeviceLanguage();

Использовать невидимую проверку reCAPTCHA

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

Web

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

const auth = getAuth();
window.recaptchaVerifier = new RecaptchaVerifier(auth, 'sign-in-button', {
  'size': 'invisible',
  'callback': (response) => {
    // reCAPTCHA solved, allow signInWithPhoneNumber.
    onSignInSubmit();
  }
});

Web

window.recaptchaVerifier = new firebase.auth.RecaptchaVerifier('sign-in-button', {
  'size': 'invisible',
  'callback': (response) => {
    // reCAPTCHA solved, allow signInWithPhoneNumber.
    onSignInSubmit();
  }
});

Как использовать виджет reCAPTCHA

Чтобы использовать видимый виджет reCAPTCHA, создайте на странице элемент, который будет содержать виджет, а затем создайте объект RecaptchaVerifier, указав идентификатор контейнера. Пример:

Web

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

const auth = getAuth();
window.recaptchaVerifier = new RecaptchaVerifier(auth, 'recaptcha-container', {});

Web

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

Необязательно: укажите параметры reCAPTCHA

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

Web

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

const auth = getAuth();
window.recaptchaVerifier = new RecaptchaVerifier(auth, 'recaptcha-container', {
  'size': 'normal',
  'callback': (response) => {
    // reCAPTCHA solved, allow signInWithPhoneNumber.
    // ...
  },
  'expired-callback': () => {
    // Response expired. Ask user to solve reCAPTCHA again.
    // ...
  }
});

Web

window.recaptchaVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container', {
  'size': 'normal',
  'callback': (response) => {
    // reCAPTCHA solved, allow signInWithPhoneNumber.
    // ...
  },
  'expired-callback': () => {
    // Response expired. Ask user to solve reCAPTCHA again.
    // ...
  }
});

Необязательно: предварительная отрисовка reCAPTCHA

Если вы хотите выполнить предварительную отрисовку reCAPTCHA перед отправкой запроса на вход, вызовите render:

Web

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

Web

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

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

Web

const recaptchaResponse = grecaptcha.getResponse(recaptchaWidgetId);

Web

const recaptchaResponse = grecaptcha.getResponse(recaptchaWidgetId);

Отправка кода подтверждения на телефон пользователя

Чтобы инициировать вход по номеру телефона, покажите пользователю интерфейс, в котором ему будет предложено указать номер телефона, а затем вызовите signInWithPhoneNumber, чтобы запросить у Firebase отправку кода аутентификации на телефон пользователя по SMS:

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

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

  2. Вызовите signInWithPhoneNumber, передав номер телефона пользователя и созданный ранее объект RecaptchaVerifier.

    Web

    import { getAuth, signInWithPhoneNumber } from "firebase/auth";
    
    const phoneNumber = getPhoneNumberFromUserInput();
    const appVerifier = window.recaptchaVerifier;
    
    const auth = getAuth();
    signInWithPhoneNumber(auth, phoneNumber, appVerifier)
        .then((confirmationResult) => {
          // SMS sent. Prompt user to type the code from the message, then sign the
          // user in with confirmationResult.confirm(code).
          window.confirmationResult = confirmationResult;
          // ...
        }).catch((error) => {
          // Error; SMS not sent
          // ...
        });

    Web

    const phoneNumber = getPhoneNumberFromUserInput();
    const appVerifier = window.recaptchaVerifier;
    firebase.auth().signInWithPhoneNumber(phoneNumber, appVerifier)
        .then((confirmationResult) => {
          // SMS sent. Prompt user to type the code from the message, then sign the
          // user in with confirmationResult.confirm(code).
          window.confirmationResult = confirmationResult;
          // ...
        }).catch((error) => {
          // Error; SMS not sent
          // ...
        });
    Если signInWithPhoneNumber возвращает ошибку, сбросьте reCAPTCHA, чтобы пользователь мог повторить попытку:
    grecaptcha.reset(window.recaptchaWidgetId);
    
    // Or, if you haven't stored the widget ID:
    window.recaptchaVerifier.render().then(function(widgetId) {
      grecaptcha.reset(widgetId);
    });

Метод signInWithPhoneNumber запускает проверку reCAPTCHA. Если пользователь проходит ее, Firebase Authentication отправляет SMS с кодом подтверждения на его телефон.

Выполните вход пользователя с помощью кода подтверждения.

После успешного вызова signInWithPhoneNumber попросите пользователя ввести код подтверждения, полученный по SMS. Затем выполните вход пользователя, передав код в метод confirm объекта ConfirmationResult, который был передан обработчику выполнения signInWithPhoneNumber (то есть его блоку then). Пример:

Web

const code = getCodeFromUserInput();
confirmationResult.confirm(code).then((result) => {
  // User signed in successfully.
  const user = result.user;
  // ...
}).catch((error) => {
  // User couldn't sign in (bad verification code?)
  // ...
});

Web

const code = getCodeFromUserInput();
confirmationResult.confirm(code).then((result) => {
  // User signed in successfully.
  const user = result.user;
  // ...
}).catch((error) => {
  // User couldn't sign in (bad verification code?)
  // ...
});

Если вызов confirm выполнен успешно, пользователь вошел в аккаунт.

Получите промежуточный объект AuthCredential

Если вам нужно получить объект AuthCredential для аккаунта пользователя, передайте код подтверждения из результата подтверждения и код подтверждения в PhoneAuthProvider.credential вместо вызова confirm:

var credential = firebase.auth.PhoneAuthProvider.credential(confirmationResult.verificationId, code);

Затем вы можете выполнить вход пользователя с помощью учетных данных:

firebase.auth().signInWithCredential(credential);

Тестирование с использованием вымышленных номеров телефонов

Вы можете настроить вымышленные номера телефонов для разработки в консоли Firebase. Тестирование с вымышленными номерами телефонов дает следующие преимущества:

  • Протестируйте аутентификацию по номеру телефона, не расходуя квоту.
  • Протестируйте аутентификацию по номеру телефона без отправки SMS.
  • Выполняйте последовательные тесты с одним и тем же номером телефона без ограничений. Это снижает риск отклонения приложения во время проверки в App Store, если проверяющий использует тот же номер телефона для тестирования.
  • Тестируйте приложения в средах разработки без дополнительных усилий, например в симуляторе iOS или эмуляторе Android без сервисов Google Play.
  • Проводить интеграционные тесты, не сталкиваясь с проверками безопасности, которые обычно применяются к реальным номерам телефонов в рабочей среде.

Вымышленные номера телефонов должны соответствовать следующим требованиям:

  1. Убедитесь, что вы используете вымышленные номера телефонов, которые не существуют. Firebase Authentication не позволяет использовать в качестве тестовых номеров существующие номера телефонов, принадлежащие реальным пользователям. Например, в США можно использовать номера с префиксом 555: +1 650-555-3434.
  2. Номера телефонов должны быть правильно отформатированы с учетом длины и других ограничений. Они будут проходить ту же проверку, что и номера реальных пользователей.
  3. Для тестирования можно добавить до 10 номеров телефонов.
  4. Используйте тестовые номера телефонов и коды, которые сложно угадать, и часто меняйте их.

Создайте вымышленные номера телефонов и коды подтверждения.

  1. В консоли Firebase выберите Безопасность > Аутентификация.
  2. На вкладке Sign-in method (Способ входа) включите поставщика аутентификации Phone (Телефон), если вы ещё этого не сделали.
  3. Разверните раздел Номера телефонов для тестирования.
  4. Укажите номер телефона, который хотите проверить, например +1 650-555-3434.
  5. Укажите шестизначный код подтверждения для этого номера, например 654321.
  6. Нажмите Добавить для каждого номера. При необходимости вы можете удалить номер телефона и его код. Для этого наведите указатель мыши на нужную строку и нажмите на значок корзины.

Ручное тестирование

Вы можете сразу начать использовать вымышленный номер телефона в своем приложении. Это позволяет выполнять ручное тестирование на этапах разработки, не сталкиваясь с проблемами квот или регулированием. Вы также можете проводить тестирование непосредственно в симуляторе iOS или эмуляторе Android без установленных сервисов Google Play.

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

После завершения входа создается пользователь Firebase с этим номером телефона. Пользователь с таким номером имеет те же возможности и свойства, что и пользователь с реальным номером телефона, и может получать доступ к Realtime Database/Cloud Firestore и другим сервисам так же, как и он. Токен идентификатора, созданный в ходе этого процесса, имеет ту же подпись, что и у пользователя с реальным номером телефона.

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

Тестирование интеграции

Помимо ручного тестирования, Firebase Authentication предоставляет API, которые помогают писать интеграционные тесты для проверки аутентификации по номеру телефона. Эти API отключают проверку приложений, отменяя требование reCAPTCHA в веб-уведомлениях и push-уведомлениях без звука в iOS. Это позволяет проводить автоматизированное тестирование в этих процессах и упрощает его реализацию. Кроме того, они позволяют тестировать процессы мгновенной проверки на устройствах Android.

На сайте задайте для appVerificationDisabledForTesting значение true перед отрисовкой firebase.auth.RecaptchaVerifier. Это автоматически решает reCAPTCHA, позволяя вам передать номер телефона без ручного решения. Обратите внимание, что даже если reCAPTCHA отключена, при использовании реального номера телефона вход не будет выполнен. С этим API можно использовать только вымышленные номера телефонов.

// Turn off phone auth app verification.
firebase.auth().settings.appVerificationDisabledForTesting = true;

var phoneNumber = "+16505554567";
var testVerificationCode = "123456";

// This will render a fake reCAPTCHA as appVerificationDisabledForTesting is true.
// This will resolve after rendering without app verification.
var appVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
// signInWithPhoneNumber will call appVerifier.verify() which will resolve with a fake
// reCAPTCHA response.
firebase.auth().signInWithPhoneNumber(phoneNumber, appVerifier)
    .then(function (confirmationResult) {
      // confirmationResult can resolve with the fictional testVerificationCode above.
      return confirmationResult.confirm(testVerificationCode)
    }).catch(function (error) {
      // Error; SMS not sent
      // ...
    });

Видимые и невидимые имитированные средства проверки приложений reCAPTCHA ведут себя по-разному, когда проверка приложений отключена:

  • Видимая reCAPTCHA. Когда видимая reCAPTCHA отображается через appVerifier.render(), она автоматически разрешается после задержки в долю секунды. Это эквивалентно тому, что пользователь нажимает на reCAPTCHA сразу после ее отрисовки. Срок действия ответа reCAPTCHA истекает через некоторое время, после чего он автоматически разрешается снова.
  • Невидимая проверка reCAPTCHA. Невидимая проверка reCAPTCHA не выполняется автоматически при отрисовке. Вместо этого она выполняется при вызове appVerifier.verify() или когда пользователь нажимает на кнопку reCAPTCHA после задержки в долю секунды. Аналогично, срок действия ответа истекает через некоторое время, и он будет автоматически разрешен только после вызова appVerifier.verify() или повторного нажатия на кнопку reCAPTCHA.

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

Дальнейшие действия

После первого входа пользователя создается новый аккаунт, который связывается с учетными данными, использованными для входа (именем пользователя и паролем, номером телефона или информацией от поставщика аутентификации). Этот новый аккаунт сохраняется в проекте Firebase и может использоваться для идентификации пользователя во всех приложениях проекта, независимо от того, как пользователь входит в систему.

  • Чтобы узнать статус аутентификации пользователя в приложении, рекомендуется настроить наблюдатель для объекта Auth. Затем вы можете получить основную информацию профиля пользователя из объекта User. Подробнее об управлении пользователями…

  • В правилах безопасности Firebase Realtime Database и Cloud Storage вы можете получить уникальный идентификатор пользователя, выполнившего вход, из переменной auth и использовать его, чтобы управлять доступом к данным.

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

Чтобы выполнить выход пользователя, вызовите signOut:

Web

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

const auth = getAuth();
signOut(auth).then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});

Web

firebase.auth().signOut().then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});