Page History

Встановлюються параметри операцій перевірки (створення) КЕП (ЕПЧ), які використовуються в контексті конкретної сесії.
Доступні наступні параметри, які відносяться до операцій КЕП та ЕПЧ:

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

URL-адреса запиту

Устанавливает параметры операций проверки (создания) ЭП (ЭМВ), которые используются в контексте определенной сессии.
Доступны следующие параметры, которые относятся к операциям ЭП и ЭМВ:

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

...

https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/option

Метод

PUT

...

Параметри запиту

uuid

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

сессииІдентифікатор сесії

...

Налаштовувані заголовки

...

запиту

Content-Type

application/json

Параметры JSON объекта запроса

Параметри JSON об'єкта запиту

Ім'яИмя

Тип

ОписаниеОпис

Допустимые значенияДопустимі значення

signatureType

String

Тип ЭПКЕП

attached - встроенная ЭП, ЭП хранится вместе с подписанными даннымивбудований, КЕП зберігається разом з підписаними даними
* detached - открепленная ЭП, ЭП хранится отдельно от подписанных данныхвідкріплений, КЕП зберігається окремо від підписаних даних

embedSignatureTs

StringПризнак включения электронной метки времени подписи

Ознака включення ЕПЧ підпису

true - встраивать электронную метку времени подписидодавання ЕПЧ підпису
* false - не встраивать электронную метку времени подписи додавати ЕПЧ підпису

Note
При установке параметра встановленні параметру cadesType в значениезначення, отличное от відмінне від "undefined", значения параметра embedSignatureTs игнорируетсязначення параметру "embedSignatureTs" ігнорується.

embedDataTs

StringПризнак включения электронной метки времени данных

Ознака включення ЕПЧ даних

true - встраивать электронную метку времени данных
* false - не встраивать электронную метку времени данных

embedCertificateType

String

Порядок включения сертификатов подписанта и издателейвключення сертифікатів підписантів та видавців

signerCert - добавлять только сертификат подписантадодавати лише сертифікат підписанта
signerAndCaCert - добавлять сертификат подписанта и сертификаты издателейдодавати сертифікат підписанта та сертифікати видавців
signerCertAndCaInfo - добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляютсядодавати сертифікат підписанта та інформацію про сертифікати видавців (самі сертифікати видавців не додаються)
* nothing - не добавлять сертификатыдодавати сертифікати

Note
При встановленні параметра cadesType у значення "CAdESXLong", то значення параметру embedCertificateType ігнорується.

signatureTsVerifyOption

String

Режим проверки электронной метки времени подписиперевірки ЕПЧ підпису

* ignore - игнорировать электронную метку времениігнорувати електронну позначку часу
verifyIfPresent - проверять электронную метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствуетперевіряти електронну позначку часу, якщо вона присутня
verifyOrFailIfNotPresent - перевіряти електронну позначку часу та повертати помилку, якщо вона відсутня

dataTsVerifyOption

String

Режим проверки электронной метки времени данных перевірки ЕПЧ даних

* ignore - игнорировать электронную метку времениігнорувати електронну позначку часу
verifyIfPresent - проверять электронную метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствуетперевіряти електронну позначку часу, якщо вона присутня
verifyOrFailIfNotPresent - перевіряти електронну позначку часу та повертати помилку, якщо вона відсутня

dataToSignQualifier

StringОписатель

данных, которые необходимо подписатьОпис даних, які необхідно підписати

* notSignedBefore - данные не содержат ранее созданную подписьдані не містять раніше створений підпис
alreadySigned - данные уже содержат подпись, для добавления новой будет использован режим множественной подписидані вже містять підпис, для додавання нової буде використано режим множинного підпису

duplicateSign

String

Признак возможности подписания документа несколько раз одним и тем же подписантом

Ознака можливості підпису документа кілька разів один і тим же підписантом

true - додає новий підпис, навіть якщо документ вже був підписаний підписантомtrue - добавляет новую подпись, даже если документ уже был подписан подписантом
* false - новая подпись новий підпис не добавляетсядодається, если документ уже был подписан подписантомякщо документ вже був підписаний підписантом

caId

String

Идентификатор КПЭДУ/(А)ЦСК, который издал сертификат ключа из ключевого контейнера.

Ідентифікатор КНЕДП, який видав сертифікат ключа з ключового контейнеру

Ідентифікатор підтримуваних Сервісом КНЕДП необхідно попередньо отримати завдяки запиту Отримання списку підтримуваних КНЕДПИдентификаторы поддерживаемых Сервисом КПЭДУ/(А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых КПЭДУ/(А)ЦСК

cadesType

String

Формат вырабатываемой электронной подписи стандарта створюваного КЕП стандарту CAdES

undefined - параметр cadesType не учитывается при создании электронной подписивраховується при створенні електронного підпису
CAdESBES - базовая электронная подпись.базовий електронний підпис
CAdEST - электронная подпись, содержащая электронную метку времени от электронной подписиелектронний підпис, який містить електронну позначку часу від електронного підпису
* CAdESXLong - электронная подпись, содержащая электронную метку времени от электронной подписи и полный набор данных для проверки.електронний підпис, який містить електронну позначку часу підпису від електронного підпису та повний набір даних для перевірки

Note
При установке встановленні параметра cadesType в значение, отличное от у значення відмінне від "undefined", значения параметра embedSignatureTs игнорируетсято значення параметру embedSignatureTs ігнорується.

nokkCompatible

StringПризнак

дополнительного кодирования подписи, созданной средствами компании Ознака додаткового кодування підпису, створюваної засобами компанії НОКК

true - учитывать, что подпись создана средствами НОКК и дополнительно закодирована враховувати, що підпис створюється засобами НОКК та додатково закодована в ASN.1 OCTET STRING
* false - кодирование подписи соответствует нормативным кодування підпису відповідає нормативним документам

exclusiveTaskExecutor

String

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

true:

для

выполнения криптографических операций, которые требуют доступ к личному ключу, будет выделен отдельный

виконання криптографічних операцій, які вимагають доступ до особистого ключа, буде виділено окремий поток;
криптоконтекст

будет создан один раз и будет повторно использоваться

створюється одноразово та буде повторно використовуватися в рамках

сессии

сесії в

последующих операциях, которые требуют доступ к личному ключу;следует использовать в случае необходимости выполнить в рамках одной сессии больше 10 операций, которые требуют доступ к личному ключу

наступних операціях, які вимагають доступ до особистого ключа;
слід використовувати у випадку необхідності виконати в рамках сесії більше 10 операцій, які вимагають доступ до особистого ключа.

* false:

для

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

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

* - значение по умолчанию

Ответ

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

* - значення за замовчуванням

Відповідь

Код відповідіКод ответа

Content-type

Допустимые параметры

Допустимі параметри

Приклад вмістуПример содержимого

200

application/json

message
settedOptions : {
    signatureType, 
    signatureTsVerifyOption,
    dataTsVerifyOption,
    embedSignatureTs,
    embedDataTs,
    embedCertificateType,
    dataToSignQualifier,
    duplicateSign
}

{
    "message": "ЗапросЗапит на установкувстановлення настроекналаштувань сессиисесії выполненвиконано.",
    "settedOptions": {
       "signatureTsVerifyOption": "IGNORE",
       "embedSignatureTs": "false",
       "embedCertificateType": "NOTHING",
       "signatureType": "DETACHED",
       "dataTsVerifyOption": "IGNORE",
       "embedDataTs": "false",
       "dataToSignQualifier": "ALREADY_SIGNED",
       "duplicateSign": "true"
    }
}

503

application/json

message

{
       "message" : "СервисСервіс хранениязберігання данныхданих не запущензапущено." 
}

400

application/json

message

{
       "message" : "СессияСесія отсутствуетвідсутня." 
}

...

Параметри JSON

...

обʼєкта відповіді

Параметр	Тип данныхданих	ОписаниеОпис
message	String	Описание результата проведения операцииОпис результату проведення операції
settedOptions	Object	Параметры и их значения, которые были установлены после выполнения запроса

...

Параметри та їх значення, які були встановлені після виконання запиту

Приклад коду на JavaScript + jQuery 2.2.4

Code Block

language	js

var selectedOptions = {
    signatureType: "detached",
    embedCertificateType: "nothing",
    embedSignatureTs: "false",
    embedDataTs: "false",
    signatureTsVerifyOption: "ignore",
    dataTsVerifyOption: "ignore"
};
$.ajax({
    url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/option",
    type: "PUT",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify(selectedOptions)
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    settedOptions = jsonResponse.settedOptions;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "ОшибкаПомилка при установкевстановлені настроекналаштувань сессиисесії." : xhr.responseText;
    }
})

...

Page tree

Versions Compared

Old Version 14

New Version 15

Key

URL-адреса запиту

https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/option

Метод

Параметри запиту

Налаштовувані заголовки

запиту

Параметры JSON объекта запроса

Параметри JSON об'єкта запиту

Ответ

Відповідь

Параметри JSON

обʼєкта відповіді

Приклад коду на JavaScript + jQuery 2.2.4