Versions Compared

Key

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

Table of Contents
maxLevel2

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

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


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

...


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

Створення

...

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


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

Створення

...

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

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

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

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

3Завантажити дані КЕП

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

Створення

...

множинної вбудованої КЕП

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


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

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

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

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

4Отримати список підтримуваних НПМЕПЗа результатами виконання запиту обрати НПМЕП та використовувати його ідентифікатор на етапах 5-6.
5Отримати список профілів власників ключівЗа результатами виконання запиту обрати профіль власника ключа та використати йога на етапі 6.

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

4Завантажити ключовий контейнер сесії
5Створити КЕП
6Отримати дані КЕП6Створити мобільну КЕП7Отримати дані мобільної КЕПБлокуюча (синхронна) операція.
87Видалити сесію

Створення

...

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

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


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

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

Завантажити дані КЕП

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

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

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

5Завантажити ключовий контейнер сесії
6Створити КЕП
7Отримати дані КЕПБлокуюча (синхронна) операція.
8Видалити сесію

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


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

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

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

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

4Отримати список підтримуваних НПМЕПЗа результатами виконнання запиту обрати НПМЕП та використовувтаи його ідентифікатор на етапах 5-6.5Отримати список профілів власників ключівЗа результатами виконання запиту обрати профіль власника ключа та використати йога на етапі 6.6Створити мобільну КЕП7Отримати дані мобільної КЕПБлокуюча (синхронна) операція.8Видалити сесію

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


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

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


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

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

5Отримати список підтримуваних НПМЕПЗа результатами виконнання запиту обрати НПМЕП та використовувтаи його ідентифікатор на етапах 6-7.6Отримати список профілів власників ключівЗа результатами виконання запиту обрати профіль власника ключа та використати йога на етапі 7.7Створити мобільну КЕП8Отримати дані мобільної КЕПБлокуюча (синхронна) операція.

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

...

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

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

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

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

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

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

URI
  • keyStoreUri:
 
-site/vhsm-53.2059a40a
  • Password: 12345678
  • 5Створити КЕП6Отримати дані КЕПБлокуюча (синхронна) операція.7Видалити сесію

    ...

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

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

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

    ...