authenticate(deviceId, certId, salt, resultCallback, errorCallback) → {string}
Аутентификация по сертификату.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | certId | string | Идентификатор сертификата |
| 3 | salt | string | Аутентификационные данные |
| 4 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 5 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Строка для аутентификации
cmsDecrypt(deviceId, keyId, cmsData, options, resultCallback, errorCallback) → {string}
Расшифрование данных в формате CMS. Аргумент options принимает параметры расшифрования, пока зарезервирован для будущего использования.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | keyId | string | Идентификатор ключа для расшифровыания |
| 3 | cmsData | string | CMS-сообщение, содержащие зашифрованные данные |
| 4 | options | object | Массив, содержащий параметры расшифрования - объекты вида {параметр:значение} (зарезервирован для будущего использования) |
| 5 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 6 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Расшифрованные данные
cmsEncrypt(deviceId, certId, recipientCert, data, options, resultCallback, errorCallback) → {string}
Шифрование данных в формате CMS.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | certId | string | Идентификатор сертификата, зарезервированно для будущего использования |
| 3 | recipientCert | string | Тело сертификата сервера |
| 4 | data | string | Зашифровываемые данные (текстовая строка или base64-encoded бинарные данные) |
| 5 | options | object | Аргумент options принимает параметры шифрования. Доступны следующие опции (в скобках указано значение по умолчанию):
|
| 6 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 7 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Зашифрованные данные в формате CMS
createPkcs10(deviceId, keyId, subject, extensions, includeSubjSignTool, resultCallback, errorCallback) → {string}
Формирование самоподписанного запроса PKCS#10.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | keyId | string | Идентификатор ключа |
| 3 | subject | object[] | Массив, содержащий объекты вида: {rdn: "commonName", value: "значение"} |
| 4 | extensions | object | Ассоциативный массив, содержащий массивы расширений: {keyUsage: ["digitalSignature",...], extKeyUsage: ["oid", "longName" ]} |
| 5 | includeSubjSignTool | boolean | Флаг, включать или нет в запрос расширение SubjectSignTool |
| 6 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 7 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Запрос PKCS#10 в PEM-формате.
Пример:
* var subject = [
{
rdn: "countryName",
value: "RU"
}
,{
rdn: "stateOrProvinceName",
value: "moscow"
}
,{
rdn: "localityName",
value: "locality"
}
,{
rdn: "streetAddress",
value: "street"
}
,{
rdn: "organizationName",
value: "Aktiv"
}
,{
rdn: "organizationalUnitName",
value: "IT"
}
,{
rdn: "title",
value: "должность"
}
,{
rdn: "commonName",
value: "Фамилия Имя Очество"
}
,{
rdn: "postalAddress",
value: "postal address"
}
,{
rdn: "pseudonym",
value: "pseudonymus"
}
,{
rdn: "surname",
value: "surname"
}
,{
rdn: "givenName",
value: "given name"
}
,{
rdn: "emailAddress",
value: "example@example.com"
}
];
var keyUsageVal = [
"digitalSignature"
,"nonRepudiation"
,"keyEncipherment"
,"dataEncipherment"
,"keyAgreement"
,"keyCertSign"
,"cRLSign"
,"encipherOnly"
,"decipherOnly"
];
var extKeyUsageVal = [
"emailProtection"
,"clientAuth"
,"serverAuth"
,"codeSigning"
,"timeStamping"
,"msCodeInd"
,"msCodeCom"
,"msCTLSign"
,"1.3.6.1.5.5.7.3.9" // OSCP
,"1.2.643.2.2.34.6" // CryptoPro RA user
// ,"anyExtendedKeyUsage"
];
var extensions = {
"keyUsage": keyUsageVal,
"extKeyUsage": extKeyUsageVal
};
plugin.createPkcs10(deviceID, keyID, subject, extensions, includeSubjectSignToolExt,
this.printResult, this.printError);
}
|
createVirtualDevice(filePath, password, resultCallback, errorCallback) → {bool}
Функция ассоциирует файл-контейнер формата PKCS#12 с виртуальным устройством с поддержкой алгоритма RSA.
При дальнейшем использовании устройства, например, для генерации ключей или импорта сертификатов, ключи и сертификаты будут сохранены в этом файле. После вызова функции последующий вызов функции enumerateDevices вернет массив идентификаторов, в который будет добавлен и идентификатор виртуального устройства. Вызов getDeviceInfo для данного устройства вернет в качестве модели "PKCS12", в качестве label - путь к файлу.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | filePath | string | Путь к файлу PKCS#12-контейнеру, с которым будет ассоциировано виртуальное устройство. Если null, то путь будет запрошен диалогом. |
| 2 | password | string | Пароль, на котором будет зашифрован PKCS#12-контейнер |
| 6 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 7 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Если контейнер успешно создан, то true. Если пользователь в диалоге выбора нажал кнопку "Отмена", то false.
decrypt(deviceId, keyLabel, data, resultCallback, errorCallback) → {string}
Расшифрование данных на симметричном ключе.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | keyLabel | string | Метка ключа для шифрования (если такого ключа нет, будет возвращена ошибка) |
| 3 | data | string | Расшифровываемые данные |
| 4 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 5 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Расшифрованные данные.
deleteCertificate(deviceId, certId, resultCallback, errorCallback)
Удаление сертификата из токена.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | certId | string | Идентификатор сертификата, полученный в результате вызова enumerateCertificates |
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки void |
deleteKeyPair(deviceId, keyId, resultCallback, errorCallback)
Удаление ключевой пары
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | keyId | string | Идентификатор секретного ключа из ключевой пары |
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки void |
digest(deviceId, hashType, data, options, resultCallback, errorCallback) → {string}
Вычисление хеш-значения по заданному алгоритму от данных
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | hashType | string | Идентификатор алгоритма хеширования |
| 3 | data | string | данные для хеширования |
| 4 | options | object | Массив, содержащий параметры хеширования - объекты вида {параметр:true/false}.
|
| 5 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 6 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки void |
Возвращает:
Хеш-значение в hex
encrypt(deviceId, keyLabel, data, resultCallback, errorCallback) → {string}
Шифрование данных.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | keyLabel | string | Метка ключа для шифрования (если такого ключа нет, он будет сгенерирован) |
| 3 | data | string | Зашифровываемые данные |
| 4 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 5 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Зашифрованные данные
enumerateCertificates(deviceId, category, resultCallback, errorCallback) → {string[]}
Получение массива с идентификаторами сертификатов.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | category | number | Тип сертификата: "user", "other" или "CA" |
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Массив строк с идентификаторами сертификатов
enumerateDevices(resultCallback, errorCallback) → {number[]}
Получение идентификаторов доступных устройств
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 2 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Список идентификаторов подключенных устройств
enumerateKeys(deviceId, marker, resultCallback, errorCallback) → {string[]}
Получение массива с идентификаторами секретных ключей в HEX.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | marker | string | Идентификатор группы ключей, "" - все ключи |
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Массив строк с идентификаторами закрытых ключей
generateKeyPair(deviceId, params, marker, options, resultCallback, errorCallback) → {string}
Генерация ключевой пары в устройстве.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | params | string | Параметры ключа |
| 3 | marker | string | Идентификатор группы ключей |
| 4 | options | object | Доступны следующие опции:
Для ключевой пары типа KEY_TYPE_COMMON так же доступны следующие атрибуты:
|
5 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 6 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
ID ключа в HEX
getCertificate(deviceId, certId, resultCallback, errorCallback) → {string}
Получение тела сертификата в PEM.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | certId | string | Идентификатор сертификата |
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Строку, содержащую сертификат в PEM-формате.
getDeviceInfo(deviceId, option, resultCallback, errorCallback) → {object}
Получение информации об устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | option | number | Тип запрашиваемой информации:
|
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Текстовая строка для метки и серийного номера, число для типа устройства.
В случае передачи в качестве параметра TOKEN_INFO_FORMATS возвращается список форматов, которые поддерживает устройство, в виде массива констант:
- DEVICE_DATA_FORMAT_PLAIN - произвольные данные
- DEVICE_DATA_FORMAT_RAW - неформатированные данные для отображения на PINPad 2
- DEVICE_DATA_FORMAT_PINPAD2 - данные в формате PINPADFILE для отображения на PINPad 2
- DEVICE_DATA_FORMAT_XML - данные в XML формате для отображения на PINPad 2 DEVICE_DATA_FORMAT_SAFETOUCH - данные для отображения на Safetouch
В случае передачи в качестве параметра TOKEN_INFO_FEATURES возвращается ассоциативный массив, определяющий возможности устройства, со следующими полями:
- journal:bool - поддержка журанала операций
- pin2:bool - поддержка ввода PIN2 на устройстве
- visualization:bool - поддержка генерации ключей, требующих визуализации данных на устройстве
В случае передачи в качестве параметра TOKEN_INFO_DEVICE_TYPE возвращает тип устройства в виде числовой константы. Возможные типы устройства:
- TOKEN_TYPE_UNKNOWN - неизвестное устройство;
- TOKEN_TYPE_RUTOKEN_ECP - Рутокен ЭЦП;
- TOKEN_TYPE_RUTOKEN_WEB - Рутокен WEB;
- TOKEN_TYPE_RUTOKEN_PINPAD_2 - Рутокен PINPad;
- TOKEN_TYPE_KAZTOKEN - Казтокен.
getDeviceLabel(deviceId, resultCallback, errorCallback) → {string}
Получение метки устройства
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 3 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Метка устройства
getDeviceModel(deviceId, resultCallback, errorCallback) → {string}
Получение строки с моделью устройства, понятной для человека. Внимание: возвращаемая строка может меняться в будущем.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 3 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Тип устройства в виде человеко-понятной строки
getDeviceType(deviceId, resultCallback, errorCallback) → {void}
Получение константы, обозначающей тип устройства.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 3 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Тип устройства в виде числовой константы. Возможные типы устройства:
- TOKEN_TYPE_UNKNOWN - неизвестное устройство;
- TOKEN_TYPE_RUTOKEN_ECP - Рутокен ЭЦП;
- TOKEN_TYPE_RUTOKEN_WEB - Рутокен WEB;
- TOKEN_TYPE_RUTOKEN_PINPAD_2 - Рутокен PINPad;
- TOKEN_TYPE_KAZTOKEN - Казтокен.
getJournal(deviceId, keyId, options resultCallback, errorCallback) → {object}
Получение журнала операций на устройстве и его подписи, сформированной на соответствующем ключе. Если с момента подключения устройства никаких операций не производилось будет возвращен null
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | keyId | string | Идентификатор ключа |
| 3 | options | object | Зарезервировано для будущего использования |
| 4 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 6 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Ассоциативный массив с полями journal и signature
getKeyByCertificate(deviceId, certId, resultCallback, errorCallback) → {string}
Получение ключа по сертификату.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | certId | string | Идентификатор сертификата |
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Идентификатор ключа
getKeyLabel(deviceId, keyId, resultCallback, errorCallback) → {string}
Получение метки секретного ключа.
Для выполнения этой функции требуется авторизоваться на устройстве.
Параметры:
| Name | Type | Description | |
|---|---|---|---|
| 1 | deviceId | number | Идентификатор устройства |
| 2 | keyId | string | Идентификатор ключа |
| 3 | resultCallback | function | Функция обратного вызова для случая успешного выполнения |
| 4 | errorCallback | function | Функция обратного вызова для случая возникновения ошибки |
Возвращает:
Метка закрытого ключа.