PHP-SDK-Übersicht

Verwenden Sie die PHP-SDK, wenn Ihre Anwendung einen Scan starten, dessen strukturierten Bericht verarbeiten oder die eingebauten Signaturindizes abfragen muss. Die unterstützte API besteht aus AMWScan\Scanner und den schreibgeschützten Nachschlagemethoden von AMWScan\Signatures.

Installieren und laden

Installieren Sie das Paket mit Composer und laden Sie vor der Verwendung der SDK den Autoloader von Composer:

composer require marcocesarato/amwscan

require __DIR__ . '/vendor/autoload.php';

use AMWScan\Scanner;

Das Paket erfordert PHP 7.4 oder höher mit den Erweiterungen fileinfo, json, mbstring und zlib. Unterstützte Umgebungen finden Sie unter Anforderungen.

Einstiegspunkt auswählen

Bedarf	API	Ergebnis
Dateien oder ein Projekt scannen	Scanner::run()	stdClass-Scanbericht oder false bei einem abgefangenen Scanfehler
Ein Scanergebnis nach Abschluss lesen	Scanner::getReport()	Aktueller stdClass-Scanbericht
Einen exakten SHA-256-Malware-Hash prüfen	Signatures::findKnownMalwareHash()	Übereinstimmungsdatensatz oder null
Einen älteren normalisierten Dateihash prüfen	Signatures::matchesLegacyCoreFile()	bool
Eingebaute Indikatoren für verdächtige Domains auflisten	Signatures::getDomainIndicators()	Array mit Indikatordatensätzen

Lesen Sie Scannen mit Scanner, bevor Sie die Scan-Ausführung integrieren. Lesen Sie Berichte und Funde, bevor Sie Ergebnisse speichern oder darauf alarmieren.

Minimaler unbeaufsichtigter Scan

use AMWScan\Scanner;

$scanner = new Scanner();
$report = $scanner
    ->enableLiteMode()
    ->setSilentMode()
    ->setAutoSkip()
    ->run([__DIR__ . '/project']);

if ($report === false) {
    throw new RuntimeException($scanner->getLastError() ?: 'Scan failed.');
}

printf("Scanned: %d; findings: %d\n", $report->scanned, $report->detected);

setSilentMode() konfiguriert den nicht interaktiven Betrieb und wählt Überspringen als Standardaktion, sofern Sie keine andere Abfrage festlegen. Dadurch wird ein Scan nicht automatisch schreibgeschützt. Lassen Sie automatisierte Behebungen deaktiviert, bis Sie repräsentative Berichte geprüft haben.

API-Stabilität

Scanner und die in diesem Abschnitt dokumentierten Nachschlagemethoden bilden die unterstützte Integrationsoberfläche. Klassen unter Archive, Checkpoint, Console, Findings, Integrity, Modules, Remote und Reputation unterstützen die Scanner-Interna. Koppeln Sie eine Anwendung nicht an diese oder an öffentliche statische Eigenschaften wie Scanner::$settings und Signatures::$raw.

Der Scanner verwaltet Konfiguration und Berichte in statischem Zustand. Ein PHP-Prozess sollte jeweils nur einen Scan ausführen. Verwenden Sie getrennte Prozesse für gleichzeitige Jobs, eingereihte Scans oder die Isolierung zwischen Mandanten. Lesen Sie Sicherheit und Zustand, bevor Sie die SDK in einem Worker oder langlebigen Webprozess ausführen.

Referenzübersicht

Referenz	Inhalt
Scannen mit Scanner	Konstruktor, Lebenszyklus, Optionen, Filter, Ausgabe und Steuerungen für Behebungen
Berichte und Funde	Berichtsstruktur, Abdeckungsstatus, Funde, Diagnosen und Fehlerbehandlung
Signaturabfrage	Verträge für Hash- und Domainabfragen
Sicherheit und Zustand	Zustandslebensdauer, destruktive Aktionen, Netzwerkverhalten und Bereitstellungshinweise