Änderungen von Dokument ClamAV

Von 4.1 nach 4.2

Von Version 4.2

bearbeitet von gru
am 17.05.2022, 15:08

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 34.6

bearbeitet von jdr
am 23.11.2023, 14:33

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.gru
++XWiki.jdr

Inhalt

@@ -1,61 +1,172 @@
++{{info}}
  {{version major="7" minor="0" patch="13" showInfo="true"}}
  Dieses Plugin kann nur mit {{formcycle/}} Version 7.0.13 oder höher verwendet werden.
  {{/version}}
++{{/info}}
--[[**Plugin-Download**>>https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-malware-scanner/ClamAV&fileid=40404]]
++[[**Plugin-Download**>>https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-malware-scanner/ClamAV&fileid=40404]] (erfordert Anmeldung)
  {{content/}}
--{{figure image="de_plugin.png" width="600"}}
--  Es muss ein TCP-Verbindung eingerichtet werden, um den ClamAV-Daemon Service zum scannen der hochgeladenen Dateien zu verwenden.
--{{/figure}}
++Mit dem kostenlosen //ClamAV//-Plugin für {{formcycle/}} besteht die Möglichkeit, hochgeladene Dateien auf Viren zu scannen. Hierfür stellt dieses Plugin eine Verbindung zu einem //ClamAV//-Daemon Service via TCP her.
--Es ist möglich, hochgeladene Elemente im Backend sowie in ausgelieferten Formularen durch ClamAV auf Viren untersuchen zu lassen. Dazu wird dieses Plugin als aktiviertes System-Plugin benötigt sowie ein laufender ClamAV-Daemon Service der über TCP erreicht werden kann.
++== Funktionalität ==
--Nachdem dieses Plugin installiert wurde, muss es konfiguriert werden. Die Konfiguration besteht daraus, dass angegeben wird, auf welche {{smallcaps}}host:port{{/smallcaps}} Kombination zugegriffen werden soll. Außerdem kann die Übertragung mit einem {{smallcaps}}InputStream{{/smallcaps}} geschehen oder es wird direkt auf dem Pfad gearbeitet.
++; Sofortiger Virenscan
++: Jede Datei wird direkt nach Ihrem Upload gescannt.
--== Konfiguration ==
++Der verwendete //ClamAV//-Daemon Service kann weder durch dieses Plugin konfiguriert noch gestartet werden.
--{{figure image="en_error.png" width="400"}}
++== Installation ==
++
++Die Installation des Plugins ist über die dafür vorgesehene Verwaltungsoberfläche von Plugins durchzuführen. Hierbei muss lediglich die entsprechende //Jar//-Datei eingespielt werden.
++
++{{info}}
++  Das //ClamAV//-Plugin scannt Dateien in Backend und Fronted. Um immer für alle Benutzer verfügbar zu sein, ist es ratsam, das Plugin als System-Plugin zu installieren. Dies umgeht auch mögliche Probleme mit doppelt belegten Ports und ermöglicht eine zentrale Konfiguration.
++{{/info}}
++
++== Konfiguration Plugin ==
++
++Nach dem Speichern wird automatisch ein Ping-Test durchgeführt. Falls dieser fehlschlägt wird eine entsprechende Meldung angezeigt. In diesem Fall werden alle Uploads im Backend oder im Formular als fehlerhaft markiert - das Plugin sollte erst einmal deaktiviert werden und eine funktionierende Verbindung aufgebaut werden.
++
++{{figure image="de_error.png" width="400"}}
    Falls keine Verbindung zu dem angegeben Host aufgebaut werden kann, wird diese Meldung ausgegeben.
  {{/figure}}
--Folgende Konfigurationparameter gibt es:
++Folgende Konfigurationsparameter gibt es:
  ; host (Erforderlich)
--: Host-Name oder IP-Adresse des Servers auf dem ClamAV-Daemon läuft, {{smallcaps}}127.0.0.1{{/smallcaps}} falls der Service auf dem gleichen Server wie {{formcycle/}} läuft.
--; port
--: Der Standard Port von ClamAV-Daemon ist {{smallcaps}}3310{{/smallcaps}}. Falls der Port abweichen sollten, so muss dieser hier angegeben werden.
--; file-source
--: Standardmäßig wird das zu überprüfende Element per Javas {{smallcaps}}InputStream{{/smallcaps}} übertragen. Falls hier der Wert {{smallcaps}}path{{/smallcaps}} eingeben wird, wird direkt auf dem Pfad gearbeitet - wobei dafür der ClamAV-Daemon Service root Rechte besitzen muss.
++: Standardwert: //127.0.0.1//. Gibt die zu verwendende //IP//-Adresse des //ClamAV//-Daemon Service an. Der Standardwert ist //127.0.0.1// und verwendet damit einen lokalen //ClamAV//-Daemon Service.
++; port (Erforderlich)
++: Standardwert: //3310//. Gibt den zu verwendenden Port des //ClamAV//-Daemon Service an. Der Standardwert sollte nur geändert werden, falls dieser Port nicht zu Verfügung steht
++; os (Optional)
++: Standardwert: //JVM_PLATFORM//. Betriebssystem, auf dem der ClamAV-Daemon-Dienst läuft. Dieser Wert ist nur relevant, wenn das Betriebssystem von formcycle und das des ClamAV-Daemon-Dienstes unterschiedlich sind. Für Linux oder MacOS geben Sie //UNIX// ein, für Windows //WINDOWS//. Wenn beide auf dem gleichen Betriebssystem laufen, können Sie diesen Wert leer lassen oder //JVM_PLATFORM// verwenden.
--Nach dem Speichern wird automatisch ein Ping-Test durchgeführt. Falls dieser fehlschlägt wird eine entsprechende Meldung angezeigt. In diesem Fall werden alle Uploads im Backend oder im Formular als fehlerhaft markiert - das Plugin sollte erst einmal deaktiviert werden und eine funktionierende Verbindung aufgebaut werden.
++== Konfiguration //ClamAV// ==
--== ClamAV Einstellungen ==
++Im folgenden Abschnitt wird auf Installation und Konfiguration von //ClamAV// auf einem UNIX-System eingegangen. Unser empfohlenes Szenario ist {{formcycle/}} und den //ClamAV//-Daemon Service auf dem selben Server zu installieren.
--Im folgenden Abschnitt wird auf wichtige Konfigurationsschritte von ClamAV-Daemon eingegangen. In diesem Szenario ist {{formcycle/}} auf einem Debian basierten Server installiert und auf selbigen System läuft der ClamAV-Daemon Service.
++=== Installation ===
--Da das eigentliche Virusscanning losgelöst von {{formcycle/}} stattfindet, sollte auf eine aktulle Virensignatur-Datenbank geachtet werden via {{smallcaps}}freshclam{{/smallcaps}}.
++Um //ClamAV// auf einem Server zu installieren, sollten folgende Befehle auf dem Server eingegeben werden.
--Dieses Plugin überträgt die zu untersuchenden Elemente via TCP, was standardmäßig in ClamAV-Daemon deaktiviert ist. Zur Aktivierung muss die Konfigurationsdatei unter: {{smallcaps}}/etc/clamav/clamd.conf{{/smallcaps}} bearbeitet werden.
++//ClamAV// ist das Programm, welches Dateien auf Viren scannen kann und wird für die Verwendung von //ClamAV//-Daemon benötigt.
--Folgende Parameter müssen der Datei hinzugefügt werden:
++; Aktualisieren der package list:
++; {{code language="shell"}} sudo apt-get update {{/code}}
--; TCPAddr (Erforderlich)
--: Soll hinzugefügt und mit dem Wert {{smallcaps}}127.0.0.1{{/smallcaps}} angegeben werden.
--; TCPSocket (Erforderlich)
--: Soll hinzugefügt und mit dem Wert {{smallcaps}}3310{{/smallcaps}} angegeben werden oder abweichend, falls der Port anderweitig genutzt werden soll.
--; User
--: Ist standardmäßig {{smallcaps}}clamav{{/smallcaps}} und muss zu {{smallcaps}}root{{/smallcaps}} geändert werden um dem ClamAV-Daemon Service root Rechte zu geben.
++; Installiere //ClamAV// und //ClamAV//-Daemon:
++; {{code language="shell"}} sudo apt-get install clamav clamav-daemon -y {{/code}}
--{{figure image="en_tcp_test.png"}}
--  Mithilfe von {{smallcaps}}netstat{{/smallcaps}} kann der TCP Socket vom ClamAV-Daemon Service untersucht werden.
--{{/figure}}
++=== Aktualisieren der Virensignatur-Datenbank ===
--Damit dieses Plugin den ClamAV-Daemon Service ansprechen kann, muss der Service an der richtigen Stelle zuhören - in diesem Fall unter {{smallcaps}}127.0.0.1:3310{{/smallcaps}}. Das kann durch folgenden Befehl im Terminal überprüft werden:
++//freshclam// wird mit //ClamAV// automatisch installiert und wird zum aktualisieren der Virensignatur Datenbank genutzt.
--{{code language="shell"}}
--sudo netstat -anp | grep -E "(clam)"
--{{/code}}
++; Beenden des automatischen //freshclam// Prozess:
++; {{code language="shell"}} sudo systemctl stop clamav-freshclam {{/code}}
++; Manuelles aktualisieren der Virensignatur Datenbank:
++; {{code language="shell"}} sudo freshclam {{/code}}
++=== Konfiguration //ClamAV//-Daemon ===
++
++//ClamAV//-Daemon ist der auf dem Server im Hintergrund laufende Prozess, welcher zum Virusscan angesprochen wird. Das geschieht via TCP und muss entprechend konfiguriert werden.
++
++Dafür soll die Konfigurationsdatei unter: // /etc/clamav/clamd.conf // angepasst werden.
++
++; Öffnen der Konfigurationsdatei:
++; {{code language="shell"}} sudo nano /etc/clamav/clamd.conf {{/code}}
++
++Mit den Pfeiltasten kann an das Ende der Datei navigiert werden.
++
++; Hinzufügen von //TCPAddr 127.0.0.1 //
++; Hinzufügen von //TCPSocket 3310 //
++
++{{lightbox image="en_clamd.conf.png"/}}
++
++; //ClamAV//-Daemon root Rechte geben
++: dafür muss in dieser Datei der Eintrag //User clamav// in //User root// geändert werden.
++
++Nun kann mit //Strg + X// gespeichert und beendet werden. Mit //Y// und der Enter-Taste bestätigen.
++
++=== Starten der //ClamAV//-Daemon Service ===
++
++Nun kann der Service gestartet werden.
++
++: Starten des //ClamAV//-Daemon Service:
++; {{code language="shell"}} sudo systemctl start clamav-daemon.service {{/code}}
++
++=== Prüfen der Verfügbarkeit des Service ===
++
++Damit dieses Plugin den //ClamAV//-Daemon Service ansprechen kann, muss der Service an der richtigen Stelle zuhören - in diesem Fall unter //127.0.0.1:3310//. Das kann im Terminal der Servers überprüft werden.
++
++; Mithilfe von //netstat// kann der TCP Socket vom //ClamAV//-Daemon Service untersucht werden.
++; {{code language="shell"}} sudo netstat -anp | grep -E "(clam)" {{/code}}
++
++{{lightbox image="de_tcp_test.png"/}}
++
++Falls keine Zeile beginnend mit //tcp// zu sehen ist oder eine abweichende //host:port// Kombination als //127.0.0.1:3310// zu erkennen ist, muss die Konfiguration erneut geprüft werden.
++
++== Beispielkonfiguration ==
++
++Ein beispielhafte Konfiguration mit den oben genannten Standardwerten:
++
++{{lightbox image="de_plugin.png"/}}
++
++== Verwendung ==
++
++Sobald eine Virensignatur erkannt wurde, ist folgende Meldung zu sehen:
++
++{{lightbox image="de_virus_found.png"/}}
++
++=== Testdatei ===
++
++Eine gängige Methode zur Überprüfung von Virenscannern ist die //eicar.com// Datei.
++An beliebiger Stelle kann diese Tastdatei hochgeladen werden und nach erfolgreicher Konfiguration ist die oben dargestellte Meldung zu sehen.
++
++; [[**Wikipedia**>>https://de.wikipedia.org/wiki/EICAR-Testdatei]]
++; [[**Download**>>https://www.eicar.org/download-anti-malware-testfile/]]
++
++=== Logging ===
++
++//ClamAV// erstellt logs, welche unter // /var/log/clamav/clamav.log // zu finden sind.
++
++: Nach dem hochladen der //eicar.com// Testdatei ist zum Beispiel folgender Eintrag in //clamav.log //zu sehen:
++; {{code language="shell"}} Wed May 25 10:10:21 2022 -> instream(127.0.0.1@32984): Win.Test.EICAR_HDB-1(44d88612fea8a8f36de82e1278abb02f:68) FOUND {{/code}}
++
++{{formcycle/}} logs sind hierfür unter // /formcycle-data/formcycle7/logs zu finden.//
++
++: Nach dem hochladen der //eicar.com// Testdatei ist zum Beispiel folgender Eintrag in //formcycle-errors-log //zu sehen:
++; {{code language="shell"}} [WARN] [25-05-22 10:10:21,192] [ajp-nio-127.0.0.1-8009-exec-43] (MalwareScanner.java:211) - Scanner <fc.plugin.malware.scanner.clamAV.ClamAntiVirusFileScanner@7b2a4953> detected malware signature for file </home/fc/tomcat9/tmp/xima-temp/formcycle7/xfc-malware-scan/stream-scan12705251110052849842/data2383296604287452271>: {stream=[Win.Test.EICAR_HDB-1]} {{/code}}
++; {{code language="shell"}} [ERROR] [25-05-22 10:10:21,207] [ajp-nio-127.0.0.1-8009-exec-43] (VirusScannerService.java:71) - Detected a virus {{/code}}
++
++== Versionshistorie ==
++
++=== Version 1.0.6 ===
++
++* Change: Virenscan über ClamAV ist nun auch für Windows oder JVM Plattformen möglich
++* Fix: Fehler bei der Fehlerbehandlung behoben
++
++=== Version 1.0.5 ===
++
++* Verbesserte Fehlermeldung im Log, wenn Clam-AV nicht angesprochen werden konnte
++
++=== Version 1.0.4 ===
++
++* Fix: Ein Fehler beim Virenscan auf dem Frontend-Server wurde behoben.
++
++=== Version 1.0.3 ===
++
++* Change: Das Plugin wird auch auf den Frontend-Server übertragen, wenn ein solcher verfügbar ist. Somit kann auch auf Frontend-Server nach Viren gesucht werden.
++
++=== Version 1.0.2 ===
++
++* Entfernen: Eigenschaft für Pfad-Scanning, nur noch InputStream
++
++=== Version 1.0.1 ===
++
++* Fix: Überspringen der Überprüfung, wenn das Betriebssystem nicht UNIX ist, anstatt die Datei als Virus zu erkennen
++
++=== Version 1.0.0 ===
++
++* Initialer Release