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