Alpha.Community

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

Функции

Login

void Login(string login, string password)

Выполняет попытку входа.

Активирует событие LoginStarted.

Входные параметры:

  • логин (тип значения – string);
  • пароль (тип значения – string).

Вызов: SecurityContext.Login("login", "password")

Результат:

  • вход произведен;
  • вход не произведен.

Исполнение функции останавливает другие процессы в проекте до тех пор, пока вход не будет выполнен или не возникнет ошибка входа. Поэтому проект в режиме исполнения может зависать. Для входа лучше использовать функцию AsyncLogin.

AsyncLogin

void AsyncLogin(string login, string password)

Выполняет попытку асинхронного входа.

Активирует событие LoginStarted.

Входные параметры:

  • логин (тип значения – string);
  • пароль (тип значения – string).

Вызов: SecurityContext.AsyncLogin("login", "password")

Результат:

  • вход произведен;
  • вход не произведен.

AsyncLoginWithPasswordChange

void AsyncLoginWithPasswordChange(string login, string oldPassword, string newPassword)

Выполняет попытку асинхронного входа с изменением пароля.

Активирует событие LoginStarted.

Входные параметры:

  • логин (тип значения – string);
  • старый пароль (тип значения – string);
  • новый пароль (тип значения – string).

Вызов: SecurityContext.AsyncLoginWithPasswordChange("login", "oldpassword", "newpassword")

Результат:

  • пароль изменен, вход произведен;
  • пароль не изменен, вход не произведен.

Изменить пароль нельзя, если не истек минимальный срок действия пароля, указанный в праве Срок действия пароля, дней (PasswordAge).

ChangePassword

bool ChangePassword(string oldPassword, string newPassword)

Выполняет попытку изменения пароля для текущего пользователя.

Входные параметры:

  • старый пароль (тип значения – string);
  • новый пароль (тип значения – string).

Вызов: SecurityContext.ChangePassword("oldpassword", "newpassword")

Результат:

  • пароль изменен;
  • пароль не изменен.

Изменить пароль нельзя, если не истек минимальный срок действия пароля, указанный в праве Срок действия пароля, дней (PasswordAge).

Logout

void Logout()

Выполняет выход пользователя.

Функция не требует входных параметров.

Вызов: SecurityContext.Logout()

Результат: завершение сессии. Текущим пользователем становится пользователь, чья учетная запись указана по умолчанию.

Group

string Group(uint8 groupNumber)

Предоставляет название группы, в которой состоит текущий пользователь, по её номеру в списке.

Входной параметр – порядковый номер группы в списке групп текущего пользователя (тип значения – uint8).

Нумерация групп пользователя в списке начинается с 0.

Вызов: SecurityContext.Group(0)

GroupDisplayName

string GroupDisplayName(uint8 groupNumber)

Предоставляет отображаемое имя группы, в которой состоит текущий пользователь, по её номеру в списке.

Входной параметр – порядковый номер группы в списке групп текущего пользователя (тип значения – uint8).

Нумерация групп пользователя в списке начинается с 0.

Вызов: SecurityContext.GroupDisplayName(0)

Пример использования:

LogAudit

void LogAudit(string message, uint4 importance)

Функция, записывающая сообщение аудита безопасности с указанной важностью.

Функция аудита безопасности предоставляется компонентом Alpha.Security и описана в соответствующем документе.

Входные параметры:

  • сообщение, которое необходимо отправить в журнал (тип значения – string);
  • уровень важности сообщения, оцененный по четырехбальной шкале, где:
    • 1 – наименее важное сообщение (Debug);
    • 2 – информационное сообщение (Info);
    • 3 – важное сообщение (Important);
    • 4 – наиболее важное сообщение (Critical).

    Тип значения – uint4.

Вызов: SecurityContext.LogAudit("Обновил запись в журнале",2)

LogAuditExt

void LogAuditExt(string message, uint4 importance, string type)

Функция, записывающая сообщение аудита с указанными важностью и типом.

Функция аудита безопасности предоставляется компонентом Alpha.Security и описана в соответствующем документе.

Входные параметры:

  • Сообщение, которое необходимо отправить в журнал (тип значения – string).
  • Уровень важности сообщения, оцененный по четырехбальной шкале, где:
    • 1 – наименее важное сообщение (Debug);
    • 2 – информационное сообщение (Info);
    • 3 – важное сообщение (Important);
    • 4 – наиболее важное сообщение (Critical).

    Тип значения – uint4.

  • Тип сообщения. Здесь следует указать одно из значений, описанных при настройке аудита в конфигурационном файле Alpha.Security – alpha.security.agent.xml. По умолчанию – Normal или Admin. Тип значения – string.

Вызов: SecurityContext.LogAuditExt("Обновил запись в журнале",2,"Normal")

LogAudit2

void LogAudit2(string message, uint4 importance, string type, uint4 ackrequired)

Функция, записывающая сообщение аудита с указанными важностью, типом и параметром, указывающим необходимость квитирования.

Функция аудита безопасности предоставляется компонентом Alpha.Security и описана в соответствующем документе.

Входные параметры:

  • Сообщение, которое необходимо отправить в журнал (тип значения – string).
  • Уровень важности сообщения, оцененный по четырехбальной шкале, где:
    • 1 – наименее важное сообщение (Debug);
    • 2 – информационное сообщение (Info);
    • 3 – важное сообщение (Important);
    • 4 – наиболее важное сообщение (Critical).

    Тип значения – uint4.

  • Тип сообщения. Здесь следует указать одно из значений, описанных при настройке аудита в конфигурационном файле Alpha.Security – alpha.security.agent.xml. По умолчанию – Normal или Admin. Тип значения – string.
  • Параметр, определяющий необходимость квитирования, где:

    • 0 – сообщение не требует квитирования;
    • 1 – сообщение необходимо квитировать.

    Тип значения – uint4.

Вызов: SecurityContext.LogAudit2("Обновил запись в журнале",2,"Normal",0)

ForceStopUserSession

void ForceStopUserSession(string login, string netName)

Завершает текущую сессию пользователя.

Завершить сессию можно как на локальном АРМ, так и на удаленном АРМ, входящем в сеть Alpha.Net.

Входные параметры:

  • логин учетной записи пользователя (тип значения – string);
  • имя узла в сети Alpha.Net (тип значения – string). Для завершения сессии на локальном АРМ имя узла в сети Alpha.Net указывать не нужно.

Вызов: SecurityContext.ForceStopUserSession("login","NetName")

ResetUserFailedLoginCounter

void ResetUserFailedLoginCounter(string login, string netName)

Сбрасывает счетчик неудачных попыток входа пользователя.

Сбросить счетчик можно как для попыток входа на локальном АРМ, так и на удаленном АРМ, входящем в сеть Alpha.Net.

Входные параметры:

  • логин учетной записи пользователя (тип значения – string);
  • имя узла в сети Alpha.Net (тип значения – string). Для сброса счетчика на локальном АРМ имя узла в сети Alpha.Net указывать не нужно.

Для использования счетчика неудачных попыток входа пользователю должно быть назначено право Количество неуспешных попыток входа до временной блокировки, шт (MaxAttemptsCount).

Вызов: SecurityContext.ResetUserFailedLoginCounter("login","NetName")

RemoteGetLoggedUsersList

void RemoteGetLoggedUsersList(string netName)

Запрашивает список текущих пользователей на удаленной рабочей станции в сети Alpha.Net.

Входной параметр – имя рабочей станции в сети Alpha.Net (тип значения – string).

Вызов: SecurityContext.RemoteGetLoggedUsersList("NetName")

Результат:

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

В случае успешной активации события RemoteGetLoggedUsersFinished список поместится во внутреннее хранилище компонента. Чтобы воспользоваться данными из списка, используйте функции GetRemoteLoggedUserCount() и GetRemoteLoggedUserByIndex().

GetRemoteLoggedUsersCount

uint4 GetRemoteLoggedUsersCount()

Возвращает количество текущих пользователей на удаленной рабочей станции. Может использоваться только после вызова функции RemoteGetLoggedUsersList.

Функция не требует входных параметров.

Вызов: SecurityContext.GetRemoteLoggedUserCount()

GetRemoteLoggedUserByIndex

string GetRemoteLoggedUserByIndex(uin4 index)

Возвращает логин одного из текущих пользователей на удаленной рабочей станции. Может использоваться только после вызова функции RemoteGetLoggedUsersList.

Входной параметр – порядковый номер пользователя в списке, полученном в результате вызова функции RemoteGetLoggedUsersList() (тип значения – uint4).

Нумерация пользователей в списке начинается с 0.

Вызов: SecurityContext.GetRemoteLoggedUserByIndex(4)