
VisualCodeGrepper - Tool zur Sicherheitsanalyse von Code.
VCG (VisualCodeGrepper) Aktuelle Version: 2.3.2 ==================================================================================== Inhalt: 1. Überblick 2. Neueste Ergänzungen in VCG V2.3.2 3. Verwendung von VCG Eingabedateien/Codebasis Optionen & Einstellungen Scannen Konfigurationsdateien Ausgabe Kommandozeilenparameter ==================================================================================== Überblick ------------------------------------------------------------------------------------ VCG ist ein automatisiertes Werkzeug zur Sicherheitsüberprüfung von Code, das C/C++, Java, C#, VB, PL/SQL, PHP und COBOL verarbeitet. Es verfügt über einige Funktionen, die hoffentlich für jeden nützlich sind, der Sicherheitsüberprüfungen von Code durchführt, insbesondere wenn die Zeit knapp ist: 1. Neben der Durchführung einiger komplexerer Prüfungen verfügt es außerdem über eine Konfigurationsdatei für jede Sprache, mit der Sie im Grunde jede fehlerhafte Funktion (oder jeden anderen Text) hinzufügen können, nach der Sie suchen möchten 2. Es versucht, eine Reihe von etwa 20 Phrasen in Kommentaren zu finden, die auf fehlerhaften Code hinweisen können (ToDo, FixMe, Kludge usw.) 3. Es bietet ein übersichtliches Kreisdiagramm (für die gesamte Codebasis und für einzelne Dateien), das die relativen Anteile von Code, Leerraum, Kommentaren, ToDo-Kommentaren und fehlerhaftem Code zeigt Ich habe versucht, etwas zu entwickeln, das nicht die große Anzahl von Fehlalarmen zurückgibt, die von einigen Werkzeugen geliefert werden, und das außerdem intelligent sucht, um Pufferüberläufe und Vergleiche zwischen vorzeichenbehafteten und vorzeichenlosen Werten zu erkennen. ==================================================================================== Neueste Ergänzungen in VCG V2.3.2 ------------------------------------------------------------------------------------ Neue Funktionen: 1) Eine Änderung der GUI bedeutet, dass die Auswahl der Zielsprache über eine Dropdown-Liste statt über ein Menü erfolgt (wie in V2.3.1). 2) Die Beta-Funktionalität umfasst nun das Scannen von R-Skripten (wie in V2.3.1). 3) Kleinere Fehlerbehebungen zur Behebung verschiedener Probleme und zur Wiederherstellung der Möglichkeit, mehrere Anwendungsinstanzen auszuführen. ==================================================================================== Verwendung von VCG ------------------------------------------------------------------------------------ Eingabedateien/Codebasis: Stellen Sie vor dem Scannen des Codes sicher, dass die richtige Sprache ausgewählt ist, da VCG nur auf Probleme im Zusammenhang mit der ausgewählten Sprache prüft und nur die relevanten Dateitypen scannt. Die Sprache kann im Einstellungsmenü oder im Optionsdialog ausgewählt werden. Wählen Sie das Verzeichnis aus, das den zu scannenden Code enthält, über Datei=>Neues Ziel... VCG lädt dann alle Dateien mit den angegebenen Endungen. Die Standardwerte sind unten aufgeführt, können aber über den Optionsdialog geändert werden: C/C++: .c .h .cpp .hpp Java: .java .jsp web.xml config.xml (die XML-Dateien sind enthalten, um die Eingabevalidierung durch Struts usw. zu prüfen) PL/SQL: .pls .sql .pkb .pks C#: .cs .asp .aspx web.config (die web.config-Datei ist enthalten, um die Eingabevalidierung, Debug-Einstellungen usw. zu prüfen) VB: .vb .asp .aspx web.config (die web.config-Datei ist enthalten, um die Eingabevalidierung, Debug-Einstellungen usw. zu prüfen) PHP: .php php.ini (die php.ini-Datei ist enthalten, um fehlerhafte Konfigurationen wie register_globals zu prüfen) COBOL: .cob .cbl .clt .cl2 .cics R: .r ------------------------------------------------------------------------------------ Optionen und Einstellungen: Dateitypen – Hiermit können Sie die Dateitypen ändern, nach denen VCG für jeden Codetyp sucht. Um alle Dateien in einem Verzeichnis zu scannen, fügen Sie .* zur Liste hinzu oder löschen Sie alle Typen und übermitteln Sie eine leere Zeichenkette. Konfigurationsdateien – Geben Sie für jede Sprache eine Konfigurationsdatei an. Diese enthält eine Auflistung aller Funktionen oder Codefragmente, die als riskant gelten und gemeldet werden müssen. Diese Funktion fügt im Wesentlichen eine zusätzliche Prüfebene zu den komplexeren Vorgängen hinzu, die im Rahmen des Code-Scans ausgeführt werden. Schweregrad – VCG kann so eingestellt werden, dass nur Fehler oberhalb eines bestimmten Schweregrads gemeldet werden. Wählen Sie z. B. „Medium“, um nur Medium, High und Critical im Bericht zu erhalten. COBOL-Einstellungen – Die Anfangsspalte muss angegeben werden – d. h. die erste Spalte nach den Zeilennummern. Diese ist im Allgemeinen 1 für ein Listing ohne Zeilennummern oder 7 für ein Listing mit Zeilennummern. Eine andere Einstellung kann erforderlich sein, wenn die Code-/Kommentarzeilen im Listing in einer anderen Spalte beginnen. Die z/OS-Einstellung kann verwendet werden, um Prüfungen auf die sichere Verwendung der CICS-API usw. einzuschließen. OWASP-Einstellungen (nur Java) – Wenn ausgewählt, werden zwei Verstöße gegen die OWASP-Best-Practice für Java-Programmierung identifiziert, die auf den OWASP-Seiten zum sicheren Programmieren aufgeführt sind. Verschachtelte Klassen und nicht-finale öffentliche Klassen werden gemeldet – da es wahrscheinlich eine große Anzahl dieser Verstöße ohne großes Risiko gibt, besteht die Möglichkeit, einen dieser Scans zu deaktivieren. Ausgabedatei – Die ASCII-Ausgabe wird in diese Datei geschrieben, wenn ausgewählt. Beta-Funktionalität – Wählen Sie durch Anklicken des entsprechenden Kontrollkästchens unter Optionen -> Beta-Funktionalität, ob Beta-Funktionalität verwendet werden soll. Derzeit verfügbare Beta-Funktionalität ist die Lokalisierung von Signed/Unsigned-Vergleichen in C (sehr unzuverlässig) und das Scannen von R (getestet und funktioniert einigermaßen gut – nahe an der Aufnahme in die nächste Version). ------------------------------------------------------------------------------------ Scannen: Der Scan kann auf drei Arten durchgeführt werden: 1. Nur Kommentare – VCG versucht, Kommentare zu identifizieren, die auf fehlerhaften oder unfertigen Code hinweisen, basierend auf einer Liste von etwa 16 Phrasen, die typischerweise in solchen Kommentaren vorkommen („ToDo“, „FixMe“ usw.) 2. Nur Code – VCG scannt und meldet potenzielle Codesicherheitsprobleme und alle gefährlichen Funktionen usw. aus der Konfigurationsdatei, die im Code gefunden werden. 3. Nur gefährliche Funktionen – VCG scannt und meldet nur gefährliche Funktionen usw. aus der Konfigurationsdatei, die im Code gefunden werden. 4. Code, gefährliche Funktionen & Kommentare – Auch bekannt als vollständiger Scan im Scan-Menü; dies ist ein kombinierter Scan von Code und Kommentaren, der alle oben genannten Punkte abdeckt. ------------------------------------------------------------------------------------ Konfigurationsdateien: Für jede der sechs Sprachen, die VCG scannt, existieren Konfigurationsdateien. Diese bieten eine zusätzliche Scanebene zur Ergänzung der integrierten komplexen Scans für jede Sprache. Der Inhalt der Konfigurationsdateien besteht aus einer Liste von Funktionen/Codefragmenten, nach denen gesucht werden soll, zusammen mit einer zugehörigen Beschreibung, die in den Ergebnissen erscheint. Die Beschreibung enthält eine optionale Schweregradangabe in eckigen Klammern und wird durch „=>“ von der Funktion getrennt, mit folgendem Format: Funktionsname[=>][[N]][Beschreibung] (wobei N eine Schweregradbewertung von 1 (Critical) bis 3 (Medium) ist (oder optional 0 für „normal“)) Zum Beispiel: strcat=>[3]String concatenation function which facilitates buffer overflow conditions. Appears in Microsoft's banned function list. ------------------------------------------------------------------------------------ Ausgabe: Die visuelle Code-Aufschlüsselung wird angezeigt, wenn der Scan abgeschlossen ist. Die Ergebnisse werden in der Reihenfolge, in der sie gefunden wurden, in den Ergebnisbereich geschrieben. Ergebnisse haben folgendes Format: SCHWEREGRAD: Code-Problem Zeilennummer – Dateiname Beschreibung [Codefragment] Der Problem-Titel hat zur besseren Übersichtlichkeit folgende Farbcodes: Critical – Magenta High – Rot Medium – Orange Standard/Normal – Gelb/Sepia Low – Graublau Potenzielles Problem/Best Practice – Grün Verdächtiger Kommentar, der auf fehlerhaften Code hinweist – Dunkelblau Die Ergebnisse werden außerdem in verkürzter Form in die Übersichtstabelle geschrieben, wo sie durch Klicken auf die Spaltenüberschriften sortiert werden können. Ein Doppelklick auf einen Eintrag in der Ergebnistabelle führt dazu, dass die Datei in der zugehörigen Anwendung geladen wird. Diese Ergebnisse können als ASCII-Text gespeichert werden, indem Sie auf Datei=>Ergebnisse speichern... klicken. Die Ergebnisse können als XML gespeichert werden, indem Sie auf Datei=>Ergebnisse als XML exportieren... klicken. Eine nach Schweregrad gefilterte Ergebnismenge kann als XML gespeichert werden, indem Sie mit der rechten Maustaste in das Fenster Ergebnisse klicken und auf Gefilterte XML-Ergebnisse exportieren... klicken. Die Ergebnisse können in einer CSV-Datei gespeichert werden, indem Sie auf Datei=>Ergebnisse als CSV exportieren... klicken. ------------------------------------------------------------------------------------ Kommandozeilenparameter: Verwendung: VisualCodeGrepper [Optionen] STARTUP-OPTIONEN: (Legen den gewünschten Startpunkt für die GUI fest. Bei Verwendung des Konsolenmodus legen diese Optionen das/die zu scannende(n) Ziel(e) fest.) -t, --target <Filename|DirectoryName>: Legt die Zieldatei oder das Zielverzeichnis fest. Verwenden Sie diese Option, um das Ziel entweder sofort in die GUI zu laden oder um das Ziel für den Konsolenmodus bereitzustellen. -l, --language <CPP|PLSQL|JAVA|CS|VB|PHP|COBOL|R>: Legt die Zielsprache fest (Standard ist C/C++). -e, --extensions <ext1|ext2|ext3>: Legt die zu analysierenden Dateiendungen fest (siehe ReadMe oder Optionsbildschirm für sprachspezifische Standardwerte). -i, --import <Filename>: Importiert XML/CSV-Ergebnisse in die GUI. AUSGABEOPTIONEN: (Exportiert Ergebnisse automatisch in eine Datei im angegebenen Format. Verwenden Sie XML- oder CSV-Ausgabe, wenn Sie die Ergebnisse später wieder in die GUI laden möchten.) -x, --export <Filename>: Exportiert Ergebnisse automatisch in eine XML-Datei. -f, --csv-export <Filename>: Exportiert Ergebnisse automatisch in eine CSV-Datei. -r, --results <Filename>: Exportiert Ergebnisse automatisch in eine reine Textdatei. KONSOLENOPTIONEN: -c, --console: Führt die Anwendung nur in der Konsole aus (blendet die GUI aus). -v, --verbose: Setzt die Konsolenausgabe in den ausführlichen Modus. -h, --help: Zeigt die Hilfe an. ====================================================================================