From: Dirk Brenken Date: Sat, 10 Nov 2018 10:19:50 +0000 (+0100) Subject: luci-app-banip: new package X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=refs%2Fpull%2F2264%2Fhead;p=oweals%2Fluci.git luci-app-banip: new package for details & LuCI screenshots see base package desprition/PR: https://github.com/openwrt/packages/pull/7373 Signed-off-by: Dirk Brenken --- diff --git a/applications/luci-app-banip/Makefile b/applications/luci-app-banip/Makefile new file mode 100644 index 000000000..1936bc36b --- /dev/null +++ b/applications/luci-app-banip/Makefile @@ -0,0 +1,12 @@ +# Copyright 2018 Dirk Brenken (dev@brenken.org) +# This is free software, licensed under the Apache License, Version 2.0 + +include $(TOPDIR)/rules.mk + +LUCI_TITLE:=LuCI support for banIP +LUCI_DEPENDS:=+banip +luci-lib-jsonc +LUCI_PKGARCH:=all + +include ../../luci.mk + +# call BuildPackage - OpenWrt buildroot signature diff --git a/applications/luci-app-banip/luasrc/controller/banip.lua b/applications/luci-app-banip/luasrc/controller/banip.lua new file mode 100644 index 000000000..e201295d5 --- /dev/null +++ b/applications/luci-app-banip/luasrc/controller/banip.lua @@ -0,0 +1,100 @@ +-- Copyright 2018 Dirk Brenken (dev@brenken.org) +-- This is free software, licensed under the Apache License, Version 2.0 + +module("luci.controller.banip", package.seeall) + +local util = require("luci.util") +local http = require("luci.http") +local i18n = require("luci.i18n") +local json = require("luci.jsonc") +local uci = require("luci.model.uci").cursor() + +function index() + if not nixio.fs.access("/etc/config/banip") then + return + end + entry({"admin", "services", "banip"}, firstchild(), _("banIP"), 40).dependent = false + entry({"admin", "services", "banip", "tab_from_cbi"}, cbi("banip/overview_tab", {hideresetbtn=true, hidesavebtn=true}), _("Overview"), 10).leaf = true + entry({"admin", "services", "banip", "ipset"}, template("banip/ipsetview"), _("IPSet-Lookup"), 20).leaf = true + entry({"admin", "services", "banip", "ripe"}, template("banip/ripeview"), _("RIPE-Lookup"), 30).leaf = true + entry({"admin", "services", "banip", "log"}, template("banip/logview"), _("View Logfile"), 40).leaf = true + entry({"admin", "services", "banip", "advanced"}, firstchild(), _("Advanced"), 100) + entry({"admin", "services", "banip", "advanced", "blacklist"}, form("banip/blacklist_tab"), _("Edit Blacklist"), 110).leaf = true + entry({"admin", "services", "banip", "advanced", "whitelist"}, form("banip/whitelist_tab"), _("Edit Whitelist"), 120).leaf = true + entry({"admin", "services", "banip", "advanced", "configuration"}, form("banip/configuration_tab"), _("Edit Configuration"), 130).leaf = true + entry({"admin", "services", "banip", "ipsetview"}, call("ipset_view"), nil).leaf = true + entry({"admin", "services", "banip", "ripeview"}, call("ripe_view"), nil).leaf = true + entry({"admin", "services", "banip", "logview"}, call("log_view"), nil).leaf = true + entry({"admin", "services", "banip", "status"}, call("status_update"), nil).leaf = true + entry({"admin", "services", "banip", "action"}, call("ban_action"), nil).leaf = true +end + +function ban_action(name) + if name == "do_refresh" then + luci.sys.call("/etc/init.d/banip start >/dev/null 2>&1") + end + luci.http.prepare_content("text/plain") + luci.http.write("0") +end + +function status_update() + local rt_file + local content + + rt_file = uci:get("banip", "global", "ban_rtfile") or "/tmp/ban_runtime.json" + + if nixio.fs.access(rt_file) then + content = json.parse(nixio.fs.readfile(rt_file) or "") + http.prepare_content("application/json") + http.write_json(content) + end +end + +function log_view() + local content + + if nixio.fs.access("/var/log/messages") then + content = util.trim(util.exec("grep -F 'banIP-' /var/log/messages")) + else + content = util.trim(util.exec("logread -e 'banIP-' 2>/dev/null")) + end + + if content == "" then + content = "No banIP related logs yet!" + end + http.write(content) +end + +function ipset_view(ipset, filter) + local content + + if not (ipset or filter) then + return + end + + if filter == "false" then + content = util.trim(util.exec("ipset -L " .. ipset .. " 2>/dev/null")) + else + content = util.trim(util.exec("ipset -L " .. ipset .. " 2>/dev/null | grep -e 'packets [1-9]\\|^[A-Z]'")) + end + + if content == "" then + content = "IPSet is empty!" + end + http.write(content) +end + +function ripe_view(query, input) + local content + + if not (query or input) then + return + end + + content = util.trim(util.exec("uclient-fetch --no-check-certificate -O- https://stat.ripe.net/data/" ..query.. "/data.json?resource=" ..input.. " 2>/dev/null")) + + if content == "" then + content = "No response!" + end + http.write(content) +end diff --git a/applications/luci-app-banip/luasrc/model/cbi/banip/blacklist_tab.lua b/applications/luci-app-banip/luasrc/model/cbi/banip/blacklist_tab.lua new file mode 100644 index 000000000..422182f4f --- /dev/null +++ b/applications/luci-app-banip/luasrc/model/cbi/banip/blacklist_tab.lua @@ -0,0 +1,55 @@ +-- Copyright 2018 Dirk Brenken (dev@brenken.org) +-- This is free software, licensed under the Apache License, Version 2.0 + +local fs = require("nixio.fs") +local util = require("luci.util") +local uci = require("luci.model.uci").cursor() +local input = uci:get("banip", "blacklist", "ban_src") or uci:get("banip", "blacklist", "ban_src_6") or "/etc/banip/adblock.blacklist" + +if not fs.access(input) then + m = SimpleForm("error", nil, translate("Input file not found, please check your configuration.")) + m.reset = false + m.submit = false + return m +end + +if fs.stat(input).size >= 102400 then + m = SimpleForm("error", nil, + translate("The file size is too large for online editing in LuCI (≥ 100 KB). ") + .. translate("Please edit this file directly in a terminal session.")) + m.reset = false + m.submit = false + return m +end + +m = SimpleForm("edit", nil) +m:append(Template("banip/banip_css")) +m.submit = translate("Save") +m.reset = false + +s = m:section(SimpleSection, nil, + translatef("This form allows you to modify the content of the banIP blacklist (%s).
", input) + .. translate("Please add only one IPv4 or IPv6 address per line. IP ranges in CIDR notation and comments introduced with '#' are allowed.")) + +f = s:option(TextValue, "data") +f.datatype = "string" +f.rows = 20 +f.rmempty = true + +function f.cfgvalue() + return fs.readfile(input) or "" +end + +function f.write(self, section, data) + return fs.writefile(input, "\n" .. util.trim(data:gsub("\r\n", "\n")) .. "\n") +end + +function f.remove(self, section, value) + return fs.writefile(input, "") +end + +function s.handle(self, state, data) + return true +end + +return m diff --git a/applications/luci-app-banip/luasrc/model/cbi/banip/configuration_tab.lua b/applications/luci-app-banip/luasrc/model/cbi/banip/configuration_tab.lua new file mode 100644 index 000000000..f90b11be0 --- /dev/null +++ b/applications/luci-app-banip/luasrc/model/cbi/banip/configuration_tab.lua @@ -0,0 +1,52 @@ +-- Copyright 2018 Dirk Brenken (dev@brenken.org) +-- This is free software, licensed under the Apache License, Version 2.0 + +local fs = require("nixio.fs") +local util = require("luci.util") +local input = "/etc/config/banip" + +if not fs.access(input) then + m = SimpleForm("error", nil, translate("Input file not found, please check your configuration.")) + m.reset = false + m.submit = false + return m +end + +if fs.stat(input).size >= 102400 then + m = SimpleForm("error", nil, + translate("The file size is too large for online editing in LuCI (≥ 100 KB). ") + .. translate("Please edit this file directly in a terminal session.")) + m.reset = false + m.submit = false + return m +end + +m = SimpleForm("edit", nil) +m:append(Template("banip/banip_css")) +m.submit = translate("Save") +m.reset = false + +s = m:section(SimpleSection, nil, + translate("This form allows you to modify the content of the main banIP configuration file (/etc/config/banip).")) + +f = s:option(TextValue, "data") +f.rows = 20 +f.rmempty = true + +function f.cfgvalue() + return fs.readfile(input) or "" +end + +function f.write(self, section, data) + return fs.writefile(input, "\n" .. util.trim(data:gsub("\r\n", "\n")) .. "\n") +end + +function f.remove(self, section, value) + return fs.writefile(input, "") +end + +function s.handle(self, state, data) + return true +end + +return m diff --git a/applications/luci-app-banip/luasrc/model/cbi/banip/overview_tab.lua b/applications/luci-app-banip/luasrc/model/cbi/banip/overview_tab.lua new file mode 100644 index 000000000..00bb5e426 --- /dev/null +++ b/applications/luci-app-banip/luasrc/model/cbi/banip/overview_tab.lua @@ -0,0 +1,200 @@ +-- Copyright 2018 Dirk Brenken (dev@brenken.org) +-- This is free software, licensed under the Apache License, Version 2.0 + +local fs = require("nixio.fs") +local uci = require("luci.model.uci").cursor() +local sys = require("luci.sys") +local net = require "luci.model.network".init() +local util = require("luci.util") +local dump = util.ubus("network.interface", "dump", {}) +local devices = sys.net:devices() + +m = Map("banip", translate("banIP"), + translate("Configuration of the banIP package to block ip adresses/subnets via IPSet. ") + .. translatef("For further information " + .. "" + .. "check the online documentation", "https://github.com/openwrt/packages/blob/master/net/banip/files/README.md")) + +-- Main banIP Options + +s = m:section(NamedSection, "global", "banip") + +o1 = s:option(Flag, "ban_enabled", translate("Enable banIP")) +o1.default = o1.disabled +o1.rmempty = false + +o2 = s:option(Flag, "ban_automatic", translate("Automatic WAN Interface Detection")) +o2.default = o2.enabled +o2.rmempty = false + +o3 = s:option(ListValue, "ban_iface", " ") +for _, dev in ipairs(devices) do + if dev ~= "lo" and dev ~= "br-lan" then + local iface = net:get_interface(dev) + if iface then + iface = iface:get_networks() or {} + for k, v in pairs(iface) do + iface[k] = iface[k].sid + if iface[k] ~= "lan" then + o3:value(iface[k], iface[k].. " (" ..dev.. ")") + end + end + end + end +end +o3.default = ban_iface +o3.rmempty = false + +o4 = s:option(ListValue, "ban_fetchutil", translate("Download Utility"), + translate("List of supported and fully pre-configured download utilities.")) +o4:value("uclient-fetch") +o4:value("wget") +o4:value("curl") +o4:value("aria2c") +o4:value("wget-nossl", "wget-nossl (noSSL)") +o4:value("busybox", "wget-busybox (noSSL)") +o4.default = "uclient-fetch" +o4.rmempty = false + +-- Runtime Information + +ds = s:option(DummyValue, "_dummy") +ds.template = "banip/runtime" + +-- Source Table + +bl = m:section(TypedSection, "source", translate("IP Blocklist Sources")) +bl.template = "banip/sourcelist" + +ssl = bl:option(DummyValue, "ban_src", translate("SSL req.")) +function ssl.cfgvalue(self, section) + local source = self.map:get(section, "ban_src") or self.map:get(section, "ban_src_6") + if source then + if source:match("https://") then + return translate("Yes") + else + return translate("No") + end + end + return translate("n/a") +end + +name_4 = bl:option(Flag, "ban_src_on", translate("enable IPv4")) +name_4.rmempty = false + +name_6 = bl:option(Flag, "ban_src_on_6", translate("enable IPv6")) +name_6.rmempty = false + +type = bl:option(ListValue, "ban_src_ruletype", translate("SRC/DST")) +type:value("src") +type:value("dst") +type:value("src+dst") +type.default = "src" +type.rmempty = false + +des = bl:option(DummyValue, "ban_src_desc", translate("Description")) + +cat = bl:option(DynamicList, "ban_src_cat", translate("ASN/Country")) +cat.datatype = "uciname" +cat.optional = true + +-- Extra options + +e = m:section(NamedSection, "extra", "banip", translate("Extra Options"), + translate("Options for further tweaking in case the defaults are not suitable for you.")) + +e1 = e:option(Flag, "ban_debug", translate("Verbose Debug Logging"), + translate("Enable verbose debug logging in case of any processing error.")) +e1.default = e1.disabled +e1.rmempty = false + +e2 = e:option(Flag, "ban_nice", translate("Low Priority Service"), + translate("Set the nice level to 'low priority' and banIP background processing will take less resources from the system. ") + ..translate("This change requires a manual service stop/re-start to take effect.")) +e2.default = e2.disabled +e2.disabled = "0" +e2.enabled = "10" +e2.rmempty = false + +e3 = e:option(Value, "ban_maxqueue", translate("Max. Download Queue"), + translate("Size of the download queue to handle downloads & IPset processing in parallel (default '8'). ") + .. translate("For further performance improvements you can raise this value, e.g. '16' or '32' should be safe.")) +e3.default = 8 +e3.datatype = "range(1,32)" +e3.rmempty = false + +e4 = e:option(Value, "ban_triggerdelay", translate("Trigger Delay"), + translate("Additional trigger delay in seconds before banIP processing begins.")) +e4.default = 2 +e4.datatype = "range(1,60)" +e4.optional = true + +e5 = e:option(Value, "ban_fetchparm", translate("Download Options"), + translate("Special options for the selected download utility, e.g. '--timeout=20 --no-check-certificate -O'.")) +e5.optional = true + +e10 = e:option(Value, "ban_wan_input_chain", translate("WAN Input Chain IPv4")) +e10.default = "input_wan_rule" +e10.datatype = "uciname" +e10.optional = true + +e11 = e:option(Value, "ban_wan_forward_chain", translate("WAN Forward Chain IPv4")) +e11.default = "forwarding_wan_rule" +e11.datatype = "uciname" +e11.optional = true + +e12 = e:option(Value, "ban_lan_input_chain", translate("LAN Input Chain IPv4")) +e12.default = "input_lan_rule" +e12.datatype = "uciname" +e12.optional = true + +e13 = e:option(Value, "ban_lan_forward_chain", translate("LAN Forward Chain IPv4")) +e13.default = "forwarding_lan_rule" +e13.datatype = "uciname" +e13.optional = true + +e14 = e:option(ListValue, "ban_target_src", translate("SRC Target IPv4")) +e14:value("REJECT") +e14:value("DROP") +e14.default = "DROP" +e14.optional = true + +e15 = e:option(ListValue, "ban_target_dst", translate("DST Target IPv4")) +e15:value("REJECT") +e15:value("DROP") +e15.default = "REJECT" +e15.optional = true + +e16 = e:option(Value, "ban_wan_input_chain_6", translate("WAN Input Chain IPv6")) +e16.default = "input_wan_rule" +e16.datatype = "uciname" +e16.optional = true + +e17 = e:option(Value, "ban_wan_forward_chain_6", translate("WAN Forward Chain IPv6")) +e17.default = "forwarding_wan_rule" +e17.datatype = "uciname" +e17.optional = true + +e18 = e:option(Value, "ban_lan_input_chain_6", translate("LAN Input Chain IPv6")) +e18.default = "input_lan_rule" +e18.datatype = "uciname" +e18.optional = true + +e19 = e:option(Value, "ban_lan_forward_chain_6", translate("LAN Forward Chain IPv6")) +e19.default = "forwarding_lan_rule" +e19.datatype = "uciname" +e19.optional = true + +e20 = e:option(ListValue, "ban_target_src_6", translate("SRC Target IPv6")) +e20:value("REJECT") +e20:value("DROP") +e20.default = "DROP" +e20.optional = true + +e21 = e:option(ListValue, "ban_target_dst_6", translate("DST Target IPv6")) +e21:value("REJECT") +e21:value("DROP") +e21.default = "REJECT" +e21.optional = true + +return m diff --git a/applications/luci-app-banip/luasrc/model/cbi/banip/whitelist_tab.lua b/applications/luci-app-banip/luasrc/model/cbi/banip/whitelist_tab.lua new file mode 100644 index 000000000..c56e40f11 --- /dev/null +++ b/applications/luci-app-banip/luasrc/model/cbi/banip/whitelist_tab.lua @@ -0,0 +1,55 @@ +-- Copyright 2018 Dirk Brenken (dev@brenken.org) +-- This is free software, licensed under the Apache License, Version 2.0 + +local fs = require("nixio.fs") +local util = require("luci.util") +local uci = require("luci.model.uci").cursor() +local input = uci:get("banip", "whitelist", "ban_src") or uci:get("banip", "whitelist", "ban_src_6") or "/etc/banip/adblock.whitelist" + +if not fs.access(input) then + m = SimpleForm("error", nil, translate("Input file not found, please check your configuration.")) + m.reset = false + m.submit = false + return m +end + +if fs.stat(input).size >= 102400 then + m = SimpleForm("error", nil, + translate("The file size is too large for online editing in LuCI (≥ 100 KB). ") + .. translate("Please edit this file directly in a terminal session.")) + m.reset = false + m.submit = false + return m +end + +m = SimpleForm("edit", nil) +m:append(Template("banip/banip_css")) +m.submit = translate("Save") +m.reset = false + +s = m:section(SimpleSection, nil, + translatef("This form allows you to modify the content of the banIP whitelist (%s).
", input) + .. translate("Please add only one IPv4 or IPv6 address per line. IP ranges in CIDR notation and comments introduced with '#' are allowed.")) + +f = s:option(TextValue, "data") +f.datatype = "string" +f.rows = 20 +f.rmempty = true + +function f.cfgvalue() + return fs.readfile(input) or "" +end + +function f.write(self, section, data) + return fs.writefile(input, "\n" .. util.trim(data:gsub("\r\n", "\n")) .. "\n") +end + +function f.remove(self, section, value) + return fs.writefile(input, "") +end + +function s.handle(self, state, data) + return true +end + +return m diff --git a/applications/luci-app-banip/luasrc/view/banip/banip_css.htm b/applications/luci-app-banip/luasrc/view/banip/banip_css.htm new file mode 100644 index 000000000..807102452 --- /dev/null +++ b/applications/luci-app-banip/luasrc/view/banip/banip_css.htm @@ -0,0 +1,91 @@ + diff --git a/applications/luci-app-banip/luasrc/view/banip/ipsetview.htm b/applications/luci-app-banip/luasrc/view/banip/ipsetview.htm new file mode 100644 index 000000000..14932ffae --- /dev/null +++ b/applications/luci-app-banip/luasrc/view/banip/ipsetview.htm @@ -0,0 +1,66 @@ +<%# +Copyright 2018 Dirk Brenken (dev@brenken.org) +This is free software, licensed under the Apache License, Version 2.0 +-%> + +<%- + local util = require("luci.util") + local ipsets = util.split(util.trim(util.exec("ipset -n -L 2>/dev/null | sort")), "\n", nil, true) or {} +-%> + +<%+header%> +<%+banip/banip_css%> + + + +
+
+
<%:Check the current available IPSets.%>
+
+
+
+
+ + +
+
+
+
+ + +
+
+
+
+ +
+
+<%+footer%> diff --git a/applications/luci-app-banip/luasrc/view/banip/logview.htm b/applications/luci-app-banip/luasrc/view/banip/logview.htm new file mode 100644 index 000000000..d298b24de --- /dev/null +++ b/applications/luci-app-banip/luasrc/view/banip/logview.htm @@ -0,0 +1,36 @@ +<%# +Copyright 2018 Dirk Brenken (dev@brenken.org) +This is free software, licensed under the Apache License, Version 2.0 +-%> + +<%+header%> +<%+banip/banip_css%> + + + +
+
+
<%:The syslog output, pre-filtered for banIP related messages only.%>
+ +
+
+ +<%+footer%> diff --git a/applications/luci-app-banip/luasrc/view/banip/ripeview.htm b/applications/luci-app-banip/luasrc/view/banip/ripeview.htm new file mode 100644 index 000000000..118504fd6 --- /dev/null +++ b/applications/luci-app-banip/luasrc/view/banip/ripeview.htm @@ -0,0 +1,105 @@ +<%# +Copyright 2018 Dirk Brenken (dev@brenken.org) +This is free software, licensed under the Apache License, Version 2.0 +-%> + +<%+header%> +<%+banip/banip_css%> + + + +
+
+
<%_The RIPEstat Data API is the public data interface provided by RIPE NCC, for details look here.%>
+
+
+
+
+ +
+
+
+
+ +

+ +
+
+
+
+ +
+
+ +<%+footer%> \ No newline at end of file diff --git a/applications/luci-app-banip/luasrc/view/banip/runtime.htm b/applications/luci-app-banip/luasrc/view/banip/runtime.htm new file mode 100644 index 000000000..041fcb143 --- /dev/null +++ b/applications/luci-app-banip/luasrc/view/banip/runtime.htm @@ -0,0 +1,130 @@ +<%# +Copyright 2018 Dirk Brenken (dev@brenken.org) +This is free software, licensed under the Apache License, Version 2.0 +-%> + +<%+banip/banip_css%> + + +

<%:Runtime Information%>

+
+ +
+ - +
+
+
+ +
+ - +
+
+
+ +
+ - +
+
+
+ +
+ - +
+
+
+ +
+ - +
+
+
+
+ +
+ + +
+
+ diff --git a/applications/luci-app-banip/luasrc/view/banip/sourcelist.htm b/applications/luci-app-banip/luasrc/view/banip/sourcelist.htm new file mode 100644 index 000000000..743886f88 --- /dev/null +++ b/applications/luci-app-banip/luasrc/view/banip/sourcelist.htm @@ -0,0 +1,47 @@ +<%# +Copyright 2018 Dirk Brenken (dev@brenken.org) +This is free software, licensed under the Apache License, Version 2.0 +-%> + +<%- +local anonclass = (not self.anonymous or self.sectiontitle) and "named" or "anonymous" +-%> + +<%+banip/banip_css%> + +
+ <% if self.title then -%> +

<%=self.title%>

+ <%- end %> +
<%=self.description%>
+
+
+
+ <%- for i, k in pairs(self.children) do -%> +
+ <%-=k.title-%> +
+ <%- end -%> +
+ <%- local section, scope, isempty = true + for i, k in ipairs(self:cfgsections()) do + section = k + local sectionname = striptags((type(self.sectiontitle) == "function") and self:sectiontitle(section) or k) + local sectiontitle = ifattr(sectionname and (not self.anonymous or self.sectiontitle), "data-title", sectionname) + isempty = false + scope = { valueheader = "cbi/cell_valueheader", valuefooter = "cbi/cell_valuefooter" } + -%> +
> + <%- + for k, node in ipairs(self.children) do + node:render(section, scope or {}) + end + if not scope.cbid:match("ban_src_cat") then + -%> +
 
+ <%- end -%> +
+ <%- end -%> +
+
+
diff --git a/applications/luci-app-banip/root/etc/uci-defaults/40_luci-banip b/applications/luci-app-banip/root/etc/uci-defaults/40_luci-banip new file mode 100755 index 000000000..adb22da91 --- /dev/null +++ b/applications/luci-app-banip/root/etc/uci-defaults/40_luci-banip @@ -0,0 +1,11 @@ +#!/bin/sh + +uci -q batch <<-EOF >/dev/null + delete ucitrack.@banip[-1] + add ucitrack banip + set ucitrack.@banip[-1].init=banip + commit ucitrack +EOF + +rm -f /tmp/luci-indexcache +exit 0