| **Термін** | **Пояснення** |
| **Терміни, що стосуються функціонування компонентів системи «Трембіта»** | |
| Апаратний токен | Захищений носій особистих ключів, який містить особисті ключі, необхідні для функціонування криптографічних функцій шлюзу безпечного обміну |
| (Д)ЕІР | (Державний) електронний інформаційний ресурс |
| Каталог системи «Трембіта» | Програмний комплекс, який забезпечує накопичення, облік та відображення інформації про учасників системи електронної взаємодії державних електронних інформаційних ресурсів «Трембіта», суб’єктів електронної взаємодії, операторів, електронні інформаційні ресурси, програмні інтерфейси електронних інформаційних ресурсів, сервіси та електронні інформаційні взаємодії |
| КНЕДП | Кваліфікований надавач електронних довірчих послуг |
| ПЗ | Програмне забезпечення |
| Система електронної взаємодії державних електронних інформаційних ресурсів (система «Трембіта») | Інформаційно-телекомунікаційна система, призначена для автоматизації та технологічного забезпечення обміну електронними даними між Суб’єктами електронної взаємодії з електронних інформаційних ресурсів під час надання адміністративних послуг та здійснення інших повноважень відповідно до покладених на них завдань |
| Токен безпеки | Сутність у програмному забезпеченні UXP Security Server, що репрезентує сховище особистих ключів. Може бути як програмним, так і апаратним |
| ШБО | Шлюз безпечного обміну – сервер, на який встановлено програмне забезпечення UXP Security Server |
| UXP | Unified eXchange Platform – програмна платформа, на базі якої побудована система «Трембіта» |
| **Терміни, що описують суб'єктів системи «Трембіта»** | |
| Адміністратор системи «Трембіта» | Державне підприємство «Дія» (визначено постановою від 8 вересня 2016 р. №606 «Деякі питання електронної взаємодії державних електронних інформаційних ресурсів») |
| Держатель системи «Трембіта» | Міністерство цифрової трансформації України (визначено постановою від 8 вересня 2016 р. №606 «Деякі питання електронної взаємодії державних електронних інформаційних ресурсів») |
| Оператор | Учасник системи електронної взаємодії державних електронних інформаційних ресурсів «Трембіта», уповноважений суб’єктом електронної взаємодії на виконання функцій суб’єкта електронної взаємодії в межах побудови електронної інформаційної взаємодії |
| Отримувач реєстрової інформації | Суб’єкт електронної взаємодії, який відповідно до закону має право на отримання реєстрової інформації у порядку електронної інформаційної взаємодії публічних електронних реєстрів |
| Постачальник реєстрової інформації | Держатель публічного електронного реєстру та/або інформаційно-комунікаційної системи, який відповідно до закону надає отримувачу реєстрову інформацію, що є об’єктом електронної інформаційної взаємодії публічних електронних реєстрів |
| Суб’єкт електронної взаємодії | Власник (держатель) електронного інформаційного ресурсу, який уклав договір про приєднання до системи «Трембіта» та забезпечує електронну інформаційну взаємодію з іншими суб’єктами електронної взаємодії через систему «Трембіта» та може розміщувати сервіси та підсистеми на шлюзах безпечного обміну учасників системи «Трембіта». Суб’єкти електронної взаємодії можуть бути постачальниками та/або отримувачами реєстрової інформації. На одному ШБО Учасника може бути опубліковано інтерфейси прикладного програмування та/або вебклієнти не більше, ніж одного Суб’єкта електронної взаємодії |
| Учасник | Суб’єкт владних повноважень, суб’єкт господарювання, який уклав договір про приєднання до системи «Трембіта» |
**Важливо!** Вебсервіси постачальника та вебклієнти отримувача можуть здійснювати електронну взаємодію у промисловому середовищі системи «Трембіта» виключно після проходження успішної перевірки у тестовому середовищі системи «Трембіта».
Типовий набір локальних компонентів системи «Трембіта» в промисловому середовищі є наступним: - Шлюз безпечного обміну (віртуальна машина або фізичний сервер); - Сервер баз даних та архівування (віртуальна машина або фізичний сервер); - Сервер аналізу транзакцій (віртуальна машина або фізичний сервер); - Сервер моніторингу за працездатністю (віртуальна машина або фізичний сервер); - Сервер аналізу журналів подій (віртуальна машина або фізичний сервер); - Робоча(і) станція(ї) адміністратора (фізичний комп’ютер/ноутбук). Дана інструкція покриває процес інсталяції перелічених вище компонентів у промисловому середовищі за допомогою скрипта автоматизації встановлення та їх конфігурацію, а також технічні вимоги до апаратного забезпечення, налаштування мережевих схем. Для забезпечення безвідмовної взаємодії на рівні компонентів ядра організовано кластер із двох вузлів, а також Учасники повинні: - перевіряти рівень навантаження на шлюзи безпечного обміну, вебсервіси та вебклієнти; - (за потреби) створювати кластер із шлюзів безпечного обміну, вебсервісів та вебклієнтів. # 3. Ролі користувачів у компонентах суб'єктів системи "Трембіта" На рисунку 3.1 зображено рольову модель для локальних компонентів системи «Трембіта» з зазначенням того, яким чином відбувається доступ користувачів до програмного забезпечення локальних компонентів, зокрема ШБО, Серверу моніторингу за працездатністю, Серверу аналізу журналів подій, Серверу баз даних та архівування та Серверу аналізу транзакцій. [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-05/5P3wdDPGffQJz9Iz-viber-image-2024-05-24-03-11-16-530.png) Рисунок 3.1 – Рольова модель локальних компонентів системи «Трембіта» В таблиці 3.1 наведено детальні пояснення щодо кожної із зазначених вище ролей. Таблиця 3.1. Ролі користувачів в локальних компонентах системи «Трембіта»| Роль | Пояснення |
| Адміністратор локальних компонентів (системний адміністратор) | Користувач операційної системи, який має право на виконання команд з керування станом операційної системи та прикладного програмного забезпечення компонентів та керування станом їх безпеки. Роль існує на всіх типах компонентів та робочій станції адміністратора. Роль виконує уповноважений співробітник Оператора або Суб'єкта електронної взаємодії, якщо він самостійно встановлює та адмініструє власні локальні компоненти |
| Адміністратор вебсервісів | Користувач операційної системи компонента «Шлюз безпечного обміну», який не має права на інтерактивний вхід до командного інтерфейсу операційної системи компонента. Цей користувач має право на адміністрування прикладного програмного забезпечення шлюзу безпечного обміну через відповідний вебінтерфейс. Роль існує тільки на шлюзі безпечного обміну. Роль виконує уповноважений співробітник Оператора або Суб'єкта електронної взаємодії, якщо він самостійно встановлює та адмініструє власні локальні компоненти |
| Відповідальний за управління ключами | Користувач операційної системи компонента «Шлюз безпечного обміну», який не має права на інтерактивний вхід до командного інтерфейсу операційної системи компонента. Цей користувач має право на керування кваліфікованими електронними печатками власної організації через відповідний вебінтерфейс. Роль існує тільки на шлюзі безпечного обміну. Роль виконує уповноважений співробітник Суб’єкта електронної взаємодії |
| Відповідальний за аналіз транзакцій | Користувач операційної системи компонента «Сервер баз даних та архівування», який не має права на інтерактивний вхід до командного інтерфейсу операційної системи компонента. Цей користувач має право на перегляд та аналіз транзакцій за допомогою відповідного вебінтерфейсу. Роль існує тільки на сервері аналізу транзакцій (в тестовому та промисловому середовищах) та сервері баз даних та архівування (в промисловому середовищі). Роль виконує уповноважений співробітник Суб’єкта електронної взаємодії |
**Важливо!** IP-адреса не може бути такою самою, як для тестового середовища!
- налаштувати мережевий зв'язок згідно мережевої схеми, наведеної на рисунку 5.1. Для підключення до промислового середовища системи «Трембіта» установа, що планує стати **Оператором**, повинна виконати наступні попередні кроки: - укласти із Держателем системи «Трембіта» (Мінцифри) угоду про приєднання до системи «Трембіта» та подати Держателю заявку із відомостями про відповідальну особу (виконується на етапі підключення до тестового середовища); ‑ укласти договір з іншим Суб’єктом електронної взаємодії, який не планує самостійно встановлювати та адмініструвати власні локальні компоненти, на виконання його функцій в межах побудови електронної інформаційної взаємодії; -встановити та налаштувати локальні компоненти системи «Трембіта» в тестовому середовищі згідно Інструкції зі встановлення локальних компонентів системи «Трембіта» в тестовому середовищі за допомогою скрипта автоматизації встановлення або Інструкції зі встановлення локальних компонентів системи «Трембіта» в тестовому середовищі вручну; - провести тестування працездатності вебсервісів та вебклієнтів в тестовому середовищі системи «Трембіта»; - підготувати програмно-апаратне забезпечення під встановлення компонентів системи «Трембіта» в промисловому середовищі згідно таблиці 5.1, де вказані мінімальні вимоги до апаратних ресурсів; - виділити одну статичну зовнішню («білу/публічну») IP-адресу (може суміщатися з іншими сервісами організації, якщо необхідні TCP-порти вільні для використання). Також саме ця зовнішня статична IP-адреса має використовуватися шлюзом безпечного обміну для підключення до шлюзів інших організацій;**Важливо!** IP-адреса не може бути такою самою, як для тестового середовища.
- налаштувати мережевий зв'язок згідно правил, вказаних рисунку 5.1; - отримати промислову електронну печатку установи на захищеному носії особистих ключів в будь-якого сумісного кваліфікованого надавача електронних довірчих послуг. Перелік сумісних КНЕДП можна дізнатись у Адміністратора системи «Трембіта». При цьому, Учасник повинен організувати дві підмережі - сегмент демілітаризованої зони та захищений сегмент. Шлюз безпечного обміну повинен розміщуватися у сегменті демілітаризованої зони. Інші компоненти - у захищеному сегменті. Також у захищеному сегменті повинні бути розміщені вебсервіси та вебклієнти, що взаємодіють з шлюзом безпечного обміну.**Примітка.** В разі, якщо Учасник та Суб’єкт електронної взаємодії є різними юридичними особами, Суб’єкт електронної взаємодії повинен мати власну(і) робочу(і) станцію(ї) адміністратора для виконання поставлених завдань користувачами з ролями «Відповідальний за аналіз транзакцій» та «Відповідальний за управління ключами».
# 5.1. Підготовка до встановлення Встановлення усіх локальних компонентів системи «Трембіта» виконується Адміністратором локальних компонентів (системним адміністратором). Перелік, мінімальні апаратні характеристики та використовуване програмне забезпечення віртуальних машин (або фізичних серверів) необхідних для підключення до промислового середовища системи «Трембіта», наведені у таблиці 5.1. Таблиця 5.1 - Склад, призначення та мінімальні апаратні характеристики компонентів промислового середовища| Назва компоненту | Кількість ядер CPU | RAM, GB | HDD (OS + APP + логи), GB | Операційна система | Встановлене програмне забезпечення | Апаратний токен | Порти, доступні із мережі Інтернет |
| У сегменті демілітаризованої зони (DMZ) | |||||||
| Шлюз безпечного обміну / **UXP Security Server** | 8 | 8 | 64 | Ubuntu Server 18.04.4 LTS 64bit | UXP Security Server | Так | TCP 5500, 5577, 5599 |
| У захищеному сегменті мережі | |||||||
| Сервер баз даних та архівування / **PostgreSQL, UXP Verifier** | 2 | 4 | 96 | Ubuntu Server 18.04.4 LTS 64bit | PostgreSQL 10, UXP Verifier | Ні | Ні |
| Сервер аналізу транзакцій / **Kibana, Elasticsearch** | 2 | 4 | 64 | Ubuntu Server 18.04.4 LTS 64bit | Kibana, Elasticsearch | Ні | Ні |
| Сервер моніторингу за працездатністю / **Zabbix** | 2 | 4 | 64 | Ubuntu Server 18.04.4 LTS 64bit | Zabbix | Ні | Ні |
| Сервер аналізу журналів подій / **Elasticsearch, graylog** | 2 | 4 | 320 | Ubuntu Server 18.04.4 LTS 64bit | Elasticsearch, graylog | Ні | Ні |
| Робоча станція адміністратора / **UXP UA Adminserver** | 2 | 4 | 64 | Ubuntu Desktop 18.04.4 LTS 64bit | UXP UA Adminserver | Ні | Ні |
**Примітка.** Обов’язково під час встановлення програмного забезпечення всі зазначені компоненти повинні мати мережевий доступ до репозиторію з програмним забезпеченням учасника системи «Трембіта». Також необхідно звернути увагу на порт підключення до репозиторію – TCP/8081.
Шлюз безпечного обміну повинен бути доступним з мережі Інтернет. Зокрема, із мережі Інтернет мають бути доступні вказані в таблиці 5.1 TCP порти, через які відбувається обмін електронними повідомленнями між шлюзами безпечного обміну учасників системи «Трембіта». ШБО використовує два типи токенів безпеки – програмні та апаратні (рис. 5.2). Програмний токен безпеки (який створюється в процесі ініціалізації нового ШБО) використовується для зберігання ключів автентифікації. Апаратні використовуються для зберігання ключів підписання та шифрування та підключаються до апаратного забезпечення, на базі якого функціонує ШБО. [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-05/SkXK15nf5ObNLy2i-screenshot-2024-05-27-173120.png) Рисунок 5.2 - Приклад зовнішнього вигляду захищених носіїв особистих ключів Шлюз безпечного обміну, сервер аналізу журналів подій, сервер баз даних та архівування функціонують на базі операційної системи Ubuntu Server 18.04.4 x64, яку потрібно встановити на відповідні віртуальні машини. Завантажити інсталяційний образ можна з репозиторію системи «Трембіта». Процес інсталяції даної операційної системи наведено в [Інструкції з інсталяції операційної системи Ubuntu Server 18.04.4 x64](https://docs.trembita.gov.ua/books/instrukciia-z-instaliaciyi-operaciinoyi-sistemi-ubuntu-server-18044-x64). Після завершення інсталяції Адміністратор локальних компонентів (системний адміністратор) може підключитися до консолі (командного інтерфейсу) операційної системи інших локальних компонентів, наприклад, за допомогою виконання наступної команди: ``` ssh**Примітка****.** При введенні паролю (password), символи, що вводяться, не відображаються на екрані – це стандартна поведінка операційної системи з паролями.
**Примітка****.** При використанні команди sudo після першого входу користувача в операційну систему буде запитано пароль цього користувача для підтвердження адміністративних повноважень у системі.
Програмне забезпечення робочої станції адміністратора функціонує на базі операційної системи Ubuntu Desktop 18.04.4 LTS x64, яку потрібно встановити на робочу станцію адміністратора. Завантажити інсталяційний образ можна з репозиторію системи «Трембіта». Процес інсталяції даної операційної системи наведено в [Інструкції з інсталяції операційної системи Ubuntu Desktop 18.04.4 x64](https://docs.trembita.gov.ua/books/instrukciia-z-instaliaciyi-operaciinoyi-sistemi-ubuntu-desktop-18044-x64). # 5.2. Налаштування мережевих параметрів Після інсталяції операційної системи необхідно налаштувати мережеві параметри на всіх компонентах (робочій станції адміністратора, ШБО, сервері аналізу журналу подій, сервері баз даних та архівування) згідно спланованих мережевих адрес. Налаштування IP-адреси в операційній системі Ubuntu Server 18.04.4 LTS здійснюється Адміністратором локальних компонентів (системним адміністратором) у файлі /etc/netplan/50-cloud-init.yaml (або іншому файлі \*.yaml у директорії /etc/netplan/): ``` sudo nano /etc/netplan/50-cloud-init.yaml ``` Приклад налаштувань для динамічної IP-адреси (за DHCP) має наступний вигляд: ``` network: version: 2 ethernets: ens160: dhcp4: true ``` де ens160 – системне ім’я мережевого адаптеру, що налаштовується. Дізнатися його можна за допомогою виконання наступної команди: ``` dmesg|grep eth ``` Приклад налаштувань для статичної IP-адреси має наступний вигляд: ``` network: version: 2 ethernets: ens160: dhcp4: no addresses: [192.168.1.181/24] gateway4: 192.168.1.1 nameservers: addresses: [192.168.1.1,8.8.8.8] ``` де ens160 – системне ім’я мережевого адаптеру, що налаштовується. Дізнатися його можна за допомогою виконання наступної команди: ``` dmesg|grep eth ``` **addresses** – перелік IP-адрес, які будуть встановлені для цього мережевого адаптера, **gateway4** – IP-адреса основного шлюза, блок **nameservers addresses** – перелік IP-адрес серверів імен, які використовуватимуться для визначення IP-адрес за DNS-іменами вузлів мережі.**Примітка****.** Конкретні значення параметрів у конкретному випадку можуть бути іншими.
**Примітка****.** Якщо віртуальна машина була клонована з метою пришвидшення процесу інсталяції, необхідно змінити ім’я вузла у наступних файлах: /etc/hosts та /etc/hostname.
--- Налаштування мережевих параметрів в операційній системі Ubuntu Desktop 18.04 здійснюється Адміністратором локальних компонентів (системним адміністратором) через графічний інтерфейс згідно документації на операційну систему Ubuntu Desktop 18.04 LTS x64. В процесі налаштування необхідно задати статичну IP-адресу та переконатись в наявності доступу до мережі Інтернет після її налаштування. --- Також після завершення мережевих налаштувань потрібно відключити функції автоматичного оновлення пакетів. Для цього потрібно: 1. Відкрити файл /etc/apt/apt.conf.d/10periodic за допомогою виконання наступної команди: ``` sudo nano /etc/apt/apt.conf.d/10periodic ``` 2. Встановити значення «0» для параметру «APT::Periodic::UpdatePackage-Lists»: ``` APT::Periodic::Update-Packages-Lists "0"; ``` 3. Закрити редактор, натиснувши комбінацію клавіш «Ctrl+X», буде відображено повідомлення про підтвердження на збереження змін – необхідно натиснути «Y», а потім «Enter» для збереження. 4. Відкрити файл /etc/update-manager/release-upgrades за допомогою виконання наступної команди: ``` sudo nano /etc/update-manager/release-upgrades ``` 5. Встановити значення «never» для параметру «Prompt»: ``` Prompt=never ``` 6. Закрити редактор, натиснувши комбінацію клавіш «Ctrl+X», буде відображено повідомлення про підтвердження на збереження змін – необхідно натиснути «Y», а потім «Enter» для збереження. 7. Перезавантажити операційну систему командою: ``` sudo shutdown -r now ``` Після завершення налаштування мережі необхідно встановити антивірусне програмне забезпечення на всіх компонентах (наприклад, Falcon).**Важливо!** Перед виконанням наступних кроків рекомендується зробити резервну копію стану віртуальних машин (snapshot).
# 6. Встановлення компонентів за допомогою скрипта автоматизації встановлення Скрипт автоматизації встановлення призначений для інсталяції необхідного програмного забезпечення на всі локальні компоненти системи «Трембіта», які попередньо сконфігуровані відповідно до розділу 5 даної інструкції. # 6.1. Початкове налаштування робочої станції адміністратора #### 6.1.1. Завантаження на робочу станцію адміністратора скрипта автоматизації встановлення Скрипт автоматизованого встановлення можна завантажити за посиланням [https://portal.trembita.gov.ua/media/website-media/trembita\_installation1\_12\_6.zip](https://portal.trembita.gov.ua/media/website-media/trembita_installation1_12_6.zip). Після завантаження необхідно розархівувати завантажений архів до домашньої директорії (/home/**<****username****>**). --- #### 6.1.2. Завантаження файлу ліцензії та якоря конфігурації для роботи шлюзу безпечного обміну Для роботи шлюзу безпечного обміну в промисловому середовищі необхідні діюча ліцензія та якір конфігурації для промислового середовища. ШБО не працюватиме без даних файлів. Файли ліцензії (файл *member.live.license.lic*) та якоря конфігурації (файл *configuration anchor*) для промислового середовища можна знайти в Особистому кабінеті Каталогу системи «Трембіта» розділ «Адміністрування», вкладка «Матеріали». З даними файлами необхідно виконати наступні дії: 1. Завантажити файл ліцензії промислового середовища *member.live.license.lic* на робочу станцію адміністратора та перейменувати його на *license.lic*; 2. Завантажити файл якоря конфігурації промислового середовища на робочу станцію адміністратора та перейменувати його на *configuration-anchor.xml*; 3. Перемістити файли *license.lic* та c*onfiguration-anchor.xml* до директорії ~*/trembita\_installation/sec\_serv\_config/* робочої станції адміністратора.| Текст помилки | Шляхи виправлення |
| Не вистачає привілеїв. | Команда python3 run.py повинна запускатися з привілеями sudo чи від імені користувача root |
| УВАГА! Не можу підключитися до сервера! | Логін, пароль чи IP-адреса помилкові, скрипт не може встановити SSH-сесію з сервером. Перевірити та вказати правильний логін, пароль та IP-адресу відповідного компоненту |
| Server OS version FAIL!!!! | Версія операційної системи відрізняється від Ubuntu 18.04, встановлення не може бути продовжене. Необхідно встановити операційну систему Ubuntu Server 18.04.4 LTS 64bit |
| Playbook for server fail! | Сталася непередбачувана помилка під час встановлення, збережіть дані з терміналу для подальшого аналізу. |
**Важливо!** В промисловому середовищі системи «Трембіта» доступ до її локальних компонентів має здійснюватися з використанням веббраузеру Mozilla Firefox або SSH виключно через Робочу станцію адміністратора відповідно до рольової моделі, [наведеної на рисунку 3.1](https://docs.trembita.gov.ua/link/177#bkmrk-%D0%A0%D0%B8%D1%81%D1%83%D0%BD%D0%BE%D0%BA-3.1-%E2%80%93-%D0%A0%D0%BE%D0%BB%D1%8C%D0%BE%D0%B2) даної інструкції.
Для того, щоб створити новий обліковий запис користувача, що зможе авторизуватися на Робочій станції адміністратора, необхідно в командній консолі даної робочої станції: 1. Виконати команду: ``` sudo uxp-ua-add-admin-user.sh**Важливо!** В разі, якщо виникає необхідність роботи з вебінтерфейсом ШБО у декількох співробітників Учасника системи "Трембіта", кожен з них обов'язково повинен мати власний обліковий запис!
Шлюз безпечного обміну використовує локальних користувачів і групи операційної системи для контролю доступу до вебінтерфейсу адміністрування шлюзу безпечного обміну. Обліковий запис, що використовується для входу в вебінтерфейс адміністрування шлюзу безпечного обміну – це обліковий запис Адміністратора вебсервісів (за замовчуванням з логіном uxpadmin). Для створення додаткового Адміністратора вебсервісів, Адміністратору локальних компонентів (системному адміністраторові) необхідно: 1. Послідовно виконати наступні команди: ``` sudo useradd -M -N**Примітка.** При першому доступі до вебінтерфейсу ШБО може з’явитись попередження про те, що використовується сертифікат, виданий недовіреним центром сертифікації. При встановленні шлюзу безпечного обміну використовується самопідписаний сертифікат, тому слід додати виняток для цього сертифікату у браузері.
**Примітка.** У перші хвилини після перезапуску шлюзу безпечного обміну вебінтерфейс ШБО може відображати повідомлення «502 Bad Gateway» (зазвичай менше однієї хвилини). Необхідно періодично оновлювати сторінку авторизації, поки не відобразиться форма входу.
Після чого відкриється вікно ініціалізації ШБО:  Для ініціалізації ШБО необхідно заповнити наступні дані:| Власник сервера безпеки (Security Server Owner) | |
| Клас Учасника (Member Class) | GOV |
| Код Учасника (Member Code) | У якості коду Учасника використовується код ЄДРПОУ організації, яка є Учасником системи «Трембіта».
**Важливо!** Якщо ввести неправильний Member Code, то шлюз безпечного обміну не буде функціонувати коректно і його потрібно буде переінсталювати! |
| Ім’я Учасника (Member Name) | Ім'я Учасника автоматично отримується з сервера Каталогу Учасників (після введення коду Учасника) відповідно до заявки на реєстрацію Учасника у системі «Трембіта». |
| Шлюз безпечного обміну (Security Server) | |
| Код сервера безпеки (Security Server Code) | Унікальний код ШБО («сервера безпеки» в вебінтерфейсі) в промисловому середовищі системи «Трембіта», який потрібно створити відповідно до наступного шаблону:
**MemberCode\_SS\_P\_Number\_FreeSymbols**, де:
**MemberCode** – код ЄДРПОУ організації;
**SS** – означення ШБО (security server);
**P** – абревіатура промислового середовища системи, не змінюється;
**Важливо!** Варто звернути увагу, що \_SS\_P\_ потрібно вводити великими латинськими літерами з використанням символу нижнього підкреслення «\_». **Number** – порядковий номер ШБО організації;**Примітка.** Нумерація ШБО для тестового та промислового середовищ системи незалежна. **FreeSymbols** – (за потреби) цифри та літери, які можна додавати до ідентифікатора ШБО задля власної зручності (наприклад, позначення центру обробки даних, позначення інформаційної системи, в якій використовується ШБО тощо).**Важливо!** Додаткові символи повинні містити лише цифри та великі літери англійського алфавіту. |
| Програмний токен (Software Token) | |
| PIN | Необхідно придумати PIN-код, який буде використаний для захисту ключів автентифікації, що зберігаються у програмному сховищі (файловій системі ОС).
**Важливо!** Адміністратор вебсервісів має зберігати PIN-код у безпечному місці, оскільки після втрати PIN-коду необхідно відновлювати токен, повторно видавати та реєструвати новий сертифікат автентифікації. |
| Повторити PIN | Ввести повторно значення PIN-коду. |
**Примітка.** Варто звернути увагу, що на шлюзі безпечного обміну в промисловому середовищі працює модуль контролю цілісності. Необхідно перевіряти значення таймеру у верхній частині сторінки. Якщо користувач не встигатиме завершити необхідні налаштування, він має натиснути на кнопку «Перевірка цілісності призупинена на ## хв», щоб отримати більше часу. Після завершення налаштувань обов’язково потрібно натиснути на кнопку «Оновити ГОСТ-ХЕШ».
**Важливо!** Якщо користувач не встиг виконати всі необхідні налаштування та зберегти зміни шляхом оновлення ГОСТ-хешу, модуль контролю цілісності може призупинити роботу сервісів шлюзу безпечного обміну, а вебінтерфейс адміністрування стане недоступним. У цьому випадку Адміністратору локальних компонентів (системному адміністраторові) необхідно виконати наступні команди в командному інтерфейсі ШБО:
``` sudo uxp-ua-integritychecker.sh recalc_all sudo uxp-ua-integritychecker.sh check sudo uxp-ua-integritychecker.sh start_all ``` --- #### 7.1.3. Налаштування сервера позначок часу Шлюз безпечного обміну використовує зовнішню службу встановлення позначок часу (timestamping) для встановлення позначок часу на кожне повідомлення. ШБО може мати декілька довірених служб позначок часу. Адміністратор вебсервісів може обрати, які служби позначок часу будуть використовуватися даним ШБО (зазвичай, це служба, створена відповідним надавачем електронних довірчих послуг, у якого організація отримала сертифікати печатки та шифрування). Необхідно додати цю службу в список служб встановлення позначок часу, використовуваних шлюзом безпечного обміну, наступним чином: 1. Перейти в розділ «Параметри системи». Список серверів позначок часу має бути порожнім («Немає (відповідних) записів»). 2. Натиснути на кнопку «Додати» в секції «Сервіси позначки часу». 3. Обрати зі списку доступний сервіс і натиснути на нього. 4. Натиснути на кнопку «OK». В результаті відобразиться інформація про обраний сервіс позначок часу і його URL в секції «Сервіси позначки часу». [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-04/oYzimage.png)**Важливо!** Повинен бути зазначений саме TSP-сервер видавця КНЕДП, де організація отримувала електронну печатку!
# 7.2. Підключення захищених носіїв особистих ключів (апаратних токенів) Шлюз безпечного обміну накладає електронну печатку на кожне повідомлення (здійснює його підписання), що відправляється до іншого шлюзу безпечного обміну через систему «Трембіта». Підписання здійснюється з використанням кваліфікованого сертифікату електронної печатки, який було отримано на підготовчих кроках від кваліфікованого надавача електронних довірчих послуг. В промисловому середовищі системи «Трембіта» є обов’язковим використання апаратних токенів або HSM-пристроїв. Захищений носій особистих ключів (апаратний токен), на якому знаходяться особисті ключі електронної печатки та шифрування необхідно правильно підключити до віртуальної машини шлюзу безпечного обміну. За дану дію відповідає Адміністратор локальних компонентів (системний адміністратор). За налаштування використання криптографічних ключів та сертифікатів печатки в цілому відповідає працівник Учасника, що є власником ШБО. За налаштування використання криптографічних ключів та сертифікатів **печатки** в цілому відповідає працівник **Учасника**, що є власником ШБО. За налаштування використання криптографічних ключів та сертифікатів **печатки Суб’єкта електронної взаємодії** відповідає користувач з роллю Відповідальний за управління ключами Суб’єкта електронної взаємодії через вебінтерфейс ШБО.**Важливо!** Паролі до ключів та сертифікатів печатки Суб’єкта електронної взаємодії вводяться через вебінтерфейс шлюзу безпечного обміну Відповідальним за управління ключами та не повинні передаватися співробітникам Оператора та іншим третім особам.
--- ##### 7.2.1. Налаштування CMP-сервісу кваліфікованого надавача електронних послуг Для того, щоб шлюз безпечного обміну мав можливість працювати з КНЕДП, що видав сертифікати, необхідно додати інформацію про нього у спеціальний файл, для чого необхідно: 1. Відкрити даний файл за допомогою виконання наступної команди: ``` sudo nano /etc/uxp/uac/osplm.ini ``` 2. Знайти розділ (у квадратних дужках визначаються розділи) з налаштуваннями CMP-сервісу та встановити наступні параметри доступу: ``` [\SOFTWARE\Institute of Informational Technologies\Certificate Authority-1.3\End User\CMP] Use=1 CommonName= Address= ca-test.czo.gov.ua Port=80 ``` 3. У поле Address необхідно вказати адресу до сервісу CMP КНЕДП, що видав сертифікати (наприклад, ca.informjust.ua, ca.iit.com.ua тощо, залежно від КНЕДП). Зазначену адресу може надати, зокрема, надавач електронних довірчих послуг або її можна дізнатись з веб інтерфейсу ШБО на вкладці «Параметри системи» в секції «Сервіси позначки часу» (який було вказано в розділі 7.1.3 даної інструкції). Приклад результату модифікації файлу: [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-04/jZ8image.png) --- ##### 7.2.2. Встановлення підтримки захищених носіїв особистих ключів (апаратних токенів) Встановлення підтримки захищених носіїв особистих ключів (апаратних токенів) виконується Адміністратором локальних компонентів (системним адміністратором). Шлюз безпечного обміну версії 1.12.6 підтримує наступні захищені носії особистих ключів: 1. Апаратні токени: - Алмаз-1К; - Автор Secure Token 337; - Автор Secure Token 338; - EfitKey; - Кристал-1; 2. Мережеві криптомодулі: - ІІТ Гряда-301; - Сайфер «Шифр-HSM». Апаратний токен (захищений носій особистих ключів) необхідно підключити до фізичного обладнання – сервера, який забезпечує функціонування ПЗ шлюзу безпечного обміну. Якщо використовується система віртуалізації на сервері – потрібно налаштувати адресацію фізичного порту, до якого підключений апаратний токен, до віртуальної машини шлюзу безпечного обміну. Правильність адресації можна перевірити через наявність інформації про ключі у операційній системі, для чого потрібно виконати наступну команду на шлюзі безпечного обміну: ``` sudo dmesg | grep usb ``` [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-04/x82image.png) З результату виконання команди можна побачити, що в системі присутні два апаратних токени – Product: IIT E.Key Crystal-1 та Product: E.Key Almaz-1C – відповідно «Кристал-1» та «Алмаз-1К». Для роботи усіх апаратних токенів необхідно встановити пакети підтримки електронних ключів операційною системою Linux, а саме Ubuntu 18.04 Server 64bit: ``` sudo apt-get install pcscd libccid pcsc-tools libccid libpcsclite1 opensc ``` ##### 7.2.2.1. Налаштування Алмаз-1К Додаткових налаштувань, крім встановлення пакетів підтримки електронних ключів операційною системою Linux, виконувати не потрібно. ##### 7.2.2.2. Налаштування Автор Secure Token 337/ Secure Token 338 Для зазначених токенів Автор необхідно: 1. Завантажити драйвер для 64-розрядної ОС Linux за допомогою виконання наступної команди: ``` wget https://project-repo.trembita.gov.ua:8081//files/t1/libav337p11d.so ``` 2. Перемістити завантажений файл у директорію /usr/lib/: ``` sudo cp libav337p11d.so /usr/lib/ ``` 3. Перевірити доступність токену в системі можна за допомогою виконання наступної команди: ``` sudo pkcs11-tool -v --list-slots --module /usr/lib/libav337p11d.so ``` У випадку, якщо ключ доступний для системи, має бути виведено інформацію про нього, наприклад: [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-04/sfGimage.png) ##### 7.2.2.3. Налаштування EfitKey При використанні захищеного носія EfitKey необхідно виконати наступні дії: 1. Скорегувати файл Info.plist, для того, щоб додати (включити) існуючий PCSC-пристрій (токен EfitKey) до відповідного списку PCSC-пристроїв, які підтримуються системою, відкривши його за допомогою виконання наступної команди: ``` sudo nano /usr/lib/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist ``` 2. Знайти строку «<key>ifdVendorID</key>» і після елементу «<array>» додати: ``` «**Примітка.** Для роботи libefitkeynxt.so і EfitKey необхідно мати запущений демон pcscd.
6. Під’єднати захищений носій ключової інформації EfitKey та перевірити доступність носія в системі: ``` sudo pkcs11-tool -v --list-slots --module /usr/lib/libefitkeynxt.so ``` У випадку, якщо ключ доступний для системи, має бути виведено інформацію про нього, наприклад: [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-04/gBMimage.png) ##### 7.2.2.4. Налаштування Кристал-1 При використанні токену «Кристал-1» необхідно виконати наступні дії: 1. Створити файл /etc/udev/rules.d/80-uxp-iit-e-keys.rules за допомогою виконання наступної команди: ``` sudo nano /etc/udev/rules.d/80-uxp-iit-e-keys.rules ``` 2. Прописати в ньому наступні правила: ``` SUBSYSTEM=="usb", ATTR{idVendor}=="03eb", ATTR{idProduct}=="9301", MODE="0660", GROUP="uxp" SUBSYSTEM=="usb", ATTR{idVendor}=="03eb", ATTR{idProduct}=="9308", MODE="0660", GROUP="uxp" ``` 3. Перевірити, чи встановлено бібліотеку libusb-0.1-4 за допомогою виконання наступної команди: ``` sudo apt list --installed | grep libusb-0.1-4 ``` У випадку, якщо бібліотеку не встановлено, встановити її за допомогою виконання наступної команди: ``` sudo apt-get install libusb-0.1-4 ``` ##### 7.2.2.5. Налаштування ІІТ Гряда-301 При використанні токену безпеки ІІТ «Гряда-301» необхідно виконати наступні дії: 1. Відкрити файл /etc/uxp/uac/osplm.ini за допомогою виконання наступної команди: ``` sudo nano /etc/uxp/uac/osplm.ini ``` 2. Додати в нього наступний блок параметрів: ``` [\SOFTWARE\Institute of Informational Technologies\Key Medias\NCM Gryada-301] [\SOFTWARE\Institute of Informational Technologies\Key Medias\NCM Gryada-301\Modules] [\SOFTWARE\Institute of Informational Technologies\Key Medias\NCM Gryada-301\Modules\**Примітка.** Дана бібліотека поставляється компанією-виробником разом з токеном безпеки.
Після цього необхідно виконати наступні кроки: 1. Змінити права доступу до бібліотеки за допомогою виконання наступної команди: ``` chmod 644 /var/tmp/uxp/EUSign-x64-1.3.263/libcihsm.so ``` 2. Впевнитись, що шлюз безпечного обміну має підключення до модулю «Шифр-HSM» за допомогою виконання наступної команди: ``` PKCS11_PROXY_SOCKET=tcp://**Примітка.** Якщо після виконання команди було отримано помилку CKR\_USER\_ALREADY\_LOGGED\_IN, необхідно видалити розділ входу -l --pin <PIN Code> з попередньої команди.
5. Скопіювати сертифікат з попереднього кроку та сертифікат КНЕДП в директорію /etc/uxp/uac/certificates/. 6. Перезавантажити сервіс uxp-signer за допомогою виконання наступної команди: ``` sudo systemctl restart uxp-signer ``` Після проведених дій з обраним ключем обов’язково необхідно перезавантажити операційну систему: ``` sudo shutdown -r now ``` Після чого використовуваний ключ повинен з’явитись в вебінтерфейсі ШБО в розділі «Ключі і сертифікати». # 7.3. Реєстрація шлюзу безпечного обміну ##### 7.3.1. Імпорт ключа підпису та шифрування Для імпорту ключа підпису та шифрування потрібно мати згенеровані ключі печатки та шифрування та відповідні сертифікати, видані одним з КНЕДП, що підтримуються системою «Трембіта». Отримання сертифікатів виконується на підготовчому етапі підключення до системи. Ключі електронної печатки та шифрування можуть зберігатися на програмних захищених носіях особистих ключів, які повинні бути підключені та налаштовані згідно розділу 7.3.3. Для імпорту ключів електронної печатки та шифрування на ШБО потрібно виконати наступні дії в його вебінтерфейсі: 1\. Перейти в розділ «Ключі і сертифікати». 2\. Ввести PIN-код до сховища ключів uacToken (це PIN-код до особистого ключа, що імпортований з ZIP-архіву). 3\. Навпроти кожного сертифікату натиснути кнопку «Імпортувати».**Примітка.** У випадку використання апаратного модулю Сайфер «Шифр-HSM», PIN-код токену вводиться в форматі ##slot\_id##password. Наприклад ##231036361##1234567890.
--- ##### 7.3.2. Створення ключа автентифікації для шлюзу безпечного обміну Шлюз безпечного обміну повинен автентифікуватися при відправці повідомлень до інших шлюзів безпечного обміну. Сертифікат автентифікації використовується для перевірки автентичності шлюзу безпечного обміну. За створення ключа автентифікації та подальші дії з ним відповідає Адміністратор вебсервісів. Для того, щоб створити новий ключ автентифікації у вебінтерфейсі шлюзу безпечного обміну, необхідно: 1. Перейти в розділ «Ключі і сертифікати». 2. Обрати токен «softToken-0», натиснувши на ньому мишкою. 3. Натиснути на кнопку «Генерувати ключ». 4. Ввести позначку для ключа автентифікації. Рекомендовано ввести позначку – authKey. 5. Натиснути на кнопку «OK». Генерація ключа може зайняти кілька секунд. Якщо все зроблено вірно, щойно створений ключ з’явиться під токеном безпеки з написом «authKey (?)».  --- ##### 7.3.3. Генерація запиту на сертифікат (Certificate Signing Request) ключа автентифікації Сертифікати автентифікації, які використовуються шлюзами безпечного обміну, повинні бути підписані технологічним центром сертифікації ключів промислового середовища системи «Трембіта». Для цього спочатку необхідно створити запит на підпис сертифікату (Certificate Signing Request (CSR)) для попередньо створеного ключа через вебінтерфейс ШБО. Центр сертифікації приймає заявки на підпис у вигляді файлів в текстовому форматі PEM. Для створення запиту необхідно виконати наступні дії в вебінтерфейсі ШБО: 1. Перейти в розділ «Ключі і сертифікати». 2. Вибрати ключ автентифікації, згенерований на попередньому кроці (authKey). 3. Натиснути на кнопку «Генерувати CSR» – відкриється діалог «Створити запит на підпис сертифіката». 4. У діалоговому вікні необхідно встановити наступні значення:| Поле | Значення |
| Використання (Usage) | Auth |
| Сервіс сертифікації (Certification Service) | Необхідно обрати технологічний центр сертифікації ключів промислового середовища системи – «Trembita Diia CA» |
| CSR Format | PEM |
**Важливо!** Без цього сертифікату подальші кроки неможливі!
--- ##### 7.3.5. Імпорт сертифікату для ключа автентифікації на шлюз безпечного обміну Для імпорту виданого на попередньому кроці сертифікату автентифікації до шлюзу безпечного обміну Адміністратору вебсервісів потрібно виконати наступні дії в вебінтерфейсі ШБО: 1. Перейти в розділ «Ключі і сертифікати». 2. Натиснути на кнопку «Імпорт сертифікату». 3. Натиснути на кнопку «Переглянути» і обрати сертифікат автентифікації, отриманий на попередньому кроці. 4. Натиснути на кнопку «OK». Якщо все зроблено правильно, у вебінтерфейсі ШБО буде відображена інформація про доданий сертифікат під ключем автентифікації «Ключ: authKey». --- ##### 7.3.6. Активація сертифікатів автентифікації та підпису На цьому етапі сертифікати автентифікації та електронної печатки вже імпортовані до шлюзу безпечного обміну, однак, вони за замовчуванням відключені (в колонці «OCSP-відповідь» для сертифікату вказано «відключений»).**Важливо!** Відключені сертифікати не використовуються шлюзом безпечного обміну.
Для їх активації Адміністратору вебсервісів необхідно виконати наступні дії в вебінтерфейсі шлюзу безпечного обміну: 1. Перейти в розділ «Ключі і сертифікати». 2. Обрати сертифікат автентифікації, який імпортовано на попередньому кроці (наступний рядок під «Ключ: authKey», з числовим серійним номером). 3. Натиснути на кнопку «Активувати». 4. Вибрати сертифікат печатки (під рядком «Ключ: uaToken-sign (sign)»). Натиснути на кнопку «Активувати». --- ##### 7.3.7. Відправка запиту на реєстрацію сертифікатів Сертифікат автентифікації використовується іншими шлюзами безпечного обміну для перевірки автентичності ШБО конкретного Учасника. Для цього шлюзи безпечного обміну повинні обмінятися зареєстрованими сертифікатами автентифікації та довіряти їм. Довірені сертифікати автентифікації поширюються через сервер Каталогу Учасників системи «Трембіта». Адміністратор системи «Трембіта» повинен перевірити отриманий запит на реєстрацію і, якщо запит дійсний, додати сертифікат автентифікації у перелік зареєстрованих у промисловому середовищі системи «Трембіта». Варто звернути увагу, що статус сертифіката автентифікації, який імпортовано в попередньому стані, «збережений», а не «зареєстровано». Це означає, що цей сертифікат ще не був відправлений на реєстрацію до серверу Каталогу Учасників. Для реєстрації сертифікату автентифікації та сертифікату шифрування Адміністратор вебсервісів у вебінтерфейсі ШБО повинен виконати наступні дії: 1. Перейти в розділ «Ключі і сертифікати». 2. Вибрати сертифікат шифрування (рядок під «Ключ: uaToken-encr (encr)»). 3. Натиснути на кнопку «Зареєструвати». Якщо всі попередні кроки виконані успішно, буде відображено повідомлення зеленого кольору з інформацією, що запит надіслано успішно, а також статус сертифіката шифрування повинен стати «в процесі реєстрації». 4. Обрати сертифікат автентифікації, який імпортовано на попередньому кроці. 5. Натиснути на кнопку «Зареєструвати». Відкриється діалог «Запит на реєстрацію». 6. Ввести загальнодоступну («білу/публічну») IP-адресу шлюзу безпечного обміну (яка доступна через мережу Інтернет, була виділена для цього шлюзу безпечного обміну та налаштована на підготовчих кроках) або відповідне DNS-ім’я та натиснути на кнопку «OK». Якщо все зроблено коректно, статус сертифіката автентифікації повинен стати «в процесі реєстрації». Це означає, що запит був успішно відправлений шлюзом безпечного обміну. Наступним кроком є подача заявки на реєстрацію шлюзу безпечного обміну засобами Особистого кабінету Каталогу системи «Трембіта» (**Реєстрація ШБО в ядрі системи (Промислове середовище)**). Порядок подання зазначеної заявки вказаний в п. 7.3.4 Регламенту роботи системи «Трембіта». Адміністратор системи «Трембіта» повинен обробити заявку та підтвердити запит. Коли запит на реєстрацію буде схвалено, статус сертифікату автентифікації та сертифікату шифрування зміниться на «зареєстровано». Це може зайняти деякий час (з врахуванням часу обробки заявки), поки глобальна конфігурація не буде оновлена. Після отримання відповіді на заявку на реєстрацію шлюзу безпечного обміну можна перевірити сторінку «Ключі і сертифікати» у вебінтерфейсі шлюзу безпечного обміну. В разі необхідності можна оновлювати її. Оновлення глобальної конфігурації може зайняти декілька хвилин. Приклад вебінтерфейсу, коли всі сертифікати коректно зареєстровані: [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-04/ZtzXTQmu9KSZjKYp-lFTimage.png) # 7.4. Створення підсистем Щоб опублікувати сервіси або здійснювати запити до інших сервісів через систему «Трембіта» на шлюзі безпечного обміну Адміністратор вебсервісів повинен створити та зареєструвати принаймні одну підсистему, яка представлятиме реальну інформаційну систему Суб’єкта електронної взаємодії у тестовому середовищі системи «Трембіта». Для реєстрації підсистем у вебінтерфейсі шлюзу безпечного обміну необхідно виконати наступні дії: 1. Обрати розділ «Клієнти сервера безпеки» та натиснути на кнопку «Додати клієнта». 2. Обрати «Клас Учасника» – GOV. 3. Ввести в поле «Код Учасника» код ЄДРПОУ організації, яка є власником інформаційної системи (Суб’єкта електронної взаємодії).**Примітка.** При створенні кластера підсистему можна додати шляхом вибору її з глобального списку, натиснувши на відповідну кнопку в інтерфейсі – «Виберіть клієнта з глобального списку», знайти необхідну підсистему шляхом пошуку по коду підсистеми, після чого натиснути на кнопку «ОК».
4. Ввести назву підсистеми (правила іменування зазначені у розділі 6.3 Регламенту роботи системи «Трембіта»). 5. Натиснути послідовно на кнопки «OK» і потім «Підтвердити».  Якщо попередні кроки виконано успішно, буде виведено повідомлення зеленого кольору про успішність відправлення запиту. Запит ШБО буде переданий на сервер Каталогу Учасників системи «Трембіта». Після цього необхідно подати заявку на реєстрацію підсистеми та прив’язку її до конкретного ШБО засобами Особистого кабінету Каталогу системи «Трембіта» (**Реєстрація підсистеми на ШБО (Промислове середовище)**). Порядок подання зазначеної заявки наведено в п. 7.5.2 Регламенту роботи системи «Трембіта». Після виконання Адміністратором системи «Трембіта» заявки з’явиться зелена позначка навпроти підсистеми у вебінтерфейсі та буде забезпечено можливість використання тестового середовища системи «Трембіта». Якщо підсистеми зареєстровані вірно, інтерфейс ШБО буде виглядати наступним чином: [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-04/MPQdpFwtbfR2wEuS-UwOimage.png) # 8. Налаштування перенесення архівних файлів на сервер баз даних та архівування Для забезпечення довгострокового збереження архівів повідомлень, прийнятих/переданих через ШБО, необхідно налаштувати процедуру архівування журналу повідомлень до сервера баз даних та архівування. Налаштування виконується Адміністратором локальних компонентів (системним адміністратором). На ШБО архівні файли (ZIP-контейнери) знаходяться у директорії, що вказана параметром конфігурації archive-path. Імена архівних файлів виражені у форматі mlog-XYZ.zip, де: - X – часовий покажчик (час UTC у форматі YYYYMMDDHHmmss) першого запису журналу повідомлень, - Y – позначка часу останнього запису журналу повідомлень (записи обробляються в хронологічному порядку), - Z – довільна буквено-цифрова послідовність довжиною 10 символів. Прикладом назви архівного файлу є: mlog-20150504152559-20150504152559-a7JS05XAJC.zip Інсталяційний пакет ШБО містить допоміжний скрипт /usr/share/uxp/scripts/archive-http-transporter.sh, призначений для передачі архівних файлів. Цей скрипт використовує протокол HTTP/HTTPS (метод POST, ім’я форми - файл) для передачі архівних файлів з ШБО на сервер баз даних та архівування. Для налаштування перенесення архівних файлів на сервер баз даних та архівування необхідно: 1. Увійти до командної консолі ШБО. 2. Відкрити на редагування файл /etc/uxp/conf.d/local.ini за допомогою виконання наступної команди: ``` sudo nano /etc/uxp/conf.d/local.ini ``` 3. Додати наступний рядок до файлу: ``` archive-transfer-command=/usr/share/uxp/scripts/archive-http-transporter.sh -r http://IP_адреса_сервера_баз_даних_та_архівування/cgi-bin/upload.pl ``` де **<IP\_адреса\_сервера\_баз\_даних\_та\_архівування****>** - відповідна IP-адреса сервера баз даних та архівування. [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-05/5n5HTSVIBa1KFbfz-picture8-9.png) 4. Закрити редактор, натиснувши комбінацію клавіш «Ctrl+X», буде показано повідомлення про підтвердження на збереження змін - необхідно натиснути «Y», а потім «Enter» для збереження. 5. Увійти до командної консолі серверу баз даних та архівування 6. Послідовно виконати наступні команди: ``` sudo apt install apache2 libapache2-mod-perl2 libcgi-session-perl sudo systemctl restart apache2 sudo a2enmod cgi sudo mkdir /var/log/uxp_message_log_archive sudo chown root:www-data /var/log/uxp_message_log_archive sudo chmod 570 /var/log/uxp_message_log_archive sudo mkdir /var/www/perl ``` 7. Відкрити на редагування файл /etc/apache2/sites-enabled/000-default.conf за допомогою наступної команди: ``` sudo nano /etc/apache2/sites-enabled/000-default.conf ``` 8. Додати наступний блок конфігурації перед тегом </VritualHost>: ``` ScriptAlias /cgi-bin/ /var/www/perl/**Примітка.** Архівний файл успішно перенесений, коли сервер баз даних та архівування повертає код статусу HTTP 200.
# 9. Встановлення та конфігурація засобу перевірки повідомлень Засіб перевірки повідомлень призначений для перевірки тих повідомлень, які зберігаються у журналі повідомлень шлюзу безпечного обміну. Встановлення цього компоненту не є обов’язковим. Засіб перевірки повідомлень надає вебінтерфейс Відповідальному за аналіз транзакцій, який дозволяє переглядати наявні збережені та підписані повідомлення (запити до сервісів та відповіді), фільтрувати їх за параметрами (у тому числі за датою отримання, ID повідомлення, кодом сервісу, кодом підсистеми-клієнта тощо). Вебінтерфейс засобу перевірки повідомлень доступний через порт TCP 5000. # 9.1 Встановлення засобу перевірки повідомлень Засіб перевірки повідомлень встановлюється на відповідному сервері баз даних та архівування, який попередньо має бути встановлений при роботі скрипта автоматизації встановлення та налаштований згідно [розділу 8](https://docs.trembita.gov.ua/books/instrukciia-zi-vstanovlennia-lokalnix-komponentiv-sistemi-trembita-v-promislovomu-seredovishhi-za-dopomogoiu-skripta-avtomatizaciyi/page/8-nalastuvannia-perenesennia-arxivnix-failiv-na-server-baz-danix-ta-arxivuvannia) даної інструкції. Встановлення та налаштування засобу перевірки повідомлень виконується Адміністратором локальних компонентів (системним адміністратором).**Примітка.** У випадку нестачі апаратних ресурсів засіб перевірки повідомлень можна встановити на окремій віртуальній машині (фізичному сервері). В такому випадку необхідно налаштувати віддалене підключення згідно [розділу 9.2.1](https://docs.trembita.gov.ua/link/195#bkmrk-9.2.1-%D0%9D%D0%B0%D0%BB%D0%B0%D1%88%D1%82%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F-%D0%B4) даної інструкції
Для інсталяції засобу перевірки повідомлень необхідно виконати наступні дії: 1. **Якщо засіб перевірки повідомлень буде встановлено на окремій віртуальній машині** – необхідно закрити доступ до сторонніх репозиторіїв за допомогою виконання наступної команди: ``` sudo sed -i 's/^[A-Za-z0-9]/#&/' /etc/apt/sources.list ``` 2. **Якщо засіб перевірки повідомлень буде встановлено на окремій віртуальній машині** – додати репозиторій з пакетами системи «Трембіта»: ``` echo 'deb https://project-repo.trembita.gov.ua:8081/repository/ss-1.12.6/ bionic main' | sudo tee -a /etc/apt/sources.list ``` Перевірити результат виконання команд можна за допомогою текстового редактора nano, відкривши файл на редагування за допомогою виконання наступної команди: ``` sudo nano /etc/apt/sources.list ``` 3. **Якщо засіб перевірки повідомлень буде встановлено на окремій віртуальній машині** – необхідно додати GPG ключ репозиторію за допомогою виконання наступної команди: ``` sudo wget -O - https://project-repo.trembita.gov.ua:8081//public-keys/public.key.txt | sudo apt-key add - ``` Якщо команду виконано успішно, то буде виведено повідомлення «ОК». 4. Створити новий обліковий запис Відповідального за аналіз транзакцій, який буде використовуватись для входу в вебінтерфейс засобу перевірки повідомлень шляхом послідовного виконання наступних команд: ``` sudo useradd -M -NПримітка. Атрибути доступу до бази даних можна подивитися в файлі /etc/uxp/db.properties на відповідному ШБО у блоці uac-messagelog.hibernate.connection.
--- #### 9.2.1 Налаштування дозволу на віддалене підключення до журналу повідомлень**Важливо!** Налаштування дозволу на віддалене підключення до журналу повідомлень необхідно здійснювати лише в тому випадку, якщо засіб перевірки повідомлень встановлений на окремому сервері, а не на тому, де розміщується база даних журналу повідомлень.
Для налаштування дозволу на віддалене підключення до журналу повідомлень потрібно виконати наступні кроки на сервері, де розміщується база даних журналів повідомлень: 1. Відкрити на редагування файл /etc/postgresql/10/main/postgresql.conf за допомогою наступної команди: ``` sudo nano /etc/postgresql/10/main/postgresql.conf ``` 2. Знайти у файлі рядок з параметром «listen\_addresses», розкоментувати його (видалити символ «\#» на початку рядка) та замінити значення: ``` #listen_addresses = 'localhost' # what IP address(es) to listen on; ``` на: ``` listen_addresses = '*' # what IP address(es) to listen on; ``` [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-05/LSDBu3Vn7W0qvPYs-picture9-1.png) 3. Відкрити на редагування файл /etc/postgresql/10/main/pg\_hba.conf, який містить налаштування прав доступу, за допомогою команди: ``` sudo nano /etc/postgresql/10/main/pg_hba.conf ``` 4. Додати у кінець відкритого файлу наступний рядок ``` host**Примітка.** Передумова для налаштувань - передбачається, що база даних була створена, заповнена схемою журналу повідомлень, а доступ до бази даних із засобу перевірки повідомлень був налаштований.
Перед проведенням налаштувань потрібно перевірити підключення від засобу перевірки повідомлень до віддаленої бази даних за допомогою наступної команди: ``` psql -h**Примітка:**
Швидко замінити <IP\_GRAYLOG\_Server> на локальну IP-адресу серверу аналізу журналів подій можна виконавши наступні дії: - Відкрити на редагування файл 45-uxpservices.conf за допомогою наступної команди. ``` sudo nano /etc/rsyslog.d/45-uxpservices.conf ``` - Натиснути комбінацію клавіш «Ctrl+\\» - це забезпечить пошук та подальшу заміну тексту. - Скопіювати (або ввести) наступний текст у поле пошуку редактора nano: ``` < IP_GRAYLOG_Server > ```  - Натиснути клавішу "Enter" та ввести локальну IP-адресу сервера аналізу журналів подій у поле «Replace with:»:  - Натиснути клавішу "Enter" та клавішу "A" (латинська розкладка) - це дозволить замінити всі знайдені рядки. [](https://docs.trembita.gov.ua/uploads/images/gallery/2024-05/Yrx1jNYnxnlgkLPz-download.png) 6. Закрити редактор, натиснувши комбінацію клавіш «Ctrl+X», буде показано повідомлення про підтвердження на збереження змін - необхідно натиснути «Y», а потім «Enter» для збереження. 7. Перезавантажити службу rsyslog на шлюзі безпечного обміну шляхом виконання наступної команди: ``` sudo service rsyslog restart ``` 8. Перевірити стан Rsyslog шляхом виконання наступної команди: ``` sudo rsyslogd -N 1 ``` Сервер аналізу журналів подій централізовано протоколює події, які реєструються на шлюзі безпечного обміну та передаються за протоколом SYSLOG. Для перегляду логів необхідно перейти за посиланням http://<IP\_GRAYLOG\_Server>:9000/search. # 11. Налаштування локального моніторингу шлюзу безпечного обміну # 11.1 Підготовка до встановлення компонентів локального моніторингу Оператор (або Суб'єкт електронної взаємодії, якщо він самостійно встановлює та адмініструє локальні компоненти) має можливість встановити та налаштувати сервер аналізу транзакцій, який може збирати та відображати відомості щодо кількості здійснених запитів, що пройшли через ШБО. Також Оператор (або Суб'єкт електронної взаємодії, якщо він самостійно встановлює та адмініструє локальні компоненти) має можливість встановити та налаштувати сервер моніторингу за працездатністю власного ШБО, який може збирати та відображати відомості щодо використання апаратних ресурсів ШБО в процесі функціонування. Мінімальні апаратні характеристики віртуальних машин (або фізичних серверів), необхідні для роботи компонентів локального моніторингу, наведено у [таблиці 5.1](https://docs.trembita.gov.ua/link/180#bkmrk-%D0%A2%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D1%8F-5.1---%D0%A1%D0%BA%D0%BB%D0%B0%D0%B4%2C). З метою економії апаратних ресурсів можна встановлювати програмне забезпечення сервера аналізу транзакцій та сервера моніторингу за працездатністю на одній віртуальній машині. При цьому, необхідно враховувати, що об’єднане програмне забезпечення може використовувати більше оперативної пам’яті. Сервер аналізу журналів подій та моніторингу за працездатністю функціонують на базі операційної системи Ubuntu Server 18.04.4 x64, процес інсталяції якої наведено в [Інструкції з інсталяції операційної системи Ubuntu Server 18.04.4 x64](https://docs.trembita.gov.ua/books/instrukciia-z-instaliaciyi-operaciinoyi-sistemi-ubuntu-desktop-18044-x64). Також на дані віртуальні машини рекомендовано встановити антивірусне програмне забезпечення (наприклад, Falcon). # 11.2 Встановлення та конфігурація Серверу аналізу транзакцій Сервер аналізу транзакцій складається з наступних програмних компонентів: - Elasticsearch, що збирає та накопичує відомості про здійснені транзакції; - Kibana, що виконує функції інтерфейсу користувача та відображає накопичені відомості за критеріями пошуку користувача. Схема мережевої взаємодії сервера аналізу транзакцій наведена на рисунку 11.1.**Примітка.** Встановлення локалі описано [в розділі 7.1.4](https://docs.trembita.gov.ua/link/65#bkmrk-6.1.3.-%D0%9D%D0%B0%D0%BB%D0%B0%D1%88%D1%82%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F-).
5. Провести системне очищення та оновити списки доступних пакетів за допомогою послідовного виконання наступних команд: ``` sudo apt autoremove && sudo apt clean && sudo apt autoclean sudo apt update ``` 6. Встановити необхідні засоби за допомогою виконання наступної команди: ``` sudo apt install zabbix-server-pgsql zabbix-agent postgresql -y ``` 7. Створити користувача бази даних та базу даних за допомогою послідовного виконання наступних команд: ``` sudo -u postgres createuser --pwprompt zabbix sudo -u postgres createdb -O zabbix zabbix ``` 8. Імпортувати схему бази даних за допомогою виконання наступної команди: ``` zcat /usr/share/doc/zabbix-server-pgsql/create.sql.gz | sudo -u zabbix psql zabbix ``` 9. Відкрити на редагування файл конфігурації zabbix\_server.conf за допомогою виконання наступної команди: ``` sudo nano /etc/zabbix/zabbix_server.conf ``` 10. Ввести пароль до файлу конфігурації як значення параметру «DBPassword», а значення параметру «DBHost» – залишити порожнім: ``` DBHost= DBPassword= ``` 11. Увімкнути Zabbix сервер за допомогою послідовного виконання наступних команд: ``` sudo systemctl enable zabbix-server sudo systemctl start zabbix-server ``` 12. Встановити web частину серверу Zabbix за допомогою виконання наступної команди: ``` sudo apt install zabbix-frontend-php php-pgsql -y ``` 13. Вимкнути Apache2 за допомогою послідовного виконання наступних команд: ``` sudo systemctl stop apache2 sudo systemctl disable apache2 ``` 14. Встановити Nginx за допомогою послідовного виконання наступних команд: ``` sudo apt install nginx-light php-fpm -y sudo ln -s /usr/share/zabbix /var/www/html/zabbix sudo rm /etc/nginx/sites-enabled/default ``` 15. Відкрити на редагування файл конфігурації php.ini за допомогою виконання наступної команди: ``` sudo nano /etc/php/7.2/fpm/php.ini ``` 16. Перевірити наявність перелічених нижче параметрів у файлі конфігурації. Якщо дані параметри відсутні – встановити їх наступним чином: ``` date.timezone = Europe/Kiev post_max_size = 16M max_execution_time = 300 max_input_time = 300 ``` 17. Створити та відкрити на редагування файл конфігурації Nginx за допомогою послідовного виконання наступних команд: ``` sudo touch /etc/nginx/sites-available/zabbix sudo ln -s /etc/nginx/sites-available/zabbix /etc/nginx/sites-enabled/zabbix sudo nano /etc/nginx/sites-enabled/zabbix ``` 18. Внести наступні конфігураційні параметри у даний файл: ``` server { listen 80 default_server; root /var/www/html; index index.php index.html index.htm; server_name zabbix_server; location / { try_files $uri $uri/ =404; } location /(conf|app|include|local) { deny all; } location ~ \.php$ { include snippets/fastcgi-php.conf; fastcgi_pass unix:/run/php/php7.2-fpm.sock; } location ~ /\.ht { deny all; } } ``` 19. Перезавантажити сервіси за допомогою виконання наступної команди: ``` sudo systemctl restart php7.2-fpm nginx ``` --- #### 11.3.2. Налаштування серверу моніторінгу за працездатністю Вебінтерфейс серверу моніторингу за працездатністю доступний за посиланням: http://<YOUR-ZABBIX-SERVER-IP>/zabbix/, де **<YOUR-ZABBIX-SERVER-IP>** – адреса відповідного серверу, на якому встановлено програмне забезпечення для моніторингу за працездатністю. Для налаштування серверу моніторингу за працездатністю Адміністратору локальних компонентів (системному адміністратору) необхідно виконати наступні дії в його вебінтерфейсі: 1. Заповнити дані, що будуть запитані в процесі налаштування у відповідності до попередніх пунктів інсталяції: - на кроці «Configure DB connection необхідно вказати пароль, що був створений у [п. 10 розділу 11.2.1](https://docs.trembita.gov.ua/link/202#bkmrk-10.-%D0%92%D0%B2%D0%B5%D1%81%D1%82%D0%B8-%D0%BF%D0%B0%D1%80%D0%BE%D0%BB%D1%8C-%D0%B4%D0%BE) даної інструкції; - на всіх інших кроках натиснути на кнопку «Next/Finish».**Примітка.** За замовчуванням логін для входу – «Admin» (\[ZABBIX-ADMIN-USER\]), пароль – «zabbix» (\[ZABBIX-ADMIN-PASSWORD\]).
2. Запустити агент моніторингу та додати його до автозапуску за допомогою послідовного виконання наступних команд: ``` sudo systemctl start zabbix-agent sudo systemctl enable zabbix-agent ``` --- ##### 11.3.3. Налаштування підключення шлюзу безпечного обміну до серверу моніторінгу за працездатністю Конфігурація підключення ШБО до серверу моніторингу за працездатністю налаштовується на ШБО у файлі /etc/uxp/monitor-agent.ini. Для налаштування підключення ШБО до сервера моніторингу за працездатністю Адміністраторові локальних компонентів (системному адміністратору) необхідно виконати наступні дії на ШБО: 1. Відкрити на редагування файл monitor-agent.ini за допомогою виконання наступної команди: ``` sudo nano /etc/uxp/monitor-agent.ini ``` 2. Розкоментувати наступні рядки (видаливши символ «#» на початку рядку): ``` [zabbix-1] address =**Примітка.** За замовчуванням логін для входу – «Admin» (<ZABBIX-ADMIN-USER>), пароль – «zabbix» (<ZABBIX-ADMIN-PASSWORD>).
3. Закрити редактор, натиснувши комбінацію клавіш «Ctrl+X», буде відображено повідомлення про підтвердження на збереження змін – необхідно натиснути «Y», а потім «Enter» для збереження. 4. Застосувати нову конфігурацію Zabbix за допомогою виконання наступної команди: ``` sudo reload-monitor-agent ``` 5. Підключитися до вебінтерфейсу Zabbix http://<YOUR-ZABBIX-SERVER-IP>/zabbix/, де **<YOUR-ZABBIX-SERVER-IP>** – адреса відповідного серверу, на якому встановлено ПЗ для моніторингу за працездатністю. 6. Перевірити, що в конфігурації з'явилися хости шлюзу безпечного обміну. Для цього необхідно виконати наступні дії: 1. Перейти на вкладку «Latest data». 2. Обрати «uxp-pma» у полі «Host groups». 3. Натиснути на кнопку «Apply». Спочатку з’являться найменування статистичних полів, через деякий час вони заповняться даними зі шлюзу безпечного обміну.**Примітка.** Деталі використання інструменту Zabbix наведено на офіційному вебсайті Zabbix.
| **Журнал** | **Призначення** |
| /var/log/uxp/audit.log | Запис успішних і невдалих дій користувачів в інтерфейсі користувача ШБО |
| /var/log/uxp/proxy.log | Запис дій, пов'язаних з обміном повідомленнями (підключення до ШБО, права доступу, пересилання запиту, мітка часу, архівування) |
| /var/log/uxp/configuration\_client.log | Запис дій, пов’язаних із завантаженням глобальної конфігурації |
| /var/log/uxp/signer.log | Запис дій, пов’язаних із керуванням ключами та сертифікатами ШБО (помилки підписання; відсутні ключі та сертифікати; проблеми із закінченням терміну дії та статусом) |
| /var/log/uxp/proxymonitoragent.log | Записи дій, пов’язаних зі збором даних моніторингу про ШБО; результати доступні на сторінці стану системи |
| /var/log/uxp/jetty/jetty.log | Записи запитів до сервера додатків, що забезпечує інтерфейс користувача |
| /var/log/uxp/clientproxy\_access.log | Стандартні записи вебдоступу запитів від клієнтської інформаційної системи (наприклад, UXP Portal) до ШБО |
| /var/log/uxp/serverproxy\_access.log | Стандартні записи вебдоступу запитів від іншого ШБО до поточного ШБО |
| /var/log/postgresql/postgresql-<version>-main.log | Записи помилок доступу до бази даних |
| **Сервіс** | **Призначення** | **Журнал** |
| uxp-confclient | Клієнтський процес для дистриб’ютора глобальної конфігурації | /var/log/uxp/configuration\_client.log |
| uxp-jetty | Програмний сервер додатків, який забезпечує функціонування вебінтерфейсу адміністрування шлюзу безпечного обміну | /var/log/uxp/jetty/ |
| uxp-proxy | Сервіс обміну повідомленнями | /var/log/uxp/proxy.log |
| uxp-signer | Сервіс, що керує функціями підписання | /var/log/uxp/signer.log |
| uxp-monitor | Сервіс внутрішнього моніторингу ШБО | /var/log/uxp/proxymonitoragent.log |
| nginx | Вебсервер, який розподіляє конфігурацію і реалізує протокол TLS в вебінтерфейсі адміністрування ШБО | /var/log/nginx/ |
| **Помилка** | **Причина** | **Виправлення** |
| При спробі відкрити вебінтерфейс ШБО відображається повідомлення «403 forbidden» | На ШБО не надано права доступу до його вебінтерфейсу з робочої станції адміністратора | Надати доступ для робочої станції адміністратора згідно [розділу 13.1](https://docs.trembita.gov.ua/link/204#bkmrk-8.1-%D0%92%D0%B8%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BF%D0%BE%D0%BC%D0%B8) даної інструкції |
| Помилка при виклику вебсервісу | Немає прав доступу до сервісу для підсистеми даної організації | Звернутися до адміністратора організації власника вебсервісу для надання доступу |
| Не введені PIN-коди для токенів | Ввести PIN-коди для токенів авторизації і підпису/шифрування | |
| Закінчився термін дії сертифіката авторизації і/або підпису/шифрування | Отримати та завантажити діючі сертифікати | |
| Сервер позначок часу не відповідає | Обрати інший сервер позначок часу згідно [розділу 7.1.3](https://docs.trembita.gov.ua/link/187#bkmrk-6.2.2.2.-%D0%9D%D0%B0%D0%BB%D0%B0%D1%88%D1%82%D1%83%D0%B2%D0%B0%D0%BD%D0%BD) даної інструкції | |
| При реєстрації було вказано неправильну адресу шлюзу безпечного обміну | Виправити адресу шлюзу безпечного обміну на сервері Каталогу Учасників системи «Трембіта» (звернутися до Адміністратора системи «Трембіта») | |
| Помилка нестачі пам'яті («java.lang.OutOfMemoryError: Java heap space») | Для віртуальної машини Java (JVM) служби uxp-proxy виділено недостатньо оперативної пам'яті | Збільшити кількість пам'яті JVM для служби uxp-proxy згідно [розділу 13.2](https://docs.trembita.gov.ua/link/204#bkmrk-13.2-%D0%92%D0%B8%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BF%D0%BE%D0%BC) даної інструкції |
**Важливо!** В промисловому середовищі користувачі з ролями «Адміністратор вебсервісів» та «Відповідальний за управління ключами» повинні підключатися до вебінтерфейсу ШБО виключно з робочих станцій адміністратора!
**Примітка.** Якщо Суб’єкт електронної взаємодії та Учасник є різними юридичними особами, то Суб’єкт електронної взаємодії аналогічно повинен мати власну робочу станцію адміністратора.
Керування доступом до вебінтерфейсу шлюзу безпечного обміну здійснюється за допомогою налаштувань NGINX. Перелік IP-адрес, з яких можна підключитись до ШБО знаходиться у файлі дозволених хостів.**Важливо!** Даний файл повинен містити виключно адреси довірених робочих станцій адміністратора. Адміністратор локальних компонентів (системний адміністратор) повинен завжди тримати перелік дозволених адрес у актуальному стані.
Для того, щоб додати ІР-адресу робочої станції адміністратора до файлу дозволених хостів необхідно: 1. Відкрити на редагування файл /etc/uxp/uaic/allowed\_hosts.conf у текстовому редакторі nano за допомогою виконання наступної команди: ``` sudo nano /etc/uxp/uaic/allowed_hosts.conf ``` 2. Додати до файлу наступний рядок: ``` allow<faultcode>Server.ServerProxy.ServiceFailed.InternalError</faultcode><faultstring>Self-suppression not permitted</faultstring>
Для виправлення даної помилки Адміністратор локальних компонентів (системний адміністратор) повинен збільшити обсяг пам'яті JVM для сервісу uxp-proxy. Для цього необхідно виконати наступні дії: 1. Відкрити на редагування файл конфігурації /etc/uxp/services/local.conf за допомогою виконання наступної команди: ``` sudo nano /etc/uxp/services/local.conf ``` 2. Вказати нове значення обсягу виділеної оперативної пам’яті в наступному рядку: ``` PROXY_JVM_OPTS="${PROXY_JVM_OPTS} -Xmx