Для використання в якості ключового контейнеру сесії завантажується:

  • файловий контейнер у кодуванні base64 в форматі PKCS#12, пропрієтарних форматів ІІТ ("Key-6.dat", "Приватбанк jks", "Україна ZS2"). У якості успішного завантаження при виконанні операції створення КЕП, зашифрування та розшифрування буде використовуватися особистий ключ, у випадку наявності, сертифікат (ланцюг сертифікатів) із завантаженого файлового контейнеру.
  • шлях у спеціальному форматі до файлового контейнеру чи захищеного носія з підтримкою PKCS#11 в активному (пасивному) режимі.

Шлях до захищеного носія з підтримкою PKCS#11, який підключено до комп'ютеру, на якому виконується сервіс, необхідно отримати за допомогою запиту.

Якщо в запиті одночасно присутні дані файлового контейнеру та шлях до ключового контейнеру, то буде використано лише шлях.

Якщо окремими запитами для сесії були завантажені та дані файлового контейнеру, то буде використано шлях.

Дані ключового контейнеру сесії в оперативній пам'яті з моменту завантаження до моменту видалення сесії та виконання віртуальною машиною Java подальшої збірки сміття. Дані ключового контейнеру НІКОЛИ не зберігаються сервісом у файлі, базу даних чи інші об'єкти для довгострокового зберігання інформації.  

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

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

Метод

PUT

Параметри запиту
uuidStringІдентифікатор сесії
Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметри JSON обʼєкту запиту
Імʼя
Тип
Опис
Допустимі значення
base64Data
String

Файловий контейнер у кодуванні Base64.

Не обовʼязковий параметр, який використовується лише при роботі з файловим контейнером. 

Правильно закодований Base64 рядок
keyStorePathString

Шлях у спеціальному форматі до файлового контейнеру чи захищеного носія з підтримкою PKCS#11

Для отримання списку підключених захищених носіїв, необхідно виконати запит
Відповідь
Код відповідіContent-typeДопустимі параметриПриклад вмісту
200application/jsonmessage
{
   "message" : "Дані ключового контейнеру успішно завантажено",
}
503application/jsonmessage
{
   "message" : "Сервіс зберігання даних не запущено."
}
400application/jsonmessage
{
    "message" : "Сесія відсутня." 
}
500application/jsonmessage
failureCause 
{
   "message" : "Помилка при завантаженні даних ключового контейнеру.",
"failureCause" : ""
}
Параметри JSON обʼєкта відповіді
ПараметрТип данихОпис
messageStringОпис результату проведення операції
failureCause StringОпис причини появи помилки