Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Собственный конфигуратор подсистемы безопасности

В разделе продемонстрировано создание собственного конфигуратора подсистемы безопасности Alpha.Security.

Описано, как с помощью компонентов расширения Alpha.HMI.Security:

  • подключиться к конкретному каталогу на определенном LDAP-сервере;
  • получать данные об учетных записях пользователей, группах пользователей и приложениях, имеющихся в подсистеме безопасности Alpha.Security, из проектов Alpha.HMI;
  • менять имеющиеся учетные записи, группы и приложения из проектов Alpha.HMI;
  • создавать новые учетные записи, группы и приложения из проектов Alpha.HMI;
  • сохранять резервные копии конфигурации Alpha.Security и восстанавливать их.

Раздел описывает расширенный сценарий применения компонентов Alpha.HMI.Security. В большинстве случаев создавать собственный конфигуратор не обязательно: для конфигурирования подсистемы безопасности можно использовать Alpha.HMI.SecurityConfigurator или Конфигуратор Alpha.Security, поставляемый в составе дистрибутива Alpha.Security.

Описанный проект-пример представляет собой простейший конфигуратор подсистемы безопасности.

  1. Скачайте архив с проектом-примером OwnConfigurator.hmi и откройте в Дизайнер Alpha.HMI.
  2. Запустите Конфигуратор Alpha.Security для просмотра конфигурации подсистемы безопасности.

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

Подключение к каталогу на LDAP-сервере

Вся информация о пользователях, группах, приложениях и правах хранится в каталогах на LDAP-сервере. Подробнее об этом читайте в документации на Alpha.Security, в разделах "О продукте" и "LDAP-сервер и его настройка".

Обратите внимание, что для получения и изменения информации необязательно подключаться к LDAP-серверу, как описано ниже. По умолчанию агент безопасности подключается к каталогу и LDAP-серверу, указанным в конфигурационном файле подсистемы безопасности alpha.security.agent.xml. Действия, описанные ниже, выполняются для подключения к другим каталогам и LDAP-серверам.

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

Ознакомьтесь с основной формой проекта-примера.

На форму добавлены:

  • Элемент типа Настройка безопасности: Менеджер – SecurityManager, позволяющий подключиться к конкретному каталогу на определенном LDAP-сервере.
  • Экземпляры Login и Password, предназначенные для ввода учетных данных администратора. Как выполняется вход в подсистему безопасности, описано в разделе Управление доступом в проектах.
  • Экземпляр CatalogName, предназначенный для ввода имени существующего каталога на LDAP-сервере.
  • Кнопка LDAP_Enter, предназначенная для открытия соединения с каталогом на LDAP-серерве.
  • Другие кнопки, по умолчанию недоступны.

Для подключения к LDAP-серверу вызывается функция SetConfigureServer() экземпляра SecurityManager. Ознакомьтесь с обработчиком события ButtonPressed кнопки LDAP_Enter.

SecurityManager.SetConfigureServer("127.0.0.1",389,false,"cn="+Login.Text+",dc=maxcrc,dc=com",
Password.Text,"ou="+CatalogName.Text+",dc=maxcrc,dc=com");

В качестве входных параметров функции указаны:

  • адрес и порт локального LDAP-сервера: "127.0.0.1",389;
  • защищено ли подключение: false;
  • каталог учетной записи администратора LDAP в виде, принятом для LDAP: "cn="+Login.Text+",dc=maxcrc,dc=com" (логин учетной записи берется из выпадающего списка логинов Login);
  • пароль учетной записи администратора LDAP: Password.Text (пароль учетной записи берется из поля ввода пароля Password, при передаче на LDAP-сервер значение шифруется);
  • имя каталога, к которому выполняется подключение, в виде, принятом для LDAP: "ou="+CatalogName.Text+",dc=maxcrc,dc=com" (название каталога берется из поля ввода названия каталога CatalogName).

Запустите проект-пример в рантайм. Введите учетные данные администратора и нажмите Войти. Затем нажмите кнопку Подключиться к 127.0.0.1:389. По нажатию кнопки будет вызвана функция SetConfigureServer() экземпляра SecurityManager. Затем активируется одно из двух событий экземпляра:

  • В случае успешного подключения активируется событие LDAPServerChanged. Станут доступны кнопки Посмотреть информацию о пользователях, Создать нового пользователя и Управление резервными копиями, а в строке под кнопкой подключения отобразится адрес текущего LDAP-сервера.
  • В случае, если подключение выполнено не будет, активируется событие LDAPServerChangeFailure. В строке под кнопкой отобразится сообщение об ошибке подключения.

Ознакомьтесь с кодом обработчиков обоих событий.

Просмотр учетных записей пользователей

Откройте форму просмотра учетных записей пользователей ViewUserForm в проекте-примере.

На форму ViewUserForm добавлены:

Извлечение списка учетных записей из подсистемы безопасности

Для извлечения списка учетных записей используются возможности элемента SecurityManager:

  1. При запуске окна формы ViewUserForm вызывается функция RequestUsersList(), запрашивающая список учетных записей из подсистемы безопасности Alpha.Security.
  2. Если список получен, активируется событие RequestUsersListComplete.

Результат активации события RequestUsersListComplete – список учетных записей пользователей – хранится в переменной JSONUsersList. Данные хранятся в формате JSON. Ознакомьтесь с кодом обработчика события RequestUsersListComplete элемента SecurityManager из проекта-примера, написанным на языке JavaScript.

var usrs = JSON.parse(JSONUsersList);
//преобразование данных из формата JSON в объект
for (var i = 0; i < usrs.data.length; i++)
{
 //для каждого массива внутри объекта usrs
 unit.Global.UserName[i] = usrs.data[i].symbolicId;
 //извлечение имени пользователя и помещение его в глобальную переменную
 unit.Global.UserId[i] = usrs.data[i].uid;
 //извлечение uid пользователя и помещение его в глобальную переменную
 ComboBox_Users.AddItem(unit.Global.UserName[i]);
 //добавление имени пользователя в выпадающий список
}

Данный скрипт извлекает из JSON-структуры логины (symbolicId) и их идентификаторы (uid). Для удобства дальнейшего использования извлеченные данные помещаются в глобальные переменные UserName[] и UserId[] соответственно.

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

Аналогично из подсистемы безопасности Alpha.Security извлекаются списки групп и приложений:

  • для получения списка групп используйте функцию RequestGroupList(), событие RequestGroupListComplete и переменную JSONGroupList элемента SecurityManager;
  • для получения списка приложений используйте функцию RequestAppList(), событие RequestAppListComplete и переменную JSONAppList элемента SecurityManager.

Просмотр информации о пользователе

Для того, чтобы просмотреть информацию о выбранной из выпадающего списка учетной записи, её необходимо сначала загрузить в элемент SecurityManagerUser. Это можно сделать с помощью функции Load(), входным параметром для которой является уникальный идентификатор выбранной учетной записи (uid). Ознакомьтесь с кодом обработчика события MouseClick кнопки Информация о пользователе.

SecurityManagerUser.Load(unit.Global.UserId[ComboBox_Users.SelectedIndex]);
//загрузка информации о выбранной учетной записи в объект SecurityManagerUser по идентификатору
Groups_List.Text = "";
//очистка информационного поля при выборе новой УЗ
Apps_List.Text = "";
//очистка информационного поля при выборе новой УЗ

После загрузки данных активируется событие LoadComplete элемента SecurityManagerUser. Ознакомьтесь с кодом обработчика этого события, написанным на языке JavaScript.

JSONGroupList = SecurityManagerUser.GetGroupsList();
//получение списка групп, в которых состоит пользователь
JSONAppList = SecurityManagerUser.GetApplicationsList();
//получения списка приложений, содержащих права пользователя
var grpslst = JSON.parse(JSONGroupList);
var applst = JSON.parse(JSONAppList);
for (var v of grpslst.data)
//для всех элементов коллекции
{
 Groups_List.Text += v.groupName + "\n";
 //добавление названия группы в список
}
for (var v of applst.data)
//для всех элементов коллекции
{
 Apps_List.Text += v.appName + "\n";
 //добавление названия приложения в список
}

Данные об учетной записи извлекаются из элемента SecurityManagerUser путем обращения к его свойствам и функциям. Например:

  • функция GetGroupsList() возвращает данные о группах, в которых состоит пользователь, в JSON-формате;
  • функция GetApplicationsList() возвращает данные о приложениях с правами, назначенными пользователю, в JSON-формате.

Поместив данные в переменные JSONGroupList и JSONAppList, можно извлечь из JSON-структуры необходимую информацию.

Запустите проект-пример в рантайм. Откроется окно выбора действия, и, если было выполнено подключение к LDAP-серверу, кнопка Посмотреть информацию о пользователях будет доступна. Нажмите кнопку. Откроется окно просмотра информации об учетных записях пользователей. Выберите любой логин из выпадающего списка и нажмите кнопку Информация о пользователе. В поле вывода информации появятся данные о группах и приложениях.

Создание новой учетной записи пользователя

Откройте форму создания новой учетной записи NewUserForm в проекте-примере.

На форму создания новой учетной записи NewUserForm добавлены:

Для добавления новой учетной записи используйте функции и свойства элемента SecurityManagerUser. Ознакомьтесь с кодом обработчика события MouseClick кнопки Добавить пользователя, написанным на языке Alpha.Om.

SecurityManagerUser.New();
//создание новой УЗ пользователя
SecurityManagerUser.Login=TextEdit_Login;
//присвоение логина новой УЗ
SecurityManagerUser.SetPassword(TextEdit_Pswd);
//присвоение пароля новой УЗ
SecurityManagerUser.Surname=TextEdit_Surname;
//присвоение фамилии новой УЗ
SecurityManagerUser.DispalyName=TextEdit_DisplayName;
//присвоение отображаемого имени новой УЗ
SecurityManagerUser.AddGroup(unit.Global.GroupId[ComboBox_Group.SelectedIndex]);
//вызов функции AddGroup для добавления пользователя в выбранную в выпадающем списке группу
SecurityManagerUser.Save();
//сохранение введенных данных

Здесь:

  • функция New() создает, а функция Save() – сохраняет новую учетную запись в подсистеме безопасности;
  • свойства элемента SecurityManager (Login, Surname, DisplayName) получают значения, введенные в текстовые поля;
  • функция SetPassword() принимает введенное значение в качестве пароля;
  • функция AddGroup() принимает uid группы, выбранной из выпадающего списка, в качестве входного параметра и добавляет пользователя в соответствующую группу.

Пользователю можно назначить только одну группу.

При вызове функции Save() выполнится автоматическая проверка уникальности указанного логина. Если логин не уникален, агент не сохранит учетную запись. Узнать об этой ошибке можно с помощью события SaveFailed элемента SecurityManagerUser, подробнее об этом написано ниже.

Будьте внимательны при работе с проектом-примером. Описанные ниже действия ведут к изменению конфигурации Alpha.Security.

Запустите проект-пример в рантайм. Откроется окно выбора действия, и, если было выполнено подключение к LDAP-серверу, кнопка Создать нового пользователя будет доступна. Нажмите кнопку. Откроется окно создания новой учетной записи. Попробуйте ввести данные новой учетной записи и нажать кнопку Добавить пользователя. Агент безопасности предоставит сообщение об успешности операции.

В Конфигуратор Alpha.Security нажмите кнопку Обновить и убедитесь в том, что новая учетная запись создана.

Набор полей ввода и необходимость их заполнения можно определять в ходе разработки собственного конфигуратора. Для подсистемы безопасности Alpha.Security обязательными являются:

  • значение свойства Login;
  • значение свойства Surname;
  • значение свойства DisplayName;
  • результат вызова функции SetPassword().

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

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

Ознакомьтесь с кодом обработчика события SaveFailed элемента SecurityManagerUser.

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

Попробуйте ввести пароль, не содержащий цифр и/или состоящий менее чем из семи символов.

Проверка требований к паролю настроена при разработке проекта-примера и выполняется в обработчике события TextChanged элемента TextEdit_Pswd. Сама подсистема безопасности не накладывает требований к содержанию пароля создаваемой учетной записи.

Аналогично в подсистеме безопасности Alpha.Security создаются группы и приложения:

Создание и восстановление резервной копии

Откройте форму управления резервными копиями Backups в проекте-примере.

На форму Backups добавлен SecurityManager – элемент типа Настройка безопасности: Менеджер.

Создание резервной копии

Для создания резервных копий используются возможности элемента SecurityManager:

  1. При нажатии кнопки Button_CreateBckp вызывается функция ExportConfiguration(), создающая файл резервной копии в указанном расположении. В данном случае резервная копия создается в папке текущего пользователя ОС. Ознакомьтесь с кодом обработчика MouseClick кнопки Button_CreateBckp:
    SecurityManager.ExportConfiguration(FileSystem.CurrentUserFolder + "/export.ldb")
  2. После выполнения функции активируется одно из событий SecurityManager: в случае успешного создания резервной копии – GetConfigurationFinished, в противном случае – GetConfigurationFailed. Ознакомьтесь с обработчиками этих событий.

Будьте внимательны при работе с проектом-примером. Описанные ниже действия ведут к изменению конфигурации Alpha.Security.

Запустите проект-пример в рантайм. Откроется окно выбора действия, и, если было выполнено подключение к LDAP-серверу, кнопка Управление резервными копиями будет доступна. Нажмите кнопку. Откроется окно формы Backups. Получите список пользователей, нажав на соответствующую кнопку.

Нажмите кнопку Создать бэкап. Будет вызвана функция ExportConfiguration():

  • в случае успешного выполнения функции создастся резервная копия и появится соответствующее сообщение;
  • в случае неуспешного выполнения функции появится сообщение с текстом ошибки.

Восстановление резервной копии

Для восстановления резервных копий используются возможности элемента SecurityManager:

  1. При нажатии кнопки Button_OpenBckp вызывается функция ImportConfiguration(), восстанавливающая резервную копию из указанного файла. В данном случае резервная копия восстанавливается из файла, расположенного в папке текущего пользователя ОС. Ознакомьтесь с кодом обработчика MouseClick кнопки Button_OpenBckp:
    SecurityManager.ImportConfiguration(FileSystem.CurrentUserFolder + "/export.ldb")
  2. После выполнения функции активируется одно из событий SecurityManager: в случае успешного восстановления конфигурации – SetConfigurationFinished, в противном случае – SetConfigurationFailed. Ознакомьтесь с обработчиками этих событий.

Будьте внимательны при работе с проектом-примером. Описанные ниже действия ведут к изменению конфигурации Alpha.Security.

Запустите проект-пример в рантайм. Откроется окно выбора действия, и, если было выполнено подключение к LDAP-серверу, кнопка Управление резервными копиями будет доступна. Нажмите кнопку. Откроется окно формы Backups. Получите список пользователей, нажав на соответствующую кнопку.

Для наглядности можно удалить одного из пользователей. Для этого нажмите Удалить пользователя и в открывшемся окне удалите любую учетную запись, кроме записи администратора. Затем вернитесь к окну управления резервными копиями. Получите список пользователей, нажав соответствую кнопку. Убедитесь, что учетная запись была удалена.

Нажмите кнопку Восстановить из бэкапа. Будет вызвана функция ImportConfiguration():

  • в случае успешного выполнения функции восстановится резервная копия из файла;
  • в случае неуспешного выполнения функции появится сообщение с текстом ошибки.

Вновь получите список пользователей, нажав соответствую кнопку. Убедитесь, что удаленная учетная запись восстановлена.