jwalanta/OpenWrt detect new device and send text message.md

Last active October 21, 2024 17:19

Star () You must be signed in to star a gist
Fork () You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/jwalanta/53f55d03fcf5265938b64ffd361502d5.js"></script>
Save jwalanta/53f55d03fcf5265938b64ffd361502d5 to your computer and use it in GitHub Desktop.

Download ZIP

Detect new network devices connecting to OpenWrt and send text message

Raw

OpenWrt detect new device and send text message.md

Add the following line in `/etc/dnsmasq.conf`

dhcp-script=/etc/detect_new_device.sh

Setup sendmail to send email to your text number.

Reference:

Create `/etc/detect_new_device.sh` with the following content

#!/bin/sh

# script to detect new dhcp lease

# this will be called by dnsmasq everytime a new device is connected
# with the following arguments
# $1 = add | old
# $2 = mac address
# $3 = ip address
# $4 = device name

notification_email="[email protected]"

if [ "$1" == "add" ]; then
  msg="New device on `uci get system.@system[0].hostname`.`uci get dhcp.@dnsmasq[0].domain` $*"
  echo `date` $msg >> /tmp/dhcpmasq.log

  # encode colon (:) and send email
  echo $msg | sed s/:/-/g | sendmail "$notification_email"
fi

Alternative script using whitelist

This script only sends alerts if the mac address is not in the list

#!/bin/sh

# script to detect new dhcp lease

# this will be called by dnsmasq everytime a new device is connected
# with the following arguments
# $1 = add | old
# $2 = mac address
# $3 = ip address
# $4 = device name

known_mac_addr="/etc/known_mac_addr"
notification_email="[email protected]"

# check if the mac is in known devices list
grep -q "$2" "$known_mac_addr"
unknown_mac_addr=$?

if [ "$1" == "add" ] && [ "$unknown_mac_addr" -ne 0 ]; then
  msg="New device on `uci get system.@system[0].hostname`.`uci get dhcp.@dnsmasq[0].domain` $*"
  echo `date` $msg >> /tmp/dhcpmasq.log

  # encode colon (:) and send email
  echo $msg | sed s/:/-/g | sendmail "$notification_email"
fi

When a new device is added, dnsmasq calls detect_new_device.sh with arguments add mac_addr ip_addr devicename. The script checks if the device is new (if the dhcp lease hasn't expired, it calls with old), then logs and emails (which eventually is a text message) the information.

erdoukki commented Apr 14, 2022 •

edited

Loading

My own version, using mstmp

/root/detect_new_device.sh

#!/bin/sh

# script to detect new dhcp lease

# HOW-TO
# - add in /etc/dnsmasq.conf:
## DNSMASQ - DETECT-NEW-DEVICES
# dhcp-script=/root/detect_new_device.sh
# - optionally add in /etc/sysupgrade.conf:
# # DNSMASQ - DETECT-NEW-DEVICES
# /root/detect_new_device.sh
# - enable execute bit with:
# $ chmod a+x /root/detect_new_device.sh

# this will be called by dnsmasq everytime a new device is connected
# with the following arguments
# $1 = add | old
# $2 = mac address
# $3 = ip address
# $4 = device name

known_mac_addr="/etc/config/dhcp"
notification_email="user@acme"

#Convert MAC to uppercase
mac=$(echo "$2" | awk '{print toupper($0)}')

# check if the mac is in known devices list
grep -q "$mac" "$known_mac_addr"
unknown_mac_addr=$?

if [ "$1" == "add" ] && [ "$unknown_mac_addr" -ne 0 ]; then
	(
		echo "Subject: New device on $(uci get system.@system[0].hostname).$(uci get dhcp.@dnsmasq[0].domain)" 
		echo "To: $notification_email"
		echo ""
		echo "$(date):	New device on $(uci get system.@system[0].hostname).$(uci get dhcp.@dnsmasq[0].domain)" 
		echo "action:	$1"
		echo "mac:	$2" 
		echo "ip:	$3" 
		echo "name:	$4" 
	) | /usr/sbin/sendmail "$notification_email"
fi

TEST

root@LPM:~# /root/detect_new_device.sh add 123456

eric-void commented Jul 29, 2022

Not working anymore in new openwrt versions, due to "ujail" limitations.
See openwrt/openwrt#9856

Now you must put script in /etc/hotplug.d/dhcp (as "00-detect_new_device.sh") and you must rewrite conditions to use environment variables ACTIONS(='add'), IPADDR, MACADDR, HOSTNAME.
See an example here:
https://forum.openwrt.org/t/how-to-detect-dhcp-assignment-to-send-an-email-on-openwrt/24416/2

benisai commented Feb 9, 2023

Anyone have a updated script?

trustno1foxm commented Apr 5, 2023

I modfied that awesome script and it now works for me with the latest openwrt release. Just put that file into the directory "/etc/hotplug.d/dhcp".
I named it 99-detect_new_device.sh

here it is:

#!/bin/sh
# script to detect new dhcp lease

#saved mac addresses to just notice new unknown devices
known_mac_addr="/etc/known_mac_addr"
#set here your email address
notification_email="**youremailaddress**"

# check if the mac is in known devices list
grep -q "$MACADDR" "$known_mac_addr"
unknown_mac_addr=$?

if [ "$ACTION" = add ] && [ "$unknown_mac_addr" -ne 0 ]; then
    (
        echo "Subject: new DHCP lease on $(hostname)"
        echo ""
        echo "A new DHCP lease has been assigned: MAC=$MACADDR, IP=$IPADDR, NAME=$HOSTNAME"
    ) | sendmail "$notification_email"
fi