Служебные функции

initialize

initialize()

Функция служит для инициализации работы с JC-WebClient. Необходимо вызывать её первой.

addEventListener

Поддерживаемые типы токенов
GOST
PRO
addEventListener(string name, JSObjectPtr callback)

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

Аргументы:
  • name

    наименование события.

    Допустимые значения:
    • tokenAdded – событие подключения электронного ключа;
    • tokenRemoved – событие отключения электронного ключа;
    • loginStateChanged – событие изменения состояния логина;
    • smartcardadded – событие подключения смарт-карты;
    • smartcardremoved – событие отключения смарт-карты.
  • callback – сallback-функция JavaScript, которая будет асинхронно выполнена при получении соответствующего события.

removeEventListener

Поддерживаемые типы токенов
GOST
PRO
removeEventListener(string name, JSObjectPtr callback)

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

Аргументы:
  • name

    наименование события.

    Допустимые значения:
    • tokenAdded – событие подключения электронного ключа;
    • tokenRemoved – событие отключения электронного ключа;
    • loginStateChanged – событие изменения состояния логина;
    • smartcardadded – событие подключения смарт-карты;
    • smartcardremoved – событие отключения смарт-карты.
  • callback – сallback-функция JavaScript, которая была зарегистрирована ранее методом addEventListener().

getAllTokens

Поддерживаемые типы токенов
GOST
PRO
getAllTokens()

Получить идентификаторы подключенных электронных ключей. Работает при любом состоянии аутентификации.

Результат:array – массив с идентификаторами.

getTokenInfo

Поддерживаемые типы токенов
GOST
PRO
getTokenInfo(int tokenDesc)

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

Аргументы:
  • tokenDesc – идентификатор электронного ключа. Получается с помощью метода getAllTokens().
Результат:

array – массив со следующей структурой:

  • первый элемент – серийный номер электронного ключа.
  • второй – флаги электронного ключа.
  • третий – метка электронного ключа.

getAllSlots

Поддерживаемые типы токенов
GOST
PRO
getAllSlots()

Получить идентификаторы всех слотов для работы с электронными ключами. Идентификаторы слотов заменяют идентификаторы токенов при вызове методов, поддерживающих работу с Антифрод-терминалом без вставленной смарт-карты. В других случаях, методы будут возращать ошибку CKR_TOKEN_NOT_PRESENT (к слоту не подключен электронный ключ) или работать как при использовании идентификатора токена (к слоту подключен электронный ключ). Работает при любом состоянии аутентификации.

Результат:array – массив с идентификаторами слотов.

getSlotInfo

Поддерживаемые типы токенов
GOST
PRO
getSlotInfo(int SlotId)

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

Аргументы:
  • SlotId – идентификатор слота. Получается с помощью метода getAllSlots().
Результат:

array – массив со следующей структурой:

  • первый элемент – серийный номер электронного ключа, а если подключен Антифрод-терминал без смарт-карты – пустой элемент.
  • второй – флаги электронного ключа.
  • третий – метка электронного ключа, а если подключен Антифрод-терминал без смарт-карты – пустой элемент.

getLoggedInState

getLoggedInState()

Получить состояние аутентификации. Работает при любом состоянии аутентификации.

Результат:array – массив со следующей структурой:
  • первый элемент – состояние аутентификации.
  • второй – идентификатор подключения или ноль, если не установлено соединения.
  • третий – идентификатор электронного ключа.

Состояния аутентификации

  • STATE_NOT_BINDED (0) – пользователь не предъявил PIN-код.
  • STATE_TOKEN_BINDED (1) – пользователь предъявил PIN-код.
  • STATE_SECURE_CHANNEL_CONNECTION_IN_PROGRESS (2) – начата установка защищенного канала.
  • STATE_SECURE_CHANNEL_ESTABLISHED (3) – защищенный канал установлен.
  • UNILATERAL_AUTHENTICATION_IN_PROGRESS (4) – начат процесс односторонней аутентификации.
  • UNILATERAL_AUTHENTICATION_COMPLETE (5) – односторонняя аутентификация успешно завершена.

getPluginVersion

getPluginVersion()

Получить версию приложения. Работает при любом состоянии аутентификации.

Результат:string – версия в виде Х.Х.Х.Х.

getSystemInfo

Поддерживаемые типы токенов
GOST
PRO
getSystemInfo(string info)

Получить информацию о системе. Работает при состоянии аутентификации выше, чем STATE_NOT_BINDED (0).

Аргументы:
  • info

    тип запрашиваемой информации.

    Допустимые значения:
    • guid – GUID рабочей станции.
    • user – активный пользователь.
    • osType – тип ОС (возвращаемые значения: Microsoft Windows, Linux, macOS).
    • osDescription – описание ОС.
    • osArchitecture – текущая архитектура (возвращаемые значения: 32 или 64).
Результат:

string – запрашиваемая информация.

checkWebBrowserVersion

Не рекомендуется, начиная с версии 3.4.0.

checkWebBrowserVersion()

Проверить, поддерживается ли данная версия браузера. Работает при любом состоянии аутентификации.

Результат:boolfalse если данная версия браузера не поддерживается.

initToken

Поддерживаемые типы токенов
GOST
initToken(int tokenDesc, string adminPin, string userPin, string label)

Инициализировать электронный ключ и установать PIN-код пользователя.

Аргументы:
  • tokenDesc – идентификатор электронного ключа. Получается с помощью метода getAllTokens().
  • adminPin – текущий PIN-код администратора.
  • userPin – новый PIN-код пользователя.
  • label – новая метка изделия. Для сохранения текущей метки необходимо передать пустую строку.

initTokenUI

Поддерживаемые типы токенов
GOST
initTokenUI(int tokenDesc)

Инициализировать электронный ключ и установать PIN-код пользователя с использованием графического интерфейса приложения JC-WebClient.

Примечание

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

Аргументы:
  • tokenDesc – идентификатор электронного ключа. Получается с помощью метода getAllTokens().
Результат:

booltrue в случае успешного завершения операции, false в случае отмены операции или несовпадения PIN-кода пользователя и его подтверждения.

initTokenWithoutUserPIN

Поддерживаемые типы токенов
GOST
initTokenWithoutUserPIN(int tokenDesc, string adminPin, string label)

Инициализировать электронный ключ без установки PIN-кода пользователя.

Аргументы:
  • tokenDesc – идентификатор электронного ключа. Получается с помощью метода getAllTokens(). Значение идентификатора электронного ключа не постоянно, но в рамках сессии не меняется.
  • adminPin – текущий PIN-код администратора.
  • label – новая метка изделия. Для сохранения текущей метки необходимо передать пустую строку.