- Файловий контейнер
Для
...
- використання в якості ключового контейнеру сесії завантажується файловий контейнер у кодуванні base64 у форматі PKCS#12, пропрієтарні формати ІІТ ("Key-6.dat", "Приватбанк jks", "
...
- Україна ZS2").
...
Путь к аппаратному носителю с поддержкой PKCS#11, который подключен к компьютеру, на котором выполняется сервис, необходимо получить посредством запроса https://docs.cipher.kiev.ua/x/GYOD.
Если в запросе одновременно присутствуют данные файлового ключевого контейнера и путь к ключевому контейнеру, то будет использован только путь.
Если отдельными запросами для сессии были загружены и данные файлового контейнера, и путь к ключевому контейнеру, то будет использован только путь.
Данные ключевого контейнера сессии находятся в оперативной памяти с момента загрузки до момента удаления сессии и выполнения виртуальной машиной Java последующей процедуры сборки мусора. Данные ключевого контейнера НИКОГДА не сохраняются сервисом в файл, базу данных или другие объекты для долгосрочного хранения информации.
URL-адрес запроса
- У випадку успішного завантаження при виконанні операції створення КЕП, зашифрування та розшифрування використовується особистий ключ, та за наявності сертифікат (ланцюг сертифікатів) із завантаженого файлового контейнеру.
Дані ключового контейнеру сесії знаходяться в оперативній памʼяті з моменту завантаження до моменту видалення сесії та виконання віртуальною машиною Java наступної процедури збору сміття. Дані ключового контейнеру НІКОЛИ не зберігаються сервісом у файл, базу даних чи інші обʼєкти для довгострокового зберігання інформації. - Сховище ключів (токен) у складі хмарного сервісу.
Підтримувані сервіси: Cipher-CKS, Depositsign
Note | ||
---|---|---|
| ||
Метод підтримує захищені параметри. |
URL-адреса запиту
https://ccs-dev-api.cipher.kiev.ua/ccshttps://localhost:9094/api/v1/ticket/{uuid}/keyStore
Метод
PUT
...
Параметри запиту
uuid | String |
Ідентифікатор сесії |
...
Налаштовувані заголовки
...
запиту
Content-Type | application/json |
...
Параметри JSON
...
обʼєкту запиту
Імʼя | Тип |
---|
Опис |
---|
Допустимі значення | |
---|---|
base64Data | String |
Файловий контейнер |
Путь в специальном формате к файловому контейнеру или аппаратному носителю с поддержкой PKCS#11
Ответ
у кодуванні Base64. Не обовʼязковий параметр, який використовується лише при роботі з файловим контейнером. | Правильно закодований Base64 рядок | ||
keyStoreUri | String | Унікальний ідентифікатор сховища ключів (токена). Не обовʼязковий параметр, який використовується лише при роботі з деякими хмарними сервісами. | Формат залежить від хмарного сервісу, який згенерував URI |
bearerToken | String | Токен доступу, який необхідний для доступу до API хмарного сервісу. Не обовʼязковий параметр, який використовується лише при роботі з деякими хмарними сервісами. | Формат залежить від хмарного сервісу, який згенерував токен |
privilegedBearerToken | String | Токен доступу, який використовується для виконання запитів без другого фактору, навіть якщо другий фактор ввімкнено в налаштуваннях облікового запису користувача. Не обовʼязковий параметр, який використовується лише при роботі з деякими хмарними сервісами. | Лише для хмарного сервісу Depositsign |
Відповідь
Код відповіді | Content-type | Допустимі параметри | Приклад вмісту |
---|
200 | application/json | message | { |
"message" : |
"Дані ключового контейнеру успішно завантажено.", | |||
503 | application/json | message | { |
"message" : |
"Сервіс зберігання даних не запущено." | |||
400 | application/json | message | { |
"message" : " |
Сесія відсутня." | |||
500 | application/json | message failureCause | { |
"message" : " |
Помилка при |
завантаженні |
даних |
ключового |
контейнеру.", |
...
Параметри JSON
...
обʼєкта відповіді
Параметр | Тип |
---|
даних |
---|
Опис | |
---|---|
message | String |
Опис результату проведення операції | |
failureCause | String |
Пример кода на JavaScript + jQuery 2.2.4 в случае использования аппаратного носителя в активном режиме
Code Block | ||
---|---|---|
| ||
var data = {
keyStorePath: "@. Avtor SecureToken 0"
}
$.ajax({
url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/keyStore",
type: "POST",
dataType: "json",
contentType: "application/json",
data: JSON.stringify(data)
}).done(function (jsonResponse, textStatus, xhr) {
message = jsonResponse.message;
}).fail(function (xhr) {
try {
var jsonResponse = JSON.parse(xhr.responseText);
message = jsonResponse.message;
failureCause = jsonResponse.failureCause;
} catch (e) {
message = (xhr.responseText == undefined) ? "Ошибка при загрузке данных ключевого контейнера." : xhr.responseText;
}
}) |
Пример кода на JavaScript + jQuery 2.2.4 в случае использования файлового контейнера с указанием пути
Code Block | ||
---|---|---|
| ||
var data = {
keyStorePath: "z:\\sharedFiles\\temp\\7\\Molyakov_overdue-DS+Arg.pfx"
}
$.ajax({
url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/keyStore",
type: "POST",
dataType: "json",
contentType: "application/json",
data: JSON.stringify(data)
}).done(function (jsonResponse, textStatus, xhr) {
message = jsonResponse.message;
}).fail(function (xhr) {
try {
var jsonResponse = JSON.parse(xhr.responseText);
message = jsonResponse.message;
failureCause = jsonResponse.failureCause;
} catch (e) {
message = (xhr.responseText == undefined) ? "Ошибка при загрузке данных ключевого контейнера." : xhr.responseText;
}
}) |
Пример кода на JavaScript + jQuery 2.2.4 в случае использования данных файлового контейнера
...
language | js |
---|
...
Опис причини появи помилки |