Class: CryptoPlugin

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

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

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

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

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

Создание бинарного файла (далее БФ) на устройстве.
Ограничения на создаваемый БФ (их необходимо придерживаться при создании БФ альтернативными способами - напрямую через PKCS, например):

• Атрибуты PKCS создаваемого БФ:
•   CKA_CLASS = CKO_DATA - класс для хранения БФ по умолчанию.
•   CKA_TOKEN = CK_TRUE - флаг хранения БФ на устройстве.
•   CKA_MODIFIABLE = CK_TRUE - флаг, разрешающий модификацию БФ после его создания.
•   CKA_LABEL - имя БФ без '\0'. Ограничения:
•     Имя бинарного файла должно быть задано.
•     Имена файлов должны быть уникальными.
•   CKA_APPLICATION = "Rutoken Plugin"
•   CKA_PRIVATE - флаг приватности БФ.
•   CKA_VALUE - тело БФ в бинарном формате.
• На отформатированном токене гарантированно можно создать 250 приватных и 250 публичных БФ.
• Максимальный суммарный размер атрибутов CKA_LABEL (имя БФ) и CKA_VALUE (тело БФ) в конечном бинарном представлении - 32'768 байт.
• Тело БФ должно быть передано в интерфейс плагина в кодировке Base64. На устройстве тело БФ хранится в бинарном виде. То есть при создании БФ не через плагин тело БФ должно быть представлено в бинарном виде.

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

• policy:string (empty) - политика, по которой ожидается создание метки времени
• cert:bool (false) - указать, что серверу требуется включить сертификат подписи в ответ
• nonce:bool (true) - включить псевдослучайное 64 битное число в запрос
• extensions:object - массив, содержащий расширения в виде: {oid: "1.2.3", value: "MA0GCCqFAwICLgAIAgEB", criticality: false}

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

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

• ukm:string (00:00:00:00:00:00:00:01) - Синхропосылка (hex-строка)

Получение перечня идентификаторов бинарных файлов (далее БФ).
Шаблон поиска БФ:

• CKA_CLASS = CKO_DATA
• CKA_APPLICATION = "Rutoken Plugin"
• CKA_TOKEN = CK_TRUE

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

• mode:enum (ENUMERATE_DEVICES_LIST) - тип получаемой информации об устройствах, доступны варианты:
• ENUMERATE_DEVICES_LIST - получить список доступных устройств;
• ENUMERATE_DEVICES_EVENTS - получить списки подключенных и отключенных устройств;

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

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

• id:string("") - уникальный идентификатор ключевой пары (hex). Если опция не задана, или в качестве значения указана пустая строка, будет сгенерирован автоматически.
  При генерации ключей для ЕГАИС необходимо указывать id:string, состоящий из печатных символов и не содержащий пустого символа. Пример правильного id:string для ЕГАИС -> "abc123", что в шестнадцатеричной кодировке будет выглядеть как id:string("41:42:43:31:32:33"), для автоматического преобразования рекомендуем использовать функцию asciitohex() см. пример ниже.


• publicKeyAlgorithm:enum(PUBLIC_KEY_ALGORITHM_GOST3410_2001) - алгоритм, варианты:
• PUBLIC_KEY_ALGORITHM_GOST3410_2001 - ГОСТ Р 34.10-2001;
• PUBLIC_KEY_ALGORITHM_GOST3410_2012_256 - ГОСТ Р 34.10-2012 длина закрытого ключа 256 бит;
• PUBLIC_KEY_ALGORITHM_GOST3410_2012_512 - ГОСТ Р 34.10-2012 длина закрытого ключа 512 бит;
• PUBLIC_KEY_ALGORITHM_RSA - RSA
• Примечание: В ЕГАИС используется PUBLIC_KEY_ALGORITHM_GOST3410_2012_256. Алгоритм ГОСТ Р 34.10-2001 выводится из эксплуатации в 2019 году


• signatureSize:number - размер подписи в битах, значения по умолчанию:
• ГОСТ Р 34.10-2001 - 512
• ГОСТ Р 34.10-2012 длина закрытого ключа 256 бит - 512
• ГОСТ Р 34.10-2012 длина закрытого ключа 512 бит - 1024
• RSA - 2048
• paramset:string - задает параметры ключевой пары. Если опция не задана, будут выбраны параметры А для любого из алгоритмов ГОСТ. Возможные варианты:
• ГОСТ Р 34.10-2001:
• "A"
• "B"
• "C"
• "XA"
• "XB"
• ГОСТ Р 34.10-2012 длина закрытого ключа 256 бит:
• "A"
• "B"
• "C"
• "XA"
• "XB"
• "TC26-A"
• "TC26-B"
• "TC26-C"
• "TC26-D"
• ГОСТ Р 34.10-2012 длина закрытого ключа 512 бит:
• "A"
• "B"
• "TC26-A"
• "TC26-B"
• "TC26-C"
• keyType:enum(KEY_TYPE_COMMON) - тип ключевой пары, доступны варианты:
• KEY_TYPE_COMMON - обычная ключевая пара;
• KEY_TYPE_JOURNAL - журнальная ключевая пара (может быть использована только для подписи журнала);

// Преобразование шестнадцатеричного id ключевой пары в формат для ЕГАИС
function asciitohex(str){
    var result = [];
    for (var n = 0, l = str.length; n < l; n++) {
         var code = str.charCodeAt(n);
         if(code > 128 || code == 32)
             continue;

         var hex = code.toString(16);
         result.push(hex);
    }
    return result.join(':');
}
 

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

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

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

• TOKEN_INFO_MODEL (string) - модель токена, не поддерживается и может быть удалена в последующих версиях плагина
• TOKEN_INFO_READER (string) - имя считывателя
• TOKEN_INFO_LABEL (string) - метка токена
• TOKEN_INFO_DEVICE_TYPE (integer) - константа, определяющая тип токена, не поддерживается и может быть удалена в последующих версиях плагина
• TOKEN_INFO_SERIAL (string) - серийный номер токена
• TOKEN_INFO_IS_PIN_CACHED (bool) - сохранён ли PIN-код. Начиная с версии 4.0.5 не поддерживается и может быть удалена в последующих версиях плагина. Используйте константу TOKEN_INFO_PINS_INFO.
• TOKEN_INFO_IS_LOGGED_IN (bool) - состояние аутентифицированности токена
• TOKEN_INFO_FORMATS (см. ниже) - поддерживаемые форматы входных данных для подписи
• TOKEN_INFO_FEATURES (см. ниже) - аппаратные возможности устройства
• TOKEN_INFO_ALGORITHMS (см. ниже) - поддерживаемые криптографические алгоритмы ЭЦП. Начиная с версии 4.0.5 не поддерживается и может быть удалена в последующих версиях плагина. Используйте константу TOKEN_INFO_SUPPORTED_MECHANISMS.
• TOKEN_INFO_SUPPORTED_MECHANISMS (см. ниже) - поддерживаемые программные и аппаратные алгоритмы.
• TOKEN_INFO_SPEED (integer) - класс скорости устройства.
• TOKEN_INFO_PIN_RETRIES_LEFT (integer) - оставшееся количество попыток ввода PIN-кода. Начиная с версии 4.0.5 не поддерживается и может быть удалена в последующих версиях плагина. Используйте константу TOKEN_INFO_PINS_INFO.
• TOKEN_INFO_PINS_INFO (см. ниже) - информация о PIN-кодах устройства
• TOKEN_INFO_FKN_SUPPORTED (bool) - поддерживает ли токен ФКН
• TOKEN_INFO_FREE_MEMORY (integer) - свободное место на токене в байтах.
• TOKEN_INFO_VENDOR_MODEL_NAME (string) - имя модели токена возвращаемое самим устройством. Проверить поддержку можно флагом vendorModelName из TOKEN_INFO_FEATURES.

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

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

Получение информации о ключе.

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

Получение лицензии с токена

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

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

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

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

• computeHash:bool (false) - должен быть true, если data — текстовые данные (хеш считается только для ключей ГОСТ)
• useHardwareHash:bool (false) - производить аппаратное хеширование данных, только если computeHash = true
• hashAlgorithm:enum - алгоритм хеширования. Для ключей RSA обязателен, даже если computeHash выставлен в false. Для ключей ГОСТ, если не задан, будет выбран автоматически. Варианты: HASH_TYPE_GOST3411_94, HASH_TYPE_GOST3411_12_256, HASH_TYPE_GOST3411_12_512, HASH_TYPE_MD5, HASH_TYPE_SHA1, HASH_TYPE_SHA256, HASH_TYPE_SHA384, HASH_TYPE_SHA512.

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

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

Запись лицензии на токен

Разблокирует заблокированный PIN-код пользователя. Пользователь не должен быть авторизован.

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

• certificates:string[] (null) - набор сертификатов в PEM формате, на которых необходимо проверять подпись, при этом сертификат, который может содержаться в метке доверенного времени, будет проигнорирован;
• CA:string[] (null) - список дополнительных корневых сертификатов в PEM формате для проверки сертификата, кроме них берутся сертификаты с устройства;
• CRL:string[] (null) - список отозванных сертификатов в PEM формате;