Загрузить пользователей с использованием LDAP и LDAPS
Администратор кластера может создавать, изменять и удалять конфигурации LDAP и LDAPS, включать и отключать синхронизацию, а также управлять загруженными пользователями во ВЦОД управления.
Администратор безопасности кластера может просматривать список и параметры конфигураций LDAP и загруженных пользователей.
Sharx Base аутентифицирует пользователей внешнего LDAP-каталога, создаёт для них учётные записи во ВЦОД и назначает роли.
Платформа поддерживает следующие службы каталогов:
- OpenLDAP.
- FreeIPA.
- Active Directory.
Требования к LDAP-серверу
Перед подключением подготовьте:
- служебную учётную запись с правами на поиск пользователей и групп;
- базовый DN;
- фильтры поиска пользователей и групп;
- LDAP-группы для назначения ролей;
- тестового пользователя с известными логином и паролем.
Для каждого загружаемого пользователя должны быть заполнены следующие атрибуты:
uid— логин пользователя;activeStatus— статус учётной записи;mail— адрес электронной почты.
Если обязательный атрибут отсутствует или не заполнен, учётная запись не будет загружена в Sharx Base.
Для подключения по LDAPS дополнительно подготовьте:
- FQDN LDAP-сервера, совпадающее с именем в его сертификате;
- сертификат удостоверяющего центра или цепочку сертификатов в формате PEM;
- сетевой доступ от узлов Sharx Base к LDAP-серверу. Обычно LDAP использует TCP-порт
389, LDAPS — TCP-порт636.
Ограничения
Внимание
В одном ВЦОД можно создать несколько конфигураций LDAP и LDAPS, но для синхронизации можно выбрать только одну из них
Роли назначаются при первой загрузке пользователя:
- пользователю можно назначить только одну роль Sharx Base по умолчанию;
- изменение
group_mapне влияет на роли загруженного пользователя. После первой загрузки управляйте его ролями так же, как ролями обычной учётной записи. Подробнее см. в статье Пользователи.
Важно
Не удаляйте загруженного LDAP-пользователя, если планируете использовать его после повторного включения синхронизации. После ручного удаления повторная синхронизация не создаёт учётную запись заново.
Чтобы загрузить пользователя с тем же логином с другого сервера, удалите прежнюю учётную запись и выполните aaa user clear --login <LOGIN>
Избегайте одинаковых логинов на разных LDAP-серверах. При переключении сервера пользователь с таким же логином остаётся в списке. Чтобы загрузить одноимённого пользователя с нового сервера, удалите прежнюю учётную запись и выполните aaa user clear --login <LOGIN> до повторной синхронизации.
Общий принцип работы
- Добавьте во ВЦОД конфигурацию подключения к LDAP-каталогу.
- Активируйте конфигурацию и включите синхронизацию с ней.
- Проверьте синхронизацию с LDAP-каталогом.
Примечание
Если синхронизация выключена, пользователь LDAP не сможет аутентифицироваться во ВЦОД
Управлять конфигурациями LDAP и LDAPS
Добавить конфигурацию
Конфигурацию можно добавить командой CLI или с помощью YAML-файла.
Команды и порядок действий одинаковы для LDAP и LDAPS. Протокол определяется схемой адреса ldap:// или ldaps://. Для LDAPS дополнительно передайте сертификат с помощью параметра ca_data или ca_file.
Добавить конфигурацию командой в CLI
Чтобы добавить конфигурацию, введите команду:
aaa param ldap add --name <NAME>
[--descr <DESCR>]
[--url <URL>]
[--ca_data <CA_DATA>]
[--ca_file <CA_FILE>]
[--user <USER>]
[--passwd <PASSWD>]
[--base_dn <BASE_DN>]
[--query_group <QUERY_GROUP>]
[--query_user <QUERY_USER>]
[--query_active_users <QUERY_ACTIVE_USERS>]
[--user_map <USER_MAP>]
[--group_map <GROUP_MAP>]
[--default_path <DEFAULT_PATH>]
[--notif_route <NOTIF_ROUTE>]
[--error_limit <ERROR_LIMIT>]
где
-
name— имя конфигурации LDAP или LDAPS в текущем ВЦОД. Обязательный параметр;Внимание
Имя не должно содержать кириллицу, пробелы, точки, запятые и специальные символы.
Допускаются латинские буквы, цифры, дефис-и нижнее подчеркивание_ -
descr— описание конфигурации; url— адрес сервера со схемой подключенияldap://илиldaps://. Для LDAP укажите IP-адрес или доменное имя. Для LDAPS укажите FQDN, совпадающее с именем в сертификате;ca_data— содержимое сертификата для LDAPS. Не может использоваться одновременно сca_file;ca_file— путь к файлу сертификата для LDAPS. Не может использоваться одновременно сca_data;user— DN служебной учётной записи LDAP;passwd— пароль служебной учётной записи LDAP;base_dn— базовый DN, относительно которого система ищет объекты;query_group— LDAP-фильтр поиска групп;query_user— LDAP-фильтр поиска пользователей;query_active_users— проверка статуса пользователя в каталоге LDAP;user_map— сопоставление атрибутов пользователя Sharx Base с атрибутами LDAP:login—uid,email—mail,status—activeStatus. Указывается в формате JSON;group_map— сопоставление LDAP-группы с ролью пользователя ВЦОД. Указывается в формате JSON;default_path— путь к директории в рамках ВЦОД, куда будут размещены пользователи из LDAP;notif_route— имя заранее созданного маршрута для уведомлений об ошибках;error_limit— количество повторений одинаковой ошибки, после которого Sharx Base отправляет администратору уведомление. Допустимые значения — целые числа от1, верхняя граница не установлена. Значение по умолчанию —3.
Пример
aaa param ldap add --name <config_name>
--descr "<config_description>"
--url "ldap://<ldap_addr>"
--user "cn=<admin_login>,dc=<dc>,dc=<dc>"
--passwd <ldap_admin_user_passwd>
--base_dn "dc=<dc>,dc=<dc>"
--query_group "(objectClass=<ldap_query_group>)"
--query_user "(objectClass=<ldap_query_user>)"
--query_active_users "<ldap_query_active_users>"
--user_map "{\"login\": \"uid\", \"email\": \"mail\", \"status\": \"activeStatus\"}
--group_map "{\"<ldap_group>\": \"<sdc_core_role>\"}"
--default_path "<path_on_sdc_core_cluster>"
--notif_route <route_for_notification>
--error_limit <count_error>
Добавить конфигурацию YAML-файлом
-
Создайте файл конфигурации в формате YAML по следующему шаблону:
apiVersion: v1 kind: api metadata: plugin: aaa: param: ldap: add spec: name: "<config_name>" descr: "<config_description>" url: "ldap://<ldap_addr>" user: "cn=<admin_login>,dc=<dc>,dc=<dc>" passwd: "<passwd_to_LDAP>" base_dn: "dc=<dc>,dc=<dc>" query_group: "(objectClass=<ldap_query_group>)" query_user: "(objectClass=<ldap_query_user>)" query_active_users: "<ldap_query_active_users>" user_map: {"login": "uid", "email": "mail", "status": "activeStatus"} group_map: {"<ldap_group>": "<sdc_core_role>"} default_path: "/" notif_route: "<route_name>" error_limit: "<count_error>"Описание полей приведено выше.
-
Загрузите файл конфигурации на Платформу.
Чтобы загрузить файлы в Sharx Base, введите команду
гдеspec— расположение YAML-файла.При локальном расположении на АРМ пользователя введите путь до файла.
При расположении в стороннем репозитории укажите ссылку на данный файл.
После загрузки проверьте конфигурацию и статус соединения по инструкции ниже.
Просмотреть конфигурации и статус подключения
-
Просмотрите список всех конфигураций:
Имя конфигурации, добавленной выше, должно отобразиться в общем списке LDAP-конфигураций ВЦОД. -
Просмотрите параметры конфигурации:
где
name— имя конфигурации LDAP или LDAPS в текущем ВЦОД.В выводе отобразятся два дополнительных параметра:
-
status— статус соединения. Возможные значения:CONNECTED— соединение установлено;
UNCONNECTED— соединение отключено;
ERROR— ошибка соединения; -
last_send_ldap_error_text— запись о последней ошибке.
-
Обновить конфигурацию
Чтобы изменить параметры существующей конфигурации, введите:
aaa param ldap update --name <NAME>
[--descr <DESCR>]
[--url <URL>]
[--ca_data <CA_DATA>]
[--ca_file <CA_FILE>]
[--user <USER>]
[--passwd <PASSWD>]
[--base_dn <BASE_DN>]
[--query_group <QUERY_GROUP>]
[--query_user <QUERY_USER>]
[--query_active_users <QUERY_ACTIVE_USERS>]
[--user_map <USER_MAP>]
[--group_map <GROUP_MAP>]
[--default_path <DEFAULT_PATH>]
[--notif_route <NOTIF_ROUTE>]
[--error_limit <ERROR_LIMIT>]
Описание полей приведено выше.
Удалить конфигурацию
Чтобы удалить конфигурацию LDAP или LDAPS, введите:
где name — имя конфигурации LDAP или LDAPS в текущем ВЦОД.
Активировать синхронизацию с LDAP
Чтобы выбрать конфигурацию и включить синхронизацию:
-
Укажите конфигурацию:
где
ldap— имя конфигурации LDAP или LDAPS. -
Включите синхронизацию с LDAP:
где
ldap_sync— синхронизация с LDAP. Возможные значения:yes— синхронизация включена;no— синхронизация выключена.
Проверить синхронизацию с LDAP
После синхронизации пользователи из LDAP должны появиться в списке пользователей ВЦОД с ролями, заданными в конфигурации.
Для проверки просмотрите пользователей ВЦОД:
Если пользователи отображаются в списке, синхронизация настроена корректно.
Параметр group_map назначает пользователям роли при первой загрузке. Если параметр не указан, учётные записи создаются без ролей.
После появления учётной записи в списке пользователь может войти во ВЦОД с логином и паролем из LDAP. Пароль пользователя в Sharx Base не хранится: при каждом входе его проверяет LDAP-сервер.
Примечание
Если синхронизация выключена, пользователь из LDAP не сможет войти во ВЦОД, даже если его учётная запись отображается в списке
Если подключение не выполнено
Статус UNCONNECTED означает, что конфигурация не выбрана для синхронизации или синхронизация выключена.
Статус ERROR означает, что при подключении или выполнении LDAP-запроса возникла ошибка.
Если отображается статус UNCONNECTED:
-
Выберите конфигурацию
-
Включите синхронизацию
-
Повторно проверьте статус
Если отображается статус ERROR:
-
Просмотрите параметр
last_send_ldap_error_textв выводе команды -
В зависимости от текста ошибки проверьте:
- схему адреса:
ldap://для LDAP илиldaps://для LDAPS; - адрес сервера и доступность портов 389 или 636;
- разрешение FQDN LDAP-сервера в IP-адрес;
- DN и пароль служебной учётной записи;
- права служебной учётной записи на поиск пользователей и групп;
- параметр
base_dn; - синтаксис фильтров
query_user,query_active_usersиquery_group; - параметры
user_mapиgroup_map.
- схему адреса:
-
Для LDAPS дополнительно проверьте:
- соответствие FQDN имени в сертификате сервера;
- срок действия сертификата;
- полноту цепочки сертификатов;
- формат сертификата, переданного в параметре
ca_dataилиca_file.
Если соединение установлено, но пользователи не загрузились, убедитесь в следующем:
- пользователи соответствуют фильтру
query_users; - у пользователей заполнены атрибуты
uid,mailиactiveStatus; - группы соответствуют фильтру
query_groups; - названия групп в
group_mapсовпадают с названиями групп на LDAP-сервере.
После исправления параметров обновите конфигурацию и повторно проверьте её статус.
Если ошибка сохраняется, передайте в техническую поддержку ООО «Шаркс ДЦ» название конфигурации, время возникновения ошибки и значение last_send_ldap_error_text.
Термины и определения содержатся в статьях: