Руководство администратора PayControl v5 — различия между версиями

Материал из PayControl Wiki
Перейти к: навигация, поиск
(Содержимое страницы заменено на «{{Уведомление|Актуальная документация по версии 5 располагается по адре…»)
(Метка: заменено)
 
Строка 1: Строка 1:
{{Уведомление|Статья для версии 5.2 находится по [https://repo.paycontrol.org/server/doc/v5.2/manuals/admin-guide/ru/ ссылке]}}
+
{{Уведомление|Актуальная документация по версии 5 располагается по адресу https://repo.paycontrol.org/index/safe-tech/#paycontrol}}
 
 
=Введение=
 
PayControl – программный комплекс, предназначенный для подтверждения пользователем операций в системах дистанционного банковского обслуживания и/или электронного документооборота.
 
 
 
PayControl призван, в первую очередь, повысить уровень удобства подтверждения и информационной безопасности по сравнению с такими способами подтверждения как SMS, одноразовые пароли (One-Time Password), скретч-карты, MAC-токены и пр.
 
 
 
При помощи PayControl могут подтверждаться волеизъявления на совершение банковских транзакций, аутентификация, создание и исполнение документов, факты получения и/или ознакомления с определённой информацией.
 
=Назначение=
 
Настоящий документ предназначен работникам организаций, выполняющим прикладные задачи по обслуживанию серверов PayControl.
 
=Общее описание=
 
Сервер PayControl функционирует на базе сервера приложений [[Wildfly]] выполняющейся в среде Java 8 и состоит из следующих частей:
 
* PayControl Server (PCS) – основной сервер PayControl. Располагается внутри локальной сети. Взаимодействует с прикладной системой. Хранит данные в БД PCS. Отправляет данные на PCP, получает данные с PCE.
 
* PayControl Pusher (PCP) – сервер для отправки Push уведомлений о появлении неподтверждённой транзакции у пользователя (без содержания информации о транзакции). Как правило располагается в DMZ-зоне, имеющей доступ к сети Интернет. Требуется доступ к серверам Google и Apple. Может быть размещён в т.ч. на одном сервере с PCS или PCE (в зависимости от требований ИБ к ИТ инфраструктуре Банка и функциональных возможностей ИТ инфраструктуры Банка).
 
* PayControl External (PCE). С этим сервером взаимодействуют приложения на мобильных устройствах для получения информации о данных платежа и отправки результатов подтверждения транзакций. Располагается в DMZ-зоне с доступом извне. Должен иметь внешний фиксированный IP-адрес. При необходимости использования TLS, должно быть присвоено доменное имя и выпущен сертификат внешним УЦ.
 
=Запуск и остановка служб сервера PayControl=
 
==Linux==
 
Запуск:
 
<syntaxhighlight lang="bash">
 
systemctl start wildfly.service
 
</syntaxhighlight>
 
Остановка:
 
<syntaxhighlight lang="bash">
 
systemctl stop wildfly.service
 
</syntaxhighlight>
 
Перезапуск:
 
<syntaxhighlight lang="bash">
 
systemctl restart wildfly.service
 
</syntaxhighlight>
 
==Windows==
 
===Из графического интерфейса===
 
Запуск, остановка и перезапуск службы осуществляется из консоли управления службами сервером (консоль services.msc).
 
===С помощью командной строки===
 
Запуск:
 
<syntaxhighlight lang="bat">
 
net start wildfly
 
</syntaxhighlight>
 
Остановка:
 
<syntaxhighlight lang="bat">
 
net stop wildfly
 
</syntaxhighlight>
 
 
 
=Журналирование=
 
==Доступ к данным журнала==
 
Журнал работы сервера PayControl записывается в общий журнал функционирования [[Wildfly]]. В общем случае записываются только ошибки PayControl, при их возникновении.
 
 
 
Файлы журналов за текущий день доступны по следующему пути:
 
* Linux:
 
*: /opt/wildfly/standalone/log/server.log
 
* Windows:
 
*: C:\wildfly\standalone\log\server.log
 
Для просмотра журнала за другие дни, нужно добавить к имени файла требуемую дату в формате server.log.YYYY-MM-DD
 
==Включение вывода информационных данных работы PayControl==
 
В некоторых случаях может потребоваться вывод отладочной информации PayControl. Порядок её включения описан ниже для разных компонентов сервера PayСоntrol.
 
===Вывод HTTP-запросов и результатов их выполнения===
 
Для записи запросов и результатов их выполнения в журнал работы сервера
 
# необходимо добавить в файл
 
#* Linux:
 
#*: /opt/wildfly/standalone/configuration/standalone.xml
 
#* Windows:
 
#*: C:\wildfly\standalone\configuration\standalone.xml
 
#: блок<syntaxhighlight lang="xml"><access-log pattern="%h %t &quot;%r&quot; %s &quot;%{i,User--Agent}&quot;" use-server-log="true"/></syntaxhighlight> в раздел <code>host</code> default-server'а. Пример:<syntaxhighlight lang="xml"><subsystem xmlns="urn:jboss:domain:undertow:3.0">
 
 
 
  ...
 
 
 
  <server name="default-server">
 
      ...
 
      <host name="default-host" alias="localhost">
 
        <location name="/" .../>
 
        <access-log pattern="%h %t &quot;%r&quot; %s &quot;%{i,User--Agent}&quot;" use-server-log="true"/>
 
        ...
 
      </host>
 
  </server>
 
 
 
  <servlet-container .../>
 
 
 
  ...
 
 
 
</subsystem></syntaxhighlight>
 
# Перезапустить службу wildfly.
 
===Для PCS и PCP===
 
====Вывод отладочной информации====
 
Для включения вывода отладочной информации необходимо:
 
# В БД PCS или БД PCP соответственно для нужного сервера, добавить/изменить запись в таблице pc_sys_property, установив следующие значения:
 
#* setting_name='DEBUG_INFO'
 
#* setting_value = '1'
 
# Перезапустить службу wildfly.
 
=====Добавление записи=====
 
Примеры SQL запросов добавления записи для разных СУБД:
 
* PostgreSQL <syntaxhighlight lang="sql">insert into pc_sys_property values (nextval('pc_setting_seq'), 'DEBUG_INFO', '1');</syntaxhighlight>
 
* Oracle <syntaxhighlight lang="sql">insert into pc_sys_property values (PC_SETTING_SEQ.NEXTVAL, 'DEBUG_INFO', '1');</syntaxhighlight>
 
* MS SQL <syntaxhighlight lang="sql">insert into pc_sys_property values (NEXT VALUE FOR PC_SETTING_SEQ, 'DEBUG_INFO', '1');</syntaxhighlight>
 
=====Изменение записи=====
 
Пример SQL запроса для изменения записи (подходит для всех перечисленных в предыдущем подразделе СУБД):
 
<syntaxhighlight lang="sql">update pc_sys_property set setting_value = '1' where setting_name='DEBUG_INFO';</syntaxhighlight>
 
===PCE===
 
Компонент может журналировать запросы, приходящие со стороны мобильных устройств.
 
 
 
Для включения журналирования необходимо в опции Java-машины добавить параметр ''pc_logRequests=yes'' следующим образом:
 
* для Linux:
 
*: в файл /opt/wildfly/bin/standalone.conf добавить <syntaxhighlight lang="bash">JAVA_OPTS="$JAVA_OPTS -Dpc_logRequests=yes"</syntaxhighlight>
 
* для Windows:
 
*: в файл C:\wildfly\bin\standalone.conf.bat добавить <syntaxhighlight lang="bat">set "JAVA_OPTS=%JAVA_OPTS% -Dpc_logRequests=yes"</syntaxhighlight>
 
затем перезапустить службу Wildfly.
 
=Отправка информации о событиях=
 
Адрес для отправки информации об устройстве и событиях взаимодействия мобильного приложения, или SDK, с сервером устанавливается путём выполнения запроса Change System Settings к API сервера PCS. Подробнее — в актуальной версии API сервера PC.
 
 
 
Перезапуск WildFly не требуется.
 
 
 
{{Предупреждение|Обязательным требованием для сбора информации о событиях является установка флага сбора информации о событиях при создании ключа, а для передачи данных об устройстве — ещё и флага сбора информации об устройстве. Подробнее — в описании API сервера.}}
 
 
 
=Установка лицензии=
 
Если установка лицензионного файла не проводилась на сервер, то он работает в демонстрационном режиме, ограничивающем возможность заведения более 20 пользователей PayControl.
 
Также при включённом выводе информационных данных работы PayControl, в журнал выводятся сообщения сообщения вида:
 
<pre>
 
2018-12-07 11:51:07,295 INFO  [ru.safetech.ws.PayControl.services.utils.licenseManager.LicenseManager] (default task-2)    --- no license found in database
 
2018-12-07 11:51:07,295 INFO  [ru.safetech.ws.PayControl.services.impl.PayControlServiceV3Impl] (default task-2)    --- Error load License, cheking if free users count exceeded
 
2018-12-07 11:51:07,295 INFO  [ru.safetech.ws.PayControl.services.impl.PayControlServiceV3Impl] (default task-2)    --- ATTENTION! LICENSE NOT FOUND! You are using unlicensed demo-only version of the service
 
</pre>
 
==Загрузка через АРМ РКС==
 
<small>''С версии АРМ РКС 5.1.42.''</small>
 
 
 
На вкладке <code>Система</code> (<code>System Info</code>) с помощью кнопки <code>Загрузить файл лицензии</code> (<code>Upload license file</code>).
 
==Путём копирования лицензионного файла на сервер==
 
Файл лицензии необходимо скопировать на сервер PCS в одну из папок:
 
* /opt/wildfly/
 
* /opt/pc/
 
* C:\wildfly\
 
* C:\pc\
 
* По пути, заданному в [[Сервер_PayControl#Параметры системы|параметре]] LICENSE_FILE_LOCATION.
 
==Через запрос по API сервера Change System Settings==
 
Можно добавить лицензию посредством изменения параметров системы, описанных в актуальной версии API сервера PC.
 
 
 
=Контроль=
 
Администратору PayControl необходимо в плановом режиме выполнять проверку:
 
* Достаточности свободного места на серверах PayControl;
 
* Достаточности свободного места, выделенного дискового пространства базам данных PayControl (БД PCS и БД PCP).
 
=Плановые работы=
 
Плановыми работами по обслуживанию является:
 
* Замена сертификата для обеспечения HTTPS защиты сервера PCE;
 
* Замена сертификатов для обеспечения HTTPS защиты на серверах PCS и PCP при их наличии.
 
[[Категория:Руководства]]
 
[[Категория:Серверная часть]]
 

Текущая версия на 18:03, 20 июля 2022

В работе
Уведомление. Актуальная документация по версии 5 располагается по адресу https://repo.paycontrol.org/index/safe-tech/#paycontrol