Встановлення параметрів операції перевірки (створення) електронного підпису/електронної позначки часу (ЕП/ЕПЧ) та зашифрування, які використовуються в контексті визначеної сесії.
Доступні наступні параметри, які відносяться до операцій ЕП та ЕПЧ:
- тип ЕП
- формат ЕП
- ознака включення ЕПЧ даних
- ознака включення ЕПЧ підпису
- порядок включення сертифікатів підписанта та видавців
- режим перевірки ЕПЧ підпису
- режим перевірки ЕПЧ даних
- опис даних, які необхідно підписати
- ознака можливості підписання документа кілька разів одним і тим же підписантом
Доступні наступні параметри, які відносяться до операції зашифрування:
- порядок включення сертифікатів підписанта та видавців
URL-адреса запиту
Устанавливает параметры операций проверки (создания) ЭЦП (МВ), которые используются в контексте определенной сессии.
Доступны следующие параметры, которые относятся к операциям ЭЦП и МВ:
- тип ЭЦП
- признак включения метки времени данных
- признак включения метки времени ЭЦП
- порядок включения сертификатов подписанта и издателей
- режим проверки метки времени цифровой подписи
- режим проверки метки времени данных
...
https://local.cipher.kiev.ua:9091/api/v1/ticket/{uuid}/option
Метод
PUT
...
Параметри запиту
...
Налаштовувані заголовки
...
запиту
Content-Type | application/json |
Параметры JSON объекта запроса
Параметри JSON об'єкта запиту
ИмяОписаниеДопустимые значенияДопустимі значення |
---|
signatureType | String | Тип |
ЭЦП встроенная ЭЦП, ЭЦП хранится вместе с подписанными даннымивбудований ЕП, ЕП зберігається разом з підписаними даними * detached - |
открепленная ЭЦП, ЭЦП хранится отдельно от подписанных данныхвідкріплений ЕП, ЕП зберігається окремо від підписаних даних |
embedSignatureTs | String |
Признак включения метки времени ЭЦПОзнака включення ЕПЧ підпису | |
встраивать метку времени ЭЦПвбудовувати ЕПЧ підпису * false - |
встраивать метку времени ЭЦП вбудовувати ЕПЧ підпису Note |
---|
При встановленні параметру cadesType в значення, відмінне від "undefined", значення параметру embedSignatureTs ігнорується. |
|
embedDataTs | String |
Признак включения метки времени данныхОзнака включення ЕПЧ даних | |
встраивать метку времени даныхвбудовувати ЕПЧ підпису * false - |
встраивать метку времени данныхвбудовувати ЕПЧ підпису Note |
---|
При встановленні параметру cadesType в значення, відмінне від "undefined", значення параметру embedDataTs ігнорується. |
|
embedCertificateType | String | Порядок |
включения сертификатов подписанта и издателейвключення сертифікатів підписанта та видавців | |
добавлять только сертификат подписантадодавати лише сертифікат підписанта signerAndCaCert - |
добавлять сертификат подписанта и сертификаты издателейдодавати сертифікат підписанта та сертифікати видавців signerCertAndCaInfo - |
добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляются)додавати сертифікат підписанта та інформацію про сертифікати видавців (самі сертифікати видавців не додаються) * nothing - не додавати сертифікати Note |
---|
При встановленні параметру cadesType в значення, відмінне від "undefined", значення параметру embedCertificateType ігнорується. |
Note |
---|
title | Значення, допустимі лише для операції зашифрування: |
---|
| signerCert - додавати лише сертифікат підписанта signerAndCaCert - додавати сертифікат підписанта та сертифікати видавців * nothing - не |
|
добавлять сертификаты |
signatureTsVerifyOption | String | Режим |
проверки метки времени цифровой подписиперевірки ЕПЧ підпису | * ignore - |
игнорировать метку времениігнорувати ЕПЧ verifyIfPresent - |
проверять метку времени, если она присутствуетперевіряти ЕПЧ, якщо вона присутня verifyOrFailIfNotPresent - |
проверять метку времени и возвращать ошибку, если она отсутствуетперевіряти ЕПЧ та повертати помилку, якщо вона відсутня |
dataTsVerifyOption | String | Режим |
проверки метки времени данных перевірки ЕПЧ даних | * ignore - |
игнорировать метку времениігнорувати ЕПЧ verifyIfPresent - |
проверять метку времени, если она присутствуетverifyOrFailIfNotPresent - проверять метку времени и возвращать ошибку, если она отсутствует * - значение по умолчанию
Ответ
перевіряти ЕПЧ, якщо вона присутня verifyOrFailIfNotPresent - перевіряти ЕПЧ та повертати помилку, якщо вона відсутня |
dataToSignQualifier | String | Опис даних, які необхідно підписати | * notSignedBefore - дані не містять раніше створений ЕП alreadySigned - дані вже містять ЕП, для додавання нової буде використано режим множинного ЕП |
duplicateSign | String | Ознака можливості підпису документу кілька раз одним і тим же підписантом | true - додає новий ЕП, якщо документ вже був підписаний цим же підписантом * false - новий ЕП не додається, якщо документ був підписаний цим же підписантом |
cadesType | String | Формат створеного ЕП за стандартом CAdES | undefined - параметр cadesType не враховується при створенні ЕП CAdESBES - базовий ЕП CAdEST - ЕП, який містить ЕПЧ підпису * CAdESXLong - ЕП, який містить ЕПЧ підпису та повний набір даних для перевірки. Note |
---|
При встановленні параметру cadesType в значення, відмінне від "undefined", значення параметрів embedSignatureTs, embedDataTs, embedCertificateType ігноруються. |
|
nokkCompatible | String | Ознака додаткового кодування підпису, створеного засобами компанії НОКК | true - враховувати, що підпис створений засобами НОКК та додатково закодовано в ASN.1 OCTET STRING * false - кодування підпису відповідає нормативним нормам |
Відповідь
Код відповіді | Content-type | Допустимі параметри | Приклад вмісту |
---|
Код ответа | Content-type | Допустимые параметры | Пример содержимого |
---|
200 | application/json | message settedOptions : { signatureType, signatureTsVerifyOption, dataTsVerifyOption, embedSignatureTs, embedDataTs, embedCertificateType, dataToSignQualifier, duplicateSign } |
Запросустановкунастроексессиивыполненвиконано.", "settedOptions": { "signatureTsVerifyOption": "IGNORE", "embedSignatureTs": "false", "embedCertificateType": "NOTHING", "signatureType": "DETACHED", "dataTsVerifyOption": "IGNORE", "embedDataTs": "false |
" }}503 | application/json | message | { message" : "Сервис выполнения криптографических операций не запущен." }400 | application/json | message | { "message" : "Сессия отсутствует." } |
Параметры JSON объекта ответа
Параметр | Тип данных | Описание |
---|
message | String | Описание результата проведения операции |
settedOptions | Object | Параметры и их значения которые были установлены после выполнения запросаПример кода на JavaScript + jQuery 2.2.4
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
} } |
503 | application/json | message | { "message" : "Сервіс збереження даних на запущено." } |
400 | application/json | message | { "message" : "Сесія відсутня." } |
Параметри JSON об'єкта відповіді
Параметр | Тип даних | Опис |
---|
message | String | Опис результату проведення операції |
settedOptions | Object | Параметри та їх значення, яке було встановлено після виконання запиту |