Управление роутером через telegram openwrt

Telegram Scripts for OpenWrt

This is a set of scripts with a plugins API written in bash, you can use it to manage and get informations on OpenWRT Routers.

How its works ?

First of all,
Make a bot for you !
https://core.telegram.org/bots/api#authorizing-your-bot

With the bot created, you need to replace «[PUT YOUR BOT KEY HERE]» in the telegramopenwrt config file with your bot key.

Second, you need to send a initial message to your bot in Telegram App.
After you send the message, in the OpenWRT run this:

curl -s -k -X GET https://api.telegram.org/bot<YOUR BOT ID>/getUpdates | grep -oE "\"id\":[[:digit:]]+" | head -n1 | awk -F : '{print $2}'

Get the number and replace «[PUT ID OF THE CHAT THAT YOU START WITH BOT]» in the telegramopenwrt config.

Directory structure

├── etc
│   ├── config
│   │   └── telegramopenwrt
│   └── init.d
│       ├── hosts_scan
│       ├── lanports
│       └── telegram_bot
├── LICENSE
├── README.md
├── sbin
│   ├── camkeyboard
│   ├── hosts_scan
│   ├── lanports
│   ├── proxy
│   ├── telebot
│   ├── telegram_bot
│   ├── telegram_sender
│   ├── telekeyboard
│   └── typing
└── usr
    └── lib
        └── telegramopenwrt
            └── plugins
                ├── actions
                │   ├── cam_mv
                │   ├── fw_delete
                │   ├── fw_disable
                │   ├── fw_enable
                │   ├── fwr_disable
                │   ├── fwr_enable
                │   ├── light_control
                │   ├── proc_restart
                │   ├── proc_start
                │   ├── proc_stop
                │   ├── proxy_disable
                │   ├── proxy_enable
                │   ├── wifi_disable
                │   ├── wifi_enable
                │   └── wifi_restart
                ├── cam_movie
                ├── cam_mv
                ├── cam_shot
                ├── cam_vdo
                ├── ctx
                │   ├── cam_kbd
                │   ├── fw_list
                │   ├── fwr_list
                │   ├── light_list
                │   ├── proxy
                │   ├── reboot
                │   ├── service_list
                │   └── wifi_list
                ├── fw_add
                ├── fw_delete
                ├── fw_disable
                ├── fw_enable
                ├── fw_list
                ├── fwr_disable
                ├── fwr_enable
                ├── fwr_list
                ├── fw_unblock
                ├── get_ip
                ├── get_mac
                ├── get_ping
                ├── get_uptime
                ├── help
                │   ├── cam_movie
                │   ├── cam_mv
                │   ├── cam_shot
                │   ├── cam_vdo
                │   ├── fw_add
                │   ├── fw_delete
                │   ├── fw_disable
                │   ├── fw_enable
                │   ├── fw_list
                │   ├── fwr_disable
                │   ├── fwr_enable
                │   ├── fwr_list
                │   ├── fw_unblock
                │   ├── get_ip
                │   ├── get_mac
                │   ├── get_ping
                │   ├── get_uptime
                │   ├── hst_list
                │   ├── lights
                │   ├── msg_tv
                │   ├── netstat
                │   ├── proc_list
                │   ├── proc_restart
                │   ├── proc_start
                │   ├── proc_stop
                │   ├── proxy_disable
                │   ├── proxy_enable
                │   ├── proxy_list
                │   ├── reboot
                │   ├── start
                │   ├── swports_list
                │   ├── wifi_disable
                │   ├── wifi_enable
                │   ├── wifi_list
                │   ├── wifi_restart
                │   └── wll_list
                ├── hst_list
                ├── lights
                ├── msg_tv
                ├── netstat
                ├── proc_list
                ├── proc_restart
                ├── proc_start
                ├── proc_stop
                ├── proxy_disable
                ├── proxy_enable
                ├── proxy_list
                ├── reboot
                ├── start
                ├── swports_list
                ├── wifi_disable
                ├── wifi_enable
                ├── wifi_list
                ├── wifi_restart
                └── wll_list

11 directories, 110 files

lanports file

This file reads the router logs with the logread -f command, and sends messages via bot telegram if a router port is turned off / on or the router delivers an IP address via DHCP.

init.d directory

Contains the necessary files for the scripts to be started at the router boot, just move them to the /etc/init.d/ of the router and run:

/etc/init.d/lanports enable
/etc/init.d/telegram_bot enable

And then:

/etc/init.d/lanports start
/etc/init.d/telegram_bot start

plugins directory

This is the main directory, it contains all the commands that the telegram bot can execute.

There are some pre-built commands, which are:

• cam_movie: Record 25 seconds of a camIP and send it.
• cam_mv: Move the camera arround.
• cam_shot: Get a Pic from the camera.
• cam_vdo: Get a 25 seconds record from a camIP.
• fw_add: Block a hostname using a deny rule in firewall, if append time to command will block from 23:00 to 8:00
• fw_delete: Remove a hostname from a deny firewall rule, if hostname is empty, will remove all rules created by this bot.
• fw_disable: Disable a firewall rule.
• fw_enable: Enable a firewall rule.
• fw_list: List all fw rules.
• fwr_disable: Disable a redirect firewall rule.
• fwr_enable: Enable a redirect firewall rule.
• fwr_list: List all redirect fw rules.
• fw_unblock: Remove a hostname from a deny firewall rule, if hostname is empty, will remove all rules created by this bot.
• get_ip: Get WAN IPAddress.
• get_mac: Get the Organization that onwer the MacAddr.
• get_ping: Ping a address or host, return Up or Down.
• get_uptime: Return the uptime from this Device.
• hst_list: Get hosts in the dhcp Leases. If a hostname is present, search only for this hostname.
• lights: Turn On or Off house Lights.
• msg_tv: Send Message to Samsung TV
• netstat: Prints netstat table in ESTABLISHED, CLOSED and TIME_WAIT State.
• proc_list: List all process in execution
• proc_restart: Restart a process in init.d
• proc_start: Start a process in init.d
• proc_stop: Stop a process in init.d
• proxy_disable: Disable HTTP and HTTPS or HTTP or HTTPS proxy.
• proxy_enable: Enable HTTP and HTTPS or HTTP or HTTPS proxy.
• proxy_list: List proxy rules that is enabled.
• reboot: Reboot the router.
• start: This menu help!
• swports_list: Switch ports list with states.
• wifi_disable: Disable a wireless device radio.
• wifi_enable: Enable a wireless device radio.
• wifi_list: List all wireless devices.
• wifi_restart: Restart a wireless device radio.
• wll_list: Get a wifi clients list that is connected to this devices.

help directory inside plugins

This is the directory containing the help files, with the same name as the command, to be displayed by the start command.

telebot file

This file sends the telegram bot messages generated by lanports

telegram_bot

The telegram_bot script is a loop that receives the updates every second and checks to see if there is a command to execute. If there is a command, the script checks to see if there is a file with the same name as the command inside the plugins directory and runs it, if it exists. The output of the executed script is sent as a response message from the command.
Inside the plugins directory, there is the special command «start», which returns a message with the commands and a brief help on each command.
For this command to work properly, you need to create a file inside the plugins / help directory, with the name equal to the command.

License

See LICENSE file.

Package Guidelines

See CONTRIBUTING.md file.

For the past 5 years or so, I have been using a single ISP at home and mobile data for backup when it went down. But since last few months, the ISP service became a bit unreliable – this is more related to the rainy season. Mobile data doesn’t give fiber like constant speeds I get on the wire. It’s very annoying to browse at < 10 Mbps on mobile data when you are used to 100 Mbps on the wire.

I decided to get another fiber pipe from a local ISP. One needs to be very unlucky to have both going down at the same time – I hope that never happens. Now the question is how to monitor the two connections: Why do I need monitoring? – so that I can inform the ISP when it goes down, with the fail-over happening automatically thanks to OpenWRT’s mwan3 package, I won’t ever know when I am using which ISP (unless I am checking the public IP address, of course).

The solution: A custom API and a Telegram bot. For those not aware about Telegram, it is an amazing messaging app just like Whatsapp with way more features (bots, channels), and does away with some idiosyncrasies of Whatsapp such as restricting you to always have the phone connected.

A Telegram bot is fairly simple to write, you just have to use their API. Now this bot is just going to send me messages, I am never going to send any to it, so implementing my WAN monitor bot was very easy.

My router is a TP Link WR740N which has 4 MB flash – so it is not possible to have curl with SSL support which is required by the API. I wrote a custom script which can be called over HTTP and plays well with the default wget. The script is present on a cloud server which can, obviously, do the SSL stuff.

A custom wrapper to Telegram API to send message in PHP:

<?php

$key = '<a random key>';

if ($_REQUEST['key'] != $key) {
    die("Access Denied");
}

$interface = $_REQUEST['interface'];
$status = $_REQUEST['status'];

$interface_map = array(
    'wan1' => 'ISP1',
    'wan2' => 'ISP2'
);

$status_map = array(
    'ifdown' => 'Down',
    'ifup' => 'Up'
);

$message = "TRIGGER: ${interface_map[$interface]} is ${status_map[$status]}";

$ch = curl_init("https://api.telegram.org/bot<bot ID>/sendMessage");

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, array(
    'chat_id' => '<your chat id>',
    'text' => $message
));
curl_exec($ch);

The <your chat id>  part needs to be discovered once you send a /start command to your bot and use Telegram’s getUpdates method. You will get it in API’s response JSON. $key  is just a security check to prevent external attacks on the script.

And this script is called on interface events by mwan3 (/etc/mwan3.user ):

wget -O /dev/null "http://<server ip address>/wanupdate.php?interface=$INTERFACE&status=$ACTION&key=<your random key>" >/dev/null 2>/dev/null &

Shell script to monitor connections by cron directly from the server:

#!/bin/bash

nc -w 2 -z <ip address> <port number>
isp1_status=$?

nc -w 2 -z <ip address> <port number>
isp2_status=$?

sendmsg() {
    curl https://api.telegram.org/bot<bot id>/sendMessage -d chat_id=<chat id> -d text="$1" &> /dev/null
}

if [[ $isp1_status -ne 0 ]]; then
    sendmsg "MONITOR: ISP1 is Down"
fi

if [[ $isp2_status -ne 0 ]]; then
    sendmsg "MONITOR: ISP2 is Down"
fi

The above script uses netcat to do the link test using a TCP connection to a port number which is port forwarded to a server because I found ping was doing some false positives. I couldn’t reproduce it when I was trying it manually but I used to get DOWN messages even though the connection was working.

One must wonder though, how will the message reach me via Telegram when both ISPs go down at the same time – well I leave that job to Android and mobile data. Android switches to mobile data as soon as it finds WiFi doesn’t have internet access.