feat: adblock inventory (#79)

Add functions to list DNS feeds and retrieve ad block status

NethServer/nethsecurity#928

src/nethsec/inventory/__init__.py

@@ -146,6 +146,20 @@ def fact_threat_shield(uci: EUci):
         pass
     return ret
 
+def fact_ad_block(uci: EUci):
+    ret = { 'enabled': False, 'community': 0, 'enterprise': 0 }
+    ret['enabled'] = uci.get('adblock', 'global', 'ts_enabled', default='0') == '1'
+    try:
+        enabled_feeds = list(uci.get_all('adblock', 'global', 'adb_sources'))
+    except:
+        enabled_feeds = []
+    for feed in enabled_feeds:
+        if feed.startswith("nethesis") or feed.startswith("yoroi"):
+            ret['enterprise'] += 1
+        else:
+            ret['community'] += 1
+    return ret
+
 def fact_ui(uci: EUci):
     ret = { 'luci': False, 'port443': False, 'port9090': False }
     ret['luci'] = uci.get('ns-ui', 'config', 'luci_enable', default='0') == '1'

tests/test_inventory.py

@@ -726,6 +726,34 @@
 	list ipaddr 'dhcp/ns_8d5d2cf4'
 """
 
+adblock_db = """
+config adblock 'global'
+	option adb_enabled '1'
+	option adb_debug '0'
+	option adb_forcedns '1'
+	option adb_safesearch '0'
+	option adb_dnsfilereset '0'
+	option adb_mail '0'
+	option adb_report '0'
+	option adb_backup '1'
+	option adb_fetchutil 'wget'
+	option adb_dns 'dnsmasq'
+	option ts_enabled '1'
+	list adb_zonelist 'lan'
+	list adb_portlist '53'
+	list adb_portlist '853'
+	option adb_srcarc '/etc/adblock/combined.sources.gz'
+	option adb_dnsinstance '0'
+	option adb_fetchparm '--compression=gzip --no-cache --no-cookies --max-redirect=0 --timeout=20 -O'
+	list adb_sources 'adaway'
+	list adb_sources 'adguard'
+	list adb_sources 'disconnect'
+	list adb_sources 'yoyo'
+	list adb_sources 'malware_lvl2'
+	list adb_sources 'yoroi_susp_level2'
+	list adb_sources 'yoroi_malware_level1'
+"""
+
 def _setup_db(tmp_path):
      # setup fake db
     with tmp_path.joinpath('network').open('w') as fp:
@@ -762,6 +790,8 @@ def _setup_db(tmp_path):
         fp.write(netmap_db)
     with tmp_path.joinpath('objects').open('w') as fp:
         fp.write(objects_db)
+    with tmp_path.joinpath('adblock').open('w') as fp:
+        fp.write(adblock_db)
     return EUci(confdir=tmp_path.as_posix())
 
 def test_fact_hotspot(tmp_path):
@@ -930,3 +960,8 @@ def test_fact_firewall_stats(tmp_path):
     assert result['objects']['rules']['forward'] == 1
     assert result['objects']['rules']['input'] == 1
     assert result['objects']['rules']['output'] == 1
+
+def test_fact_ad_block(tmp_path):
+	u = _setup_db(tmp_path)
+	result = inventory.fact_ad_block(u)
+	assert result == {"enabled": True, "community": 5, "enterprise": 2}