Versions Compared

Old Version 6

changes.mady.by.user Svitlana Nimych

Saved on

compared with

New Version Current

changes.mady.by.user Vladimir Karuk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

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

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

...

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

Метод

PUT

...

Параметри запиту
uuidString
Идентификатор сессии
Ідентифікатор сесії

...

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

...

запиту
Content-Typeapplication/json
Параметры JSON объекта запроса
Параметри JSON об'єкта запиту
Ім'яТипОписДопустимі значення
asicFormStringФорма Associated Signature Container* NONE - не створювати Associated Signature Container
ASIC_S - простий формат (тільки один файл в архіві)
ASIC_E - розширений формат (один та більше файлів архіві)
ИмяТипОписаниеДопустимые значения
signatureTypeStringТип
ЭП
КЕП

attached -

встроенная ЭП, ЭП хранится вместе с подписанными данными

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

открепленная ЭП, ЭП хранится отдельно от подписанных данных

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

Note

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


embedSignatureTsString
Признак включения электронной метки времени подписи
Ознака включення ЕПЧ підпису

true -

встраивать электронную метку времени подписи

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

встраивать электронную метку времени подписи

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

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

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

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


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

true -

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

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

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

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

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

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

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

signerCert -

добавлять только сертификат подписанта

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

добавлять сертификат подписанта и сертификаты издателей

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

добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляются

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

добавлять сертификаты

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

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

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

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


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

* ignore -

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

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

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

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

Note

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

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

* ignore -

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

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

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

tsAdditionalVerifying

String

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

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

dataToSignQualifier

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

duplicateSign

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

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

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

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

Note

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

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

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

Note

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

dataToSignQualifier

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

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

Note

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

duplicateSign

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

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

Note

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

caIdStringІдентифікатор КНЕДП, який видав сертифікат ключа з ключового контейнеруІдентифікатор підтримуваних Сервісом КНЕДП необхідно попередньо отримати завдяки запиту Отримання списку підтримуваних КНЕДП
cadesTypeStringФормат створюваного КЕП стандарту CAdES

UNDEFINED - параметр cadesType не враховується при створенні електронного підпису
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 - враховувати, що підпис створюється засобами НОКК та додатково закодована в ASN.1 OCTET STRING
* false -

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

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

Ответ

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

Note

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

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

true: 

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

* false:

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

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

Відповідь
Код відповіді
Код ответа
Content-type
Допустимые параметрыПример содержимого
Допустимі параметриПриклад вмісту
200application/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"
    }
}
503application/jsonmessage
{
   
    "message" : "
Сервис
Сервіс
хранения
зберігання
данных
даних не
запущен
запущено." 
}
400application/jsonmessage
{
   
    "message" : "
Сессия
Сесія
отсутствует
відсутня." 
}

...

Параметри JSON

...

обʼєкта відповіді
ПараметрТип
данных
даних
Описание
Опис
messageString
Описание результата проведения операции
Опис результату проведення операції
settedOptions
Object
Параметры и их значения, которые были установлены после выполнения запроса
Пример кода на JavaScript + jQuery 2.2.4

...

languagejs

...

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