Versions Compared

Key

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

Table of Contents
maxLevel2

Створення

...

ЕП

Створення

...

ЕП


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
3Встановити параметри сесіїМає бути вказаний параметр "caId".
4Завантажити ключовий контейнер сесії
5Створити КЕПЕП
6Отримати дані КЕПЕП

Блокуюча (синхронна) операція.

Note
titleУвага

За допомогою запиту Отримання результату створення ЕП можна отримати розширену помилку, чому саме не створений ЕП.

7Видалити сесію

Приклад створення КЕП ЕП для текстових даних (Java, Maven, Cipher Signer Server): https://github.com/stokipny/sjwsa-singer-server-client 

...

Створення ЕП з контролем стану

Можливо використовувати у випадку пакетної обробки великої кількості ресурсів (файлів).

...

Note

...

titleУвага

За допомогою запиту Отримати результат створення ЕП можна отримати розширену помилку, чому саме не створений ЕП.


Назва операціїПримітка
1Створити сесію Рекомендується для 1Створити сесію Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
3Встановити параметри сесіїМає бути вказаний параметр "caId". 
4Завантажити ключовий контейнер сесії
5Створити КЕПЕП
6Отримати результат створення КЕПЕП

Не блокуюча (асинхронна) операція. Слід використовувати для контролю стану процесу створення

КЕП

ЕП.

7Отримати дані КЕПЕП

Блокуюча (синхронна) операція.

Note
titleУвага

За допомогою запиту Отримання результату створення ЕП можна отримати розширену помилку, чому саме не створений ЕП.

8Видалити сесію

Створення

...

ЕП з контролем стану для формату CAdES

КЕП КЕП КЕП КЕП

Назва операціїПримітка
1Створити сесію Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
3Встановити параметри сесіїМає бути вказані параметри "caId", "signatureType" та "cadesType". 
4Завантажити ключовий контейнер сесії
5Створити
ЕП
6Отримати результат створення
ЕП

Не блокуюча (асинхронна) операція. Слід використовувати для контролю стану процесу створення

ЕП.

7Отримати дані
ЕП

Блокуюча (синхронна) операція.

Note
titleУвага

За допомогою запиту Отримання результату створення ЕП можна отримати розширену помилку, чому саме не створений ЕП.

8Видалити сесію

Створення

...

ЕП з контролем стану для формату XAdES та контейнерів ASIC-S(E)

Має бути вказаний параметр та Отримати результат створення КЕП КЕП7 КЕП

Назва операціїПримітка
1Створити сесію Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесії

Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.

3Встановити параметри сесії

При своренні вбудованого (ATTACHED) підпису формату XAdES в якості даних має бути завантажений xml-документ.

3Встановити параметри сесії

Вказати наступні параметри:

  • XAdES: "caId", "signatureType"
  • , "xadesType".
  • ASiC-E з XAdES: "caId", 
4Завантажити ключовий контейнер сесії5Створити КЕП
  • "xadesType", "asicForm=ASIC_E"
  • ASiC-E з CAdES: "caId", "cadesType", "asicForm=ASIC_E"
  • ASIC-S з CAdES: "caId", "cadesType", "asicForm=ASIC_S"
  • ASIC-S з XAdES: не підтримується

Параметр "caId" можна не вказувати, якщо в ключовому контейнері присутній сертифікат підписанта.

4Завантаження метаданих сесіїВ якості метаданих завантажити ідентифікатор даних, зазвичай ім'я файлу.
5Завантажити ключовий контейнер сесії
6Створити ЕП
7Отримати результат створення ЕП
6

Не блокуюча (асинхронна) операція. Слід використовувати для контролю стану процесу створення

ЕП.

8Отримати дані
ЕП

Блокуюча (синхронна) операція.

8
Note
titleУвага

За допомогою запиту Отримання результату створення ЕП можна отримати розширену помилку, чому саме не створений ЕП.

9Видалити сесію

Створення

...

множинної вбудованої ЕП

Підтримується лише для формату CAdES

  сесіїМають вказані параметри  asicForm", "cadesType" та/чи "xadesType".Отримати дані КЕП8

Назва операціїПримітка
1Створити сесію
Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані
ЕП

В якості даних ЕП має бути завантажена раніше створено вбудований ЕП.
Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.

3Встановити параметри сесії

Має бути

вказаний параметр "caId" та

"

cadesType".
Для параметра "dataToSignQualifier" має бути встановлено значення "alreadySigned".
Для параметра "signatureType" має бути встановлено значення "attached".
Для параметра "duplicateSign" має бути встановлено значення "true", якщо необхідно забезпечити можливість підписання документа кілька разів одним і тим же підписантом.

4Завантажити ключовий контейнер сесії
5Створити ЕП
6Отримати дані ЕП
4Завантажити ключовий контейнер сесії5Створити КЕП
6Отримати результат створення КЕПНе блокуюча (асинхронна) операція. Слід використовувати для контролю стану процесу створення КЕП.
7

Блокуюча (синхронна) операція.

Note
title
Видалити сесію

...

Увага

За допомогою запиту Отримання результату створення ЕП можна отримати розширену помилку, чому саме не створений ЕП.

7Видалити сесію

Створення множинної відкріпленої ЕП

Підтримується лише для формату CAdES


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані КЕПсесіїВ якості даних КЕП має бути завантажена раніше створено вбудований КЕП.
Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
3Завантажити дані ЕП

В якості даних ЕП має бути завантажена раніше створено відкріплений ЕП.
Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.

4Встановити параметри сесії

Має бути вказаний параметр

Встановити параметри сесії

Має бути вказаний параметр "caId" та "cadesType".
Для параметра "dataToSignQualifier" має бути встановлено значення "alreadySigned".
Для параметра "signatureType" має бути встановлено значення "attacheddetached".
Для параметра параметр "duplicateSign" має бути встановлено значення "true",
якщо необхідно забезпечити можливість підписання документа кілька разів одним і тим же підписантом.

45Завантажити ключовий контейнер сесії
56Створити КЕПЕП
67Отримати дані КЕПЕП

Блокуюча (синхронна) операція.

7
Note
Видалити сесію

Створення множинної відкріпленої КЕП

...

titleУвага

За допомогою запиту Отримання результату створення ЕП можна отримати розширену помилку, чому саме не створений ЕП.

8Видалити сесію

Створення ЕП для даних (масова операція) для формату CAdES


Назва операціїПримітка
1Створити сесію
Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.

2
Завантажити дані
Встановити параметри сесії
Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
Має бути вказані параметри "caId", "signatureType" та "cadesType". 
3Завантажити
дані КЕП

В якості даних КЕП має бути завантажена раніше створено відкріплений КЕП.
Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.

4Встановити параметри сесії

Має бути вказаний параметр "caId" та "cadesType".
Для параметра "dataToSignQualifier" має бути встановлено значення "alreadySigned".
Для параметра "signatureType" має бути встановлено значення "detached".
Для параметр "duplicateSign" має бути встановлено значення "true",
якщо необхідно забезпечити можливість підписання документа кілька разів одним і тим же підписантом.

5Завантажити ключовий контейнер сесії6Створити КЕП7Отримати дані КЕПБлокуюча (синхронна) операція.8Видалити сесію

Створення КЕП для даних (масова операція) для формату CAdES

...

Створення КЕП для даних (масова операція) для формату XAdES

...

Створення КЕП для даних (масова операція) для типу ASIC-S/ASIC-E

...

Створення КЕП для гешів (масова операція)

...

Створення КЕП з ключами з Шифр-HSM-Site для формату CAdES

...

В параметрі keyStoreUri має бути вказано URI токену.

Тестовий токен:

...

Створення КЕП з ключами з Шифр-HSM-Site для формату XAdES

...

В параметрі keyStoreUri має бути вказано URI токену.

Тестовий токен:

...

Створення ЕП для даних (масова операція) для для формату XAdES та контейнерів ASIC-S(E)


Назва операціїПримітка
1Створити сесію
2Встановити параметри сесії

Вказати наступні параметри:

  • XAdES: "caId", "signatureType", "xadesType".
  • ASiC-E з XAdES: "caId", "xadesType", "asicForm=ASIC_E"
  • ASiC-E з CAdES: "caId", "cadesType", "asicForm=ASIC_E"
  • ASIC-S з CAdES: "caId", "cadesType", "asicForm=ASIC_S"
  • ASIC-S з XAdES: не підтримується

Параметр "caId" можна не вказувати, якщо в ключовому контейнері присутній сертифікат підписанта.

3Завантажити ключовий контейнер сесії
4Створення ЕП для даних (масова операція)

При створенні вбудованого (ATTACHED) підпису формату XAdES в якості даних має бути завантажений xml-документ.

Має бути вказаний параметр "keyStorePassword" та "dataToSign".

5Видалити сесію

Створення ЕП для гешів (масова операція)


Назва операціїПримітка
1Створити сесію
Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.

2
Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.3
Встановити параметри сесіїМає бути
вказані параметри 
вказаний параметр "
asicForm", "cadesType" та/чи "xadesType".
caId".
3Завантажити ключовий контейнер сесії
4Створення ЕП для гешів (масова операція)
5Видалити сесію

Створення ЕП з ключами на МКМ Шифр-HSM

Порядок виконання усіх операцій аналогічний представленому у прикладах для файлових контейнерів. Відмінність полягає тільки в операції завантаження ключового контейнера сесії.


Назва операціїПримітка
4

Завантажити ключовий контейнер сесії

В параметрі keyStoreUri має бути вказано URI токену.

Тестовий токен:

5Створити КЕП
6Отримати дані КЕПБлокуюча (синхронна) операція.7Видалити сесію

...

Створення ЕП з ключами Depositsign

Підтримується лише для формату CAdES


Назва операціїПримітка
1Отримати токен доступу до API Depositsign та ідентифікатор сховища ключів

Виконати метод API Depositsign: /api/v1/{clientId}/auth/login

Тестовий обліковий запис:

  • UserName: testDS
  • Password: testDS

Документація з API Depositsign: https://depositsign.com/swagger-api-doc

2Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
3Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
4Встановити параметри сесії
5Завантажити ключовий контейнер сесіїВ параметрі keyStoreUri має бути вказано URI сховища ключів (токена), отримуємо значення "KeyName" з 1-го запиту "Отримати токен доступу до API Depositsign та ідентифікатор сховища ключів".
В параметрі bearerToken має бути вказано токен доступу до API Depositsign.
6Створити КЕПЕП
7Отримати дані КЕПЕП

Блокуюча (синхронна) операція.

Note
titleУвага

За допомогою запиту Отримання результату створення ЕП можна отримати розширену помилку, чому саме не створений ЕП

Блокуюча (синхронна) операція

.

8Видалити сесію

Перевірка

...

ЕП


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
3Завантажити дані КЕПЕПМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
4Встановити параметри сесії
5Перевірити КЕПЕП
6Отримати результат перевірки КЕПЕПБлокуюча (синхронна) операція.
7Видалити сесію

Якщо після перевірки вбудованого КЕП ЕП необхідно отримати (виокремити) підписані дані, то слід використовувати запит запит Отримання підписаних даних.

Приклад перевірки КЕП ЕП з отриманням текстових даних (Java, Maven, Cipher Signer Server): https://github.com/stokipny/sjwsa-singer-server-client 

...

Розширення ЕП


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
3Завантажити дані КЕПЕПМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
4Встановити параметри сесіїМає бути вказаний параметр "cadesType", "signatureType"
5Розширення КЕПЕП
6Отримати дані розширеного КЕПЕПБлокуюча (синхронна) операція.
7Отримати результат розширення КЕПЕП
8Видалити сесію

Зашифрування

Зашифрування


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки.
3Встановити параметри сесіїМає бути вказаний параметр "caId", "embedCertificateType".
4Завантажити ключовий контейнер сесії
5Завантажити сертифікати отримувачівНеобхідно вказати як мінімум один сертифікат отримувача зашифрованих даних.
Сертифікати можуть бути завантажені у вигляді: двійкових даних, Base64 рядка.
6Зашифрувати
7Отримати зашифровані даніБлокуюча (синхронна) операція. Можуть бути отримати у вигляді: двійкових даних, Base64 рядка.
8Видалити сесію

Зашифрування з контролем стану

...


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки.
3Встановити параметри сесіїМає бути вказаний параметр "caId", "embedCertificateType".
4Завантажити ключовий контейнер сесії
5Завантажити сертифікати отримувачівНеобхідно вказати як мінімум один сертифікат отримувача зашифрованих даних.
Сертифікати можуть бути завантажені у вигляді: двійкових даних, Base64 рядка.
6Зашифрувати
7Отримати результат зашифруванняНе блокуюча (асинхронна) операція. Слід використовувати для контроля стану процесу зашифрування.
8Отримати зашифровані даніБлокуюча (синхронна) операція. Можуть бути отримати у вигляді: двійкових даних, Base64 рядка.
9Видалити сесію

Зашифрувати ключами

...

на МКМ Шифр-HSM

...

Можливе використання у випадку пакетної обробки великої кількості ресурсів (файлів).

...


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки.
3Встановити параметри сесіїМає бути вказаний параметр "caId".
4Завантажити ключовий контейнер сесії
5Розшифрувати
6Отримати результат розшифруванняНе блокуюча (асинхронна) операція. Слід використовувати для контроля стану процесу зашифрування.
7Отримати розшифровані даніБлокуюча (синхронна) операція. Можуть бути отримати у вигляді: двійкових даних, Base64 рядка.
8Видалити сесію

Розшифрувати ключами

...

на МКМ Шифр-HSM

...


Назва операціїПримітка
1Створити сесіюРекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію.
2Завантажити дані сесіїМожуть бути завантажені у вигляді: двійкових даних, Base64 рядки.
3Встановити параметри сесіїМає бути вказаний параметр "caId".
4Завантажити ключовий контейнер сесії

В параметрі keyStoreUri має бути вказано URI токену.

Тестовий токен:

5Розшифрувати
6Отримати розшифровані даніБлокуюча (синхронна) операція. Можуть бути отримати у вигляді: двійкових даних, Base64 рядка.
7Видалити сесію

...