Подпись и проверка подписи
Описание и примеры представлены в разделе Работа с электронной подписью.
Посчитать хэш от данных, используя заданный алгоритм.
Если указан аргумент tokenID, то работает при любом состоянии аутентификации, в противном случае — выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.
Аргументы:
- Тип: Array
- Описание: Массив байт с данными для хэширования.
tokenID (Необязательный)
Заголовок раздела «tokenID (Необязательный)»- Тип: Integer
- Описание: Идентификатор токена. Получается с помощью команды getAllSlots. Значение идентификатора не постоянно, но в рамках сессии не меняется.
algorithm (По умолчанию: JCWebClient2.Vars.DigestAlgorithm.GOST_94)
Заголовок раздела «algorithm (По умолчанию: JCWebClient2.Vars.DigestAlgorithm.GOST_94)»- Тип: String
- Допустимые значения:
JCWebClient2.Vars.DigestAlgorithm - Описание: Алгоритм вычисления хэш-функции.
Результат: Array — результаты работы хэш-функции.
signBase64EncodedData
Заголовок раздела «signBase64EncodedData»Подписать данные.
Возвращает подпись в формате PKCS#7, закодированную в Base64.
Передавать на подпись можно либо данные (аргумент data), либо имя файла (аргумент fileName). Если одновременно передать аргументы data и fileName, то fileName игнорируется.
При подписании данных можно предъявлять PIN-код подписи. Предъявить его можно одним из способов:
- передав напрямую (аргумент signaturePin);
- используя графический интерфейс приложения JC-WebClient (аргумент useUI);
- используя Антифрод-терминал (аргумент antifraud).
Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.
Примеры в разделе Формирование электронной подписи.
Аргументы:
- Тип: Integer
- Описание: Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList. Значение идентификатора не постоянно, но в рамках сессии не меняется.
attachedSignature (По умолчанию: false)
Заголовок раздела «attachedSignature (По умолчанию: false)»- Тип: Boolean
- Описание: Включать ли данные в подпись PKCS#7 (
true— включать). Если установлен вtrueи подписываются данные из файла (аргумент fileName), то будет сгенерировано исключение. Если установлен аргумент signature, то значение attachedSignature игнорируется.
data (Необязательный)
Заголовок раздела «data (Необязательный)»- Тип: String
- Описание: Данные для подписи в виде строки, закодированной в Base64.
fileName (Необязательный)
Заголовок раздела «fileName (Необязательный)»- Тип: String
- Описание: Имя файла, содержимое которого требуется подписать. Если аргумент data установлен, то fileName игнорируется.
signature (Необязательный)
Заголовок раздела «signature (Необязательный)»- Тип: String
- Описание: Подпись в формате PKCS#7, закодированная в Base64. Используется для создания множественной подписи. Если signature является отсоединенной подписью, то необходимо наличие аргументов data или fileName. Если signature является присоединенной подписью, то данные для подписи извлекаются из signature, если отсутствуют аргументы data или fileName.
userHostData (Необязательный)
Заголовок раздела «userHostData (Необязательный)»- Тип: Array
- Описание: Список получаемых данных с пользовательского ПК, которые будут подписаны и войдут в результирующий PKCS#7 конверт. Массив должен содержать строки из
JCWebClient2.Vars.UserHostData. Информация о системе представляет собой строку в формате JSON. Она добавляется в подпись как подписываемый атрибут (signed attribute). OID атрибута: 1.2.643.2.7.1.1.1.
customSignedAttributes (Необязательный)
Заголовок раздела «customSignedAttributes (Необязательный)»-
Тип: Array
-
Описание: Массив с пользовательскими подписываемыми атрибутами. Каждый элемент массива является объектом с параметрами:
- Тип: String
- Описание: OID атрибута.
- Тип: String
- Описание: Значение атрибута.
addSigningTime (По умолчанию: false)
Заголовок раздела «addSigningTime (По умолчанию: false)»- Тип: Boolean
- Описание: Включать в подпись время подписания. Время подписания добавляется в PKCS#7-контенер как атрибут с OID 1.2.840.113549.1.9.5. Если при подписи передаются подписываемые атрибуты (customSignedAttributes), то время подписания включается автоматически.
signaturePin (Необязательный)
Заголовок раздела «signaturePin (Необязательный)»- Тип: String
- Описание: PIN-код подписи.
useUI (По умолчанию: false)
Заголовок раздела «useUI (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования графического интерфейса приложения JC-WebClient для предъявления PIN-кода подписи. Если равен
true, то аргумент signaturePin игнорируется.
antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)
Заголовок раздела «antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)»- Тип: PlainObject
- Описание: Параметры для предъявления PIN-кода подписи с Антифрод-терминала. Если указан, то аргументы useUI и signaturePin игнорируются.
Параметры:
deviceID (Необязательный)
Заголовок раздела «deviceID (Необязательный)»- Тип: Integer
- Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.
langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)
Заголовок раздела «langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.AftLang - Описание: Идентификатор языка, используемого для отображения сообщений.
timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)
Заголовок раздела «timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)»- Тип: Integer
- Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.
Результат: String — подпись в формате PKCS#7, закодированная в Base64.
signBase64EncodedDataPack
Заголовок раздела «signBase64EncodedDataPack»Подписать несколько пакетов данных.
Возвращает массив подписей в формате PKCS#7, закодированных в Base64.
Передавать на подпись можно либо массив данных (аргумент data), либо массив имён файлов (аргумент fileName). Если одновременно передать аргументы data и fileName, то fileName игнорируется.
При подписании данных можно предъявлять PIN-код подписи. Предъявить его можно одним из способов:
- передав напрямую (аргумент signaturePin);
- используя графический интерфейс приложения JC-WebClient (аргумент useUI);
- используя Антифрод-терминал (аргумент antifraud).
Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.
Примеры в разделе Формирование электронной подписи.
Аргументы:
- Тип: Integer
- Описание: Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList. Значение идентификатора не постоянно, но в рамках сессии не меняется.
attachedSignature (По умолчанию: false)
Заголовок раздела «attachedSignature (По умолчанию: false)»- Тип: Boolean
- Описание: Включать ли данные в подпись PKCS#7 (
true— включать). Если установлен вtrueи подписываются данные из файла (аргумент fileName), то будет сгенерировано исключение. Если установлен аргумент signature, то значение attachedSignature игнорируется.
data (Необязательный)
Заголовок раздела «data (Необязательный)»- Тип: Array
- Описание: Данные для подписи в виде массива строк, закодированных в Base64.
fileName (Необязательный)
Заголовок раздела «fileName (Необязательный)»- Тип: Array
- Описание: Массив имён файлов, содержимое которых требуется подписать. Если аргумент data установлен, то fileName игнорируется.
signature (Необязательный)
Заголовок раздела «signature (Необязательный)»- Тип: String
- Описание: Подпись в формате PKCS#7, закодированная в Base64. Используется для создания множественной подписи. Если signature является отсоединенной подписью, то необходимо наличие аргументов data или fileName. Если signature является присоединенной подписью, то данные для подписи извлекаются из signature, если отсутствуют аргументы data или fileName.
userHostData (Необязательный)
Заголовок раздела «userHostData (Необязательный)»- Тип: Array
- Описание: Список получаемых данных с пользовательского ПК, которые будут подписаны и войдут в результирующий PKCS#7 конверт. Массив должен содержать строки из
JCWebClient2.Vars.UserHostData. Информация о системе представляет собой строку в формате JSON. Она добавляется в подпись как подписываемый атрибут (signed attribute). OID атрибута: 1.2.643.2.7.1.1.1.
customSignedAttributes (Необязательный)
Заголовок раздела «customSignedAttributes (Необязательный)»-
Тип: Array
-
Описание: Массив с пользовательскими подписываемыми атрибутами. Каждый элемент массива является объектом с параметрами:
- Тип: String
- Описание: OID атрибута.
- Тип: String
- Описание: Значение атрибута.
addSigningTime (По умолчанию: false)
Заголовок раздела «addSigningTime (По умолчанию: false)»- Тип: Boolean
- Описание: Включать в подпись время подписания. Время подписания добавляется в PKCS#7-контенер как атрибут с OID 1.2.840.113549.1.9.5. Если при подписи передаются подписываемые атрибуты (customSignedAttributes), то время подписания включается автоматически.
signaturePin (Необязательный)
Заголовок раздела «signaturePin (Необязательный)»- Тип: String
- Описание: PIN-код подписи.
useUI (По умолчанию: false)
Заголовок раздела «useUI (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования графического интерфейса приложения JC-WebClient для предъявления PIN-кода подписи. Если равен
true, то аргумент signaturePin игнорируется.
antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)
Заголовок раздела «antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)»- Тип: PlainObject
- Описание: Параметры для предъявления PIN-кода подписи с Антифрод-терминала. Если указан, то аргументы useUI и signaturePin игнорируются.
Параметры:
deviceID (Необязательный)
Заголовок раздела «deviceID (Необязательный)»- Тип: Integer
- Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.
langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)
Заголовок раздела «langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.AftLang - Описание: Идентификатор языка, используемого для отображения сообщений.
timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)
Заголовок раздела «timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)»- Тип: Integer
- Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.
Результат: Array — массив подписей в формате PKCS#7, закодированных в Base64. Количество возвращаемых подписей и их порядок соответствуют количеству и порядку строк передаваемых данных (data) или имён файлов (fileName).
signData
Заголовок раздела «signData»Подписать данные.
Возвращает подпись в формате PKCS#7.
Передавать на подпись можно либо данные (аргумент data), либо имя файла (аргумент fileName). Если одновременно передать аргументы data и fileName, то fileName игнорируется.
При подписании данных можно предъявлять PIN-код подписи. Предъявить его можно одним из способов:
- передав напрямую (аргумент signaturePin);
- используя графический интерфейс приложения JC-WebClient (аргумент useUI);
- используя Антифрод-терминал (аргумент antifraud).
Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.
Примеры в разделе Формирование электронной подписи.
Аргументы:
- Тип: Integer
- Описание: Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList. Значение идентификатора не постоянно, но в рамках сессии не меняется.
attachedSignature (По умолчанию: false)
Заголовок раздела «attachedSignature (По умолчанию: false)»- Тип: Boolean
- Описание: Включать ли данные в подпись PKCS#7 (
true— включать). Если установлен вtrueи подписываются данные из файла (аргумент fileName), то будет сгенерировано исключение. Если установлен аргумент signature, то значение attachedSignature игнорируется.
data (Необязательный)
Заголовок раздела «data (Необязательный)»- Тип: Array
- Описание: Данные для подписи в виде массива байт.
fileName (Необязательный)
Заголовок раздела «fileName (Необязательный)»- Тип: String
- Описание: Имя файла, содержимое которого требуется подписать. Если аргумент data установлен, то fileName игнорируется.
signature (Необязательный)
Заголовок раздела «signature (Необязательный)»- Тип: Array
- Описание: Подпись в виде массива байт в формате PKCS#7. Используется для создания множественной подписи. Если signature является отсоединенной подписью, то необходимо наличие аргументов data или fileName. Если signature является присоединенной подписью, то данные для подписи извлекаются из signature, если отсутствуют аргументы data или fileName.
userHostData (Необязательный)
Заголовок раздела «userHostData (Необязательный)»- Тип: Array
- Описание: Список получаемых данных с пользовательского ПК, которые будут подписаны и войдут в результирующий PKCS#7 конверт. Массив должен содержать строки из
JCWebClient2.Vars.UserHostData. Информация о системе представляет собой строку в формате JSON. Она добавляется в подпись как подписываемый атрибут (signed attribute). OID атрибута: 1.2.643.2.7.1.1.1.
customSignedAttributes (Необязательный)
Заголовок раздела «customSignedAttributes (Необязательный)»-
Тип: Array
-
Описание: Массив с пользовательскими подписываемыми атрибутами. Каждый элемент массива является объектом с параметрами:
- Тип: String
- Описание: OID атрибута.
- Тип: String
- Описание: Значение атрибута.
addSigningTime (По умолчанию: false)
Заголовок раздела «addSigningTime (По умолчанию: false)»- Тип: Boolean
- Описание: Включать в подпись время подписания. Время подписания добавляется в PKCS#7-контенер как атрибут с OID 1.2.840.113549.1.9.5. Если при подписи передаются подписываемые атрибуты (customSignedAttributes), то время подписания включается автоматически.
signaturePin (Необязательный)
Заголовок раздела «signaturePin (Необязательный)»- Тип: String
- Описание: PIN-код подписи.
useUI (По умолчанию: false)
Заголовок раздела «useUI (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования графического интерфейса приложения JC-WebClient для предъявления PIN-кода подписи. Если равен
true, то аргумент signaturePin игнорируется.
antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)
Заголовок раздела «antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)»- Тип: PlainObject
- Описание: Параметры для предъявления PIN-кода подписи с Антифрод-терминала. Если указан, то аргументы useUI и signaturePin игнорируются.
Параметры:
deviceID (Необязательный)
Заголовок раздела «deviceID (Необязательный)»- Тип: Integer
- Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.
langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)
Заголовок раздела «langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.AftLang - Описание: Идентификатор языка, используемого для отображения сообщений.
timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)
Заголовок раздела «timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)»- Тип: Integer
- Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.
Результат: Array — массив байт с подписью в формате PKCS#7.
signDataPack
Заголовок раздела «signDataPack»Подписать несколько пакетов данных.
Возвращает массив подписей в формате PKCS#7.
Передавать на подпись можно либо массив данных (аргумент data), либо массив имён файлов (аргумент fileName). Если одновременно передать аргументы data и fileName, то fileName игнорируется.
При подписании данных можно предъявлять PIN-код подписи. Предъявить его можно одним из способов:
- передав напрямую (аргумент signaturePin);
- используя графический интерфейс приложения JC-WebClient (аргумент useUI);
- используя Антифрод-терминал (аргумент antifraud).
Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.
Примеры в разделе Формирование электронной подписи.
Аргументы:
- Тип: Integer
- Описание: Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList. Значение идентификатора не постоянно, но в рамках сессии не меняется.
attachedSignature (По умолчанию: false)
Заголовок раздела «attachedSignature (По умолчанию: false)»- Тип: Boolean
- Описание: Включать ли данные в подпись PKCS#7 (
true— включать). Если установлен вtrueи подписываются данные из файла (аргумент fileName), то будет сгенерировано исключение. Если установлен аргумент signature, то значение attachedSignature игнорируется.
data (Необязательный)
Заголовок раздела «data (Необязательный)»- Тип: Array
- Описание: Данные для подписи в виде массива массивов байт.
fileName (Необязательный)
Заголовок раздела «fileName (Необязательный)»- Тип: Array
- Описание: Массив имён файлов, содержимое которых требуется подписать. Если аргумент data установлен, то fileName игнорируется.
signature (Необязательный)
Заголовок раздела «signature (Необязательный)»- Тип: Array
- Описание: Подпись в виде массива байт в формате PKCS#7. Используется для создания множественной подписи. Если signature является отсоединенной подписью, то необходимо наличие аргументов data или fileName. Если signature является присоединенной подписью, то данные для подписи извлекаются из signature, если отсутствуют аргументы data или fileName.
userHostData (Необязательный)
Заголовок раздела «userHostData (Необязательный)»- Тип: Array
- Описание: Список получаемых данных с пользовательского ПК, которые будут подписаны и войдут в результирующий PKCS#7 конверт. Массив должен содержать строки из
JCWebClient2.Vars.UserHostData. Информация о системе представляет собой строку в формате JSON. Она добавляется в подпись как подписываемый атрибут (signed attribute). OID атрибута: 1.2.643.2.7.1.1.1.
customSignedAttributes (Необязательный)
Заголовок раздела «customSignedAttributes (Необязательный)»-
Тип: Array
-
Описание: Массив с пользовательскими подписываемыми атрибутами. Каждый элемент массива является объектом с параметрами:
- Тип: String
- Описание: OID атрибута.
- Тип: String
- Описание: Значение атрибута.
addSigningTime (По умолчанию: false)
Заголовок раздела «addSigningTime (По умолчанию: false)»- Тип: Boolean
- Описание: Включать в подпись время подписания. Время подписания добавляется в PKCS#7-контенер как атрибут с OID 1.2.840.113549.1.9.5. Если при подписи передаются подписываемые атрибуты (customSignedAttributes), то время подписания включается автоматически.
signaturePin (Необязательный)
Заголовок раздела «signaturePin (Необязательный)»- Тип: String
- Описание: PIN-код подписи.
useUI (По умолчанию: false)
Заголовок раздела «useUI (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования графического интерфейса приложения JC-WebClient для предъявления PIN-кода подписи. Если равен
true, то аргумент signaturePin игнорируется.
antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)
Заголовок раздела «antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)»- Тип: PlainObject
- Описание: Параметры для предъявления PIN-кода подписи с Антифрод-терминала. Если указан, то аргументы useUI и signaturePin игнорируются.
Параметры:
deviceID (Необязательный)
Заголовок раздела «deviceID (Необязательный)»- Тип: Integer
- Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.
langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)
Заголовок раздела «langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.AftLang - Описание: Идентификатор языка, используемого для отображения сообщений.
timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)
Заголовок раздела «timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)»- Тип: Integer
- Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.
Результат: Array — массив массивов байт с подписями в формате PKCS#7. Количество возвращаемых подписей и их порядок соответствуют количеству и порядку массивов передаваемых данных (data) или имён файлов (fileName).
signHash
Заголовок раздела «signHash»Подписать данные без хэширования (т.е. подписать хэш).
Возвращает подпись в формате PKCS#7.
При подписании хэша можно предъявлять PIN-код подписи. Предъявить его можно одним из способов:
- передав напрямую (аргумент signaturePin);
- используя графический интерфейс приложения JC-WebClient (аргумент useUI);
- используя Антифрод-терминал (аргумент antifraud).
Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.
Аргументы:
- Тип: Integer
- Описание: Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList. Значение идентификатора не постоянно, но в рамках сессии не меняется.
-
Тип: Array
-
Описание: Хэш в виде массива байт.
Примечание: в зависимости от алгоритма ключа контейнера, длина должна быть равна:
- ГОСТ Р 34.10-2001 — 32 байта (алгоритм хэширования — ГОСТ Р 34.11-94).
- ГОСТ Р 34.10-2012 с длиной ключа 256 — 32 байта (алгоритм хэширования — ГОСТ Р 34.11-2012 с длиной ключа 256).
- ГОСТ Р 34.10-2012 с длиной ключа 512 — 64 байта (алгоритм хэширования — ГОСТ Р 34.11-2012 с длиной ключа 512).
base64Encoded (По умолчанию: true)
Заголовок раздела «base64Encoded (По умолчанию: true)»- Тип: Boolean
- Описание: Признак кодирования результата в Base64 (
true— вернуть строку с подписью в формате PKCS#7, закодированную в Base64).
signaturePin (Необязательный)
Заголовок раздела «signaturePin (Необязательный)»- Тип: String
- Описание: PIN-код подписи.
useUI (По умолчанию: false)
Заголовок раздела «useUI (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования графического интерфейса приложения JC-WebClient для предъявления PIN-кода подписи. Если равен
true, то аргумент signaturePin игнорируется.
antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)
Заголовок раздела «antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)»- Тип: PlainObject
- Описание: Параметры для предъявления PIN-кода подписи с Антифрод-терминала. Если указан, то аргументы useUI и signaturePin игнорируются.
Параметры:
deviceID (Необязательный)
Заголовок раздела «deviceID (Необязательный)»- Тип: Integer
- Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.
langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)
Заголовок раздела «langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.AftLang - Описание: Идентификатор языка, используемого для отображения сообщений.
timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)
Заголовок раздела «timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)»- Тип: Integer
- Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.
Результат:
- Если аргумент base64Encoded был равен
true: String — строка с подписью в формате PKCS#7, закодированная в Base64. - Если аргумент base64Encoded был равен
false: Array — массив байт с подписью в формате PKCS#7.
signHashInByte
Заголовок раздела «signHashInByte»Подписать данные без хэширования (т.е. подписать хэш).
При подписании хэша можно предъявлять PIN-код подписи. Предъявить его можно одним из способов:
- передав напрямую (аргумент signaturePin);
- используя графический интерфейс приложения JC-WebClient (аргумент useUI);
- используя Антифрод-терминал (аргумент antifraud).
Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded. Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.
Аргументы:
- Тип: Integer
- Описание: Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList. Значение идентификатора не постоянно, но в рамках сессии не меняется.
-
Тип: Array
-
Описание: Данные для подписи в виде массива байт.
Примечание: в зависимости от алгоритма ключа контейнера, длина должна быть равна:
- ГОСТ Р 34.10-2001 — 32 байта (алгоритм хэширования — ГОСТ Р 34.11-94).
- ГОСТ Р 34.10-2012 с длиной ключа 256 — 32 байта (алгоритм хэширования — ГОСТ Р 34.11-2012 с длиной ключа 256).
- ГОСТ Р 34.10-2012 с длиной ключа 512 — 64 байта (алгоритм хэширования — ГОСТ Р 34.11-2012 с длиной ключа 512).
signaturePin (Необязательный)
Заголовок раздела «signaturePin (Необязательный)»- Тип: String
- Описание: PIN-код подписи.
useUI (По умолчанию: false)
Заголовок раздела «useUI (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования графического интерфейса приложения JC-WebClient для предъявления PIN-кода подписи. Если равен
true, то аргумент signaturePin игнорируется.
antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)
Заголовок раздела «antifraud [устаревшее] (Обязательный — для смарт-карты в Антифрод-терминале, в остальных случаях — Необязательный)»- Тип: PlainObject
- Описание: Параметры для предъявления PIN-кода подписи с Антифрод-терминала. Если указан, то аргументы useUI и signaturePin игнорируются.
Параметры:
deviceID (Необязательный)
Заголовок раздела «deviceID (Необязательный)»- Тип: Integer
- Описание: Идентификатор Антифрод-терминала, работающего без смарт-карты. Получаются с помощью команды getAllSlots. Идентификатор игнорируется, если в tokenID передали идентификатор смарт-карты, подключенной к Антифрод-терминалу. Значения идентификатора не постоянно, но в рамках сессии не меняется.
langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)
Заголовок раздела «langID (По умолчанию: JCWebClient2.defaults().antifraud.langID)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.AftLang - Описание: Идентификатор языка, используемого для отображения сообщений.
timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)
Заголовок раздела «timeout (По умолчанию: JCWebClient2.defaults().antifraud.timeout)»- Тип: Integer
- Описание: Тайм-аут ожидания ввода от пользователя до отмены операции, в секундах.
Результат: Array — массив байт с подписью.
verifyBase64EncodedData
Заголовок раздела «verifyBase64EncodedData»Проверить подпись PKCS#7 с данными и подписью, закодированными в Base64.
В случае отсоединенной подписи передавать на проверку необходимо либо данные (аргумент data), либо имя файла (аргумент fileName). Если одновременно передать data и fileName, то fileName игнорируется.
Работает при любом состоянии аутентификации.
Примеры в разделе Проверка электронной подписи.
Аргументы:
signature
Заголовок раздела «signature»- Тип: String
- Описание: Закодированная в Base64 подпись в формате PKCS#7.
data (Необязательный)
Заголовок раздела «data (Необязательный)»- Тип: String
- Описание: Закодированные в Base64 данные, если используется PKCS#7 отсоединённая подпись (detached signature).
fileName (Необязательный)
Заголовок раздела «fileName (Необязательный)»- Тип: String
- Описание: Имя файла, если используется PKCS#7 отсоединённая подпись (detached signature). Если аргумент data установлен, то fileName игнорируется.
options (Необязательный)
Заголовок раздела «options (Необязательный)»- Тип: PlainObject
- Описание: Дополнительные параметры проверки на токене.
Параметры:
tokenID
Заголовок раздела «tokenID»- Тип: Integer
- Описание: Идентификатор токена. Получается с помощью команды getAllSlots. Значение идентификатора не постоянно, но в рамках сессии не меняется.
useToken (По умолчанию: false)
Заголовок раздела «useToken (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования токена при проверке подписи.
chainOfTrust (Необязательный)
Заголовок раздела «chainOfTrust (Необязательный)»- Тип: PlainObject
- Описание: Цепочка сертификатов от сертификата подписанта до доверенного открытого ключа, загруженного в доверенное хранилище в JaCarta-2 ГОСТ.
Параметры:
useTokenStorage
Заголовок раздела «useTokenStorage»- Тип: Boolean
- Описание: Признак использования сертификатов на токене для установления доверия. Если передан аргумент certificates и текущий аргумент равен
true, то для установки доверия используются в том числе сертификаты с токена.
certificates (Необязательный)
Заголовок раздела «certificates (Необязательный)»- Тип: Array
- Описание: Массив из тел сертификатов в форматах DER или PEM для установления доверия.
checkCRL (По умолчанию: JCWebClient2.Vars.CheckCRLMode.None)
Заголовок раздела «checkCRL (По умолчанию: JCWebClient2.Vars.CheckCRLMode.None)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.CheckCRLMode.None,JCWebClient2.Vars.CheckCRLMode.MildилиJCWebClient2.Vars.CheckCRLMode.Strong - Описание: Способ проверки списков отзыва сертификатов.
loadIntermediateCerts (Необязательный)
Заголовок раздела «loadIntermediateCerts (Необязательный)»- Тип: Boolean
- Описание: Автоматически загружать недостающие промежуточное сертификаты.
Результат: Boolean — результат проверки.
verifyData
Заголовок раздела «verifyData»Проверить подпись PKCS#7.
В случае отсоединенной подписи передавать на проверку необходимо либо данные (аргумент data), либо имя файла (аргумент fileName). Если одновременно передать data и fileName, то fileName игнорируется.
Работает при любом состоянии аутентификации.
Примеры в разделе Проверка электронной подписи.
Аргументы:
signature
Заголовок раздела «signature»- Тип: Array
- Описание: Массив байт с подписью в формате PKCS#7.
data (Необязательный)
Заголовок раздела «data (Необязательный)»- Тип: Array
- Описание: Данные, если используется PKCS#7 отсоединённая подпись (detached signature).
fileName (Необязательный)
Заголовок раздела «fileName (Необязательный)»- Тип: String
- Описание: Имя файла, если используется PKCS#7 отсоединённая подпись (detached signature). Если аргумент data установлен, то fileName игнорируется.
options (Необязательный)
Заголовок раздела «options (Необязательный)»- Тип: PlainObject
- Описание: Дополнительные параметры проверки на токене.
Параметры:
tokenID
Заголовок раздела «tokenID»- Тип: Integer
- Описание: Идентификатор токена. Получается с помощью команды getAllSlots. Значение идентификатора не постоянно, но в рамках сессии не меняется.
useToken (По умолчанию: false)
Заголовок раздела «useToken (По умолчанию: false)»- Тип: Boolean
- Описание: Признак использования токена при проверке подписи.
chainOfTrust (Необязательный)
Заголовок раздела «chainOfTrust (Необязательный)»- Тип: PlainObject
- Описание: Цепочка сертификатов от сертификата подписанта до доверенного открытого ключа, загруженного в доверенное хранилище в JaCarta-2 ГОСТ.
Параметры:
useTokenStorage
Заголовок раздела «useTokenStorage»- Тип: Boolean
- Описание: Признак использования сертификатов на токене для установления доверия. Если передан аргумент certificates и текущий аргумент равен
true, то для установки доверия используются в том числе сертификаты с токена.
certificates (Необязательный)
Заголовок раздела «certificates (Необязательный)»- Тип: Array
- Описание: Массив из тел сертификатов в форматах DER или PEM для установления доверия.
checkCRL (По умолчанию: JCWebClient2.Vars.CheckCRLMode.None)
Заголовок раздела «checkCRL (По умолчанию: JCWebClient2.Vars.CheckCRLMode.None)»- Тип: Integer
- Допустимые значения:
JCWebClient2.Vars.CheckCRLMode.None,JCWebClient2.Vars.CheckCRLMode.MildилиJCWebClient2.Vars.CheckCRLMode.Strong - Описание: Способ проверки списков отзыва сертификатов.
loadIntermediateCerts (Необязательный)
Заголовок раздела «loadIntermediateCerts (Необязательный)»- Тип: Boolean
- Описание: Автоматически загружать недостающие промежуточное сертификаты.
Результат: Boolean — результат проверки.
verifyHashInByte
Заголовок раздела «verifyHashInByte»Проверить подпись хэша в виде массива байт.
Работает при любом состоянии аутентификации.
Аргументы:
signature
Заголовок раздела «signature»- Тип: Array
- Описание: Массив байт с подписью.
-
Тип: Array
-
Описание: Хэш данных в виде массива байт.
Примечание: в зависимости от алгоритма ключа, длина должна быть равна:
- ГОСТ Р 34.10-2001 — 32 байта (алгоритм хэширования — ГОСТ Р 34.11-94).
- ГОСТ Р 34.10-2012 с длиной ключа 256 — 32 байта (алгоритм хэширования — ГОСТ Р 34.11-2012 с длиной ключа 256).
- ГОСТ Р 34.10-2012 с длиной ключа 512 — 64 байта (алгоритм хэширования — ГОСТ Р 34.11-2012 с длиной ключа 512).
publicKey
Заголовок раздела «publicKey»- Тип: Array
- Описание: Массив байт с публичным ключом.
paramSet (По умолчанию: A)
Заголовок раздела «paramSet (По умолчанию: A)»- Тип: String
- Допустимые значения:
A,B,C,XA,XB,TC26-256-B,TC26-256-C,TC26-256-D,TC26-256-A,TC26-512-A,TC26-512-B,TC26-512-C - Описание: Параметры эллиптической кривой ключевой пары. Используется для формирования публичного ключа. Для следующих значений определяются алгоритмы публичного ключа:
A,B,C,XA,XB,TC26-256-B,TC26-256-C,TC26-256-D,TC26-256-A— ГОСТ Р 34.10-2012 с длиной ключа 256TC26-512-A,TC26-512-B,TC26-512-C— ГОСТ Р 34.10-2012 с длиной ключа 512
Результат: Boolean — результат проверки.

