Versions Compared

Key

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

В качестве клиента VPN используется OpenVPN. Для включения в работу необходимо загрузить файлы ключей и сертификатов, настроить клиент VPN, настроить работу Used VPN client is OpenVPN. For inclusion in work it is necessary to load files of keys and certificates, to adjust the client VPN, to adjust work of Watchdog Ping.

Wathdog Ping обеспечивает проверку доступности сети и при сбоях должен реагировать проводя переподключение клиента VPN, и если нужно, переподключение соединения LTE и пересброс модема.Для загрузки файлов ключей используются следующие URIprovides a network availability check and, if it fails, responds by reconnecting the VPN client.

The following URIs are used to load key files:

  • upload-vpn-crt.htm - сертификат клиентаclient certificate;
  • upload-vpn-ca.htm - сертификат ЦСCA certificate;
  • upload-vpn-key.htm - ключ клиента.

...

  • client key;
  • upload-tls-auth.htm - key TLS.


To configure the VPN client, use a query with querytype = setvpn, с полямиwith fields:

  • enable - включение/отключение клиентаenabling / disabling the client;

  • iface - интерфейс через который работает клиент, может быть "ethernet" или "modem";

  • gateway - имя или адрес сервера VPN;

  • port - порт сервера VPN, числовое значениеvpn_debug - enable openvpn debug log, if the field is absent, then debugging is not enabled;
  • gateway - name or address of the VPN server;

  • port - port of the VPN server, numeric value;

  • auth_type - тип авторизации клиента на сервере, может быть следующим (пока поддерживается только type of client authorization on the server, can be the following (currently only PASS_TLS is supported):
    • TLS - сертификаты  certificates (TLS);
    • PASS - парольpassword;
    • PASS_TLS - пароль и сертификаты  password and certificates (TLS).
  • user - имя пользователя, может быть пустымusername, can be empty;
  • pass - пароль пользователя, может быть пустымuser password, may be empty;
  • cipherta_type - режим шифрования (пока только AES-256-CBC);
  • hmac_type - аутентификация HMAC (пока только SHA512);
  • verify_type - способ проверки сертификата сервера (пока поддерживается только "name", по имени);
  • verify_str - строка по которой сличается сертификат сервера, вводится пользователем произвольно;
  • dns1 - адрес сервера DNS 1, может быть пустым;
  • dns2 - адрес сервера DNS 2, может быть пустым.

Для чтения параметров клиента VPN используется запрос с querytype=getvpn, ответ содержит следующие поля:

  • status - характеризует текущее состояние клиентаenable - enable authorization using TLS key;
  • complzo - use LZO compression;
  • watchdog_enable - enable Watchdog Ping;
  • watchdog_host - ping address;
  • watchdog_interval - ping interval, in seconds;
  • watchdog_timeout - ping timeout, in seconds, after which the VPN will be reconnected.

To read the VPN client settings, use the query with querytype = getvpn, the response contains the following fields:

  • status - characterizes the current state of the client;
  • connect_time - время в формате UnixTimeStamp показывающее момент соединенияtime in UnixTimeStamp format showing the moment of connection, "0" если нет данныхif there is no data;
  • vpn_debug - enable - включен или отключен клиент;
  • iface - интерфей через который работает клиетн ("ethernet" или "modem");
  • gateway - имя или адрес сервера VPN;
  • port - порт сервера VPN, числовое значениеor disabled openvpn debug log;
  • ipaddr - client address in VPN network;
  • enable - enabled or disabled client;
  • gateway - name or address of the VPN server;
  • port - port of the VPN server, numeric value;
  • auth_type - тип авторизации клиента на сервереtype of client authorization on the server;
  • user - имя пользователя, может быть пустымusername, can be empty;
  • pass - пароль пользователя, может быть пустымuser password, may be empty;
  • cipher_type - режим шифрования (пока только AES-256-CBC);
  • hmac_type - аутентификация HMAC (пока только SHA512);
  • verify_type - способ проверки сертификата сервера;
  • verify_str - строка по которой сличается сертификат сервера;
  • dns1 - адрес сервера DNS 1, может быть пустым;
  • dns2 - адрес сервера DNS 2, может быть пустым.

Для настройки Watchdog Ping используется запрос с querytype=setwdogping, с полями:

  • enable - включение/отключение;

  • ping_addr - адрес для пинга;

  • ping_time - периодичность пинга, в секундах, от 10 секунд до 5 минут;
  • ping_errors1 - количество ошибок для первого действия, если 0 то не используется;
  • ping_errors2 - количество ошибок для второго действия, если 0 то не используется;
  • ping_errors3 - количество ошибок для третьего действия, если 0 то не используется.

Действия которые выполняются при достижении числа ошибок:

  • ping_errors1 - пересброс соединения VPN;
  • ping_errors2 - пересброс соединения по модему LTE и соединения VPN;
  • ping_errors3 - пересброс модема и всех соединений, счет ошибок начинается заново.

Для чтения параметров Watchdog Ping используется запрос с querytype=getwdogping, ответ содержит следующие поля:

  • enable - включение/отключение;
  • ping_addr - адрес для пинга;
  • ping_time - периодичность пинга, в секундах;
  • ping_errors1 - количество ошибок для первого действия - пересброс соединения VPN;
  • ping_errors2 - количество ошибок для второго действия - пересброс соединения по модему LTE и соединения VPN;
  • ping_errors3 - количество ошибок для третьего действия - пересброс модема и всех соединенийta_enable - enable authorization using TLS key;
  • complzo - use LZO compression;
  • file_ca - CA certificate file name, empty if no file;
  • file_cert - client certificate file name, empty if no file;
  • file_key - client key file name, empty if no file;
  • file_ta - TLS authorization key file name, empty if no file;
  • watchdog_enable - enable Watchdog Ping;
  • watchdog_host - ping address;
  • watchdog_interval - ping interval, in seconds;
  • watchdog_timeout - ping timeout, in seconds, after which the VPN will be reconnected.

To download the debug log file, use the address "/download-vpn-log.htm".