Чтобы запретить публичную регистрацию на самостоятельно размещенном домашнем сервере Matrix под управлением Synapse, внесите соответствующие изменения enable_registration: falseи homeserver.yamlперезапустите Synapse. Если вы хотите, чтобы приглашенные пользователи могли создавать учетные записи самостоятельно, оставьте регистрацию включенной, но требуйте вместо этого регистрационные токены. Проверьте отдельную registration_shared_secretнастройку: любой, кто ее знает, все равно сможет создавать учетные записи, включая администраторов сервера, даже если обычная регистрация отключена.
Выберите подходящую политику регистрации.
Правильные настройки зависят от способа создания новых учетных записей:
- Частный сервер, учетные записи, созданные администратором: отключить публичную регистрацию. Создавайте пользователей с помощью команды Synapse
register_new_matrix_userили другого утвержденного административного процесса.
- Сервер работает только по приглашениям, пользователи регистрируются через Element или другой клиент: включена регистрация и требуется токен. Каждому пользователю выдается токен ограниченного использования через закрытый канал.
- На общедоступном сервере: регистрационные токены, CAPTCHA или подтвержденный адрес электронной почты/телефона могут снизить уровень злоупотреблений со стороны автоматизированных систем, но они не гарантируют надежность каждой учетной записи.
В этой статье рассматривается Synapse, наиболее распространенная реализация домашнего сервера Matrix с самостоятельным размещением. Другие программы для домашних серверов имеют свои собственные настройки. В текущей документации по настройке Synapse указано, что регистрация по умолчанию отключена, и что токены регистрации работают только тогда, когда сама регистрация включена. Если вы используете Matrix Authentication Service (MAS), ознакомьтесь с его документацией для получения информации о соответствующих параметрах регистрации; API администратора Synapse для токенов регистрации отключен, когда интеграция с MAS включена.
Отключить публичную регистрацию в Synapse
- Найдите активный конфигурационный файл. Обычно при установке пакетов используется путь
/etc/matrix-synapse/homeserver.yaml`/etc /data/homeserver.yaml/config ...
- Создайте резервную копию файла, затем установите флаг регистрации. В конфигурации YAML верхнего уровня добавьте или измените параметр следующим образом:
enable_registration: false
Если ключ уже существует, отредактируйте эту запись, а не добавляйте дубликат. Отступы в YAML и повторяющиеся ключи могут вызвать путаницу, поэтому оставляйте настройку на верхнем уровне и сохраняйте существующую структуру файла.
- Проверьте общий секретный ключ регистрации. Synapse
registration_shared_secret(или registration_shared_secret_path) поддерживает скрипт административной регистрации. В руководстве по установке Synapse предупреждается, что тот, кто обладает этим секретным ключом, может создавать стандартные или административные учетные записи, даже если публичная регистрация отключена. Держите его в секрете, ограничьте доступ к его файлу и не размещайте его в общедоступном репозитории, конфигурации клиента или сообщении приглашенным. Если вы не используете регистрацию с общим секретным ключом, удалите этот параметр только после подтверждения того, что от него не зависит никакая автоматизация. Вместо этого вы можете создавать учетные записи, используя другой поддерживаемый административный рабочий процесс.
- Проверьте и перезапустите Synapse. Используйте менеджер служб, оркестрацию контейнеров или метод развертывания, который используется на вашем сервере. Для службы systemd, обычно называемой
matrix-synapse, администратор может выполнить следующую команду:
sudo systemctl restart matrix-synapse
sudo systemctl status matrix-synapse --no-pager
Точное имя службы может отличаться в зависимости от развертывания пакета или контейнера. Если служба не запускается, проверьте журналы; не следует многократно редактировать файл конфигурации, не устранив обнаруженную ошибку YAML или ошибки конфигурации.
Отключение регистрации не удаляет существующие учетные записи и доступ к комнатам. Эта настройка предотвращает новые обычные регистрации через процесс регистрации клиента; она не является средством удаления пользователей или деактивации сервера.
Разрешите регистрацию только с использованием регистрационных токенов.
Используйте этот параметр, если хотите, чтобы приглашенные самостоятельно завершили регистрацию, но не хотите, чтобы открывалась страница регистрации. В homeserver.yamlнастройках укажите оба параметра:
enable_registration: true
registration_requires_token: true
Перезапустите Synapse после сохранения. Использование токенов не равнозначно отключению регистрации: пользователи с действительными токенами могут создавать учетные записи. В руководстве по настройке Synapse рекомендуется использовать средства защиты от злоупотреблений при включенной регистрации; выберите политику, соответствующую вашей аудитории и операционным возможностям.
Для версий Synapse, поддерживающих документированный API администратора для регистрационных токенов, администратор может создать одноразовый токен. В следующем примере используется URL-адрес-заполнитель и токен доступа; запускайте его только из доверенной административной среды, замените публичный базовый URL-адрес вашего домашнего сервера и токен доступа администратора, а также защитите историю командной строки и журналы:
curl -X POST "https://matrix.example.com/_synapse/admin/v1/registration_tokens/new" \
-H "Authorization: Bearer YOUR_SERVER_ADMIN_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data '{"uses_allowed":1}'
В ответе содержится сгенерированный токен. Передайте это значение конфиденциально предполагаемому пользователю. API Synapse также поддерживает время истечения срока действия, измеряемое в миллисекундах с момента начала эпохи Unix; используйте официальную справочную информацию по API, чтобы правильно рассчитать и установить срок действия для вашего развертывания. Токен с неуказанным лимитом использования или сроком действия по умолчанию имеет неограниченное количество использований и не имеет срока действия, поэтому устанавливайте лимиты обдуманно. Администраторы могут просматривать, обновлять или удалять токены через тот же API. Не вставляйте фактический токен носителя или регистрационный токен в публичную проблему или статью.
Управление токенами имеет ограничения по версии и развертыванию: обратитесь к документации по Admin API, соответствующей установленной вами версии Synapse. В текущей документации указано, что этот Synapse API недоступен при включенной интеграции с MAS; в этом случае используйте MAS Admin API или CLI.
Распространенные ошибки конфигурации
- Изменение не того файла: контейнеры могут считывать смонтированный файл, в то время как на хосте имеется его отдельная копия. Подтвердите путь, используемый запущенным процессом Synapse.
- Если забыть о перезапуске: изменения конфигурации считываются службой, поэтому успешное редактирование текста само по себе не доказывает, что новая политика активна.
- Если отключенная регистрация блокирует все пути, то настроенный общий секретный ключ остается путем создания учетной записи. Защитите или удалите его в зависимости от того, требуется ли он для автоматизации администрирования.
- Включение токенов, но отключение регистрации:
registration_requires_token само по себе не включает регистрацию. Оба флага должны обеспечивать желаемый ход процесса.
- Предположим, что токены, доступные только по приглашению, предотвращают все злоупотребления: утечка многоразового токена может привести к его использованию непреднамеренными лицами. Ограничьте количество использований, установите срок действия там, где это возможно, и распространяйте токены в частном порядке.
Проверьте результат
После перезапуска Synapse откройте процесс регистрации на вашем домашнем сервере в клиенте Matrix, используя сеанс, из которого выдан пароль. Для закрытого сервера клиент не должен предлагать успешную публичную регистрацию, в то время как существующие пользователи должны иметь возможность войти в систему. Для регистрации с использованием токена попробуйте запустить процесс без токена и убедитесь, что он запрашивает токен; затем используйте тестовый токен в контролируемой тестовой учетной записи и подтвердите, что регистрация прошла успешно. Проверьте журналы Synapse и статус токена Admin API, если результат отличается от желаемого. Избегайте тестирования с реальным пригласительным токеном, если это приведет к исчерпанию его единственного разрешенного использования.
Официальные ссылки