Page History

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

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

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

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

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

...

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

Метод

PUT

...

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

uuid

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

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

...

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

...

запиту

Content-Type

application/json

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

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

Допустимые значения ЭП встроенная ЭП, ЭП хранится вместе с подписанными данными открепленная ЭП, ЭП хранится отдельно от подписанных данныхПризнак включения электронной метки времени подписи встраивать электронную метку времени подписи встраивать электронную метку времени подписиПри установке параметра cadesType в значение, отличное от "undefined", значения параметра embedSignatureTs игнорируетсяПризнак включения электронной метки времени данных встраивать электронную метку времени данныхвстраивать электронную метку времени данныхПри установке параметра cadesType в значение, отличное от "undefined", значения параметра embedDataTs игнорируется включения сертификатов подписанта и издателей добавлять только сертификат подписанта добавлять сертификат подписанта и сертификаты издателей добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляются добавлять сертификатыПри установке параметра cadesType в значение, отличное от "undefined", значения параметра embedCertificateType игнорируется проверки электронной метки времени подписи игнорировать электронную метку времени проверять электронную метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствует проверки электронной метки времени данных игнорировать электронную метку времени проверять электронную метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствуетОписатель данных, которые необходимо подписать данные не содержат ранее созданную подпись данные уже содержат подпись, для добавления новой будет использован режим множественной подписиtrue - добавляет новую подпись, даже если документ уже был подписан подписантом новая подпись добавляется если документ уже был подписан подписантомИдентификаторы поддерживаемых Сервисом КПЭДУ/(А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых КПЭДУ/(А)ЦСК вырабатываемой электронной подписи стандарта undefined учитывается при создании электронной подписи
CAdESBES - базовая электронная подпись.
CAdEST - электронная подпись, содержащая электронную метку времени от электронной подписи
* CAdESXLong - электронная подпись, содержащая электронную метку времени от электронной подписи и полный набор данных для проверки.

Ім'я

Тип

Опис

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

asicForm

String

Форма Associated Signature Container

* NONE - не створювати Associated Signature Container
ASIC_S - простий формат (тільки один файл в архіві)
ASIC_E - розширений формат (один та більше файлів архіві)

Имя

Тип

Описание

signatureType

String

Тип

КЕП

attached -

вбудований, ЕП зберігається разом з підписаними даними
* detached -

відкріплений, ЕП зберігається окремо від підписаних даних

Note
Значення параметра ігнорується, якщо для параметра asicForm вказане значення відмінне від "NONE".

embedSignatureTs

String

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

true -

додавання ЕПЧ підпису
* false - не

додавати ЕПЧ підпису

Note

Значення параметра ігнорується:

Якщо для параметра cadesType вказане значення відмінне від "UNDEFINED".
При створенні електронного підпису формату XAdES.

embedDataTs

String

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

true -

додавання ЕПЧ даних
* false - не

додавати ЕПЧ даних

Note

Значення параметра ігнорується при створенні електронного підпису формату XAdES.

embedCertificateType

String

Порядок

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

signerCert -

додавати лише сертифікат підписанта
signerAndCaCert -

додавати сертифікат підписанта та сертифікати видавців
signerCertAndCaInfo -

додавати сертифікат підписанта та інформацію про сертифікати видавців (самі сертифікати видавців не додаються)
* nothing - не

додавати сертифікати

Note

Значення параметру ігнорується:

Якщо для параметра cadesType вказане значення "CADES_X_LONG"
При створенні електронного підпису формату XAdES.

signatureTsVerifyOption

String

Режим

перевірки ЕПЧ підпису

* ignore -

ігнорувати електронну позначку часу
verifyIfPresent -

перевіряти електронну позначку часу, якщо вона присутня
verifyOrFailIfNotPresent - перевіряти електронну позначку часу та повертати помилку, якщо вона відсутня

Note
Значення параметру ігнорується при перевірці електронного підпису формату XAdES.

dataTsVerifyOption

String

Режим

перевірки ЕПЧ даних

* ignore -

ігнорувати електронну позначку часу
verifyIfPresent -

перевіряти електронну позначку часу, якщо вона присутня
verifyOrFailIfNotPresent - перевіряти електронну позначку часу та повертати помилку, якщо вона відсутня

Note
Значення параметра ігнорується при перевірці електронного підпису формату XAdES.

dataToSignQualifier

String

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

* notSignedBefore -

дані не містять раніше створений підпис
alreadySigned -

дані вже містять підпис, для додавання нової буде використано режим множинного підпису

Note
Значення параметра ігнорується при створенні електронного підпису формату XAdES.

duplicateSign

String

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

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

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

новий підпис не

додається,

якщо документ вже був підписаний підписантом

Note
Значення параметру ігнорується при створенні електронного підпису формату XAdES.

caId

String

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

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

Ідентифікатор підтримуваних Сервісом КНЕДП необхідно попередньо отримати завдяки запиту Отримання списку підтримуваних КНЕДП

cadesType

String

Формат

створюваного КЕП стандарту CAdES

UNDEFINED - параметр cadesType не

Note
При установке параметра cadesType в значение, отличное от "undefined", значения параметров embedSignatureTs, embedDataTs, embedCertificateType игнорируются.

враховується при створенні електронного підпису
NONE - не створювати підпис у форматі CAdES
CADES_BES - базовий електронний підпис
CADES_T - електронний підпис, який містить електронну позначку часу від електронного підпису
CADES_E_T - електронний підпис, який містить електронну позначку часу від електронного підпису та додаткові атрибути
* CADES_X_LONG - електронний підпис, який містить електронну позначку часу підпису від електронного підпису та повний набір даних для перевірки

xadesTypeStringФормат створюваного КЕП стандарту XAdES

* NONE - не створювати підпис у форматі XAdES
XADES_B_B - базовий електронний підпис
XADES_B_T - електронний підпис, який містить електронну позначку часу від електронного підпису
XADES_B_LT - електронний підпис, який містить електронну позначку часу підпису від електронного підпису та повний набір даних для перевірки
XADES_B_LTA - електронний підпис для тривалого (архівного) зберігання.

Note
Значення параметра ігнорується, якщо для параметра cadesType вказане значення відмінне від "NONE".

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

true - враховувати, що підпис створюється засобами НОКК та додатково закодована

nokkCompatibleStringПризнак дополнительного кодирования подписи, созданной средствами компании НОККtrue - учитывать, что подпись создана средствами НОКК и дополнительно закодирована

в ASN.1 OCTET STRING
* false -

кодирование подписи соответствует нормативным документам

кодування підпису відповідає нормативним документам

Note
Значення параметра ігнорується при перевірці електронного підпису формату XAdES.

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

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

...

language	js

...

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

Page tree

Versions Compared

Old Version 12

New Version Current

Key

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

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

Метод

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

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

запиту

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

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

Ответ

Відповідь

Параметри JSON

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

Пример кода на JavaScript + jQuery 2.2.4