3 utl = require "luci.util"
4 sys = require "luci.sys"
6 require("luci.model.uci")
7 require("luci.sys.iptparser")
10 local uci = luci.model.uci.cursor_state()
11 local ipt = luci.sys.iptparser.IptParser()
13 local fs = require "luci.fs"
14 local ip = require "luci.ip"
18 local has_ipv6 = fs.access("/proc/net/ipv6_route") and fs.access("/usr/sbin/ip6tables")
21 os.execute("lock /var/run/luci_splash.lock")
25 os.execute("lock -u /var/run/luci_splash.lock")
29 local ret = sys.exec(cmd)
32 if ret and ret ~= "" then
39 local o3, o4 = ip:match("[0-9]+%.[0-9]+%.([0-9]+)%.([0-9]+)")
41 return string.format("%02X%s", tonumber(o3), "") .. string.format("%02X%s", tonumber(o4), "")
47 function update_stats(leased, whitelisted, whitelisttotal, blacklisted, blacklisttotal)
48 local leases = uci:get_all("luci_splash_leases", "stats")
49 uci:delete("luci_splash_leases", "stats")
50 uci:section("luci_splash_leases", "stats", "stats", {
51 leases = leased or (leases and leases.leases) or 0,
52 whitelisttotal = whitelisttotal or (leased and leases.whitelisttotal) or 0,
53 whitelistonline = whitelisted or (leases and leases.whitelistonline) or 0,
54 blacklisttotal = blacklisttotal or (leases and leases.blacklisttotal) or 0,
55 blacklistonline = blacklisted or (leases and leases.blacklistonline) or 0,
57 uci:save("luci_splash_leases")
60 function get_device_for_ip(ipaddr)
62 uci:foreach("network", "interface", function(s)
63 if s.ipaddr and s.netmask then
64 local network = ip.IPv4(s.ipaddr, s.netmask)
65 if network:contains(ip.IPv4(ipaddr)) then
66 -- this should be rewritten to luci functions if possible
67 dev = utl.trim(sys.exec(". /lib/functions/network.sh; network_get_device IFNAME '" .. s['.name'] .. "'; echo $IFNAME"))
74 function get_physdev(interface)
76 dev = utl.trim(sys.exec(". /lib/functions/network.sh; network_get_device IFNAME '" .. interface .. "'; echo $IFNAME"))
82 function get_filter_handle(parent, direction, device, mac)
83 local input = utl.split(sys.exec('/usr/sbin/tc filter show dev ' .. device .. ' parent ' .. parent) or {})
86 for k, v in pairs(input) do
87 handle = v:match('filter protocol ip pref %d+ u32 fh (%d*:%d*:%d*) order')
89 local mac, mac1, mac2, mac3, mac4, mac5, mac6
90 if direction == 'src' then
91 mac1, mac2, mac3, mac4 = input[k+1]:match('match ([%a%d][%a%d])([%a%d][%a%d])([%a%d][%a%d])([%a%d][%a%d])/ffffffff')
92 mac5, mac6 = input[k+2]:match('match ([%a%d][%a%d])([%a%d][%a%d])0000/ffff0000')
94 mac1, mac2 = input[k+1]:match('match 0000([%a%d][%a%d])([%a%d][%a%d])/0000ffff')
95 mac3, mac4, mac5, mac6 = input[k+2]:match('match ([%a%d][%a%d])([%a%d][%a%d])([%a%d][%a%d])([%a%d][%a%d])/ffffffff')
97 if mac1 and mac2 and mac3 and mac4 and mac5 and mac6 then
98 mac = "%s:%s:%s:%s:%s:%s" % { mac1, mac2, mac3, mac4, mac5, mac6 }
110 local cmd = table.remove(argv, 1)
113 limit_up = (tonumber(uci:get("luci_splash", "general", "limit_up")) or 0) * 8
114 limit_down = (tonumber(uci:get("luci_splash", "general", "limit_down")) or 0) * 8
116 if ( cmd == "lease" or cmd == "add-rules" or cmd == "remove" or
117 cmd == "whitelist" or cmd == "blacklist" or cmd == "status" ) and #argv > 0
121 local arp_cache = net.arptable()
122 local leased_macs = get_known_macs("lease")
123 local blacklist_macs = get_known_macs("blacklist")
124 local whitelist_macs = get_known_macs("whitelist")
126 for i, adr in ipairs(argv) do
128 if adr:find(":") then
131 for _, e in ipairs(arp_cache) do
132 if e["IP address"] == adr then
133 mac = e["HW address"]:lower()
139 if mac and cmd == "add-rules" then
140 if leased_macs[mac] then
141 add_lease(mac, arp_cache, true)
142 elseif blacklist_macs[mac] then
143 add_blacklist_rule(mac)
144 elseif whitelist_macs[mac] then
145 add_whitelist_rule(mac)
147 elseif mac and cmd == "status" then
148 print(leased_macs[mac] and "lease"
149 or whitelist_macs[mac] and "whitelist"
150 or blacklist_macs[mac] and "blacklist"
152 elseif mac and ( cmd == "whitelist" or cmd == "blacklist" or cmd == "lease" ) then
153 if cmd ~= "lease" and leased_macs[mac] then
154 print("Removing %s from leases" % mac)
156 leased_macs[mac] = nil
159 if cmd ~= "whitelist" and whitelist_macs[mac] then
160 print("Removing %s from whitelist" % mac)
161 remove_whitelist(mac)
162 whitelist_macs[mac] = nil
165 if cmd ~= "blacklist" and blacklist_macs[mac] then
166 print("Removing %s from blacklist" % mac)
167 remove_blacklist(mac)
168 blacklist_macs[mac] = nil
171 if cmd == "lease" and not leased_macs[mac] then
172 print("Adding %s to leases" % mac)
174 leased_macs[mac] = true
175 elseif cmd == "whitelist" and not whitelist_macs[mac] then
176 print("Adding %s to whitelist" % mac)
178 whitelist_macs[mac] = true
179 elseif cmd == "blacklist" and not blacklist_macs[mac] then
180 print("Adding %s to blacklist" % mac)
182 blacklist_macs[mac] = true
184 print("The mac %s is already %sed" %{ mac, cmd })
186 elseif mac and cmd == "remove" then
187 if leased_macs[mac] then
188 print("Removing %s from leases" % mac)
190 leased_macs[mac] = nil
191 elseif whitelist_macs[mac] then
192 print("Removing %s from whitelist" % mac)
193 remove_whitelist(mac)
194 whitelist_macs[mac] = nil
195 elseif blacklist_macs[mac] then
196 print("Removing %s from blacklist" % mac)
197 remove_blacklist(mac)
198 blacklist_macs[mac] = nil
200 print("The mac %s is not known" % mac)
203 print("Can not find mac for ip %s" % argv[i])
209 elseif cmd == "sync" then
212 elseif cmd == "list" then
217 print("\n luci-splash list\n List connected, black- and whitelisted clients")
218 print("\n luci-splash sync\n Synchronize firewall rules and clear expired leases")
219 print("\n luci-splash lease <MAC-or-IP>\n Create a lease for the given address")
220 print("\n luci-splash blacklist <MAC-or-IP>\n Add given address to blacklist")
221 print("\n luci-splash whitelist <MAC-or-IP>\n Add given address to whitelist")
222 print("\n luci-splash remove <MAC-or-IP>\n Remove given address from the lease-, black- or whitelist")
229 -- Get current arp cache
230 function get_arpcache()
232 for _, entry in ipairs(net.arptable()) do
233 arpcache[entry["HW address"]:lower()] = { entry["Device"]:lower(), entry["IP address"]:lower() }
238 -- Get a list of known mac addresses
239 function get_known_macs(list)
240 local leased_macs = { }
242 if not list or list == "lease" then
243 uci:foreach("luci_splash_leases", "lease",
244 function(s) leased_macs[s.mac:lower()] = true end)
247 if not list or list == "whitelist" then
248 uci:foreach("luci_splash", "whitelist",
249 function(s) leased_macs[s.mac:lower()] = true end)
252 if not list or list == "blacklist" then
253 uci:foreach("luci_splash", "blacklist",
254 function(s) leased_macs[s.mac:lower()] = true end)
261 -- Helper to delete iptables rules
262 function ipt_delete_all(args, comp, off)
264 for i, r in ipairs(ipt:find(args)) do
265 if comp == nil or comp(r) then
266 off[r.table] = off[r.table] or { }
267 off[r.table][r.chain] = off[r.table][r.chain] or 0
269 exec("iptables -t %q -D %q %d 2>/dev/null"
270 %{ r.table, r.chain, r.index - off[r.table][r.chain] })
272 off[r.table][r.chain] = off[r.table][r.chain] + 1
277 function ipt6_delete_all(args, comp, off)
279 for i, r in ipairs(ipt:find(args)) do
280 if comp == nil or comp(r) then
281 off[r.table] = off[r.table] or { }
282 off[r.table][r.chain] = off[r.table][r.chain] or 0
284 exec("ip6tables -t %q -D %q %d 2>/dev/null"
285 %{ r.table, r.chain, r.index - off[r.table][r.chain] })
287 off[r.table][r.chain] = off[r.table][r.chain] + 1
293 -- Convert mac to uci-compatible section name
294 function convert_mac_to_secname(mac)
295 return string.gsub(mac, ":", "")
298 -- Add a lease to state and invoke add_rule
299 function add_lease(mac, arp, no_uci)
302 -- Get current ip address
304 for _, entry in ipairs(arp or net.arptable()) do
305 if entry["HW address"]:lower() == mac then
306 ipaddr = entry["IP address"]
311 -- Add lease if there is an ip addr
313 local device = get_device_for_ip(ipaddr)
315 local leased = uci:get("luci_splash_leases", "stats", "leases")
316 if type(tonumber(leased)) == "number" then
317 update_stats(leased + 1, nil, nil, nil, nil)
320 uci:section("luci_splash_leases", "lease", convert_mac_to_secname(mac), {
325 limit_down = limit_down,
328 uci:save("luci_splash_leases")
330 add_lease_rule(mac, ipaddr, device)
332 print("Found no active IP for %s, lease not added" % mac)
337 -- Remove a lease from state and invoke remove_rule
338 function remove_lease(mac)
341 uci:delete_all("luci_splash_leases", "lease",
343 if s.mac:lower() == mac then
344 remove_lease_rule(mac, s.ipaddr, s.device, tonumber(s.limit_up), tonumber(s.limit_down))
345 local leased = uci:get("luci_splash_leases", "stats", "leases")
346 if type(tonumber(leased)) == "number" and tonumber(leased) > 0 then
347 update_stats(leased - 1, nil, nil, nil, nil)
354 uci:save("luci_splash_leases")
358 -- Add a whitelist entry
359 function add_whitelist(mac)
360 uci:section("luci_splash", "whitelist", convert_mac_to_secname(mac), { mac = mac })
361 uci:save("luci_splash")
362 uci:commit("luci_splash")
363 add_whitelist_rule(mac)
367 -- Add a blacklist entry
368 function add_blacklist(mac)
369 uci:section("luci_splash", "blacklist", convert_mac_to_secname(mac), { mac = mac })
370 uci:save("luci_splash")
371 uci:commit("luci_splash")
372 add_blacklist_rule(mac)
376 -- Remove a whitelist entry
377 function remove_whitelist(mac)
379 uci:delete_all("luci_splash", "whitelist",
380 function(s) return not s.mac or s.mac:lower() == mac end)
381 uci:save("luci_splash")
382 uci:commit("luci_splash")
383 remove_lease_rule(mac)
384 remove_whitelist_tc(mac)
387 function remove_whitelist_tc(mac)
389 print("Removing whitelist filters for " .. mac)
391 uci:foreach("luci_splash", "iface", function(s)
392 local device = get_physdev(s['.name'])
393 local handle = get_filter_handle('ffff:', 'src', device, mac)
394 exec('tc filter del dev "%s" parent ffff: protocol ip prio 1 handle %s u32' % { device, handle })
395 local handle = get_filter_handle('1:', 'dest', device, mac)
396 exec('tc filter del dev "%s" parent 1:0 protocol ip prio 1 handle %s u32' % { device, handle })
400 -- Remove a blacklist entry
401 function remove_blacklist(mac)
403 uci:delete_all("luci_splash", "blacklist",
404 function(s) return not s.mac or s.mac:lower() == mac end)
405 uci:save("luci_splash")
406 uci:commit("luci_splash")
407 remove_lease_rule(mac)
411 -- Add an iptables rule
412 function add_lease_rule(mac, ipaddr, device)
418 exec("iptables -t mangle -I luci_splash_mark_out -m mac --mac-source %q -j RETURN" % mac)
420 if id and device then
421 exec("iptables -t mangle -I luci_splash_mark_in -d %q -j MARK --set-mark 0x1%s -m comment --comment %s" % {ipaddr, id, mac:upper()})
425 exec("ip6tables -t mangle -I luci_splash_mark_out -m mac --mac-source %q -j MARK --set-mark 79" % mac)
426 -- not working yet, needs the ip6addr
427 --exec("ip6tables -t mangle -I luci_splash_mark_in -d %q -j MARK --set-mark 80 -m comment --comment %s" % {ipaddr, mac:upper()})
431 if device and tonumber(limit_up) > 0 then
432 exec('tc filter add dev "%s" parent ffff: protocol ip prio 2 u32 match ether src %s police rate %skbit mtu 6k burst 6k drop' % {device, mac, limit_up})
435 if id and device and tonumber(limit_down) > 0 then
436 exec("tc class add dev %s parent 1: classid 1:0x%s htb rate %skbit" % { device, id, limit_down })
437 exec("tc qdisc add dev %s parent 1:%s sfq perturb 10" % { device, id })
440 exec("iptables -t filter -I luci_splash_filter -m mac --mac-source %q -j RETURN" % mac)
441 exec("iptables -t nat -I luci_splash_leases -m mac --mac-source %q -j RETURN" % mac)
443 exec("ip6tables -t filter -I luci_splash_filter -m mac --mac-source %q -j RETURN" % mac)
448 -- Remove lease, black- or whitelist rules
449 function remove_lease_rule(mac, ipaddr, device, limit_up, limit_down)
456 ipt_delete_all({table="mangle", chain="luci_splash_mark_in", options={"/*", mac:upper()}})
457 ipt_delete_all({table="mangle", chain="luci_splash_mark_out", options={"MAC", mac:upper()}})
458 ipt_delete_all({table="filter", chain="luci_splash_filter", options={"MAC", mac:upper()}})
459 ipt_delete_all({table="nat", chain="luci_splash_leases", options={"MAC", mac:upper()}})
461 ipt6_delete_all({table="mangle", chain="luci_splash_mark_out", options={"MAC", mac:upper()}})
462 ipt6_delete_all({table="filter", chain="luci_splash_filter", options={"MAC", mac:upper()}})
464 if device and tonumber(limit_up) > 0 then
465 local handle = get_filter_handle('ffff:', 'src', device, mac)
467 exec('tc filter del dev "%s" parent ffff: protocol ip prio 2 handle %s u32 police rate %skbit mtu 6k burst 6k drop' % {device, handle, limit_up})
471 -- remove clients class
472 if device and id then
473 exec('tc class del dev "%s" classid 1:%s' % {device, id})
474 exec('tc qdisc del dev "%s" parent 1:%s sfq perturb 10' % { device, id })
480 -- Add whitelist rules
481 function add_whitelist_rule(mac)
482 exec("iptables -t filter -I luci_splash_filter -m mac --mac-source %q -j RETURN" % mac)
483 exec("iptables -t nat -I luci_splash_leases -m mac --mac-source %q -j RETURN" % mac)
485 exec("ip6tables -t filter -I luci_splash_filter -m mac --mac-source %q -j RETURN" % mac)
487 uci:foreach("luci_splash", "iface", function(s)
488 local device = get_physdev(s['.name'])
489 exec('tc filter add dev "%s" parent ffff: protocol ip prio 1 u32 match ether src %s police pass' % { device, mac })
490 exec('tc filter add dev "%s" parent 1:0 protocol ip prio 1 u32 match ether dst %s classid 1:1' % { device, mac })
495 -- Add blacklist rules
496 function add_blacklist_rule(mac)
497 exec("iptables -t filter -I luci_splash_filter -m mac --mac-source %q -j DROP" % mac)
499 exec("ip6tables -t filter -I luci_splash_filter -m mac --mac-source %q -j DROP" % mac)
504 -- Synchronise leases, remove abandoned rules
508 local time = os.time()
510 -- Current leases in state files
511 local leases = uci:get_all("luci_splash_leases")
513 -- Convert leasetime to seconds
514 local leasetime = tonumber(uci:get("luci_splash", "general", "leasetime")) * 3600
517 uci:load("luci_splash_leases")
518 uci:revert("luci_splash_leases")
522 for k, v in pairs(leases) do
523 if v[".type"] == "lease" then
524 if os.difftime(time, tonumber(v.start)) > leasetime then
526 remove_lease_rule(v.mac, v.ipaddr, v.device, tonumber(v.limit_up), tonumber(v.limit_down))
528 leasecount = leasecount + 1
530 uci:section("luci_splash_leases", "lease", convert_mac_to_secname(v.mac), {
535 limit_down = limit_down,
542 -- Get the mac addresses of current leases
543 local macs = get_known_macs()
544 local arpcache = get_arpcache()
546 local blackwhitelist = uci:get_all("luci_splash")
547 local whitelist_total = 0
548 local whitelist_online = 0
549 local blacklist_total = 0
550 local blacklist_online = 0
552 -- Whitelist, Blacklist
553 for _, s in utl.spairs(blackwhitelist,
554 function(a,b) return blackwhitelist[a][".type"] > blackwhitelist[b][".type"] end
556 if (s[".type"] == "whitelist") then
557 whitelist_total = whitelist_total + 1
559 local mac = s.mac:lower()
560 if arpcache[mac] then
561 whitelist_online = whitelist_online + 1
565 if (s[".type"] == "blacklist") then
566 blacklist_total = blacklist_total + 1
568 local mac = s.mac:lower()
569 if arpcache[mac] then
570 blacklist_online = blacklist_online + 1
576 update_stats(leasecount, whitelist_online, whitelist_total, blacklist_online, blacklist_total)
578 uci:save("luci_splash_leases")
582 ipt_delete_all({table="filter", chain="luci_splash_filter", options={"MAC"}},
583 function(r) return not macs[r.options[2]:lower()] end)
584 ipt_delete_all({table="nat", chain="luci_splash_leases", options={"MAC"}},
585 function(r) return not macs[r.options[2]:lower()] end)
586 ipt_delete_all({table="mangle", chain="luci_splash_mark_out", options={"MAC", "MARK", "set"}},
587 function(r) return not macs[r.options[2]:lower()] end)
588 ipt_delete_all({table="mangle", chain="luci_splash_mark_in", options={"/*", "MARK", "set"}},
589 function(r) return not macs[r.options[2]:lower()] end)
593 ipt6_delete_all({table="filter", chain="luci_splash_filter", options={"MAC"}},
594 function(r) return not macs[r.options[2]:lower()] end)
595 ipt6_delete_all({table="mangle", chain="luci_splash_mark_out", options={"MAC", "MARK", "set"}},
596 function(r) return not macs[r.options[2]:lower()] end)
604 local arpcache = get_arpcache()
605 -- Find traffic usage
606 local function traffic(lease)
608 local traffic_out = 0
610 local rin = ipt:find({table="mangle", chain="luci_splash_mark_in", destination=lease.ipaddr})
611 local rout = ipt:find({table="mangle", chain="luci_splash_mark_out", options={"MAC", lease.mac:upper()}})
613 if rin and #rin > 0 then traffic_in = math.floor( rin[1].bytes / 1024) end
614 if rout and #rout > 0 then traffic_out = math.floor(rout[1].bytes / 1024) end
616 return traffic_in, traffic_out
620 local leases = uci:get_all("luci_splash_leases")
621 local blackwhitelist = uci:get_all("luci_splash")
624 "%-17s %-15s %-9s %-4s %-7s %20s",
625 "MAC", "IP", "State", "Dur.", "Intf.", "Traffic down/up"
629 for _, s in pairs(leases) do
630 if s[".type"] == "lease" and s.mac then
631 local ti, to = traffic(s)
632 local mac = s.mac:lower()
633 local arp = arpcache[mac]
635 "%-17s %-15s %-9s %3dm %-7s %7dKB %7dKB",
636 mac, s.ipaddr, "leased",
637 math.floor(( os.time() - tonumber(s.start) ) / 60),
638 arp and arp[1] or "?", ti, to
643 -- Whitelist, Blacklist
644 for _, s in utl.spairs(blackwhitelist,
645 function(a,b) return blackwhitelist[a][".type"] > blackwhitelist[b][".type"] end
647 if (s[".type"] == "whitelist" or s[".type"] == "blacklist") and s.mac then
648 local mac = s.mac:lower()
649 local arp = arpcache[mac]
651 "%-17s %-15s %-9s %4s %-7s %9s %9s",
652 mac, arp and arp[2] or "?", s[".type"],
653 "- ", arp and arp[1] or "?", "-", "-"