phpBB File Check - Zum prüfen auf Existenz und Intaktheit der phpBB Dateien

[LukeWCS]

Link zu diesem Artikel:

Code: Alles auswählen

[url=https://www.phpbb.de/community/viewtopic.php?t=246810]phpBB File Check - Zum prüfen auf Existenz und Intaktheit der phpBB Dateien[/url]

Wer im Rahmen eines Supportfalls auf dieses Thema hingewiesen wurde, der liest bitte direkt ab dem Punkt "4. Anleitung". Die vorhergehenden Punkte sind primär für Admins gedacht, die das Tool in Eigenregie benutzen wollen.

Übersicht

1. Einleitung
2. Beispiel Bericht
3. Erklärung der Meldungen
4. Anleitung
5. Nach Benutzung löschen
6. Sonstiges
7. Download

1. Einleitung

Es kommt immer mal wieder vor, dass bei der Installation von phpBB oder nach einem Update der Verdacht besteht, dass Dateien von phpBB entweder defekt sind oder ganz fehlen. In den meisten Fällen sind Probleme beim Hochladen der zahlreichen Dateien die Ursache. Da eine manuelle Prüfung aller Dateien durch ihre schiere Anzahl (über 4000 beim deutschen Komplettpaket) praktisch nicht durchführbar ist, wurde dieses Tool geschaffen. Damit kann der komplette phpBB Core schnell und zuverlässig auf Vollständigkeit und Integrität überprüft werden.

• Das Tool wird bei Bedarf von den Supportern (nicht auf das phpBB.de Team beschränkt) verlinkt, wenn der Verdacht auf eine beschädigte Dateistruktur besteht.
• Wer Änderungen an Core Dateien vorgenommen hat, der bekommt bei den betroffenen Dateien entsprechende * CHANGED Meldungen.
• Das Tool kann nicht zwischen einer gezielten Änderung und einem echten Defekt unterscheiden, sondern kann nur feststellen, ob eine Datei noch im Originalzustand ist oder nicht.
• Kann sowohl im Browser als auch in der Shell ausgeführt werden, File Check passt sich automatisch an.
• Kann sowohl unter Linux als auch unter Windows ausgeführt werden.
• Benötigt zur Ausführung keine phpBB Komponenten, ist also vollständig autark.
• Voraussetzung: PHP 7.1.0 oder höher. Getestet bis einschließlich PHP 8.3.

2. Beispiel Bericht

Code: Alles auswählen

phpBB File Check v1.4.1
=======================

Version mode : Auto
MD5 source   : ZIP (1, 2, E)
phpBB Version: 3.3.12
MD5 Version 1: 3.3.12 (phpBB.com)
MD5 Version 2: 3.3.12 (phpBB.de)
PHP Version  : 8.3.9 (WINNT)

Please wait, 4069 checksums are being processed...

------------------------------------------------------------------------------------------
{1: 20} ! MISSING: [web.config]
{1:246} * CHANGED: [config/production/config.yml] (hash: d063b506c36d582fddd1af49e7bd3ea9)
{2:210}   NOTICE : [vendor/composer/installed.php] has the phpBB.de hash
------------------------------------------------------------------------------------------

Finished!

Report summary
-------------------
Checked files: 4040
Missing files:    1
Changed files:    1
Notices      :    1

Script/PHP information
---------------------------------------------------------------------
Run time          : 0.617 seconds
Max execution time: 120 seconds
Memory peak usage : 4,233,104 bytes
Memory limit      : 128M
Services          : ZipArchive:1, cURL:1, Sockets:1, allow_url_fopen:1

3. Erklärung der Meldungen

1. In den geschweiften Klammern wird zuerst die Nummer der Prüfsummen-Datei aufgeführt: 1 = phpBB.com, 2 = phpBB.de. Dann folgt hinter dem Doppelpunkt die Zeilennummer in der Prüfsummen-Datei, durch die die Meldung ausgelöst wurde.
   Die Angaben in den geschweiften Klammern sind lediglich eine Randinformation und für die Auswertung der Meldungen nicht relevant.
2. Danach folgt der Meldungstyp:
   • ! MISSING = Datei fehlt.
   • ! WARNING = Verschiedene Warnungen in Bezug auf phpBB Dateien.
   • * CHANGED = Datei geändert (oder beschädigt).
   •   NOTICE = Verschiedene Hinweise in Bezug auf phpBB Dateien.
   • ~ ERROR = Fehler die bei der Ausführung von File Check auftreten können.
   Nur im Debug-Modus:
   • - IGNORED = Datei wurde aufgrund einer Ignorieren-Regel von der Prüfung ausgeschlossen.
   • - EXCEPTION = Datei wurde aufgrund einer Ausnahme-Regel von der Prüfung ausgeschlossen.
   Der Debug-Modus kommt nur in Sonderfällen zum Einsatz.
3. In den eckigen Klammern wird der vollständige Dateiname angezeigt.
4. In runden Klammern wird bei geänderten Dateien der berechnete MD5 Hash angezeigt.

4.Anleitung

File Check steht am Ende dieses Beitrags als Anhang zum Download zur Verfügung. Das passende Prüfsummen-Paket wird automatisch von unserem Server nachgeladen und im Foren-Root gespeichert. Nur wenn dieser Automatismus aufgrund von Hoster Beschränkungen nicht funktioniert, muss Anleitung 4.b ausgeführt werden.

4.a Automatisch: Das Prüfsummen-Paket selbständig nachladen lassen.

1. In das Foren-Root müssen folgende Dateien hochgeladen werden, also dorthin, wo auch config.php ist.
   1. filecheck.php (aus dem File Check Archiv)
   2. filecheck_config.php (aus dem File Check Archiv)
2. Sofern möglich: Dann ruft man im Forum am besten zuerst den Index (Foren-Übersicht) auf.
3. Sofern möglich: Anschließend im Adressfeld des Browsers den Teil index.php und alles rechts davon entfernen. Stattdessen gibt man filecheck.php ein.
4. Schlussendlich hat man also in etwa das im Adressfeld stehen: https://meinforum.de/filecheck.php oder https://meineseite.de/forum/filecheck.php. Dann einfach mit Enter ausführen.
5. Nachdem der Bericht vollständig erzeugt wurde, kann dieser mit dem Button "Copy report to clipboard" direkt in die Zwischenablage kopiert werden.

4.b Manuell: Die Prüfsummen-Dateien selber hochladen.

Wenn es File Check nicht möglich war, das Prüfsummen-Paket automatisch nachzuladen, zum Beispiel wegen Beschränkungen seitens des Hosters, kann das Prüfsummen-Paket oder die einzelnen Prüfsummen-Dateien auch manuell hochgeladen werden. Dazu wird das passende Prüfsummen-Paket benötigt.

• Option 1 - Soll die aktuelle phpBB Version geprüft werden, findet man in unserem Download Bereich unter phpBB-Pakete beim Punkt "Prüfsummen-Paket" die dazu passende Version.
• Option 2 - Soll eine ältere Version von phpBB geprüft werden, findet man das passende Prüfsummen-Paket im Paketarchiv, dort sind Prüfsummen-Pakete ab phpBB 3.2.0 verfügbar. Die Prüfsummen-Pakete haben das Dateimuster phpBB-x.y.z-deutsch-FileCheck-MD5.zip, wobei x.y.z der jeweiligen phpBB Version entspricht. Wenn man sich im Paketarchiv bereits im richtigen Ordner befindet, zum Beispiel 3.3.11, kann man den Browser nach "FileCheck" suchen lassen, in vielen Browsern geht das mit Strg+F.

• Die Version des Prüfsummen-Pakets muss zur vorhandenen phpBB Installation passen, da jedes Prüfsummen-Paket für eine spezifische phpBB Version erstellt wurde. Es ist also zum Beispiel nicht möglich, mit einem 3.3.12 Prüfsummen-Paket ein 3.3.11 phpBB zu prüfen.
• Weder das Prüfsummen-Paket noch die Prüfsummen-Dateien dürfen umbenannt werden. Alle Dateien müssen unverändert hochgeladen werden.

1. In das Foren-Root müssen folgende Dateien hochgeladen werden, also dorthin, wo auch config.php ist.
   • Option 1 - Wenn bei der ersten Ausführung von File Check nicht die Meldung FC_NOTICE: ZipArchive extension not available angezeigt wurde:
     1. filecheck.php (aus dem File Check Archiv)
     2. filecheck_config.php (aus dem File Check Archiv)
     3. phpBB-x.y.z-deutsch-FileCheck-MD5.zip (Prüfsummen-Paket)
   • Option 2 - Wenn bei der ersten Ausführung von File Check die Meldung FC_NOTICE: ZipArchive extension not available angezeigt wurde:
     1. filecheck.php (aus dem File Check Archiv)
     2. filecheck_config.php (aus dem File Check Archiv)
     3. filecheck_x.y.z.md5 (aus dem Prüfsummen-Paket)
     4. filecheck_x.y.z_diff.md5 (aus dem Prüfsummen-Paket)
     5. filecheck_exceptions.txt (aus dem Prüfsummen-Paket)
2. Sofern möglich: Dann ruft man im Forum am besten zuerst den Index (Foren-Übersicht) auf.
3. Sofern möglich: Anschließend im Adressfeld des Browsers den Teil index.php und alles rechts davon entfernen. Stattdessen gibt man filecheck.php ein.
4. Schlussendlich hat man also in etwa das im Adressfeld stehen: https://meinforum.de/filecheck.php oder https://meineseite.de/forum/filecheck.php. Dann einfach mit Enter ausführen.
5. Nachdem der Bericht vollständig erzeugt wurde, kann dieser mit dem Button "Copy report to clipboard" direkt in die Zwischenablage kopiert werden.

5. Nach Benutzung löschen

Das Tool stellt keinerlei Risiko bezüglich Sicherheit dar, weil es keine Benutzereingaben verarbeitet, keine Schreibzugriffe ausführt - abgesehen vom Download des Prüfsummen-Pakets - und auch keine sensiblen Informationen anzeigt. Trotzdem sollten die Dateien von File Check wieder vom Server entfernt werden, wenn das Tool nicht mehr benötigt wird, da es während der Ausführung tausende Lesezugriffe ausführt und auch rechenintensiv ist. Wenn die Dateien von File Check auf dem Server verbleiben, dann besteht die Gefahr, dass das Tool eventuell von Suchmaschinen indiziert und dann regelmäßig frequentiert wird, wodurch die Leistung des Forums unnötig reduziert wird. Auf jeden Fall sollte mindestens die Datei filecheck.php gelöscht werden, damit das Tool nicht mehr ausgeführt werden kann.

6. Sonstiges

Das Tool kann hier diskutiert werden.

Die bisherigen Änderungen am Tool können im Changelog auf GitHub nachgelesen werden.

7. Download

Vorherige kumulierte Downloads: 309

[LukeWCS]

Version 1.1.0 veröffentlicht.

Ausserdem:

• Prüfsummen-Paket komplett neu erstellt. Pro phpBB Version gibt es jetzt 2 Prüfsummen-Dateien; eine vollständige für das phpBB.com Paket und eine für das phpBB.de Komplettpaket, welche nur die Abweichungen zum phpBB.com Paket enthält. Die alten Prüfsummen-Dateien werden nicht mehr akzeptiert.
• Erklärung der Meldungen angepasst.
• Anleitung angepasst. Ausserdem gelbe Info-Box entfernt, da das Installationspaket (original phpBB.com Paket oder phpBB.de Komplettpaket) nicht länger relevant ist.

[LukeWCS]

Version 1.1.1 veröffentlicht.

[LukeWCS]

Version 1.1.2 veröffentlicht.

Ausserdem:

• Im Startbeitrag eine gelbe Info-Box am Anfang hinzugefügt mit einem Hinweis für phpBB Admins, die im Rahmen eines Supportfalls auf das Thema hingewiesen wurden.
• Anleitung auf das Nötigste reduziert.
• Ausserhalb der Anleitung Texte präzisiert sowie Hinweise (blaue Info-Box) eingefügt.
• Das Changelog wird nur noch zentral verwaltet und nicht mehr bei jedem Update einzeln aufgeführt. Link zum Changelog ist im Startbeitrag zu finden. Die einzelnen Changelogs pro Beitrag wurden entfernt.

[LukeWCS]

Version 1.1.3 veröffentlicht.

[LukeWCS]

Ab sofort werden die FileCheck Hash-Pakete im Zuge der Komplettpaket-Erstellung bei phpBB.de automatisch erstellt und sind nicht länger hier im Thema zu finden. Siehe "4. Anleitung" im Startbeitrag für Details.

[LukeWCS]

Version 1.2.0 veröffentlicht.

[LukeWCS]

Version 1.2.1 veröffentlicht.

[LukeWCS]

Version 1.2.2 veröffentlicht.

[LukeWCS]

Version 1.3.0 veröffentlicht.