Versions Compared

Key

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

Table of Contents
maxLevel2

Создание ЭП

Створення ЕП

Створення ЕП


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

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

Note
titleУвага

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

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

.

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

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

Создание ЭП с контролем состояния

Возможно использовать в случае пакетной обработки большого количества ресурсов (файлов).

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

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

Note
titleУвага

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


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

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

Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса создания ЭП

.

7Получить данные ЭПОтримати дані ЕП

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

Note
titleУвага

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

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

.

8Удалить сессию

Создание множественной встроенной ЭП

...

В качестве данных ЭП должна быть загружена ранее созданная встроенная ЭП.
Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.

...

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


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

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

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

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

Note
titleУвага

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

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

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


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

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

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

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

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

  • 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" можна не вказувати, якщо в ключовому контейнері присутній сертифікат підписанта.

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

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

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

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

Note
titleУвага

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

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

Створення множинної вбудованої ЕП

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


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

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

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

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

4Завантажити ключовий контейнер сесії
5Створити ЕП
6Отримати дані ЕП

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

Note
titleУвага

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

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

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

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


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

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

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

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

5Завантажити ключовий контейнер сесії
6Створити ЕП
7Отримати дані ЕП

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

Note
titleУвага

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

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

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


Назва операціїПримітка
1Створити сесію
2Встановити параметри сесіїМає бути вказані параметри "caId", "signatureType" та "cadesType". 
3Завантажити ключовий контейнер сесії
4Створення ЕП для даних (масова операція)Має бути вказаний параметр "keyStorePassword" та "dataToSign".
5Видалити сесію

Створення ЕП для даних (масова операція) для для формату 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Видалити сесію

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

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

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


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

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

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

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

Створення ЕП з ключами 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Видалити сесію

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

Приклад перевірки ЕП з отриманням текстових даних

...

Создание множественной открепленной ЭП

...

В качестве данных ЭП должна быть загружена ранее созданная для данных сессии открепленная ЭП.
Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.

...

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

...

Создание мобильной ЭП

...

Название операции

...

Примечания

...

Поддерживаемые параметры: "signatureType", "cadesType".

...

Создание мобильной ЭП с контролем состояния

...

Название операции

...

Примечания

...

Создание множественной встроенной мобильной ЭП

...

Название операции

...

Примечания

...

Поддерживаемые параметры: "signatureType", "cadesType", "dataToSignQualifier".
Для параметра "dataToSignQualifier" должно быть установлено значение "alreadySigned".

...

Создание множественной открепленной мобильной ЭП

...

Название операции

...

Примечания

...

Поддерживаемые параметры: "signatureType", "cadesType", "dataToSignQualifier".
Для параметра "dataToSignQualifier" должно быть установлено значение "alreadySigned".

...

Проверка ЭП

...

Если после проверки прикрепленной ЭП необходимо получить (извлечь) подписанные данные, то следует использовать запрос Получение подписанных данных.

Пример проверки ЭП с извлечением для текстовых данных (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Встановити параметри сесіїМає бути вказаний параметр "embedCertificateType".
4Завантажити ключовий контейнер сесії

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

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

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

Розшифрування

Розшифрувати


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

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


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

Розшифрувати ключами на МКМ Шифр-HSM


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

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

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

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

Електронна позначка часу

Створення електронної позначки часу


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

Створення електронної позначки часу з контролем стану

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


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

Перевірка електронної позначки часу


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

Отримання даних про ключовий контейнер


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

Отримання даних сертифіката


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

...

Получение данных сертификата

...

Создание ЭП с ключами из Cipher-CKS

...

В параметре keyStoreUri должен быть указан URI токена.

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

...

Создание ЭП с ключами Depositsign

Название операцииПримечания
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-формы c двоичными данными.
4Установить параметры сессии
5Загрузить ключевой контейнер сессииВ параметре keyStoreUri должен быть указан URI хранилища ключей (токена).
В параметре bearerToken должен быть указан токен доступа к API Depositsign.
6Создать ЭП
7Получить данные ЭПБлокирующая (синхронная) операция.
8Удалить сессию