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

Аутентификация по сертификату.

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

Параметры:

Возвращает:

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

 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 запроса.

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

Параметры:

Возвращает:

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 extensions = {
          "keyUsage":     keyUsageVal,
          "extKeyUsage":  extKeyUsageVal
      };
      plugin.createPkcs10(deviceID, keyID, subject, extensions, includeSubjectSignToolExt,
              this.printResult, this.printError);
  }

decrypt(deviceId, keyLabel, data, resultCallback, errorCallback) → {string}

Расшифрование данных.

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

Параметры:

Возвращает:

Расшифрованные данные

deleteCertificate(deviceId, certId, resultCallback, errorCallback)

Удаление сертификата из токена.

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

Параметры:

deleteKeyPair(deviceId, keyId, resultCallback, errorCallback)

Удаление ключевой пары

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

Параметры:

digest(deviceId, hashType, data, options, resultCallback, errorCallback) → {string}

        Вычисление хеш-значения по заданному алгоритму от данных

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

Параметры:

Возвращает:

Хеш-значение в hex

encrypt(deviceId, keyLabel, data, resultCallback, errorCallback) → {string}

Шифрование данных.

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

Параметры:

Возвращает:

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

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 на "борту" токена.

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

Параметры:

Возвращает:

ID ключа в HEX

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

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

Параметры:

Возвращает:

Строку, содержащую сертификат в PEM-формате.

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

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

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

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

Параметры:

Возвращает:

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

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

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

getDeviceType(deviceId, resultCallback, errorCallback) → {void}

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

Параметры:

Возвращает:

Тип устройства в виде числовой константы. Возможные типы устройства:

• 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

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

Параметры:

Возвращает:

Ассоциативный массив с полями journal и signature

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

Получение ключа по сертификату.

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

Параметры:

Возвращает:

Идентификатор ключа

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

Получение метки секретного ключа.

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

Параметры:

Возвращает:

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

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

Получение значения открытого ключа.

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

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

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

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

Параметры:

Возвращает:

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

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 принимает параметры подписи.

Параметры:

Возвращает:

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

removePin(deviceId, resultCallback, errorCallback) 

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

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

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

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

Параметры:

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

Вычисление цифровой подписи.

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

Параметры:

Возвращает:

Электронную подпись в формате CMS в base64

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) - набор списков отзыва сертификатов. Каждый список отзыва в PEM.
  • useHardwareHash:bool (false) - производить хеширование на устройстве;
  • verifyCertificate:bool (true) - проверять ли сертификат пользователя (выстраивать цепочку до корневого);