telegram Проект "Жезл" - телеграмм бот для работы с роутером

Zeleza · 10 апреля, 2022

Доброго всем дня,

Представляю Вашему вниманию проект Жезл (Zezl). Это инструмент, реализованный в виде бота, для управления роутером Keenetic через интерфейс мессенджера Telegram.

На первом этапе, данный пакет позволяет осуществлять контроль и поддерживать в актуальном состоянии "Белый список", который может содержать домены/хосты, трафик на которые будет маршрутизироваться через существующие и заранее настроенные VPN соединения.

Другими словами, если у Вас есть необходимость зайти на некоторые сайты через VPN соединение, то данный инструмент позволит Вам посредством телефона или компьютера на которых установлен Telegram управлять, так называемом "Белым списком" доменных имен, на которые Вы сможете попасть, минуя провайдера, через настроенное ранее и существующее VPN соединение.

Но помните, про завет мой добрый для всех страждущих VPN…

Цитата

Софтину сию используй по воле доброй своей, справедливости ради, да по совести для.
Крепко-накрепко помни - силу воли свою обретая, к воле-волюшке путь короче делаешь.

Супротив же воли своей ступая, знай - за кон идешь, кабалой пленен будешь, в неволю угодишь.

Посему, по кону следуй и в ладу с собою будь, поступай по разуму - мудро, на лета долгие - наперед.
Помни, кроткий ум - то воле раздолье, а дай волю уму, так и сума не за горами.

Да пребудет СИЛА С ТОБОЮ!
Сила та - в воле, в правде, в доброте и в справедливости.

Жезл является продолжением и развитием проекта vpn-list-update (vpu):

Скрытый текст

Пакет полностью переписан на языке Python 3.
Устанавливается в виде ipk пакета под все виды процессоров, поддерживаемые Keenetic.
Как новый, так и предыдущий пакет, оба используют существующий и реализованный в прошивке роутеров Keenetic вариант маршрутизации, который достаточно просто отследить в Системе Управления Роутером, или на иноземный лад - WUI (Web User Interface), на странице "Сетевые правила -> Маршрутизация".

Функционал обоих пакетов позволяет автоматически получать список связанных с хостом IP адресов и автоматически добавлять их в таблицу маршрутизации.

К недостаткам данного механизма можно отнести следующие пункты:

В таблице маршрутизации прописываются, к сожалению, не названия сайтов (доменов), а их IP адреса, а для добавления какого либо домена приходится в ручную добавлять адреса домена в таблицу, коих может быть большое множество.
Так же, домены, которые часто обновляют свои IP адреса и которые имеют ссылки на другие ресурсы открываться НЕ будут. Как пример instagram.com, facebook.com и пр. высоко-нагруженные ресурсы.

В дальнейших выпусках пакета, будет реализован один из вариантов работы через ipset, это позволит решить вопрос с открытием высоко-нагруженных сайтов и сайтов, которые имеют ссылки на другие ресурсы .

Проект Жезл продолжает развивать функциональность и удобство использования пакета vpu и предлагает несколько вариантов работы:

В режиме командной строки - после установки пакета осуществляется командой: zpu <команда>
В режиме взаимодействия через месседжер Telegram.

На текущий момент, версия пакета Жезл (zezl) имеет номер 1.1-beta-02 и реализуют следующий функционал:

Цитата

Работа с Белым списком:
Осуществляет авто-выбор VPN соединения, если соединение одно или позволяет произвести выбор, если их несколько;

Осуществляет работу в режиме группового выборки доменых имен
Включает и отключает у доменов флаг auto

Удаляет выбранные домены

Сохраняет выбранные домены в архив

Осуществляет перенос доменов на другой VPN интерфейс (в случае их наличия)

Отображает детали выбранных доменов (список IP адресов/интерфейс/флаг auto)

Работа с Архивами
Сохраняет и удаляет текущий вариант белого списка в архив

Отображает содержимое выбранного архива

Позволяет в режиме селекции экспортировать домены на выбранный интерфейс.

Удаляет выбранный архив

Осуществляет фильтрацию доменов по интерфейсу

Работа с Таймером обновления
Обновляет текущий список доменов на всех интерфейсах и фиксирует время обновления

Удаляет таймер обновления ip адресов

Изменяет таймер обновления ip адресов на любой из интервалов: минуты/часы/дни/недели/месяца

Меню "Сторожей"
Создан сторож, который отлавливает системные ошибки, с выводом справки по каждой из ошибок.

Создан сторож, который отлавливает изменения на определенных страницах сайтов.

Планируемое расширение функционала:

Скрытый текст

Меню "VPN"
-- переделать схему перенаправления трафика посредством ipset.
Меню "Сторожей" (с возможностью отправки сообщений, как в Телеграм, так и по СМС, в случае наличия USB "свистка" с сим картой)
-- сторож, который отлавливает системные ошибки, с выводом справки по каждой из ошибок
--- возможность добавлять произвольные сочетания текста для поиска в системном журнале.
-- сторож, который отлавливает звонки (при наличии DECT модуля) и выводит по ним информацию (см. пункт "Меню DECТ" ниже)
-- сторож, который отлавливает подключения/отключения устройств по WIFI (см. пункт "Меню WIFI" ниже)
-- сторож, который отлавливает изменения на определенных страницах сайтов (см. ниже "Меню Новости")
-- сторож, который отлавливает появление/пропадание сети в роутере
-- сторож, который отслеживает смену внешнего IP роутера
Меню DECT (при наличии подключенного модуля к роутеру)
-- осуществлять поиск номеров телефона во внешних БД по запросу и при входящем звонке.
-- выводить информацию о номере телефона при входящем звонке: регион, временная зона, оператор
-- Журнал звонков входящих и исходящих
Меню WiFi
-- Отслеживать новые подключения и давать им возможность подключаться к сети
--- на определенное время
--- до определенного времени
-- Блокировать клиентов по mac и по имени
--- на определенное время
--- до определенного времени
-- Вывод истории подключения и отключения устройств к WIFI с группировкой по клиентам
Меню "Новости" (этот пункт никак не связан с роутером, но лично мною очень востребован, так как люблю быть в курсе различных событий.)
-- Организовать СМС приход соответствующих уведомлений об обновлении страниц.
-- Организовать архивацию отслеживаемых сайтов
Меню "Настройки"
-- Производить периодическую архивацию настроек роутера, наподобие той, которая которая обсуждается в этой теме, осуществляемая, через Телеграм.
Меню "Терминал" (данный функционал под вопросом из-за вопросов безопастности исполнения произвольных команд.)
-- /ent команда - выполняет произвольную команду в оболочке entware.
-- /cli команда - выполняет любую из команд в роутере keenetic.

* синим текстом помечены пункты над которыми сейчас ведется работа.
* зеленым цветом помечаются пункты , которые уже реализованы, но по ним происходит доработка.

Существующие ограничения использования пакета Zezl:

Скрытый текст

Данный пакет возможно установить и использовать только на роутерах компании Keenetic, так как пакет использует встроенный функционал API от Keenetic.
Полноценная работа пакета возможна исключительно только после того, как:
1. Вы зарегистрируете своего «бота» в Телеграм и получите токен, который необходимо будет ввести при установке пакета.
2. Вы введете свой user_id.
В текущей версии проекта доступны следующие типы VPN интерфейсов:
1. OpenVPN
2. Wireguard
3. L2TP/IPsec (IKEv1)
4. PPPOE
5. CdcEthernet
6. SSTP
7. IKEv2
При работе бот занимает 107М виртуальной памяти, что для "слабых" моделей роутеров может служить препятствием.
Пакет не работает на прошивках Keenetic OS 2.16 из-за отсутствия поля comment в таблице маршрутизации (подтверждено @TheDopplerEffect).

Установка пакета:

Первым шагом, создайте своего бота и скопируйте токен. Как это сделать - информацию можно найти по этой ссылке.
С целью обеспечения безопасного управления ботом необходимо вторым шагом выяснить свой user_id, согласно этой инструкции.
Третьим шагом, скачайте требуемую версию пакета на роутер, например в папку /opt/apps/packages/. Крайнюю версию пакета всегда можно найти по этой ссылке.
Важно! Запись файлов разрешена только в каталог /opt и далее по дереву каталога /opt.
Четвертым шагом, удалите предыдущую версию пакета (если она была установлена ранее) командой opkg remove zezl.
Если ранее пакет был уже установлен, то при запросе об удалении файлов конфигурации можете их не удалять, тогда не придется повторно вводить token и user_id и последующие пункты инструкции 6 и 7 будут автоматически пропущены.
Установите новую версию opkg install /opt/apps/packages/zezl_x.x-beta-x.ipk
В процессе установки введите, полученный Вами токен на шаге №1
Далее, на запрос, введите Ваш user_id, полученный на втором шаге, если Вы планируете администрировать бота, либо user_id того, кто будет этим заниматься.

Token и user_id можно установить без переустановки пакета, воспользовавшись командой zpu token <ваш_токен> и zpu admin <user_id администратора>, после чего бот будет запущен автоматически.

Цитата

Данная версия программы находится на стадии бета тестирования, потому возможно появление различного рода ошибок.

Кто хочет принять участие в ее доработке и развитии, со своими идеями, комментариями и пожеланиями - приглашаю: оставляйте свои комментарии и идеи в этой теме.
Наиболее интересные из них - постараюсь реализовать в проекте.

Далее проект планируется расширять различными функциями работы с роутером, которые будут востребованы пользователями и которые пока не реализованы в официальном боте от keenetic.

P.S.
Поддержать проект можете, путем своего участия в проекте (пишите в "личку"), либо путем перевода любой суммы средств на этот кошелек ЮМани.

Изменено 30 мая, 2022 пользователем Zeleza

kilia · 10 апреля, 2022

Zeleza, добрый день!

Можно ли одного и того же бота использовать на двух роутерах? Будет ли работать или будут конфликты?

Zeleza · 10 апреля, 2022

3 минуты назад, kilia сказал:

Можно ли одного и того же бота использовать на двух роутерах? Будет ли работать или будут конфликты?

@kilia, доброго Вам дня,

Нет, подобная возможность исключена.

ExFet · 10 апреля, 2022

Почему могут не отображаться некоторые впн срединия в списке бота? Есть WG, есть A3 через OpenVpn но нет другого который идёт через L2tp/Ipsec

Zeleza · 10 апреля, 2022

В 10.04.2022 в 12:52, ExFet сказал:

Почему могут не отображаться некоторые впн срединия в списке бота?

Здравствуйте,
Все сообщения относительно отладки бета версий - прошу в "личку". Так же, желательно более подробно описать ситуацию и предоставить консольный вывод команды:

curl -s localhost:79/rci/show/ip/name-server

Bigus55 · 10 апреля, 2022

Можешь добавить опцию для прогрузки адресов целыми CIDR блоками?

И опубликуй код на гитхабе, а то выглядит как кот в мешке.

kilia · 10 апреля, 2022

Zeleza, добрый день!

Что-то у меня не взлетело:

~ # zpu add rutracker.org
Команда: 'if [ -f '/opt/etc/zezl/zezl.conf' ]; then echo 1; else echo 0; fi'
[INFO] zezl->tools.py->run[498] - "Команда: 'if [ -f '/opt/etc/zezl/zezl.conf' ]; then echo 1; else echo 0; fi'"
Команда: 'cat < /opt/etc/zezl/zezl.conf | grep 'DNS=' | cut -d'=' -f2'
[INFO] zezl->tools.py->run[498] - "Команда: 'cat < /opt/etc/zezl/zezl.conf | grep 'DNS=' | cut -d'=' -f2'"
Команда: 'curl -s localhost:79/rci/ip/route'
[INFO] zezl->tools.py->run[498] - "Команда: 'curl -s localhost:79/rci/ip/route'"
Traceback (most recent call last):
  File "/opt/bin/zpu", line 234, in <module>
    res = cmd_add_hosts(hosts=sys.argv[2:]) if args_count > 1 else no_args()
  File "/opt/bin/zpu", line 149, in cmd_add_hosts
    mess = vpn_lib.load_hosts_to_white_list(hosts=hosts)
  File "/opt/apps/zezl/vpn_lib.py", line 1114, in load_hosts_to_white_list
    messages_list = add_some_hosts(hosts=hosts, interfaces=interfaces, dns_ip=dns_config)
  File "/opt/apps/zezl/vpn_lib.py", line 1219, in add_some_hosts
    for inface in interfaces:
TypeError: 'NoneType' object is not iterable

Попробовал

# zpu interface Wireguard0

В ответ список поддерживаемых команд.

Попробовал еще раз добавить токен, так как в телеграм на /start ничего не происходит:

~ # zpu token ******:**********************
Команда: 'sed -i "/TOKEN/d" "/opt/etc/zezl/zezl.conf" && echo TOKEN=******:********************** >> "/opt/etc/zezl/zezl.conf" && /opt/etc/init.d/S61zezl restart && /opt/etc/init.d/S61zezl status'
[INFO] zezl->tools.py->run[498] - "Команда: 'sed -i "/TOKEN/d" "/opt/etc/zezl/zezl.conf" && echo TOKEN=******:********************** >> "/opt/etc/zezl/zezl.conf" && /opt/etc/init.d/S61zezl restart && /opt/etc/init.d/S61zezl status'"
Токен успешно установлен.
Запускаем бота...
---------------------------------------------------
 Starting zezl.py...              done. 
 Checking zezl.py...              alive. 
---------------------------------------------------
Готово.

Что я сделал не так?

Изменено 10 апреля, 2022 пользователем kilia

Zeleza · 10 апреля, 2022

9 минут назад, kilia сказал:

Что я сделал не так?

Доброго дня,
Забыл отключить вариант отладки, прошу прощения.
Потому много всяких ненужных сообщений, но в целом - бот у Вас запустился судя по логу.
Можете проверить командой:

/opt/etc/init.d/S61zezl status

В боте введите команду /start или /list или /backup, должно появится одно из меню.

Относительно zpu - написал выше:

Цитата

В версии 1.0-beta-9 доступен пока не весь функционал, планируется в следующем релизе его реализовать полностью.

kilia · 10 апреля, 2022

После установки токена запускается, но следующей командой падает:

~ # /opt/etc/init.d/S61zezl status
 Checking zezl.py...              dead. 
~ # zpu token *****:*******
Команда: 'sed -i "/TOKEN/d" "/opt/etc/zezl/zezl.conf" && echo TOKEN=*****:******* >> "/opt/etc/zezl/zezl.conf" && /opt/etc/init.d/S61zezl restart && /opt/etc/init.d/S61zezl status'
[INFO] zezl->tools.py->run[498] - "Команда: 'sed -i "/TOKEN/d" "/opt/etc/zezl/zezl.conf" && echo TOKEN=*****:******* >> "/opt/etc/zezl/zezl.conf" && /opt/etc/init.d/S61zezl restart && /opt/etc/init.d/S61zezl status'"
Токен успешно установлен.
Запускаем бота...
---------------------------------------------------
 Starting zezl.py...              done. 
 Checking zezl.py...              alive. 
---------------------------------------------------
Готово.
~ # /opt/etc/init.d/S61zezl status
 Checking zezl.py...              alive. 
~ # /opt/etc/init.d/S61zezl status
 Checking zezl.py...              dead. 
~ # /opt/etc/init.d/S61zezl status
 Checking zezl.py...              dead.

При этом сам бот в телеге ни на что не реагирует. Подожду следующей версии тогда, чтобы вы не подумали что я проблемный=)))

Zeleza · 10 апреля, 2022

Попробуйте запустить следующей командой

/opt/etc/init.d/S61zezl stop
/opt/apps/zezl/zezl.py

и пришлите вывод терминальный.

kilia · 10 апреля, 2022

Zeleza, спасибо! В общем у меня бот уже был ранее создан, перевыпустил токен и все заработало.

Aleksandr Akimov · 10 апреля, 2022

А как обстоят дела с безопасностью? Как определяется список пользователей/чатов которые могут управлять функционалом?

Zeleza · 10 апреля, 2022

8 минут назад, Aleksandr Akimov сказал:

А как обстоят дела с безопасностью? Как определяется список пользователей/чатов которые могут управлять функционалом?

Доброго дня, пока нет такого функционала - предлагайте.
Есть идея привязать к аккаунту телеграм.

Aleksandr Akimov · 10 апреля, 2022

Как вариант - сделать привязку к chat_id. Установил пакет, сразу написал боту, он записал chat_id, остальные будет игнорировать.

По моему опыту - имею ряд ботов с рандомными именами, которые нигде не "засвечены", но периодически и им пишут разные пользователи, поэтому стоит защитится от такого.

Zeleza · 10 апреля, 2022

1 минуту назад, Aleksandr Akimov сказал:

Как вариант - сделать привязку к chat_id. Установил пакет, сразу написал боту, он записал chat_id, остальные будет игнорировать.

По моему опыту - имею ряд ботов с рандомными именами, которые нигде не "засвечены", но периодически и им пишут разные пользователи, поэтому стоит защитится от такого.

Добро, благодарю за идею.
Сделаю в последующих релизах.

Zeleza · 11 апреля, 2022

Доступна для установки новая версия zezl_1.0-beta_11_all.ipk.

При инсталляции пакета необходимо теперь вводить свой user_id для избежания проблем с безопасностью. После его ввода, другие пользователи не смогут иметь доступ к боту (прошу подтвердить, что все работает как надо - сделана привязка к user_id).
Внесены правки в скрипты удаления и установки пакета, которые позволяют не вводить каждый раз token и user_id. Опция доступна, если Вы, при удалении пакета, не станете удалять файлы конфигурации - данные будут браться из предыдущей установки.

Изменено 11 апреля, 2022 пользователем Zeleza

kilia · 11 апреля, 2022

~~Может кому полезно будет:~~

~~Чтобы узнать свой id можно написать телеграм боту @getmyid_bot, в ответ получите ваш id~~

А походу Жезл сам находит id

Zeleza, добрый день!

У меня вот такое во время запуска:

Запускаем zezl...

Для начала работы необходимо перейти в Телеграм и открыть диалог 
с созданным Вами ботом, а затем набрать команду /start

[INFO] zezl->tools.py->run[498] - "Команда: 'cat < /opt/etc/zezl/zezl.conf | grep 'USER_ID=' | cut -d'=' -f2'"
Traceback (most recent call last):
  File "/opt/apps/zezl/handlers.py", line 25, in get_user_id
    from remote_data import USER_ID
ModuleNotFoundError: No module named 'remote_data'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/apps/zezl/zezl.py", line 13, in <module>
    from handlers import (
  File "/opt/apps/zezl/handlers.py", line 304, in <module>
    admin = Filters.user(get_user_id())
  File "/opt/apps/zezl/handlers.py", line 35, in get_user_id
    user_id = int(out.replace('\n', '')) if is_ok else -1
ValueError: invalid literal for int() with base 10: ''
Collected errors:
 * pkg_run_script: package "zezl" postinst script returned status 1.
 * opkg_configure: zezl.postinst returned 1.

Вписал в nano /opt/etc/zezl/zezl.conf свой USER_ID вручную, и все заработало!

Спасибо!

Изменено 11 апреля, 2022 пользователем kilia

Zeleza · 11 апреля, 2022

19 минут назад, kilia сказал:

У меня вот такое во время запуска:

Доброго дня
Это происходит по причине отсутствия данных об user_id в файле конфигурации - попробуйте снова удалить пакет и переустановить его, введя данные заново.

kilia · 11 апреля, 2022

13 минуты назад, Zeleza сказал:

Доброго дня
Это происходит по причине отсутствия данных об user_id в файле конфигурации - попробуйте снова удалить пакет и переустановить его, введя данные заново.

Остановил, удалил, установил заново:

~ # /opt/etc/init.d/S61zezl stop
 Checking zezl.py...              alive. 
 Shutting down zezl.py...              done. 
~ # opkg remove zezl
Removing package zezl from root...
Удаляем файлы пакета 'zezl'...
Удаляем данные из cron...
Удалить файлы конфигурации пакета [Y/N]? 
Y
Удаляем файлы конфигурации 'zezl'...
Удалить python пакеты: telegram-bot [Y/N]? 
N
~ # opkg install /opt/apps/packages/zezl_1.0-beta_11_all.ipk 
Installing zezl (1.0-beta_11) to root...
Configuring zezl.

Установка пакета ЖЕЗЛ™ [Zezl™] версия 1.0-beta_11...

Для полноценной работы пакета необходимо создать своего бота в 'Телеграм'
и получить ключ-токен. Видео-инструкцию Вы можете найти по ссылке ниже: 
https://youtu.be/KAgvPrvlI7Q

Для продолжения работы, ведите token Вашего бота: 
********:********
Запускаем zezl...

Для начала работы необходимо перейти в Телеграм и открыть диалог 
с созданным Вами ботом, а затем набрать команду /start

[INFO] zezl->tools.py->run[498] - "Команда: 'cat < /opt/etc/zezl/zezl.conf | grep 'USER_ID=' | cut -d'=' -f2'"
Traceback (most recent call last):
  File "/opt/apps/zezl/handlers.py", line 25, in get_user_id
    from remote_data import USER_ID
ModuleNotFoundError: No module named 'remote_data'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/apps/zezl/zezl.py", line 13, in <module>
    from handlers import (
  File "/opt/apps/zezl/handlers.py", line 304, in <module>
    admin = Filters.user(get_user_id())
  File "/opt/apps/zezl/handlers.py", line 35, in get_user_id
    user_id = int(out.replace('\n', '')) if is_ok else -1
ValueError: invalid literal for int() with base 10: ''
Collected errors:
 * pkg_run_script: package "zezl" postinst script returned status 1.
 * opkg_configure: zezl.postinst returned 1.

При этом если вручную впишу вручную nano /opt/etc/zezl/zezl.conf свой USER_ID, то скрипт стартует, но ботом может управлять кто угодно.

Zeleza · 11 апреля, 2022

5 минут назад, kilia сказал:

Остановил, удалил, установил заново:
При этом если вручную впишу вручную nano /opt/etc/zezl/zezl.conf свой USER_ID, то скрипт стартует, но ботом может управлять кто угодно.

Отправил сообщение в "личку".

Andrey Che · 11 апреля, 2022

Длина user_id зафиксирована на 9 цифрах, но у меня 8 цифр в ИД. Что делать?

Zeleza · 11 апреля, 2022

26 минут назад, Andrey Che сказал:

Длина user_id зафиксирована на 9 цифрах, но у меня 8 цифр в ИД. Что делать?

Доброго дня, сделал от 6 до 10 знаков.

Andrey Che · 11 апреля, 2022

Здравствуйте!

Заработало! Спасибо.

Изменено 11 апреля, 2022 пользователем Andrey Che

Aleksandr Akimov · 12 апреля, 2022

При установке получаю такую ошибку. update конечно делал.

Aleksandr Akimov · 12 апреля, 2022

Запустил повторно установку - теперь завершилась успешно.

Ещё заметил такой нюанс, сразу токен не принимал, пришлось обновить. Разница, кмк была в том, что в старом токене был символ нижнего подчеркивания.

Aleksandr Akimov · 12 апреля, 2022

При выборе пункта "детали" сообщение закрывается и ничего не происходит (я так понимаю он должен вывести список ip?)

Zeleza · 13 апреля, 2022

Доброго дня,

да именно так, должно вывести список ip.

По всем вопросам работы программы, пожалуйста в «личку». Будет эффективнее и быстрее.

Chernikov Ov · 13 апреля, 2022

Приветствую! Спасибо за труды!

В целом вроде все работает, но пристально не тестил, ждем ipset, это наверное ключевое чего сейчас сильно не хватает. Поэтому пока живем либо без условной инсты, либо с ворохом скриптов.

Изменено 13 апреля, 2022 пользователем Chernikov Ov

amcq · 13 апреля, 2022

Zeleza, добрый вечер

а планируете ли вы в будущем апдейт, позволяющий работу с instagram, facebook и подобным?

Chernikov Ov · 13 апреля, 2022

10 минут назад, amcq сказал:

а планируете ли вы в будущем апдейт, позволяющий работу с instagram, facebook и подобным?

А описание прочитать?

В 10.04.2022 в 10:29, Zeleza сказал:

В дальнейших выпусках пакета, скорее всего будет реализован один из вариантов работы через ipset.

telegram Проект "Жезл" - телеграмм бот для работы с роутером

Рекомендуемые сообщения

Топ авторов темы

Популярные дни

Топ авторов темы

Популярные дни

Популярные посты

Zeleza

Zeleza

Zeleza

Изображения в теме

Присоединяйтесь к обсуждению

Последние посетители 0 пользователей онлайн

Важная информация