Page History

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

2

Загрузить данные сессии

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

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

3

Установить параметры сессии

Має бути вказаний

3

Должен быть указан параметр "caId".

4

Загрузить ключевой Завантажити ключовий контейнер сессии

Путь к аппаратному носителю с поддержкой PKCS#11, который подключен к компьютеру, на котором выполняется сервис, необходимо получить посредством запроса.

Адрес аппаратного носителя с поддержкой PKCS#11, необходимо загрузить с помощью запроса.

5

Создать ЭП

6

Получить данные ЭП

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

7

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

сесії

Шлях до апаратного носія з підтримкою PKCS#11, який підключено до комп'ютеру, на якому здійснюється сервіс, необхідно отримати завдяки запиту.

Адреса апаратного носія з підтримкою PKCS#11, необхідно завантажити за допомогою запиту.

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

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

4

5

6

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

7

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

Note

title	Увага

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

8

Створення ЕП з контролем стану за допомогою защищенного носія

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

Примітка

1

Рекомендується для кожного окремого ресурсу (файлу) створити окрему сесію.

2

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

3

Отримання списку підключених носіїв

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

4

5

6

7

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

8

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

Note

title	Увага

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

9

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

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

Примітка

1

Рекомендується для кожного окремого ресурсу (файлу) створити окрему сесію.

2

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

3

Має бути вказані параметри "caId", "signatureType" та "cadesType".

4

5

6

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

7

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

Note

title	Увага

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

8

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

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

Примітка

1

Рекомендується для кожного окремого ресурсу (файлу) створити окрему сесію.

2

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

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

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

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

Примітка

1

Рекомендується для кожного окремого ресурсу (файлу) створити окрему сесію.

2

Завантажені дані ЕП

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

3

Установить параметры сессии

Має бути вказаний

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

Примечания

1

Создать сессию

Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.

2

Загрузить данные ЭП

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

3

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

4

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

6

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

Note

title	Увага

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

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

.

7

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

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

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

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

Проверка ЭП

...

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

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

Note

title	Увага

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

8

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

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

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

	Назва операції	Примітка
1	Створити сесію	Рекомендується для кожного окремого ресурсу (файлу) створити окрему сесію.
2	Завантажити дані сесії	Можуть бути завантажені у вигляді: двійкових даних, Base64 рядки, HTML-форми з двійковими даними.
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	Створення ЕП для даних (масова операція)	Має бути вказаний параметр "keyStorePassword" та "dataToSign".
6	Видалити сесію

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

	Назва операції	Примітка
1	Створити сесію	Рекомендується для кожного окремого ресурсу (файлу) створити окрему сесію.
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	Створення ЕП для гешів (масова операція)	Має бути вказаний параметр "keyStorePassword" та "dataToSign".
6	Видалити сесію

Перевірка ЕП

	Назва операції	Примітка
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 рядкиМогут быть загружены в виде: двоичных данных, Base64 строки.
3	Установить параметры сессии	Встановити параметри сесії	Має бути вказаний Должен быть указан параметр "caId".
4	Загрузить ключевой Завантажити ключовий контейнер сессиисесії
5	Загрузить сертификаты получателей	Завантажити сертифікати отримувачів	Необхідно, як мінімум один сертифікат отримувача зашифрованих даних. Сертифікати можуть бути завантажені у вигляді: двійкових даних, Base64 рядкаНеобходим как минимум один сертификат получателя зашифрованных данных. Сертификаты могут быть загружены в виде: двоичных данных, Base64 строки.
6	Зашифровать Зашифрувати
7	Получить зашифрованные данные	Отримати зашифровані дані	Блокуюча (синхронна) операція. Можуть бути отримані у вигляді: двійкових даних, Base64 рядкаБлокирующая (синхронная) операция. Могут быть получены в виде: двоичных данных, Base64 строки.
8	Удалить сессию

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

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

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

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

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

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

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

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

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

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

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

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

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

...

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

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

...

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

...

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

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

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

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

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

Название операцииПримечания1Создать сессиюРекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию.2Установить параметры сессииДолжен быть указан

параметр "caId".

3

Загрузить ключевой

сессии

сесії
4

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

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

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

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

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

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

Название операцииПримечания


1

Создать сессию

Загрузить ключевой контейнер сессии4Получение данных сертификата5Удалить сессию

Рекомендуется для каждого отдельного ресурса (файла) создавать отдельную сессию

Рекомендується для кожного окремого ресурсу (файлу) створити окрему сесію.

2

Установить параметры сессииДолжен быть указан

Встановити параметри сесії	Має бути вказаний параметр "caId".
3

	Завантажити ключовий контейнер сесії
4	Отримання даних сертифікату
5	Видалити сесію

Генерація ключів

Генерація ключів з автоматичною відправкою сертифікатів до (К)НЕДП

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

Примітка

1

Отримання профілів генерації ключів

Отримати перелік доступних профілів генерації ключів.
Для кожного профілю генерації ключів отримати перелік полів та їх параметри (типове (default) значення, обов'язковість заповнення, ідентифікатор та інші).

2

Генерація нових ключів

Після успішного виконання запит або запити на сертифікат будуть відправлені до (К)НЕДП через проксі сервер, який вказаний у конфігурації Агента.

3

4