Table of Contents | ||
---|---|---|
|
Создание ЭЦП
Створення КЕП
Створення КЕП
Назва операції | Примітка |
---|
1 |
Створити сесію |
Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію. |
2 |
Завантажити дані сесії | Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними. | |
3 | Встановити параметри сесії | Має бути вказаний |
параметр "caId". |
4 |
Завантажити ключовий контейнер сесії | |
5 |
Створити КЕП | |
6 |
Отримати дані КЕП | Блокуюча (синхронна) операція. |
7 |
Видалити сесію |
Приклад створення КЕП для текстових даних Пример создания ЭЦП для текстовых данных (Java, Maven, Cipher Signer Server): https://github.com/stokipny/sjwsa-singer-server-client
Создание ЭЦП с контролем состояния
Возможно использовать в случае пакетной обработки большого количества ресурсов (файлов).
Створення КЕП з контролем стану
Можливо використовувати у випадку пакетної обробки великої кількості ресурсів (файлів).
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію. |
2 | Завантажити дані сесії | Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними. |
3 | Встановити параметри сесії | Має бути вказаний |
параметр "caId". |
4 |
Создание множественной встроенной ЭЦП
Завантажити ключовий контейнер сесії | ||
5 | Створити КЕП | |
6 | Отримати результат створення КЕП | Не блокуюча (асинхронна) операція. Слід використовувати для контролю стану процесу створення КЕП. |
7 | Отримати дані КЕП | Блокуюча (синхронна) операція. |
8 | Видалити сесію |
Створення КЕП з контролем стану для формату CAdES
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію. |
2 | Завантажити дані сесії | Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними. |
3 | Встановити параметри сесії | Має бути вказані параметри "caId", "signatureType" та "cadesType". |
4 | Завантажити ключовий контейнер сесії | |
5 | Створити КЕП | |
6 | Отримати результат створення КЕП | Не блокуюча (асинхронна) операція. Слід використовувати для контролю стану процесу створення КЕП. |
7 | Отримати дані КЕП | Блокуюча (синхронна) операція. |
8 | Видалити сесію |
Створення КЕП з контролем стану для формату XAdES та контейнерів ASIC-S(E)
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію. |
2 | Завантажити дані сесії | Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними. При своренні вбудованого (ATTACHED) підпису формату XAdES в якості даних має бути завантажений xml-документ. |
3 | Встановити параметри сесії | Вказати наступні параметри:
Параметр "caId" можна не вказувати, якщо в ключовому контейнері присутній сертифікат підписанта. |
4 | Завантаження метаданих сесії | В якості метаданих завантажити ідентифікатор даних, зазвичай ім'я файлу. |
5 | Завантажити ключовий контейнер сесії | |
6 | Створити КЕП | |
7 | Отримати результат створення КЕП | Не блокуюча (асинхронна) операція. Слід використовувати для контролю стану процесу створення КЕП. |
8 | Отримати дані КЕП | Блокуюча (синхронна) операція. |
9 | Видалити сесію |
Створення множинної вбудованої КЕП
Підтримується лише для формату CAdES
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію. |
2 | Завантажити дані КЕП | В якості даних КЕП має бути завантажена раніше створено вбудований КЕП. |
3 | Встановити параметри сесії | Має бути вказаний параметр "caId" та "cadesType |
В качестве данных ЭЦП должна быть загружена ранее созданная встроенная ЭЦП.
Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
". |
має бути встановлено значення "alreadySigned". |
має бути встановлено значення "attached". |
параметра "duplicateSign" |
має бути встановлено значення "true", |
если необходимо обеспечить возможность подписания документа несколько раз одним и тем же подписантом
якщо необхідно забезпечити можливість підписання документа кілька разів одним і тим же підписантом. |
4 |
Завантажити ключовий контейнер сесії | |
5 |
Створити КЕП |
6 |
Отримати дані КЕП | Блокуюча (синхронна) операція. |
7 |
Создание множественной открепленной ЭЦП
Створення множинної відкріпленої КЕП
Підтримується лише для формату CAdES
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | Рекомендується для кожного окремого ресурсу (файлу) створювати окрему сесію. |
2 | Завантажити дані сесії | Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними. |
3 | Завантажити дані КЕП | В якості даних КЕП має бути завантажена раніше створено відкріплений КЕП. |
4 | Встановити параметри сесії | Має бути вказаний параметр "caId" та "cadesType" |
В качестве данных ЭЦП должна быть загружена ранее созданная для данных сессии открепленная ЭЦП.
Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.
. |
має бути встановлено значення "alreadySigned". |
має бути встановлено значення "detached". |
має бути встановлено значення "true", |
Проверка ЭЦП
Название операции | Примечания | |
---|---|---|
1 | Создать сессию | Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию. |
2 | Загрузить данные сессии | Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными |
3 | Загрузить данные ЭЦП | Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными |
3 | Установить параметры сессии | |
5 | Проверить ЭЦП | |
6 | Получить результат проверки ЭЦП | Блокирующая (синхронная) операция. |
7 | Удалить сессию |
Если после проверки ЭЦП необходимо получить подписанные данные, то следует использовать запрос Получение подписанных данных.
якщо необхідно забезпечити можливість підписання документа кілька разів одним і тим же підписантом. | ||
5 | Завантажити ключовий контейнер сесії | |
6 | Створити КЕП | |
7 | Отримати дані КЕП | Блокуюча (синхронна) операція. |
8 | Видалити сесію |
Створення КЕП для даних (масова операція) для формату CAdES
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | |
2 | Встановити параметри сесії | Має бути вказані параметри "caId", "signatureType" та "cadesType". |
3 | Завантажити ключовий контейнер сесії | |
4 | Створення ЕП для даних (масова операція) | Має бути вказаний параметр "keyStorePassword" та "dataToSign". |
5 | Видалити сесію |
Створення КЕП для даних (масова операція) для для формату XAdES та контейнерів ASIC-S(E)
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | |
2 | Встановити параметри сесії | Вказати наступні параметри:
Параметр "caId" можна не вказувати, якщо в ключовому контейнері присутній сертифікат підписанта. |
3 | Завантажити ключовий контейнер сесії | |
4 | Створення ЕП для даних (масова операція) | При створенні вбудованого (ATTACHED) підпису формату XAdES в якості даних має бути завантажений xml-документ. Має бути вказаний параметр "keyStorePassword" та "dataToSign". |
5 | Видалити сесію |
Створення КЕП для гешів (масова операція)
Назва операції | Примітка | |
---|---|---|
1 | Створити сесію | |
2 | Встановити параметри сесії | Має бути вказаний параметр "caId". |
3 | Завантажити ключовий контейнер сесії | |
4 | Створення ЕП для гешів (масова операція) | |
5 | Видалити сесію |
Створення КЕП з ключами на МКМ Шифр-HSM
Порядок виконання усіх операцій аналогічний представленому у прикладах для файлових контейнерів. Відмінність полягає тільки в операції завантаження ключового контейнера сесії.
Назва операції | Примітка | |
---|---|---|
Завантажити ключовий контейнер сесії | В параметрі keyStoreUri має бути вказано URI токену. Тестовий токен:
|
Створення КЕП з ключами Depositsign
Підтримується лише для формату CAdES
Назва операції | Примітка | |
---|---|---|
1 | Отримати токен доступу до API Depositsign та ідентифікатор сховища ключів | Виконати метод API Depositsign: /api/v1/{clientId}/auth/login Тестовий обліковий запис:
Документація з 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 | Отримати дані КЕП | Блокуюча (синхронна) операція. |
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 строки. |
3 | Установить параметры сессии | Должен быть указан параметр "caId". |
4 | Загрузить ключевой контейнер сессии | |
5 | Загрузить сертификаты получателей | Необходим как минимум один сертификат получателя шифрованных данных. Сертификаты могут быть загружены в виде: двоичных данных, Base64 строки. |
6 | Шифровать | |
7 | Получить шифрованные данные | Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки. |
8 | Удалить сессию |
Шифрование с контролем состояния
Возможно использовать в случае пакетной обработки большого количества ресурсов (файлов).
Название операции | Примечания | |
---|---|---|
1 | Создать сессию | Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию. |
2 | Загрузить данные сессии | Могут быть загружены в виде: двоичных данных, Base64 строки. |
3 | Установить параметры сессии | Должен быть указан параметр "caId". |
4 | Загрузить ключевой контейнер сессии | |
5 | Загрузить сертификаты получателей | Необходим как минимум один сертификат получателя шифрованных данных. Сертификаты могут быть загружены в виде: двоичных данных, Base64 строки. |
6 | Шифровать | |
7 | Получить результат шифрования | Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса шифрования. |
8 | Получить шифрованные данные | Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки. |
9 | Удалить сессию |
Дешифрование
Название операции | Примечания | |
---|---|---|
1 | Создать сессию | Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию. |
2 | Загрузить данные сессии | Могут быть загружены в виде: двоичных данных, Base64 строки. |
3 | Установить параметры сессии | Должен быть указан параметр "caId". |
4 | Загрузить ключевой контейнер сессии | |
5 | Дешифровать | |
6 | Получить дешифрованные данные | Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки. |
7 | Удалить сессию |
Дешифрование с контролем состояния
Название операции | Примечания | |
---|---|---|
1 | Создать сессию | Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию. |
2 | Загрузить данные сессии | Могут быть загружены в виде: двоичных данных, Base64 строки. |
3 | Установить параметры сессии | Должен быть указан параметр "caId". |
4 | Загрузить ключевой контейнер сессии | |
5 | Дешифровать | |
6 | Получить результат дешифрования | Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса дешифрования. |
7 | Получить дешифрованные данные | Блокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки. |
8 | Удалить сессию |
Создание метки времени
Название операции | Примечания | |
---|---|---|
1 | Создать сессию | Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию. |
2 | Загрузить данные сессии | Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными |
3 | Установить параметры сессии | Пункты 3 и 4 могут выполняться в произвольном порядке. |
4 | Создать МВ | |
5 | Получить данные МВ | Блокирующая (синхронная) операция. |
6 | Удалить сессию |
Создание метки времени с контролем состояния
Возможно использовать в случае пакетной обработки большого количества ресурсов (файлов).
Название элемента | Примечания | |
---|---|---|
1 | Создать сессию | Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию. |
2 | Загрузить данные сессии | Могут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными |
3 | Установить параметры сессии | |
4 | Создать МВ | |
5 | Получить результат создания МВ | Неблокирующая (асинхронная) операция. Следует использовать для контроля состояния процесса создания МВ. |
6 | Получить данные МВ | Блокирующая (синхронная) операция. |
7 | Удалить сессию |
Проверка метки времени
Розширення КЕП
Назва операції | Примітка | |
---|---|---|
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 | Видалити сесію |