fangfrisch 1.9.0.dev2__tar.gz → 1.9.0.dev3__tar.gz

{fangfrisch-1.9.0.dev2/fangfrisch.egg-info → fangfrisch-1.9.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fangfrisch
-Version: 1.9.0.dev2
+Version: 1.9.0.dev3
 Summary: Update and verify unofficial Clam Anti-Virus signatures
 Home-page: https://github.com/rseichter/fangfrisch
 Author: Ralph Seichter

{fangfrisch-1.9.0.dev2 → fangfrisch-1.9.0.dev3}/docs/combined.conf

@@ -10,6 +10,16 @@ local_directory = /var/lib/clamav
 on_update_exec = clamdscan --reload
 on_update_timeout = 42
 
+[fangfrischnews]
+interval = 12h
+local_directory = /tmp
+max_size = 50KB
+script = /path/to/script/fangfrisch-has-news.sh
+on_update_exec = sh -c "[ ! -r ${script} ] || ${script} ${local_directory}"
+prefix = http://mirror.sentries.org/fangfrisch/
+url_alerts = ${prefix}fangfrisch_alerts.txt
+url_news = ${prefix}fangfrisch_news.txt
+
 [interserver]
 interval = 1h
 integrity_check = disabled

{fangfrisch-1.9.0.dev2 → fangfrisch-1.9.0.dev3}/docs/fangfrisch.adoc

@@ -1,6 +1,6 @@
 # Fangfrisch
 Ralph Seichter <fangfrisch@seichter.de>
-v1.9.0.dev2, {docdate}
+v1.9.0.dev3, {docdate}
 :copyright: © 2020-2024 Ralph Seichter
 :encoding: UTF-8
 :hyphens: en
@@ -17,6 +17,7 @@ v1.9.0.dev2, {docdate}
 Fangfrisch (German for "freshly caught") is a sibling of the https://www.clamav.net[Clam Anti-Virus] freshclam utility.
 It allows downloading virus definition files that are not official ClamAV canon, e.g. from https://sanesecurity.com[Sanesecurity] and https://urlhaus.abuse.ch[URLhaus].
 Fangfrisch was designed with security in mind, to be run by an unprivileged user only.
+For those curious about the development history, a https://github.com/rseichter/fangfrisch/blob/master/CHANGELOG.rst[changelog] is available online.
 
 == License
 
@@ -158,8 +159,10 @@ If providers don't respond with content length information, Fangfrisch will log
 * *on_update_exec*: If any files were downloaded during a pass, a command can be executed in after the pass finishes.
 No default.
 A typical value is `clamdscan --reload`.
+Starting with Fangfrisch 1.9.0, this option may be overridden in individual sections, permitting per-provider actions.
 * *on_update_timeout*: Timeout for the `on_update_exec` command, in seconds.
 Default: 30.
+This option may also be overridden in individual sections.
 
 See https://docs.python.org/3.7/library/configparser.html[here] for details about the configuration parser and extended interpolation.
 <<Semantics>> provides additional information on how configuration options are interpreted.
@@ -174,6 +177,7 @@ Fangfrisch contains internal defaults for the following providers, listed in alp
 * https://www.securiteinfo.com/services/anti-spam-anti-virus/improve-detection-rate-of-zero-day-malwares-for-clamav.shtml[SecuriteInfo]
 * https://urlhaus.abuse.ch[URLhaus]
 
+I have also included "Fangfrisch News" (see <<ffnews>>).
 Providers can be enabled by specifiying `enabled = yes` in the desired configuration file sections.
 
 IMPORTANT: Please make sure to examine the respective settings for yourself before enabling providers.
@@ -354,6 +358,30 @@ The following effective configuration is the result of combining internal defaul
 include::combined.conf[]
 ----
 
+[[ffnews]]
+[appendix]
+== Fangfrisch News
+
+This pseudo provider does not offer antivirus signature files.
+It is only meant for me to pass news about Fangfrisch to you, the user, in lieu of a mailing list.
+Don't expect this to happen on a regular basis.
+I am only thinking about release notifications at this point in time.
+Still, I kindly ask you to please enable this service as you would enable any other provider, by adding the following to your configuration file:
+----
+[fangfrischnews]
+enabled = yes
+# Uncomment/adapt the following to trigger a script in case of news.
+# script = /path/to/script/fangfrisch-has-news.sh
+----
+This will only enable Fangfrisch to occasionally download small text files, nothing more.
+You will not need to read the content, nor will anything else happen, unless you modify the `script` option.
+Here is an example script which you could use to have downloaded news items mailed to you.
+It needs to be readable for the user account running Fangfrisch, and the sender/recipient addresses obviously have to be adapted.
+For your convenience, the latest version of the script can be downloaded https://github.com/rseichter/fangfrisch/blob/master/contrib/process-news.sh[here].
+----
+include::../contrib/process-news.sh[]
+----
+
 [[dbstructure]]
 [appendix]
 == Database structure