Table of Contents

maxLevel	2

Создание ЭП

Створення КЕП

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

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

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

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

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

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

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

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

...

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

...

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

Створення КЕП з контролем стану для формату 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	Встановити параметри сесії	Вказати наступні параметри: 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	Отримати дані КЕП	Блокуюча (синхронна) операція.
9	Видалити сесію

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

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

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

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

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

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

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

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

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

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

Назва операції

Примітка

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

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

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

keyStoreUri: cihsm://cipher-test-site/vhsm-53.46df7832
Password: 12345678

Створення КЕП з ключами 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	Отримати дані КЕП	Блокуюча (синхронна) операція.
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 токену. Тестовий токен: URI: cihsm://cipher-test-site/vhsm-53.46df7832 Password: 12345678
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 токену. Тестовий токен: URI: cihsm://cipher-test-site/vhsm-53.46df7832 Password: 12345678
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

...

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

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

Выполнить метод API Depositsign: /api/v1/{clientId}/auth/login

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

2Создать сессиюРекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.3Загрузить данные сессииМогут быть загружены в виде: двоичных данных, Base64 строки, HTML-формы c двоичными данными.4Установить параметры сессии5Загрузить ключевой контейнер сессииВ параметре keyStoreUri должен быть указан URI хранилища ключей (токена).
В параметре bearerToken должен быть указан токен доступа к API Depositsign.6Создать ЭП7Получить данные ЭПБлокирующая (синхронная) операция.8Удалить сессию

Page tree

Page History

Versions Compared

Old Version 17

New Version Current

Key

Создание ЭП

Створення КЕП

Створення КЕП

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

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

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

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

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

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

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

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

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

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

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

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

Перевірка КЕП

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

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

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

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

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

Проверка ЭП

Зашифровывание

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

Расшифровывание

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

Создание электронной метки времени

Создание электронной метки времени с контролем состояния

Проверка электронной метки времени

Получение данных о ключевом контейнере

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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