Page History

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

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

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

https://ccs-dev-api.cipher.kiev.ua/ccs

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

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

URL-адрес запроса

https://localhost:9092/api/v1/ticket/{uuid}/option

Метод

PUT

...

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

uuid

String

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

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

...

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

...

запиту

Content-Type

application/json

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

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

Ім'я	Тип	Опис	Допустимі значення
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 - проверять метку времени и возвращать ошибку, если она отсутствует

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

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

dataTsVerifyOption

String

Режим

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

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

* ignore -

игнорировать метку времени

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

проверять метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять метку времени и возвращать ошибку, если она отсутствует

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

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

tsAdditionalVerifying

String

Признак выполнения дополнительной проверки метки времени

true - выполнять дополнительную проверку меток времени ЭЦП и данных при проверке ЭЦП для предоставления дополнительной информации в ответе
* false - не выполнять дополнительную проверку меток времени при проверке ЭЦП

dataToSignQualifier

String

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

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

* notSignedBefore -

данные не содержат ранее созданную подпись

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

данные уже содержат подпись, для добавления новой будет использован режим множественной подписи

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

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

duplicateSign

String

Признак возможности подписания документа несколько раз одним и тем же подписантомtrue - добавляет новую подпись, даже если документ уже был подписан подписантом

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

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

новая подпись

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

добавляется

додається,

если документ уже был подписан подписантомcaIdStringИдентификатор (А)ЦСК, который издал сертификат ключа из ключевого контейнера.Идентификаторы поддерживаемых Сервисом (А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых (А)ЦСК

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

Ответ

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

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

caId

String

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

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

cadesType

String

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

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

xadesType

String

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

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

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

nokkCompatible

String

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

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

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

exclusiveTaskExecutor

String

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

true:

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

* false:

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

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

Відповідь

Код відповіді	Content-type	Допустимі параметри	Приклад вмісту

Код ответа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 2

New Version Current

Key

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

URL-адрес запроса

Метод

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

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

запиту

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

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

Ответ

Відповідь

Параметри JSON

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

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