Умная OTP-авторизация и регистрация по Email или СМС в одном поле

Стандартная установка модуля из MarketPlace.

После установки модуля, в папке /bitrix/components/abcwww/ появится компонент otpauth, содержащий форму авторизации, который вы можете подключить на странице вручную или через визуальный редактор. В настройках компонента можно настроить редирект после авторизации и указать группы пользователей, в которые пользователь будет добавлен при регистрации.


Далее, на странице настроек модуля bitrix/admin/settings.php?lang=ru&mid=abcwww .otpauth заполняются необходимые данные, подробности ниже.

Процесс установки и начальная настройка

В административной панели доступна настройка, которая определяет, какие данные пользователь может вводить в поле авторизации:

• телефон и e-mail (режим по умолчанию);
  
• только телефон;
  
• только e-mail;
  

Регистрация пользователей

Логика создания учётной записи зависит от типа введённых данных:

• Email: Создаётся новый пользователь. Логин и Email устанавливаются равными введённому адресу.
  
• Номер телефона: Создаётся новый пользователь. Логин устанавливается равным номеру телефона, сам номер сохраняется в поле `PERSONAL_PHONE`.
  
• Обязательный Email: Если в настройках главного модуля активирована опция «Email является обязательным полем», в поле Email автоматически подставляется адрес вида `номер_телефона@local.ru`.
  

База данных и проверка дубликатов

В процессе установки модуль создаёт служебную таблицу для хранения всех проверочных кодов (доступна в административном интерфейсе).

Также добавляется обработчик события редактирования пользователя, который:

1. Приводит номер телефона к единому формату перед записью в поле `PERSONAL_PHONE`.
   
2. Блокирует регистрацию, если пользователь с таким номером уже существует в базе.
   

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

Отправка оповещений на Email

При установке автоматически создаются почтовые шаблоны:

1. Почтовое событие `OTP_CODE` с шаблоном и стандартным HTML-текстом уведомления.
   
2. Проверяется наличие шаблонов для почтового события `NEW_USER`. Если они отсутствуют, устанавливается новый шаблон. Это необходимо для работы настройки «Отправлять дополнительное оповещение о регистрации».
   

Мгновенная отправка писем

При использовании штатного шаблона отправка Email производится через штатный механизм Битрикс (CEvent::SendImmediate). Модуль поддерживает альтернативную отправку оповещения через SMTP с использованием встроенной библиотеки phpMailer. Параметры подключения настраиваются в опции «Метод отправки Email».

Отправка СМС

Для отправки проверочных кодов по СМС предусмотрена интеграция с провайдерами SmsRu, SmscRu, SmsAero, RedSms, ProstorSms.

При необходимости можно добавить собственного провайдера. Для этого нужно разместить новый класс в директории модуля lib/Sms/, соблюдая несколько правил:

1. Класс должен реализовывать интерфейс SmsSenderInterface.
   
2. В классе должен быть реализован метод send, который принимает номер телефона и проверочный код, а возвращает true или false в зависимости от результата отправки.
   
3. Название класса и имя файла должны совпадать, файл имеет расширение .php. Обязательный суффикс — Sender. Например: класс NewProviderSender и файл NewProviderSender.php.
   

По умолчанию активен тестовый класс LogSmsSender. В этом режиме реальная отправка СМС не выполняется — проверочный код просто записывается в таблицу БД.

Данные доступа для каждого провайдера задаются в настройках модуля.

Система анти-абьюз контроля

• Лимиты по IP-адресу:
 - 5 запросов в минуту
 - 20 запросов в сутки

• Лимиты по логину:
 - 5 запросов в минуту  
 - 20 запросов в сутки

Тестовый режим

Для отладки формы авторизации предусмотрен специальный режим. При его активации уведомления на Email и СМС не отправляются. Проверочный код записывается в таблицу базы данных, которая доступна в админке (раздел «Сервисы → ОТП → ОТП-коды»).

Согласие при регистрации

Если телефон или Email отсутствуют в базе (новый пользователь), при попытке отправки форме отображаются чекбоксы согласия. Их состав настраивается в административной панели, а текст редактируется в шаблоне компонента.
Предусмотрена настройка для отправки отдельного уведомления о регистрации. Оно отправляется стандартным методом `Event::send()` по почтовому событию `NEW_USER`.
Не забудьте отредактировать дефолтный почтовый шаблон, если он уже существует.

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

Кастомизация шаблона компонента

Разметку и вёрстку шаблона формы можно редактировать, адаптируя её под дизайн вашего проекта. Основное требование: сохранить все CSS-классы и id, название которых начинается с префикса `js-`. Эти селекторы используются для корректной работы JavaScript-функционала отправки формы. Также необходимо сохранить правильную вложенность HTML-тегов с указанными селекторами.

Логирование ошибок

В модуле предусмотрено логирование. Если при настройке или тестировании что-то пошло не так, в первую очередь стоит заглянуть в директорию модуля /bitrix/modules/abcwww .otpauth/log/. Там собираются файлы с записями возможных ошибок. Имена файлов соответствуют классам модуля — это упрощает поиск нужной информации.