Запит використовується для отримання інформації про ключі, які містять ключовий контейнер. Ключовий контейнер може містити ключі електронного підпису, ключі шифрування чи обидва типи ключів одночасно. Запит також ініціює, у випадку необхідності, діалогову процедуру зміни стартових чи діючих ключів.
Діалогова процедура зміни ключів
Для виконання діалогової процедури зміни ключів шлях до ключового контейнеру має бути завантажено за допомогою спеціального запиту
URL-адреса запиту
https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/keyStore/verifier
Метод
PUT
Параметри запиту
uuid | String | Ідентифікатор сесії |
Налаштовувані заголовки запиту
Content-Type | application/json |
Параметри JSON обʼєкта запиту
Імʼя | Тип | Опис | Допустимі значення |
---|---|---|---|
keyStorePassword | String | Пароль до ключового контейнеру сесії | Рядок, який представляє собою пароль для доступу до ключового контейнеру сесії. Ключовий контейнер сесії має бути раніше завантажений за допомогою спеціального запиту. |
Відповідь
Код відповіді | Content-type | Допустимі параметри | Приклад вмісту |
---|---|---|---|
200 | application/json | keyAgreement signature | |
503 | application/json | message | { |
500 | application/json | message | { |
Параметри JSON обʼєкта відповіді
Параметр | Тип даних | Опис |
---|---|---|
message | String | Опис результату проведення операції |
signature | KeyUsageInfo | Інформація про можливість використання ключа ЕП |
keyAgreement | KeyUsageInfo | Інформація про можливість використання ключа шифрування |
Поля обʼєкта KeyUsageInfo
Поле | Тип даних | Опис |
---|---|---|
canBeUsed | Boolean | Ключ присутній в ключовому контейнері та немає обмежень на його застосування |
message | String | Якщо canBeUsed=false, то message містить опис причини, за якою ключ не може бути використаний. Якщо canBeUsed=false, а message не містить значення, то вказаний ключ відсутній у ключовому контейнері. Якщо canBeUsed=true, то message може містити попередження, наприклад, про те, що до завершення строку дії ключів залишилося менше 14 днів, чи за наявності в контейнері раніше сформованого запиту на зміну ключів та ін. |
certificateInfo | CertificateInfo | Дані із сертифікату ключа |
Поля обʼєкта CertificateInfo
Поле | Тип даних | Опис |
---|---|---|
ownerCertificateInfo | Object* | Інформація про власника |
issuerCertificateInfo | Object* | Інформація про видавця |
publicKeyCertificateInfo | Object* | Інформація про відкритий ключ |
certificateSerialNumber | Object* | Серійний номер сертифікату |
notBefore | Object* | Початок дії |
notAfter | Object* | Завершення дії |
extensionsCertificateInfo | Object* | Розширення |
Поля обʼєкта ownerCertificateInfo.value
Поле | Тип даних | Опис |
---|---|---|
ownerSurname | Object* | Прізвище |
ownerGivenname | Object* | Імʼя та по батькові |
ownerFullName | Object* | Повне імʼя |
ownerCountry | Object* | Країна |
ownerRegion | Object* | Область |
ownerCity | Object* | Населений пункт |
ownerAddress | Object* | Поштова адреса |
ownerSerialNumber | Object* | Серійний номер власника |
ownerPosition | Object* | Посада |
Поля обʼєкта issuerCertificateInfo.value
Поле | Тип даних | Опис |
---|---|---|
issuerOrganization | Object* | Організація |
issuerDepartment | Object* | Підрозділ |
issuerFullName | Object* | Повне імʼя |
issuerCountry | Object* | Країна |
issuerRegion | Object* | Область |
issuerCity | Object* | Населений пункт |
issuerAddress | Object* | Поштова адреса |
issuerSerialNumber | Object* | Серійний номер видавця |
Поля обʼєкта publicKeyCertificateInfo.value
Поля обʼєкта signerInfo.extensionsCertificateInfo.value
Поле | Тип даних | Опис |
---|---|---|
personalData | Object* | Персональні дані |
alternativeOwnerName | Object* | Альтернативне імʼя власника |
subjectKeyId | Object* | Ідентифікатор ключа |
subjectOwnerId | Object* | Ідентифікатор власника |
certificateProfile | Object* | Профіль сертифікату |
keyUsage | Object* | Призначення сертифікату |
isTemporary | Object* | Ознака стартового сертифікату |
isReinforced | Object* | Ознака посиленого сертифікату |
isQualified | Object* | Ознака кваліфікованого сертифікату |
isPrivateKeyOnQSCD | Object* | Ознака засобу КЕП |
qscdTypeName | Object* | Тип засобу КЕП |
isElectronicStamp | Object* | Ознака електронної печатки |
Поля обʼєкта extensionsCertificateInfo.value.personalData.value
Поле | Тип даних | Опис |
---|---|---|
customId | Object* | Зовнішній ідентифікатор |
passport | Object* | Паспортні дані |
drfou | Object* | Реєстраційний номер облікової картки платника податків |
edrpou | Object* | Код ЄДРПОУ |
eddrun | Object* | Унікальний номер запиту в ЄДДР |
Поля обʼєкта типа Object*
Поле | Тип даних | Опис |
---|---|---|
description | String | Опис поля на мові, який обрано користувачем у Сервісі |
value | [Object, String, Boolean, Number, Array, null] | Значення поля |
Приклад обʼєкта JSON відповіді
{ "keyAgreement": { "canBeUsed": false, "certificateInfo": {}, "message": "" }, "signature": { "canBeUsed": true, "certificateInfo": { "ownerCertificateInfo": { "description": "Власник", "value": { "ownerSurname": { "description": "Прізвище", "value": "Коваль" }, "ownerGivenname": { "description": "Ім'я по-батькові", "value": "Кирило Кирилович" }, "ownerFullName": { "description": "Повне ім'я", "value": "Співробітник банку" }, "ownerCountry": { "description": "Країна", "value": "UA" }, "ownerRegion": { "description": "Область", "value": "Харківська" }, "ownerCity": { "description": "Місто", "value": "Харків" }, "ownerAddress": { "description": "Поштова адреса", "value": null }, "ownerSerialNumber": { "description": "Серійний номер власника", "value": "1AAAD3DEE6684A8F" }, "ownerPosition": { "description": "Посада", "value": "Співробітник банку" }, "ownerOrganization": { "description": "Організація", "value": "ПАТ "Кредобанк"" }, "ownerOrganizationUnit": { "description": "Відділ (підрозділ)", "value": "Захисту інформації" } } }, "issuerCertificateInfo": { "description": "Видавник", "value": { "issuerOrganization": { "description": "Організація", "value": "ТОВ \"Сайфер БІС\"" }, "issuerDepartment": { "description": "Підрозділ", "value": "Центр сертифікації ключів" }, "issuerFullName": { "description": "Повне ім'я", "value": "ЦСК ТОВ \"Сайфер БІС\"" }, "issuerCountry": { "description": "Країна", "value": "ua" }, "issuerRegion": { "description": "Область", "value": null }, "issuerCity": { "description": "Місто", "value": "Київ" }, "issuerAddress": { "description": "Поштова адреса", "value": null }, "issuerSerialNumber": { "description": "Серійний номер видавця", "value": "UA-33349855-0002" } } }, "publicKeyCertificateInfo": { "description": "Інформація про відкритий ключ", "value": { "publicKey": { "description": "Відкритий ключ", "value": "86 CA 20 5C 1D CA 25 8E 56 80 26 15 D6 5F 26 E9 1B 2B B5 12 D6 FE 9B B0 28 4B F2 05 D7 7E 38 57 00" }, "dsAlgorism": { "description": "Алгоритм ЕП", "value": "ДСТУ 4145-2002, ПБ, little-endian" } } }, "certificateSerialNumber": { "description": "Серійний номер сертифікату", "value": "B8 BF CA F0 E1 7D B9 1C" }, "notBefore": { "description": "Початок дії", "value": "2018-09-11T09:22:11Z" }, "notAfter": { "description": "Закінчення дії", "value": "2018-09-21T21:00:00Z" }, "extensionsCertificateInfo": { "description": "Розширення", "value": { "personalData": { "description": "Персональні дані", "value": { "customId": { "description": "Зовнішній ідентифікатор", "value": "001" }, "passport": { "description": "Паспортні дані", "value": "000123456" }, "drfou": { "description": "Реєстраційний номер облікової картки платника податків", "value": "1234567891" }, "edrpou": { "description": "Код ЕДПРОУ", "value": null }, "eddrun": { "description": "Унікальний номер запису в ЄДДР", "value": "01010101010115" } } }, "alternativeOwnerName": { "description": "Альтернативне ім'я власника", "value": "test@cipher.com" }, "subjectKeyId": { "description": "Ідентифікатор ключа", "value": "D7 AE 17 4E B0 2B 38 68 8F D9 17 22 67 D1 5B AF 36 A2 5A 62 76 AA 44 94 86 C8 D9 42 E1 86 E8 9D" }, "subjectOwnerId": { "description": "Ідентифікатор власника", "value": "1A AA D3 DE E6 68 4A 8F" }, "certificateProfile": { "description": "Профіль сертифіката", "value": "3" }, "keyUsage": { "description": "Призначення сертифіката", "value": "Цифровий підпис" }, "isTemporary": { "description": "Стартовий", "value": "false" }, "isReinforced": { "description": "Посилений", "value": "false" }, "isQualified": { "description": "Кваліфікований", "value": "false" }, "isPrivateKeyOnQSCD": { "description": "Засіб КЕП", "value": "false" }, "qscdTypeName": { "description": "Тип засобу КЕП", "value": null }, "isElectronicStamp" : { "description": "Електронна печатка", "value": "false" } } } }, "message": "До закінчення дії ключів залишилося менше 6 днів. Зверніться протягом 6 днів до центру реєстрації ключів для отримання нових ключів" } }