Änderungen von Dokument ClamAV

Von Version 6.1
bearbeitet von fse
am 17.05.2022, 16:47
Ä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

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.fse
1 +XWiki.jdr
Inhalt
... ... @@ -4,62 +4,169 @@
4 4  {{/version}}
5 5  {{/info}}
6 6  
7 -[[**Plugin-Download**>>https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-malware-scanner/ClamAV&fileid=40404]]
7 +[[**Plugin-Download**>>https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-malware-scanner/ClamAV&fileid=40404]] (erfordert Anmeldung)
8 8  
9 9  {{content/}}
10 10  
11 -{{figure image="de_plugin.png" width="600"}}
12 - Es muss ein TCP-Verbindung eingerichtet werden, um den ClamAV-Daemon Service zum scannen der hochgeladenen Dateien zu verwenden.
13 -{{/figure}}
11 +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.
14 14  
15 -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.
13 +== Funktionalität ==
16 16  
17 -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.
15 +; Sofortiger Virenscan
16 +: Jede Datei wird direkt nach Ihrem Upload gescannt.
18 18  
19 -== Konfiguration ==
18 +Der verwendete //ClamAV//-Daemon Service kann weder durch dieses Plugin konfiguriert noch gestartet werden.
20 20  
21 -ClamAV ist dafür gedacht, auf Linux basierten Servern zu laufen. Deswegen kann eine anderweitige Unterstützung unserseits nicht garantiert werden.
20 +== Installation ==
22 22  
22 +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.
23 +
24 +{{info}}
25 + 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.
26 +{{/info}}
27 +
28 +== Konfiguration Plugin ==
29 +
30 +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.
31 +
23 23  {{figure image="de_error.png" width="400"}}
24 24   Falls keine Verbindung zu dem angegeben Host aufgebaut werden kann, wird diese Meldung ausgegeben.
25 25  {{/figure}}
26 26  
27 -Folgende Konfigurationparameter gibt es:
36 +Folgende Konfigurationsparameter gibt es:
28 28  
29 29  ; host (Erforderlich)
30 -: Host-Name oder IP-Adresse des Servers auf dem ClamAV-Daemon läuft. Der standard Host ist {{smallcaps}}127.0.0.1{{/smallcaps}}, genau dann wenn ClamAV auf dem gleichen Server wie {{formcycle/}} läuft.
39 +: 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.
31 31  ; port (Erforderlich)
32 -: Der Standard Port von ClamAV-Daemon ist {{smallcaps}}3310{{/smallcaps}}. Falls der Port abweichen sollten, so muss dieser hier angepasst werden.
33 -; file-source
34 -: 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.
41 +: 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
42 +; os (Optional)
43 +: 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.
35 35  
36 -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.
45 +== Konfiguration //ClamAV// ==
37 37  
38 -== ClamAV Einstellungen ==
47 +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.
39 39  
40 -Im folgenden Abschnitt wird auf wichtige Konfigurationsschritte von ClamAV-Daemon eingegangen. Unser empfohlenes Szenario ist {{formcycle/}} und den ClamAV-Daemon Service auf dem selben Server zu installieren.
49 +=== Installation ===
41 41  
42 -Da das eigentliche Virusscanning losgelöst von {{formcycle/}} stattfindet, sollte auf eine aktulle Virensignatur-Datenbank geachtet werden via {{smallcaps}}freshclam{{/smallcaps}}.
51 +Um //ClamAV// auf einem Server zu installieren, sollten folgende Befehle auf dem Server eingegeben werden.
43 43  
44 -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.
53 +//ClamAV// ist das Programm, welches Dateien auf Viren scannen kann und wird für die Verwendung von //ClamAV//-Daemon benötigt.
45 45  
46 -Folgende Parameter müssen der Datei hinzugefügt werden:
55 +; Aktualisieren der package list:
56 +; {{code language="shell"}} sudo apt-get update {{/code}}
47 47  
48 -; TCPAddr (Erforderlich)
49 -: Soll hinzugefügt und mit dem Wert {{smallcaps}}127.0.0.1{{/smallcaps}} angegeben werden.
50 -; TCPSocket (Erforderlich)
51 -: Soll hinzugefügt und mit dem Wert {{smallcaps}}3310{{/smallcaps}} angegeben werden oder abweichend, falls der Port anderweitig genutzt werden soll.
52 -; User
53 -: Ist standardmäßig {{smallcaps}}clamav{{/smallcaps}} und muss zu {{smallcaps}}root{{/smallcaps}} geändert werden um dem ClamAV-Daemon Service root Rechte zu geben.
58 +; Installiere //ClamAV// und //ClamAV//-Daemon:
59 +; {{code language="shell"}} sudo apt-get install clamav clamav-daemon -y {{/code}}
54 54  
55 -{{figure image="en_tcp_test.png"}}
56 - Mithilfe von {{smallcaps}}netstat{{/smallcaps}} kann der TCP Socket vom ClamAV-Daemon Service untersucht werden.
57 -{{/figure}}
61 +=== Aktualisieren der Virensignatur-Datenbank ===
58 58  
59 -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:
63 +//freshclam// wird mit //ClamAV// automatisch installiert und wird zum aktualisieren der Virensignatur Datenbank genutzt.
60 60  
61 -{{code language="shell"}}
62 -sudo netstat -anp | grep -E "(clam)"
63 -{{/code}}
65 +; Beenden des automatischen //freshclam// Prozess:
66 +; {{code language="shell"}} sudo systemctl stop clamav-freshclam {{/code}}
64 64  
68 +; Manuelles aktualisieren der Virensignatur Datenbank:
69 +; {{code language="shell"}} sudo freshclam {{/code}}
65 65  
71 +=== Konfiguration //ClamAV//-Daemon ===
72 +
73 +//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.
74 +
75 +Dafür soll die Konfigurationsdatei unter: // /etc/clamav/clamd.conf // angepasst werden.
76 +
77 +; Öffnen der Konfigurationsdatei:
78 +; {{code language="shell"}} sudo nano /etc/clamav/clamd.conf {{/code}}
79 +
80 +Mit den Pfeiltasten kann an das Ende der Datei navigiert werden.
81 +
82 +; Hinzufügen von //TCPAddr 127.0.0.1 //
83 +; Hinzufügen von //TCPSocket 3310 //
84 +
85 +{{lightbox image="en_clamd.conf.png"/}}
86 +
87 +; //ClamAV//-Daemon root Rechte geben
88 +: dafür muss in dieser Datei der Eintrag //User clamav// in //User root// geändert werden.
89 +
90 +Nun kann mit //Strg + X// gespeichert und beendet werden. Mit //Y// und der Enter-Taste bestätigen.
91 +
92 +=== Starten der //ClamAV//-Daemon Service ===
93 +
94 +Nun kann der Service gestartet werden.
95 +
96 +: Starten des //ClamAV//-Daemon Service:
97 +; {{code language="shell"}} sudo systemctl start clamav-daemon.service {{/code}}
98 +
99 +=== Prüfen der Verfügbarkeit des Service ===
100 +
101 +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.
102 +
103 +; Mithilfe von //netstat// kann der TCP Socket vom //ClamAV//-Daemon Service untersucht werden.
104 +; {{code language="shell"}} sudo netstat -anp | grep -E "(clam)" {{/code}}
105 +
106 +{{lightbox image="de_tcp_test.png"/}}
107 +
108 +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.
109 +
110 +== Beispielkonfiguration ==
111 +
112 +Ein beispielhafte Konfiguration mit den oben genannten Standardwerten:
113 +
114 +{{lightbox image="de_plugin.png"/}}
115 +
116 +== Verwendung ==
117 +
118 +Sobald eine Virensignatur erkannt wurde, ist folgende Meldung zu sehen:
119 +
120 +{{lightbox image="de_virus_found.png"/}}
121 +
122 +=== Testdatei ===
123 +
124 +Eine gängige Methode zur Überprüfung von Virenscannern ist die //eicar.com// Datei.
125 +An beliebiger Stelle kann diese Tastdatei hochgeladen werden und nach erfolgreicher Konfiguration ist die oben dargestellte Meldung zu sehen.
126 +
127 +; [[**Wikipedia**>>https://de.wikipedia.org/wiki/EICAR-Testdatei]]
128 +; [[**Download**>>https://www.eicar.org/download-anti-malware-testfile/]]
129 +
130 +=== Logging ===
131 +
132 +//ClamAV// erstellt logs, welche unter // /var/log/clamav/clamav.log // zu finden sind.
133 +
134 +: Nach dem hochladen der //eicar.com// Testdatei ist zum Beispiel folgender Eintrag in //clamav.log //zu sehen:
135 +; {{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}}
136 +
137 +{{formcycle/}} logs sind hierfür unter // /formcycle-data/formcycle7/logs zu finden.//
138 +
139 +: Nach dem hochladen der //eicar.com// Testdatei ist zum Beispiel folgender Eintrag in //formcycle-errors-log //zu sehen:
140 +; {{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}}
141 +; {{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}}
142 +
143 +== Versionshistorie ==
144 +
145 +=== Version 1.0.6 ===
146 +
147 +* Change: Virenscan über ClamAV ist nun auch für Windows oder JVM Plattformen möglich
148 +* Fix: Fehler bei der Fehlerbehandlung behoben
149 +
150 +=== Version 1.0.5 ===
151 +
152 +* Verbesserte Fehlermeldung im Log, wenn Clam-AV nicht angesprochen werden konnte
153 +
154 +=== Version 1.0.4 ===
155 +
156 +* Fix: Ein Fehler beim Virenscan auf dem Frontend-Server wurde behoben.
157 +
158 +=== Version 1.0.3 ===
159 +
160 +* 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.
161 +
162 +=== Version 1.0.2 ===
163 +
164 +* Entfernen: Eigenschaft für Pfad-Scanning, nur noch InputStream
165 +
166 +=== Version 1.0.1 ===
167 +
168 +* Fix: Überspringen der Überprüfung, wenn das Betriebssystem nicht UNIX ist, anstatt die Datei als Virus zu erkennen
169 +
170 +=== Version 1.0.0 ===
171 +
172 +* Initialer Release