Class: CryptoPlugin

Navigation

Overview
Summary
Properties | Methods
Details
Properties | Methods

Hiding private elements (toggle)

Showing extended elements (toggle)

Главный класс плагина. Реализует всю функциональность плагина.

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

Асинхронный интерфейс.

Все функции принимают resultCallback и errorCallback двумя последними параметрами и работают асинхронно. Сразу после вызова все функции возвращают управление. Функция вызывает resultCallback в случае успешного выполнения и errorCallback в случае ошибки. resultCallback принимает один параметр - результат выполнения операции. errorCallback - принимает код ошибки первым параметром.

Cинхронный интерфейс.

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

Примерs:

<object type="application/x-rutoken-pki" id="plugin"></object>
<script type="text/javascript">
// получение объекта плагина
var plugin = document.getElementById("plugin");
if (!plugin.valid) {
    alert("Couldn't load plugin");
}
// использование асинхронного интерфейса
plugin.enumerateDevices(
    function(devices) {
        console.log(devices);
    },
    function(error) {
        console.log(error);
    });
</script>

<object type="application/x-rutoken-pki" id="plugin"></object>
<script type="text/javascript">
// получение объекта плагина
var plugin = document.getElementById("plugin");
if (!plugin.valid) {
    alert("Couldn't load plugin");
}
// использование синхронного интерфейса
var devices = Array();
try {
    devices = plugin.enumerateDevices();
}
catch (error) {
    console.log(error);
}
</script>

Резюме

Свойства

errorCodes :weak_ptr< ErrorCodesApi >: Объект с константами ошибок
valid :boolean: Правильно созданный объект всегда возвращает true
version :string: Версия плагина в формате 1.2.3.4

Методы

addLicense(domain, license, resultCallback, errorCallback) → {bool}

Добавление лицензии для текущего домена.

authenticate(deviceId, certId, salt, resultCallback, errorCallback) → {string}

Аутентификация по сертификату. Для выполнения этой функции требуется авторизоваться на устройстве.

changePin(deviceId, oldPin, newPin, options, resultCallback, errorCallback)

Изменение PIN пользователя.

cmsDecrypt(deviceId, keyId, cmsData, options, resultCallback, errorCallback) → {string}

Расшифрование данных в формате CMS. Аргумент options принимает параметры расшифрования, пока зарезервирован для будущего использования. Для выполнения этой функции требуется авторизоваться на устройстве.

cmsEncrypt(deviceId, certId, recipientCert, data, options, resultCallback, errorCallback) → {string}

Шифрование данных в формате CMS. Аргумент options принимает параметры шифрования. Доступны следующие опции (в скобках указано значение по умолчанию):

base64:bool (false) - закодированы ли переданные данные в base64
useHardwareEncryption:bool (false) - производить шифрование на устройстве

Для выполнения этой функции требуется авторизоваться на устройстве.

createPkcs10(deviceId, keyId, subject, extensions, includeSubjSignTool, resultCallback, errorCallback) → {string}

Формирование самоподписанного PKCS#10 запроса Для выполнения этой функции требуется авторизоваться на устройстве.

deleteCertificate(deviceId, certId, resultCallback, errorCallback)

Удаление сертификата с устройства. Для выполнения этой функции требуется авторизоваться на устройстве.

deleteKeyPair(deviceId, keyId, resultCallback, errorCallback)

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

enumerateCertificates(deviceId, category, resultCallback, errorCallback) → {string[]}

Получение массива с идентификаторами сертификатов.

enumerateDevices(resultCallback, errorCallback) → {number[]}

Получение идентификаторов доступных устройств

enumerateKeys(deviceId, marker, resultCallback, errorCallback) → {string[]}

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

generateKeyPair(deviceId, params, marker, options, resultCallback, errorCallback) → {string}

Генерация ключевой пары ГОСТ Р 34.10-2001 на устройстве. Для выполнения этой функции требуется авторизоваться на устройстве. Аргумент options задает различные свойства ключа. Доступны следующие опции: needPin:bool(false) - если ключевая пара создана на PINPad 2, для каждого ее использования потребуется ввести PIN на устройстве; needConfirm:bool(false) - если ключевая пара создана на PINPad 2, для каждого ее использования потребуется подтверждение на устройстве.

getCertificate(deviceId, certId, resultCallback, errorCallback) → {string}

Получение тела сертификата в PEM.

getDeviceInfo(deviceId, option, resultCallback, errorCallback) → {object}

Получение информации об устройстве. Тип информации задается константами: TOKEN_INFO_MODEL, TOKEN_INFO_LABEL, TOKEN_INFO_DEVICE_TYPE, TOKEN_INFO_SERIAL, TOKEN_INFO_IS_LICENSED

getDeviceLabel(deviceId, resultCallback, errorCallback) → {string}

Получение метки устройства

getDeviceModel(deviceId, resultCallback, errorCallback) → {string}

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

getDeviceType(deviceId, resultCallback, errorCallback) → {Pkcs11DeviceBase::DeviceType}

Получение константы, обозначающей тип устройства.

getKeyByCertificate(deviceId, certId, resultCallback, errorCallback) → {string}

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

getKeyLabel(deviceId, keyId, resultCallback, errorCallback) → {string}

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

importCertificate(deviceId, certificate, category, resultCallback, errorCallback) → {string}

Импорт сертификата на устройство. Для выполнения этой функции требуется авторизоваться на устройстве.

isLicensed(deviceId, resultCallback, errorCallback) → {boolean}

Проверка подлинности лицензии устройстве.

login(deviceId, pin, resultCallback, errorCallback)

Авторизация на устройстве

logout(deviceId, resultCallback, errorCallback)

Закрытие сессии

parseCertificate(deviceId, certId, resultCallback, errorCallback) → {object}

Получение ассоциативного массива с разобранными полями из сертификата.

parseCertificateFromString(text, resultCallback, errorCallback) → {object}

Получение ассоциативного массива с разобранными полями из сертификата.

rawSign(deviceId, keyId, data, options, resultCallback, errorCallback) → {string}

Подпись заранее вычисленного хеша. Аргумент options принимает параметры расшифрования, пока зарезервирован для будущего использования. Для выполнения этой функции требуется авторизоваться на устройстве.

removePin(deviceId, resultCallback, errorCallback)

Удаление закешированного PIN-кода из файла.

savePin(deviceId, resultCallback, errorCallback)

Сохранение PIN-кода в файл для автоматической аутентификации.

setKeyLabel(deviceId, keyId, label, resultCallback, errorCallback)

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

sign(deviceId, certId, data, isBase64, options, resultCallback, errorCallback) → {string}

Вычисление цифровой подписи. Аргумент options принимает параметры подписи. Доступны следующие опции (в скобках указано значение по умолчанию):

detached:bool (false) - генерировать отсоединенную подпись
addUserCertificate:bool (false) - включить в подпись сертификат пользователя
addSignTime:bool (false) - включить в подпись время подписи
useHardwareHash:bool (false) - производить аппаратное хеширование данных

Для выполнения этой функции требуется авторизоваться на устройстве.

verify(deviceId, cms, options, resultCallback, errorCallback) → {bool}

Проверка цифровой подписи. Аргумент options принимает параметры проверки подписи. Доступны следующие опции (в скобках указано значение по умолчанию):

data:string (null) - подписанные данные, только в случае detached подписи;
base64:bool (false) - указывает, закодированы ли даные, переданные в data в base64;
certificates:string[] (null) - набор сертификатов, на которых необходимо проверять подпись, при этом сертификаты содержащиеся в cms будут проигнорированы;
CA:string[] (null) - список дополнительных корневых сертификатов для проверки сертифката, кроме них берутся сертифкаты с устройства;
CRL:string[] (null) - список отозванных сертификатов;
useHardwareHash:bool (false) - производить хеширование на устройстве;
verifyCertificate:bool (true) - проверть сертификат пользователя;

Подробно

Свойства

errorCodes :weak_ptr< ErrorCodesApi >

Объект с константами ошибок

valid :boolean

Правильно созданный объект всегда возвращает true

version :string

Версия плагина в формате 1.2.3.4

Методы

addLicense(domain, license, resultCallback, errorCallback) → {bool}

Добавление лицензии для текущего домена.

Параметры:

	Name	Type	Description
1	domain	string	Доменное имя, для которого выдана лицензия
2	license	string	Строка с лицензией
3	resultCallback	function	Функция обратного вызова для случая успешного выполнения
4	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

true - лицензия успешно проверена / false - лицензия не подходит

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	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Строка для аутентификации

changePin(deviceId, oldPin, newPin, options, resultCallback, errorCallback)

Изменение PIN пользователя.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	oldPin	string	Старый PIN пользователя
3	newPin	string	Новый PIN пользователя
4	options	object	Массив, содержащий дополнительные параметры - объекты вида {параметр:значение} (зарезервирован для будущего использования)
5	resultCallback	function	Функция обратного вызова для случая успешного выполнения
6	errorCallback	function	Функция обратного вызова для случая возникновения ошибки void

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}

base64:bool (false) - закодированы ли переданные данные в base64
useHardwareEncryption:bool (false) - производить шифрование на устройстве

Для выполнения этой функции требуется авторизоваться на устройстве.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	certId	string	Идентификатор сертификата, зарезервированно для будущего использования
3	recipientCert	string	Тело сертификата сервера
4	data	string	Зашифровываемые данные (текстовая строка или base64-encoded бинарные данные)
5	options	object	Массив, содержащий параметры шифрования - объекты вида {параметр:значение}
6	resultCallback	function	Функция обратного вызова для случая успешного выполнения
7	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Зашифрованные данные в формате CMS

createPkcs10(deviceId, keyId, subject, extensions, includeSubjSignTool, resultCallback, errorCallback) → {string}

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	keyId	string	Идентификатор ключа
3	subject	object	Массив, содержащий объекты вида: {rdn: "commonName", value: "значение"}
4	extensions	object	Ассоциативный массив, содержащий массивы расширений: {keyUsage: ["digitalSignature",...], extKeyUsage: ["oid", "longName" ], certificatePolicies: ["OID", ...]}
5	includeSubjSignTool	boolean	Флаг, включать или нет в запрос расширение SubjectSignTool
6	resultCallback	function	Функция обратного вызова для случая успешного выполнения
7	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

PKCS#10 запрос

Пример:

 *        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 certificatePolicies = [
           "1.2.643.100.113.1", // КС1
           "1.2.643.100.113.2", // КС2
           "1.2.643.100.113.3", // КС3
           "1.2.643.100.113.4", // КВ1
           "1.2.643.100.113.5", // КВ2
           "1.2.643.100.113.6"  // КА1
       ];
       var extensions = {
           "keyUsage":            keyUsageVal,
           "extKeyUsage":         extKeyUsageVal,
           "certificatePolicies": certificatePolicies
       };
       plugin.createPkcs10(deviceID, keyID, subject, extensions, includeSubjectSignToolExt,
               this.printResult, this.printError);
   }

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

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	Attributes	Default	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}

Генерация ключевой пары ГОСТ Р 34.10-2001 на устройстве.

Для выполнения этой функции требуется авторизоваться на устройстве. Аргумент options задает различные свойства ключа. Доступны следующие опции: needPin:bool(false) - если ключевая пара создана на PINPad 2, для каждого ее использования потребуется ввести PIN на устройстве; needConfirm:bool(false) - если ключевая пара создана на PINPad 2, для каждого ее использования потребуется подтверждение на устройстве.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	params	string	Параметры ключа
3	marker	string	Идентификатор группы ключей
4	options	object	Дополнительные свойтва ключевой пары в виде ассоциативного массива, см. подробное описание функции
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	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Описатель сертификата в виде объекта

getDeviceInfo(deviceId, option, resultCallback, errorCallback) → {object}

Получение информации об устройстве.

Тип информации задается константами: TOKEN_INFO_MODEL, TOKEN_INFO_LABEL, TOKEN_INFO_DEVICE_TYPE, TOKEN_INFO_SERIAL, TOKEN_INFO_IS_LICENSED

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	option	number	Тип запрашиваемой информации (тип устройства, метка, серийный номер или наличие лицензии)
3	resultCallback	function	Функция обратного вызова для случая успешного выполнения
4	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

текстовая строка для метки и серийного номера, число для типа устройства или true/false в случае лицензии

getDeviceLabel(deviceId, resultCallback, errorCallback) → {string}

Получение метки устройства

Deprecated:: Внимание: начиная с версии 0.15.0.0, функция не поддерживается и может быть удалена в последующих версиях плагина. Используйте метод getDeviceInfo.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Метка устройства

getDeviceModel(deviceId, resultCallback, errorCallback) → {string}

Получение строки с моделью устройства, понятной для человека.

Внимание: возвращаемая строка может меняться в будущем.

Deprecated:: Внимание: начиная с версии 0.15.0.0, функция не поддерживается и может быть удалена в последующих версиях плагина. Используйте метод getDeviceInfo.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Тип устройства в виде человеко-понятной строки

getDeviceType(deviceId, resultCallback, errorCallback) → {Pkcs11DeviceBase::DeviceType}

Получение константы, обозначающей тип устройства.

Deprecated:: Внимание: начиная с версии 0.15.0.0, функция не поддерживается и может быть удалена в последующих версиях плагина. Используйте метод getDeviceInfo.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

deviceType Тип устройства в виде числовой константы

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	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Метка закрытого ключа

importCertificate(deviceId, certificate, category, resultCallback, errorCallback) → {string}

Импорт сертификата на устройство.

Для выполнения этой функции требуется авторизоваться на устройстве.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	certificate	string	Тело сертификата в формате BASE64
3	category	number	Тип сертификата: "user", "other" или "CA"
4	resultCallback	function	Функция обратного вызова для случая успешного выполнения
5	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Идентификатор сертификата

isLicensed(deviceId, resultCallback, errorCallback) → {boolean}

Проверка подлинности лицензии устройстве.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

true, если устройство лицензировано и false в противном случае

login(deviceId, pin, resultCallback, errorCallback)

Авторизация на устройстве

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	pin	string	PIN-код доступа к устройству
3	resultCallback	function	Функция обратного вызова для случая успешного выполнения
4	errorCallback	function	Функция обратного вызова для случая возникновения ошибки void

logout(deviceId, resultCallback, errorCallback)

Закрытие сессии

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки void

parseCertificate(deviceId, certId, resultCallback, errorCallback) → {object}

Получение ассоциативного массива с разобранными полями из сертификата.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	certId	string	Идентификатор сертификата, полученный в результате вызова enumerateCertificates
3	resultCallback	function	Функция обратного вызова для случая успешного выполнения
4	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Ассоциативный массив объектов

parseCertificateFromString(text, resultCallback, errorCallback) → {object}

Получение ассоциативного массива с разобранными полями из сертификата.

Параметры:

	Name	Type	Description
1	text	string	Тело сертификата в BASE64
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Ассоциативный массив объектов

rawSign(deviceId, keyId, data, options, resultCallback, errorCallback) → {string}

Подпись заранее вычисленного хеша. Аргумент options принимает параметры расшифрования, пока зарезервирован для будущего использования.

Для выполнения этой функции требуется авторизоваться на устройстве.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	keyId	string	Идентификатор ключа
3	data	string	Подписываемый хеш (hex-строка)
4	options	object	Массив, содержащий параметры подписи - объекты вида {параметр:true/false}
5	resultCallback	function	Функция обратного вызова для случая успешного выполнения
6	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Электронно-цифровая подпись

removePin(deviceId, resultCallback, errorCallback)

Удаление закешированного PIN-кода из файла.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки boolean

savePin(deviceId, resultCallback, errorCallback)

Сохранение PIN-кода в файл для автоматической аутентификации.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	resultCallback	function	Функция обратного вызова для случая успешного выполнения
3	errorCallback	function	Функция обратного вызова для случая возникновения ошибки void

setKeyLabel(deviceId, keyId, label, resultCallback, errorCallback)

Установка метки секретного ключа.

Для выполнения этой функции требуется авторизоваться на устройстве.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	keyId	string	Идентификатор ключа
3	label	string	Новая метка закрытого ключа
4	resultCallback	function	Функция обратного вызова для случая успешного выполнения
5	errorCallback	function	Функция обратного вызова для случая возникновения ошибки void

sign(deviceId, certId, data, isBase64, options, resultCallback, errorCallback) → {string}

detached:bool (false) - генерировать отсоединенную подпись
addUserCertificate:bool (false) - включить в подпись сертификат пользователя
addSignTime:bool (false) - включить в подпись время подписи
useHardwareHash:bool (false) - производить аппаратное хеширование данных

Для выполнения этой функции требуется авторизоваться на устройстве.

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	certId	string	Идентификатор сертификата
3	data	string	Подписываемые данные (текстовая строка или base64-encoded бинарные данные)
4	isBase64	boolean	Флаг, данные передаются в кодировке base64 или нет
5	options	object	Массив, содержащий параметры подписи - объекты вида {параметр:true/false}
6	resultCallback	function	Функция обратного вызова для случая успешного выполнения
7	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

Электронно-цифровая подпись

verify(deviceId, cms, options, resultCallback, errorCallback) → {bool}

data:string (null) - подписанные данные, только в случае detached подписи;
base64:bool (false) - указывает, закодированы ли даные, переданные в data в base64;
certificates:string[] (null) - набор сертификатов, на которых необходимо проверять подпись, при этом сертификаты содержащиеся в cms будут проигнорированы;
CA:string[] (null) - список дополнительных корневых сертификатов для проверки сертифката, кроме них берутся сертифкаты с устройства;
CRL:string[] (null) - список отозванных сертификатов;
useHardwareHash:bool (false) - производить хеширование на устройстве;
verifyCertificate:bool (true) - проверть сертификат пользователя;

Параметры:

	Name	Type	Description
1	deviceId	number	Идентификатор устройства
2	cms	string	Контейнер с цифровой подписью
3	options	object	Массив, содержащий параметры проверки подписи - объекты вида {параметр:значение}
4	resultCallback	function	Функция обратного вызова для случая успешного выполнения
5	errorCallback	function	Функция обратного вызова для случая возникновения ошибки

Возвращает:

true - подпись верна / false - не верна

Documentation generated by JSDoc 3 on 12th May 2014 - 16:20 with the DataTables template.