net/banip/files/README.md

   1 <!-- markdownlint-disable -->
   2
   3 # banIP - ban incoming and outgoing IP addresses/subnets via Sets in nftables
   4
   5 ## Description
   6 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. Further more banIP scans the log file via logread and bans IPs that make too many password failures, e.g. via ssh.
   7
   8 ## Main Features
   9 * banIP supports the following fully pre-configured domain blocklist feeds (free for private usage, for commercial use please check their individual licenses).
  10   **Please note:** By default every feed blocks all supported chains. The columns "WAN-INP", "WAN-FWD" and "LAN-FWD" show for which chains the feeds are suitable in common scenarios, e.g. the first entry should be limited to the LAN forward chain - see the config options 'ban\_blockpolicy', 'ban\_blockinput', 'ban\_blockforwardwan' and 'ban\_blockforwardlan' below.
  11
  12 | Feed                | Focus                          | WAN-INP | WAN-FWD | LAN-FWD | Information                                                   |
  13 | :------------------ | :----------------------------- | :-----: | :-----: | :-----: | :-----------------------------------------------------------  |
  14 | adaway              | adaway IPs                     |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  15 | adguard             | adguard IPs                    |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  16 | adguardtrackers     | adguardtracker IPs             |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  17 | antipopads          | antipopads IPs                 |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  18 | asn                 | ASN IPs                        |         |         |    x    | [Link](https://asn.ipinfo.app)                                |
  19 | backscatterer       | backscatterer IPs              |    x    |    x    |         | [Link](https://www.uceprotect.net/en/index.php)               |
  20 | bogon               | bogon prefixes                 |    x    |    x    |         | [Link](https://team-cymru.com)                                |
  21 | country             | country blocks                 |    x    |    x    |         | [Link](https://www.ipdeny.com/ipblocks)                       |
  22 | cinsscore           | suspicious attacker IPs        |    x    |    x    |         | [Link](https://cinsscore.com/#list)                           |
  23 | darklist            | blocks suspicious attacker IPs |    x    |    x    |         | [Link](https://darklist.de)                                   |
  24 | debl                | fail2ban IP blacklist          |    x    |    x    |         | [Link](https://www.blocklist.de)                              |
  25 | doh                 | public DoH-Provider            |         |         |    x    | [Link](https://github.com/dibdot/DoH-IP-blocklists)           |
  26 | drop                | spamhaus drop compilation      |    x    |    x    |         | [Link](https://www.spamhaus.org)                              |
  27 | dshield             | dshield IP blocklist           |    x    |    x    |         | [Link](https://www.dshield.org)                               |
  28 | edrop               | spamhaus edrop compilation     |    x    |    x    |         | [Link](https://www.spamhaus.org)                              |
  29 | feodo               | feodo tracker                  |    x    |    x    |    x    | [Link](https://feodotracker.abuse.ch)                         |
  30 | firehol1            | firehol level 1 compilation    |    x    |    x    |         | [Link](https://iplists.firehol.org/?ipset=firehol_level1)     |
  31 | firehol2            | firehol level 2 compilation    |    x    |    x    |         | [Link](https://iplists.firehol.org/?ipset=firehol_level2)     |
  32 | firehol3            | firehol level 3 compilation    |    x    |    x    |         | [Link](https://iplists.firehol.org/?ipset=firehol_level3)     |
  33 | firehol4            | firehol level 4 compilation    |    x    |    x    |         | [Link](https://iplists.firehol.org/?ipset=firehol_level4)     |
  34 | greensnow           | suspicious server IPs          |    x    |    x    |         | [Link](https://greensnow.co)                                  |
  35 | iblockads           | Advertising IPs                |         |         |    x    | [Link](https://www.iblocklist.com)                            |
  36 | iblockspy           | Malicious spyware IPs          |    x    |    x    |         | [Link](https://www.iblocklist.com)                            |
  37 | ipthreat            | hacker and botnet TPs          |    x    |    x    |         | [Link](https://ipthreat.net)                                  |
  38 | myip                | real-time IP blocklist         |    x    |    x    |         | [Link](https://myip.ms)                                       |
  39 | nixspam             | iX spam protection             |    x    |    x    |         | [Link](http://www.nixspam.org)                                |
  40 | oisdbig             | OISD-big IPs                   |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  41 | oisdnsfw            | OISD-nsfw IPs                  |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  42 | oisdsmall           | OISD-small IPs                 |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  43 | proxy               | open proxies                   |    x    |         |         | [Link](https://iplists.firehol.org/?ipset=proxylists)         |
  44 | ssbl                | SSL botnet IPs                 |    x    |    x    |         | [Link](https://sslbl.abuse.ch)                                |
  45 | stevenblack         | stevenblack IPs                |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  46 | talos               | talos IPs                      |    x    |    x    |         | [Link](https://talosintelligence.com/reputation_center)       |
  47 | threat              | emerging threats               |    x    |    x    |         | [Link](https://rules.emergingthreats.net)                     |
  48 | threatview          | malicious IPs                  |    x    |    x    |         | [Link](https://threatview.io)                                 |
  49 | tor                 | tor exit nodes                 |    x    |    x    |         | [Link](https://github.com/SecOps-Institute/Tor-IP-Addresses)  |
  50 | uceprotect1         | spam protection level 1        |    x    |    x    |         | [Link](http://www.uceprotect.net/en/index.php)                |
  51 | uceprotect2         | spam protection level 2        |    x    |    x    |         | [Link](http://www.uceprotect.net/en/index.php)                |
  52 | uceprotect3         | spam protection level 3        |    x    |    x    |         | [Link](http://www.uceprotect.net/en/index.php)                |
  53 | urlhaus             | urlhaus IDS IPs                |    x    |    x    |         | [Link](https://urlhaus.abuse.ch)                              |
  54 | urlvir              | malware related IPs            |    x    |    x    |         | [Link](https://iplists.firehol.org/?ipset=urlvir)             |
  55 | webclient           | malware related IPs            |    x    |    x    |         | [Link](https://iplists.firehol.org/?ipset=firehol_webclient)  |
  56 | voip                | VoIP fraud blocklist           |    x    |    x    |         | [Link](https://voipbl.org)                                    |
  57 | yoyo                | yoyo IPs                       |         |         |    x    | [Link](https://github.com/dibdot/banIP-IP-blocklists)         |
  58
  59 * Zero-conf like automatic installation & setup, usually no manual changes needed
  60 * All Sets are handled in a separate nft table/namespace 'banIP'
  61 * Full IPv4 and IPv6 support
  62 * Supports nft atomic Set loading
  63 * Supports blocking by ASN numbers and by iso country codes
  64 * Supports local allow- and blocklist with MAC/IPv4/IPv6 addresses or domain names
  65 * Supports concatenation of local MAC addresses with IPv4/IPv6 addresses, e.g. to enforce dhcp assignments
  66 * All local input types support ranges in CIDR notation
  67 * Auto-add the uplink subnet or uplink IP to the local allowlist
  68 * Provides a small background log monitor to ban unsuccessful login attempts in real-time (like fail2ban, crowdsec etc.)
  69 * Auto-add unsuccessful LuCI, nginx, Asterisk or ssh login attempts to the local blocklist
  70 * Auto-add entire subnets to the blocklist Sets based on an additional RDAP request with the monitored suspicious IP
  71 * Fast feed processing as they are handled in parallel as background jobs (on capable multi-core hardware)
  72 * Per feed it can be defined whether the wan-input chain, the wan-forward chain or the lan-forward chain should be blocked (default: all chains)
  73 * Automatic blocklist backup & restore, the backups will be used in case of download errors or during startup
  74 * Automatically selects one of the following download utilities with ssl support: aria2c, curl, uclient-fetch or full wget
  75 * Supports an 'allowlist only' mode, this option restricts internet access from/to a small number of secure websites/IPs
  76 * Deduplicate IPs accross all Sets (single IPs only, no intervals)
  77 * Provides comprehensive runtime information
  78 * Provides a detailed Set report
  79 * Provides a Set search engine for certain IPs
  80 * Feed parsing by fast & flexible regex rulesets
  81 * Minimal status & error logging to syslog, enable debug logging to receive more output
  82 * Procd based init system support (start/stop/restart/reload/status/report/search/survey/lookup)
  83 * Procd network interface trigger support
  84 * Add new or edit existing banIP feeds on your own with the LuCI integrated custom feed editor
  85 * Supports external allowlist URLs to reference additional IPv4/IPv6 feeds
  86
  87 ## Prerequisites
  88 * **[OpenWrt](https://openwrt.org)**, latest stable release or a snapshot with nft/firewall 4 and logd/logread support
  89 * A download utility with SSL support: 'aria2c', 'curl', full 'wget' or 'uclient-fetch' with one of the 'libustream-*' SSL libraries
  90 * A certificate store like 'ca-bundle', as banIP checks the validity of the SSL certificates of all download sites by default
  91 * For E-Mail notifications you need to install and setup the additional 'msmtp' package
  92
  93 **Please note the following:**
  94 * Devices with less than 256Mb of RAM are **_not_** supported
  95 * Any previous installation of ancient banIP 0.7.x must be uninstalled, and the /etc/banip folder and the /etc/config/banip configuration file must be deleted (they are recreated when this version is installed)
  96
  97 ## Installation & Usage
  98 * Update your local opkg repository (_opkg update_)
  99 * Install banIP (_opkg install banip_) - the banIP service is disabled by default
 100 * Install the LuCI companion package 'luci-app-banip' (opkg install luci-app-banip)
 101 * It's strongly recommended to use the LuCI frontend to easily configure all aspects of banIP, the application is located in LuCI under the 'Services' menu
 102 * If you're going to configure banIP via CLI, edit the config file '/etc/config/banip' and enable the service (set ban\_enabled to '1'), then add pre-configured feeds via 'ban\_feed' (see the feed list above) and add/change other options to your needs (see the options reference below)
 103 * Start the service with '/etc/init.d/banip start' and check everything is working by running '/etc/init.d/banip status'
 104
 105 ## banIP CLI interface
 106 * All important banIP functions are accessible via CLI.
 107 ```
 108 ~# /etc/init.d/banip
 109 Syntax: /etc/init.d/banip [command]
 110
 111 Available commands:
 112         start           Start the service
 113         stop            Stop the service
 114         restart         Restart the service
 115         reload          Reload configuration files (or restart if service does not implement reload)
 116         enable          Enable service autostart
 117         disable         Disable service autostart
 118         enabled         Check if service is started on boot
 119         report          [text|json|mail] Print banIP related Set statistics
 120         search          [<IPv4 address>|<IPv6 address>] Check if an element exists in a banIP Set
 121         survey          [<Set name>] List all elements of a given banIP Set
 122         lookup          Lookup the IPs of domain names in the local lists and update them
 123         running         Check if service is running
 124         status          Service status
 125         trace           Start with syscall trace
 126         info            Dump procd service info
 127 ```
 128
 129 ## banIP config options
 130
 131 | Option                  | Type   | Default                       | Description                                                                                                  |
 132 | :---------------------- | :----- | :---------------------------- | :----------------------------------------------------------------------------------------------------------- |
 133 | ban_enabled             | option | 0                             | enable the banIP service                                                                                     |
 134 | ban_nicelimit           | option | 0                             | ulimit nice level of the banIP service (range 0-19)                                                          |
 135 | ban_filelimit           | option | 1024                          | ulimit max open/number of files (range 1024-4096)                                                            |
 136 | ban_loglimit            | option | 100                           | scan only the last n log entries permanently. A value of '0' disables the monitor                            |
 137 | ban_logcount            | option | 1                             | how many times the IP must appear in the log to be considered as suspicious                                  |
 138 | ban_logterm             | list   | regex                         | various regex for logfile parsing (default: dropbear, sshd, luci, nginx, asterisk)                           |
 139 | ban_autodetect          | option | 1                             | auto-detect wan interfaces, devices and subnets                                                              |
 140 | ban_debug               | option | 0                             | enable banIP related debug logging                                                                           |
 141 | ban_loginput            | option | 1                             | log drops in the wan-input chain                                                                             |
 142 | ban_logforwardwan       | option | 1                             | log drops in the wan-forward chain                                                                           |
 143 | ban_logforwardlan       | option | 0                             | log rejects in the lan-forward chain                                                                         |
 144 | ban_autoallowlist       | option | 1                             | add wan IPs/subnets and resolved domains automatically to the local allowlist (not only to the Sets)         |
 145 | ban_autoblocklist       | option | 1                             | add suspicious attacker IPs and resolved domains automatically to the local blocklist (not only to the Sets) |
 146 | ban_autoblocksubnet     | option | 0                             | add entire subnets to the blocklist Sets based on an additional RDAP request with the suspicious IP          |
 147 | ban_autoallowuplink     | option | subnet                        | limit the uplink autoallow function to: 'subnet', 'ip' or 'disable' it at all                                |
 148 | ban_allowlistonly       | option | 0                             | restrict the internet access from/to a small number of secure websites/IPs                                   |
 149 | ban_basedir             | option | /tmp                          | base working directory while banIP processing                                                                |
 150 | ban_reportdir           | option | /tmp/banIP-report             | directory where banIP stores the report files                                                                |
 151 | ban_backupdir           | option | /tmp/banIP-backup             | directory where banIP stores the compressed backup files                                                     |
 152 | ban_protov4             | option | - / autodetect                | enable IPv4 support                                                                                          |
 153 | ban_protov6             | option | - / autodetect                | enable IPv4 support                                                                                          |
 154 | ban_ifv4                | list   | - / autodetect                | logical wan IPv4 interfaces, e.g. 'wan'                                                                      |
 155 | ban_ifv6                | list   | - / autodetect                | logical wan IPv6 interfaces, e.g. 'wan6'                                                                     |
 156 | ban_dev                 | list   | - / autodetect                | wan device(s), e.g. 'eth2'                                                                                   |
 157 | ban_trigger             | list   | -                             | logical startup trigger interface(s), e.g. 'wan'                                                             |
 158 | ban_triggerdelay        | option | 10                            | trigger timeout before banIP processing begins                                                               |
 159 | ban_triggeraction       | option | start                         | trigger action on ifup events, e.g. start, restart or reload                                                 |
 160 | ban_deduplicate         | option | 1                             | deduplicate IP addresses across all active Sets                                                              |
 161 | ban_splitsize           | option | 0                             | split ext. Sets after every n lines/members (saves RAM)                                                      |
 162 | ban_cores               | option | - / autodetect                | limit the cpu cores used by banIP (saves RAM)                                                                |
 163 | ban_nftloglevel         | option | warn                          | nft loglevel, values: emerg, alert, crit, err, warn, notice, info, debug                                     |
 164 | ban_nftpriority         | option | -200                          | nft priority for the banIP table (default is the prerouting table priority)                                  |
 165 | ban_nftpolicy           | option | memory                        | nft policy for banIP-related Sets, values: memory, performance                                               |
 166 | ban_nftexpiry           | option | -                             | expiry time for auto added blocklist members, e.g. '5m', '2h' or '1d'                                        |
 167 | ban_feed                | list   | -                             | external download feeds, e.g. 'yoyo', 'doh', 'country' or 'talos' (see feed table)                           |
 168 | ban_asn                 | list   | -                             | ASNs for the 'asn' feed, e.g.'32934'                                                                         |
 169 | ban_country             | list   | -                             | country iso codes for the 'country' feed, e.g. 'ru'                                                          |
 170 | ban_blockpolicy         | option | -                             | limit the default block policy to a certain chain, e.g. 'input', 'forwardwan' or 'forwardlan'                |
 171 | ban_blockinput          | list   | -                             | limit a feed to the wan-input chain, e.g. 'country'                                                          |
 172 | ban_blockforwardwan     | list   | -                             | limit a feed to the wan-forward chain, e.g. 'debl'                                                           |
 173 | ban_blockforwardlan     | list   | -                             | limit a feed to the lan-forward chain, e.g. 'doh'                                                            |
 174 | ban_fetchcmd            | option | - / autodetect                | 'uclient-fetch', 'wget', 'curl' or 'aria2c'                                                                  |
 175 | ban_fetchparm           | option | - / autodetect                | set the config options for the selected download utility                                                     |
 176 | ban_fetchretry          | option | 5                             | number of download attempts in case of an error (not supported by uclient-fetch)                             |
 177 | ban_fetchinsecure       | option | 0                             | don't check SSL server certificates during download                                                          |
 178 | ban_mailreceiver        | option | -                             | receiver address for banIP related notification E-Mails                                                      |
 179 | ban_mailsender          | option | no-reply@banIP                | sender address for banIP related notification E-Mails                                                        |
 180 | ban_mailtopic           | option | banIP notification            | topic for banIP related notification E-Mails                                                                 |
 181 | ban_mailprofile         | option | ban_notify                    | mail profile used in 'msmtp' for banIP related notification E-Mails                                          |
 182 | ban_mailnotification    | option | 0                             | receive E-Mail notifications with every banIP run                                                            |
 183 | ban_reportelements      | option | 1                             | count Set elements in the report, disable this option to speed up the report significantly                   |
 184 | ban_resolver            | option | -                             | external resolver used for DNS lookups                                                                       |
 185
 186 ## Examples
 187 **banIP report information**
 188 ```
 189 ~# /etc/init.d/banip report
 190 :::
 191 ::: banIP Set Statistics
 192 :::
 193     Timestamp: 2023-06-21 07:03:23
 194     ------------------------------
 195     auto-added to allowlist today: 0
 196     auto-added to blocklist today: 0
 197
 198     Set                  | Elements     | WAN-Input (packets)   | WAN-Forward (packets) | LAN-Forward (packets)
 199     ---------------------+--------------+-----------------------+-----------------------+------------------------
 200     allowlistv4MAC       | 0            | -                     | -                     | OK: 0
 201     allowlistv6MAC       | 0            | -                     | -                     | OK: 0
 202     allowlistv4          | 1            | OK: 0                 | OK: 0                 | OK: 0
 203     allowlistv6          | 1            | OK: 0                 | OK: 0                 | OK: 0
 204     cinsscorev4          | 13115        | OK: 142               | OK: 0                 | -
 205     deblv4               | 8076         | OK: 5                 | OK: 0                 | OK: 0
 206     countryv6            | 37313        | OK: 0                 | OK: 1                 | -
 207     countryv4            | 36155        | OK: 33                | OK: 0                 | -
 208     deblv6               | 15           | OK: 0                 | OK: 0                 | OK: 0
 209     dropv6               | 35           | OK: 0                 | OK: 0                 | OK: 0
 210     dropv4               | 620          | OK: 0                 | OK: 0                 | OK: 0
 211     dohv6                | 598          | -                     | -                     | OK: 0
 212     dohv4                | 902          | -                     | -                     | OK: 0
 213     edropv4              | 247          | OK: 0                 | OK: 0                 | OK: 0
 214     threatviewv4         | 571          | OK: 0                 | OK: 0                 | OK: 0
 215     firehol1v4           | 877          | OK: 8                 | OK: 0                 | OK: 0
 216     ipthreatv4           | 5751         | OK: 0                 | OK: 0                 | OK: 0
 217     urlvirv4             | 169          | OK: 0                 | OK: 0                 | OK: 0
 218     blocklistv4MAC       | 0            | -                     | -                     | OK: 0
 219     blocklistv6MAC       | 0            | -                     | -                     | OK: 0
 220     blocklistv4          | 3            | OK: 0                 | OK: 0                 | OK: 0
 221     blocklistv6          | 0            | OK: 0                 | OK: 0                 | OK: 0
 222     ---------------------+--------------+-----------------------+-----------------------+------------------------
 223     22                   | 104449       | 16 (188)              | 16 (1)                | 19 (0)
 224 ```
 225
 226 **banIP runtime information**
 227 ```
 228 root@blackhole:~# /etc/init.d/banip status
 229 ::: banIP runtime information
 230   + status            : active (nft: ✔, monitor: ✔)
 231   + version           : 0.8.8-1
 232   + element_count     : 104449
 233   + active_feeds      : allowlistv4MAC, allowlistv6MAC, allowlistv4, allowlistv6, cinsscorev4, deblv4, countryv6, countryv4, deblv6, dropv6, dropv4, dohv6, dohv4, edropv4, threatviewv4, firehol1v4, ipthreatv4, urlvirv4, blocklistv4MAC, blocklistv6MAC, blocklistv4, blocklistv6
 234   + active_devices    : br-wan ::: wan, wan6
 235   + active_uplink     : 91.63.198.120, 2a12:810c:0:80:a20d:52c3:5cf:f4f
 236   + nft_info          : priority: -200, policy: performance, loglevel: warn, expiry: -
 237   + run_info          : base: /mnt/data/banIP, backup: /mnt/data/banIP/backup, report: /mnt/data/banIP/report, custom feed: ✘
 238   + run_flags         : auto: ✔, proto (4/6): ✔/✔, log (wan-inp/wan-fwd/lan-fwd): ✔/✔/✔, dedup: ✔, split: ✘, allowed only: ✘
 239   + last_run          : action: restart, duration: 0m 19s, date: 2023-06-21 06:45:52
 240   + system_info       : cores: 4, memory: 1634, device: Bananapi BPI-R3, OpenWrt SNAPSHOT r23398-c4be106f4d
 241 ```
 242
 243 **banIP search information**
 244 ```
 245 ~# /etc/init.d/banip search 221.228.105.173
 246 :::
 247 ::: banIP Search
 248 :::
 249     Looking for IP '221.228.105.173' on 2023-02-08 22:12:48
 250     ---
 251     IP found in Set 'oisdbasicv4'
 252 ```
 253
 254 **banIP survey information**
 255 ```
 256 ~# /etc/init.d/banip survey cinsscorev4
 257 :::
 258 ::: banIP Survey
 259 :::
 260     List of elements in the Set 'cinsscorev4' on 2023-03-06 14:07:58
 261     ---
 262 1.10.187.179
 263 1.10.203.30
 264 1.10.255.58
 265 1.11.67.53
 266 1.11.114.211
 267 1.11.208.29
 268 1.12.75.87
 269 1.12.231.227
 270 1.12.247.134
 271 1.12.251.141
 272 1.14.96.156
 273 1.14.250.37
 274 1.15.40.79
 275 1.15.71.140
 276 1.15.77.237
 277 [...]
 278 ```
 279 **default regex for logfile parsing**
 280 ```
 281 list ban_logterm 'Exit before auth from'
 282 list ban_logterm 'luci: failed login'
 283 list ban_logterm 'error: maximum authentication attempts exceeded'
 284 list ban_logterm 'sshd.*Connection closed by.*\[preauth\]'
 285 list ban_logterm 'SecurityEvent=\"InvalidAccountID\".*RemoteAddress='
 286 ```
 287
 288 **allow-/blocklist handling**
 289 banIP supports local allow and block lists, MAC/IPv4/IPv6 addresses (incl. ranges in CIDR notation) or domain names. These files are located in /etc/banip/banip.allowlist and /etc/banip/banip.blocklist.
 290 Unsuccessful login attempts or suspicious requests will be tracked and added to the local blocklist (see the 'ban_autoblocklist' option). The blocklist behaviour can be further tweaked with the 'ban_nftexpiry' option.
 291 Depending on the options 'ban_autoallowlist' and 'ban_autoallowuplink' the uplink subnet or the uplink IP will be added automatically to local allowlist.
 292 Furthermore, you can reference external Allowlist URLs with additional IPv4 and IPv6 feeds (see 'ban_allowurl').
 293 Both local lists also accept domain names as input to allow IP filtering based on these names. The corresponding IPs (IPv4 & IPv6) will be extracted and added to the Sets. You can also start the domain lookup separately via /etc/init.d/banip lookup at any time.
 294
 295 **MAC/IP-binding**
 296 banIP supports concatenation of local MAC addresses with IPv4/IPv6 addresses, e.g. to enforce dhcp assignments. Following notations in the local allow and block lists are allowed:
 297 ```
 298 MAC-address only:
 299 C8:C2:9B:F7:80:12                                  => this will be populated to the v4MAC- and v6MAC-Sets with the IP-wildcards 0.0.0.0/0 and ::/0
 300
 301 MAC-address with IPv4 concatenation:
 302 C8:C2:9B:F7:80:12 192.168.1.10                     => this will be populated only to v4MAC-Set with the certain IP, no entry in the v6MAC-Set
 303
 304 MAC-address with IPv6 concatenation:
 305 C8:C2:9B:F7:80:12 2a02:810c:0:80:a10e:62c3:5af:f3f => this will be populated only to v6MAC-Set with the certain IP, no entry in the v4MAC-Set
 306
 307 MAC-address with IPv4 and IPv6 concatenation:
 308 C8:C2:9B:F7:80:12 192.168.1.10                     => this will be populated to v4MAC-Set with the certain IP
 309 C8:C2:9B:F7:80:12 2a02:810c:0:80:a10e:62c3:5af:f3f => this will be populated to v6MAC-Set with the certain IP
 310
 311 MAC-address with IPv4 and IPv6 wildcard concatenation:
 312 C8:C2:9B:F7:80:12 192.168.1.10                     => this will be populated to v4MAC-Set with the certain IP
 313 C8:C2:9B:F7:80:12                                  => this will be populated to v6MAC-Set with the IP-wildcard ::/0
 314 ```
 315
 316 **allowlist-only mode**
 317 banIP supports an "allowlist only" mode. This option restricts the internet access from/to a small number of secure MACs, IPs or domains, and block access from/to the rest of the internet. All IPs and Domains which are _not_ listed in the allowlist are blocked.
 318
 319 **redirect Asterisk security logs to lodg/logread**
 320 banIP only supports logfile scanning via logread, so to monitor attacks on Asterisk, its security log must be available via logread. To do this, edit '/etc/asterisk/logger.conf' and add the line 'syslog.local0 = security', then run 'asterisk -rx reload logger' to update the running Asterisk configuration.
 321
 322 **send status E-Mails and update the banIP lists via cron job**
 323 For a regular, automatic status mailing and update of the used lists on a daily basis set up a cron job, e.g.
 324 ```
 325 55 03 * * * /etc/init.d/banip report mail
 326 00 04 * * * /etc/init.d/banip reload
 327 ```
 328
 329 **tweaks for low memory systems**
 330 nftables supports the atomic loading of firewall rules (incl. elements), which is cool but unfortunately is also very memory intensive. To reduce the memory pressure on low memory systems (i.e. those with 256-512Mb RAM), you should optimize your configuration with the following options:
 331
 332     * point 'ban_basedir', 'ban_reportdir' and 'ban_backupdir' to an external usb drive
 333     * set 'ban_cores' to '1' (only useful on a multicore system) to force sequential feed processing
 334     * set 'ban_splitsize' e.g. to '1000' to split the load of an external Set after every 1000 lines/members
 335     * set 'ban_reportelements' to '0' to disable the CPU intensive counting of Set elements
 336
 337 **tweak the download options**
 338 By default banIP uses the following pre-configured download options:
 339 ```
 340     * aria2c: --timeout=20 --retry-wait=10 --max-tries=5 --max-file-not-found=5 --allow-overwrite=true --auto-file-renaming=false --log-level=warn --dir=/ -o
 341     * curl: --connect-timeout 20 --retry-delay 10 --retry 5 --retry-all-errors --fail --silent --show-error --location -o
 342     * wget: --no-cache --no-cookies --timeout=20 --waitretry=10 --tries=5 --retry-connrefused --max-redirect=0 -O
 343     * uclient-fetch: --timeout=20 -O
 344 ```
 345 To override the default set 'ban_fetchretry', 'ban_fetchinsecure' or globally 'ban_fetchparm' to your needs.
 346
 347 **send E-Mail notifications via 'msmtp'**
 348 To use the email notification you must install & configure the package 'msmtp'.
 349 Modify the file '/etc/msmtprc', e.g.:
 350 ```
 351 [...]
 352 defaults
 353 auth            on
 354 tls             on
 355 tls_certcheck   off
 356 timeout         5
 357 syslog          LOG_MAIL
 358 [...]
 359 account         ban_notify
 360 host            smtp.gmail.com
 361 port            587
 362 from            <address>@gmail.com
 363 user            <gmail-user>
 364 password        <password>
 365 ```
 366 Finally add a valid E-Mail receiver address.
 367
 368 **change existing banIP feeds or add a new one**
 369 The banIP default blocklist feeds are stored in an external JSON file '/etc/banip/banip.feeds'. All custom changes should be stored in an external JSON file '/etc/banip/banip.custom.feeds' (empty by default). It's recommended to use the LuCI based Custom Feed Editor to make changes to this file.
 370 A valid JSON source object contains the following information, e.g.:
 371 ```
 372         [...]
 373         "tor":{
 374                 "url_4": "https://raw.githubusercontent.com/SecOps-Institute/Tor-IP-Addresses/master/tor-exit-nodes.lst",
 375                 "url_6": "https://raw.githubusercontent.com/SecOps-Institute/Tor-IP-Addresses/master/tor-exit-nodes.lst",
 376                 "rule_4": "/^(([0-9]{1,3}\\.){3}(1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])(\\/(1?[0-9]|2?[0-9]|3?[0-2]))?)$/{printf \"%s,\\n\",$1}",
 377                 "rule_6": "/^(([0-9A-f]{0,4}:){1,7}[0-9A-f]{0,4}:?(\\/(1?[0-2][0-8]|[0-9][0-9]))?)$/{printf \"%s,\\n\",$1}",
 378                 "descr": "tor exit nodes",
 379                 "flag": ""
 380         },
 381         [...]
 382 ```
 383 Add an unique feed name (no spaces, no special chars) and make the required changes: adapt at least the URL, the regex and the description for a new feed. The flag is optional, currently only 'gz' is supported to process archive downloads.
 384
 385 ## Support
 386 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>
 387
 388 ## Removal
 389 * stop all banIP related services with _/etc/init.d/banip stop_
 390 * remove the banip package (_opkg remove banip_)
 391
 392 Have fun!
 393 Dirk