Перейти к основному содержимому

Включение двухфакторной аутентификации (2FA)

Двухфакторная аутентификация (2FA) добавляет дополнительный уровень безопасности в процессе входа пользователей в систему. В коробочной версии YouGile 2FA активируется и настраивается через конфигурационные файлы. Следуйте этой инструкции для настройки и управления двухфакторной аутентификацией в вашей компании. Включение двухфакторной аутентификации не приведет к автоматическому разлогированию пользователей. При использовании встроенного SMS-сервиса YouGile для прохождения авторизации пользователи смогут вводить только российские и белорусские номера телефонов. Для отправки сообщений на номера других стран необходимо самостоятельно настроить связь с оператором, который подходит вам лучше всего.

Обратите внимание, что 2FA доступен для всех видов лицензий, кроме демо-лицензии для разработчиков.

Настройка подключения​

Для включения двухфакторной аутентификации администратор должен настроить соответствующие параметры в conf.json.

В конфигурационном файле необходимо указать:

  • Значение true в настройке twoFactorAuth
  • Использование сервиса отправки SMS: администратор может выбрать между использованием встроенного сервиса YouGile или подключением собственного SMS-сервиса. Для использования собственного сервиса нужно указать параметр twoFactorCodeSendCommand, ниже представлено подробное описание того, как именно это можно сделать.
  • Время, после которого код из SMS будет считаться недействительным: twoFactorCodeLifetime (по умолчанию - 5 минут), указывается в mls.
  • Длину сессии: дефолтная длина задается через keyExpirationTimeout и составляет 300 дней.

Пример конфигурации:

{
"twoFactorAuth": true
}

Пример использования собственного сервиса для отправки SMS сообщений​

Для интеграции со своим сервисом отправки SMS необходимо в конфигурации conf.json указать параметр twoFactorCodeSendCommand

Этот параметр представляет собой исполняемую команду, которая будет вызвана при отправке кода подтверждения.

Пример с Node.js​

node <file_path> code:$code phone:$phone email:$email name:$name lang:$lang

где file_path — путь до исполняемого файла (скрипта),

на вход передаются параметры:

  • code — проверочный код
  • phone — номер телефона
  • email — email пользователя
  • name — имя пользователя
  • lang — язык интерфейса

Пример с Curl​

Можно напрямую выполнить HTTP-запрос с помощью curl:

curl -X POST https://<url>/<send-sms> \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "code=$code&phone=$phone&email=$email&name=$name&lang=$lang"

https://<url>/<send-sms> — адрес (хост и эндпоинт) вашего сервиса для отправки SMS.

Параметры code, phone, email, name, lang будут переданы в теле POST-запроса.

Запрос номера телефона и SMS-кода при входе​

Веб и десктопная версия YouGile​

При включенной двухфакторной аутентификации система будет автоматически запрашивать у пользователей номер телефона (если он не указан) и отправлять им код доступа по SMS при входе. Код будет действителен в течение времени, указанного в конфигурации (twoFactorCodeLifetime).

Мобильное приложение YouGile​

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

Команды управления номерами телефонов​

Вы можете управлять номерами телефонов пользователей.

Добавление номера телефона​

Для добавления номера телефона пользователю используйте команду:

/.server task change-user-auth-phone 'dev@YouGile.com' '+71111111111'

для Windows:

server.exe task change-user-auth-phone 'dev@YouGile.com' '+71111111111'

Изменение номера телефона пользователя​

Для изменения номера телефона пользователя используйте команду:

/.server task change-user-auth-phone 'dev@YouGile.com' '+72222222222'

для Windows:

server.exe task change-user-auth-phone 'dev@YouGile.com' '+72222222222'

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

Лимит SMS на компанию​

Система учитывает лимиты отправки SMS в зависимости от количества пользователей в лицензии:

  • Лимит SMS на день рассчитывается по формуле: 6 * количество пользователей в лицензии (рекомендованная длина сессии – не менее 8 часов, иначе есть риск израсходовать лимит)
  • Пользователи могут перезапрашивать код неограниченное количество раз, пока не будет достигнут общий лимит