API v4.11.2.0

Константы

Константы, используемые в методах класса CryptoPlugin.

Резюме

Категория сертификата

Константа Описание
CERT_CATEGORY_CAДоверенный в рамках текущего устройства сертификат
CERT_CATEGORY_OTHERСертификат третьей стороны
CERT_CATEGORY_UNSPECКатегория сертификата не уточняется
CERT_CATEGORY_USERПользовательский сертификат. Может быть использован в операциях, требующих операцию подписи


Алгоритм шифрования

Константа Описание
CIPHER_ALGORITHM_AES128Шифрование AES в режиме CBC для ключевой пары RSA. Длина секретного ключа 128 бит
CIPHER_ALGORITHM_AES192Шифрование AES в режиме CBC для ключевой пары RSA. Длина секретного ключа 192 бит
CIPHER_ALGORITHM_AES256Шифрование AES в режиме CBC для ключевой пары RSA. Длина секретного ключа 256 бит
CIPHER_ALGORITHM_GOST28147Шифрование ГОСТ 28147-89 для ключевой пары ГОСТ
CIPHER_ALGORITHM_KUZNECHIK_CTR_ACPKMШифрование ГОСТ 34.12-2015 "Кузнечик" в режиме шифрования CTR-ACPKM, для ключевой пары ГОСТ
CIPHER_ALGORITHM_KUZNECHIK_CTR_ACPKM_OMACШифрование ГОСТ 34.12-2015 "Кузнечик" в режиме выработки имитовставки OMAC-ACPKM, для ключевой пары ГОСТ
CIPHER_ALGORITHM_MAGMA_CTR_ACPKMШифрование ГОСТ 34.12-2015 "Магма" в режиме шифрования CTR-ACPKM, для ключевой пары ГОСТ
CIPHER_ALGORITHM_MAGMA_CTR_ACPKM_OMACШифрование ГОСТ 34.12-2015 "Магма" в режиме выработки имитовставки OMAC-ACPKM, для ключевой пары ГОСТ


Формат данных

Константа Описание
DATA_FORMAT_BASE64Формат данных в Base64
DATA_FORMAT_HASHФормат данных в виде хеш сообщения (hex-строка)
DATA_FORMAT_PLAINПроизвольный формат данных. Не поддерживается для метода createTsRequest


Формат вывода подписанного сообщения

Константа Описание
DATA_FORMAT_BASE64Формат данных в Base64
DATA_FORMAT_PEMФормат данных в PEM


Тип получаемой информации об устройствах

Константа Описание
ENUMERATE_DEVICES_EVENTSВозвращает списки подключенных и отключенных устройств в виде ассоциативного массива:
  • connected – список устройств, которые были подключены;
  • disconnected – список устройств, которые были отключены
ENUMERATE_DEVICES_LISTВозвращает список идентификаторов подключенных устройств


Алгоритм хеширования

Константа Описание
HASH_TYPE_GOST3411_12_256ГОСТ Р 34.11-2012, длина хеш-кода 256 бит
HASH_TYPE_GOST3411_12_512ГОСТ Р 34.11-2012, длина хеш-кода 512 бит
HASH_TYPE_GOST3411_94ГОСТ Р 34.11-94
HASH_TYPE_MD5MD5
HASH_TYPE_SHA1SHA-1
HASH_TYPE_SHA256SHA-2, длина хеш-кода 256 бит
HASH_TYPE_SHA384SHA-2, длина хеш-кода 384 бит
HASH_TYPE_SHA512SHA-2, длина хеш-кода 512 бит


Тип интерфейса

Константа Описание
INTERFACE_TYPE_BTBluetooth
INTERFACE_TYPE_ISOISO 7816
INTERFACE_TYPE_NFC_TYPE_ANFC, тип A
INTERFACE_TYPE_NFC_TYPE_BNFC, тип B
INTERFACE_TYPE_SDSD-карта
INTERFACE_TYPE_UARTUART
INTERFACE_TYPE_USBUSB


Тип запрашиваемой информации о ключе

Константа Описание
KEY_INFO_ALGORITHMТип алгоритма.
Возвращает число, равное одной из констант алгоритма генерации открытого ключа
KEY_INFO_SPECВозвращающает назначение ключевой пары:
  • KEY_SPEC_SIGN – только подпись;
  • KEY_SPEC_SIGN_AND_EXCHANGE – подпись и обмен
KEY_INFO_USAGE_PERIODВозвращающает объект, содержащий опциональные поля в формате Unix-время (целое число секунд, прошедших с 1970.01.01.00:00:00).
Поля объекта:
  • notBefore:number – дата начала валидности закрытого ключа;
  • notAfter:number – дата окончания валидности закрытого ключа;
  • инварианты полей notBefore/notAfter: существующая дата


    Назначение ключевой пары

    Константа Описание
    KEY_SPEC_SIGNТолько подпись
    KEY_SPEC_SIGN_AND_EXCHANGEПодпись и обмен


    Тип ключевой пары

    Константа Описание
    KEY_TYPE_COMMONОбычная ключевая пара
    KEY_TYPE_JOURNALЖурнальная ключевая пара (может быть использована только для подписи журнала)


    Алгоритм генерации открытого ключа

    Константа Описание
    PUBLIC_KEY_ALGORITHM_ECDSAECDSA с допустимыми типами кривых:
    • secp256k1;
    • secp256r1;
    • secp384r1;
    • secp521r1
    PUBLIC_KEY_ALGORITHM_RSA_1024RSA, длина закрытого ключа 1024 бит
    PUBLIC_KEY_ALGORITHM_RSA_1280RSA, длина закрытого ключа 1280 бит
    PUBLIC_KEY_ALGORITHM_RSA_1536RSA, длина закрытого ключа 1536 бит
    PUBLIC_KEY_ALGORITHM_RSA_1792RSA, длина закрытого ключа 1792 бит
    PUBLIC_KEY_ALGORITHM_RSA_2048RSA, длина закрытого ключа 2048 бит
    PUBLIC_KEY_ALGORITHM_RSA_4096RSA, длина закрытого ключа 4096 бит
    PUBLIC_KEY_ALGORITHM_RSA_512RSA, длина закрытого ключа 512 бит
    PUBLIC_KEY_ALGORITHM_RSA_768RSA, длина закрытого ключа 768 бит


    Алгоритм выработки производного ключа

    Константа Описание
    PUBLIC_KEY_ALGORITHM_EXCHANGE_ECDHECDH
    PUBLIC_KEY_ALGORITHM_EXCHANGE_VKO_GOST3410_2001ГОСТ Р 34.10-2001
    PUBLIC_KEY_ALGORITHM_EXCHANGE_VKO_GOST3410_2012_256ГОСТ Р 34.10-2012, длина закрытого ключа 256 бит
    PUBLIC_KEY_ALGORITHM_EXCHANGE_VKO_GOST3410_2012_512ГОСТ Р 34.10-2012, длина закрытого ключа 512 бит


    Алгоритм генерации ключевой пары

    Константа Описание
    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_RSARSA


    Тип secure messaging

    Константа Описание
    SECURE_MESSAGING_ENHANCEDSecure messaging включен (усиленный режим)
    SECURE_MESSAGING_NOT_SPECIFIEDSecure messaging поддерживается. Тип определить не удалось
    SECURE_MESSAGING_OFFSecure messaging отключен
    SECURE_MESSAGING_ONSecure messaging включен
    SECURE_MESSAGING_UNSUPPORTEDSecure messaging не поддерживается


    Тип запрашиваемой информации об устройстве

    Константа Описание
    TOKEN_INFO_ALGORITHMSПоддерживаемые криптографические алгоритмы ЭЦП.

    Предупреждение

    С версии Рутокен Плагин 4.0.5 параметр считается устаревшим и не рекомендуется к применению. В будущих обновлениях может быть удален из состава продукта. Используйте константу TOKEN_INFO_SUPPORTED_MECHANISMS

    TOKEN_INFO_DEVICE_TYPEТип токена

    Предупреждение

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

    TOKEN_INFO_FEATURESАппаратные возможности устройства. Возвращается ассоциативный массив, определяющий возможности устройства:
    • journal:bool – поддержка журнала операций;
    • pin2:bool – поддержка ввода PIN-кода "PIN2" на устройстве;
    • visualization:bool – поддержка генерации ключей, требующих визуализации данных;
    • sm:bool – поддержка secure messaging;
    • flashDrive:bool – наличие flash-памяти;
    • rtc:bool – наличие часов реального времени;
    • confirmation:bool – поддержка генерации ключей, требующих подтверждения;
    • externalAuth:bool – поддержка внешней аутентификации;
    • customPin:bool – поддержка пользовательских PIN-кодов;
    • interfaces:array – поддерживаемые типы интерфейсов;
    • bio:enum – наличие биометрического считывателя:
      • BIO_TYPE_NOT_SUPPORTED – биометрия не поддерживается;
      • BIO_TYPE_NOT_SPECIFIED – биометрия поддерживается, но тип считывателя не удалось определить.
    • smType:enum – тип secure messaging;
    • vendorModelName:bool – поддержка самоидентификации токена (имя модели устройства)
    TOKEN_INFO_FKN_SUPPORTEDПоддерживает ли токен технологию ФКН (Функциональный ключевой носитель)
    TOKEN_INFO_FORMATSПоддерживаемые форматы входных данных для подписи. Возвращается список форматов, которые поддерживает устройство, в виде массива констант:
    • DEVICE_DATA_FORMAT_PLAIN – произвольные данные;
    • DEVICE_DATA_FORMAT_SAFETOUCH – данные для отображения на Safetouch
    TOKEN_INFO_FREE_MEMORYСвободное место на токене в байтах
    TOKEN_INFO_IS_LOGGED_INСостояние аутентифицированности токена
    TOKEN_INFO_IS_PIN_CACHEDCохранён ли PIN-код.

    Предупреждение

    С версии Рутокен Плагин 4.0.5 параметр считается устаревшим не рекомендуется к применению. В будущих обновлениях может быть удален из состава продукта. Используйте константу TOKEN_INFO_PINS_INFO

    TOKEN_INFO_LABELМетка токена
    TOKEN_INFO_MODELМодель токена.

    Предупреждение

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

    TOKEN_INFO_PIN_RETRIES_LEFTОставшееся количество попыток ввода PIN-кода.

    Предупреждение

    С версии Рутокен Плагин 4.0.5 параметр считается устаревшим и не рекомендуется к применению. В будущих обновлениях может быть удален из состава продукта. Используйте константу TOKEN_INFO_PINS_INFO

    TOKEN_INFO_PINS_INFOИнформация о PIN-кодах устройства. Возвращается ассоциативный массив, определяющий возможности устройства. Массив содержит поля:
    • isPinCached:bool – сохранён ли PIN-код;
    • isPinDefault:bool – установлен ли PIN-код Пользователя по умолчанию;
    • isAdminPinDefault:bool – установлен ли PIN-код Администратора по умолчанию;
    • canUserChangeUserPin:bool – может ли пользователь сменить PIN-код Пользователя;
    • canAdminChangeUserPin:bool – может ли администратор сменить PIN-код Пользователя;
    • retriesLeft:integer – оставшееся количество попыток ввода PIN-кода Пользователя
    TOKEN_INFO_READERИмя считывателя
    TOKEN_INFO_SERIALСерийный номер токена
    TOKEN_INFO_SPEEDКласс скорости устройства.
    Возвращается константа, определяющая класс скорости устройства (выше класс – выше скорость). Возможные варианты: 1 – 5
    TOKEN_INFO_SUPPORTED_MECHANISMSПоддерживаемые программные и аппаратные алгоритмы. Возвращается ассоциативный массив, определяющий возможности устройства. Содержит поля:
    TOKEN_INFO_VENDOR_MODEL_NAMEИмя модели токена, возвращаемое самим устройством.
    Проверить поддержку можно флагом vendorModelName из TOKEN_INFO_FEATURES


    Documentation generated by JSDoc 3 on 7th Aug 2025 - 14:47 with the DataTables template.