ff8b853a6d
* new 'ca-bundle' dependency as all https connections are now validated by default * automatically select the download utility: 'aria2', 'curl', 'uclient-fetch' with libustream-* or wget are supported * track & ban failed LuCI login attempts as well * add a small log/banIP background monitor to block SSH/LuCI brute force attacks in realtime (disabled by default) * add a config version check (please update your default config!) * made the automatic wan detection more stable * fix the IPv6 logfile parser * fix the service status message * update readme Signed-off-by: Dirk Brenken <dev@brenken.org>
96 lines
5.5 KiB
Markdown
96 lines
5.5 KiB
Markdown
# banIP - ban incoming and/or outgoing ip adresses via ipsets
|
|
|
|
## Description
|
|
IP address blocking is commonly used to protect against brute force attacks, prevent disruptive or unauthorized address(es) from access or it can be used to restrict access to or from a particular geographic area — for example.
|
|
|
|
## Main Features
|
|
* support many IP blocklist sources (free for private usage, for commercial use please check their individual licenses):
|
|
* zero-conf like automatic installation & setup, usually no manual changes needed
|
|
* automatically selects one of the following download utilities: aria2c, curl, uclient-fetch, wget
|
|
* Really fast downloads & list processing as they are handled in parallel as background jobs in a configurable 'Download Queue'
|
|
* full IPv4 and IPv6 support
|
|
* ipsets (one per source) are used to ban a large number of IP addresses
|
|
* supports blocking by ASN numbers
|
|
* supports blocking by iso country codes
|
|
* supports local white & blacklist (IPv4, IPv6 & CIDR notation), located by default in /etc/banip/banip.whitelist and /etc/banip/banip.blacklist
|
|
* auto-add unsuccessful LuCI and ssh login attempts via 'dropbear' or 'sshd' to local blacklist (see 'ban_autoblacklist' option)
|
|
* auto-add the uplink subnet to local whitelist (see 'ban_autowhitelist' option)
|
|
* provides a small background log monitor to ban unsuccessful login attempts in real-time
|
|
* per source configuration of SRC (incoming) and DST (outgoing)
|
|
* integrated IPSet-Lookup
|
|
* integrated RIPE-Lookup
|
|
* blocklist source parsing by fast & flexible regex rulesets
|
|
* minimal status & error logging to syslog, enable debug logging to receive more output
|
|
* procd based init system support (start/stop/restart/reload/refresh/status)
|
|
* procd network interface trigger support
|
|
* automatic blocklist backup & restore, they will be used in case of download errors or during startup
|
|
* output comprehensive runtime information via LuCI or via 'status' init command
|
|
* strong LuCI support
|
|
* optional: add new banIP sources on your own
|
|
|
|
## Prerequisites
|
|
* [OpenWrt](https://openwrt.org), tested with the stable release series (19.07) and with the latest snapshot
|
|
* download utility: 'uclient-fetch' with one of the 'libustream-*' ssl libraries, 'wget', 'aria2c' or 'curl' is required
|
|
|
|
## Installation & Usage
|
|
* install 'banip' (_opkg install banip_)
|
|
* at minimum configure the needed IP blocklist sources, the download utility and enable the banIP service in _/etc/config/banip_
|
|
* control the banip service manually with _/etc/init.d/banip_ start/stop/restart/reload/refresh/status or use the LuCI frontend
|
|
|
|
## LuCI banIP companion package
|
|
* it's recommended to use the provided LuCI frontend to control all aspects of banIP
|
|
* install 'luci-app-banip' (_opkg install luci-app-banip_)
|
|
* the application is located in LuCI under 'Services' menu
|
|
|
|
## banIP config options
|
|
* usually the pre-configured banIP setup works quite well and no manual overrides are needed
|
|
* the following options apply to the 'global' config section:
|
|
* ban\_enabled => main switch to enable/disable banIP service (bool/default: '0', disabled)
|
|
* ban\_automatic => determine the L2/L3 WAN network device automatically (bool/default: '1', enabled)
|
|
* ban\_iface => space separated list of WAN network interface(s)/device(s) used by banIP (default: not set, automatically detected)
|
|
* ban\_realtime => a small log/banIP background monitor to block SSH/LuCI brute force attacks in realtime (bool/default: 'false', disabled)
|
|
|
|
* the following options apply to the 'extra' config section:
|
|
* ban\_debug => enable/disable banIP debug output (bool/default: '0', disabled)
|
|
* ban\_nice => set the nice level of the banIP process and all sub-processes (int/default: '0', standard priority)
|
|
* ban\_triggerdelay => additional trigger delay in seconds before banIP processing begins (int/default: '2')
|
|
* ban\_backupdir => target directory for banIP backups (default: '/tmp')
|
|
* ban\_sshdaemon => select the SSH daemon for logfile parsing, 'dropbear' or 'sshd' (default: 'dropbear')
|
|
* ban\_starttype => select the used start type during boot, 'start', 'refresh' or 'reload' (default: 'start')
|
|
* ban\_maxqueue => size of the download queue to handle downloads & IPSet processing in parallel (int/default: '4')
|
|
* ban\_fetchutil => name of the used download utility: 'uclient-fetch', 'wget', 'curl', 'aria2c' (default: not set, automatically detected)
|
|
* ban\_fetchparm => special config options for the download utility (default: not set)
|
|
* ban\_autoblacklist => store auto-addons temporary in ipset and permanently in local blacklist as well (bool/default: '1', enabled)
|
|
* ban\_autowhitelist => store auto-addons temporary in ipset and permanently in local whitelist as well (bool/default: '1', enabled)
|
|
|
|
## Examples
|
|
**receive banIP runtime information:**
|
|
|
|
<pre><code>
|
|
/etc/init.d/banip status
|
|
::: banIP runtime information
|
|
+ status : enabled
|
|
+ version : 0.3.0
|
|
+ util_info : /usr/bin/aria2c, true
|
|
+ ipset_info : 10 IPSets with overall 106729 IPs/Prefixes
|
|
+ backup_dir : /tmp
|
|
+ last_run : 03.10.2019 19:15:25
|
|
+ system : UBNT-ERX, OpenWrt SNAPSHOT r11102-ced4c0e635
|
|
</code></pre>
|
|
|
|
**cronjob for a regular IPSet blocklist update (/etc/crontabs/root):**
|
|
|
|
<pre><code>
|
|
0 06 * * * /etc/init.d/banip reload
|
|
</code></pre>
|
|
|
|
|
|
## Support
|
|
Please join the banIP discussion in this [forum thread](https://forum.openwrt.org/t/banip-support-thread/16985) or contact me by mail <dev@brenken.org>
|
|
|
|
## Removal
|
|
* stop all banIP related services with _/etc/init.d/banip stop_
|
|
* optional: remove the banip package (_opkg remove banip_)
|
|
|
|
Have fun!
|
|
Dirk
|