Prüfbericht lesen
Nach dem Abschluss der Validierung können Sie den Bericht exportieren oder online lesen.
Vorgehensweise
- Um den Bericht im JSON-Format herunterzuladen, klicken Sie auf das Downloadsymbol (
) oben rechts auf der Seite. - Um den Bericht online zu lesen, klicken Sie auf das Dokumentsymbol (
) oben rechts auf der Seite.In den folgenden Tabellen werden die Validierungsschritte beschrieben und Lösungen zur Behebung von Fehlern bereitgestellt.Tabelle 1. ZIP-Datei für Erweiterung Regelname Beschreibung Inhalt der ZIP-Datei für Erweiterung überprüfen Prüft, ob die ZIP-Erweiterungsdatei extrahiert werden kann und erforderliche Dateien enthält. Vorhandensein der XML für Inhaltsexport Prüft, ob die ZIP-Datei der Erweiterung Inhalts-XML enthält. Andernfalls wird der Prüfprozess abgebrochen. Vorhandensein der Manifestdatei für die Erweiterung Prüft, ob die ZIP-Datei der Erweiterung manifest.txt enthält. Andernfalls wird der Prüfprozess abgebrochen. Tabelle 2. Manifestdatei (manifest.txt) für die Erweiterung Regelname Beschreibung Manifest-Datei für die Erweiterung laden Prüft, ob manifest.txt (die Informationen der Erweiterung) im JSON-Format vorliegt. Andernfalls wird der Prüfprozess abgebrochen. Sie können die Datei manifest.txt aus dem Übergabeportal von X-Force App Exchange herunterladen. Die zugehörigen Felder werden automatisch generiert. Format der Erweiterungsversion ist gültig Prüft, ob die Erweiterungsversion (Feld Version in manifest.txt) ein Sequenzformat mit drei Ziffern aufweist, wie z. B. MAJOR.MINOR.PATCH. Mindestversion von QRadar ist gültig Prüft, ob die unterstützte Version von QRadar (min_qradar_version , definiert in manifest.txt) gültig ist. Es kann in einer Folge von drei Ziffern (2019.14.6) oder vier Ziffern (2019.14.6.20201205215722) formatiert werden. Sie können sich über SSH bei QRadar anmelden und mithilfe von /opt/qradar/bin/myver nach Ihrer QRadar -Version in Ihrer Entwicklungsumgebung suchen. Erweiterung muss Englisch unterstützen Prüft, ob doc.extension_manifest.supported_language_set (ein Array) mindestens 'en-US' enthält. Dieses Feld wird vom X-Force App Exchange-Übergabeportal generiert. Größe des Erweiterungspakets ist gültig Überprüft die Datei doc.extension_manifest.package_size in der Datei manifest.txt. Dieses Feld wird vom X-Force App Exchange-Übergabeportal generiert. Abgleich mit anderen Feldern Prüft, ob die Pflichtfelder (Name, Beschreibung, Autor und Autor-E-Mail) in der Datei manifest.txt definiert sind. Diese Felder werden durch das Übergabeportal von X-Force App Exchange generiert. Tabelle 3. Signieren der Erweiterung Regelname Beschreibung Signaturartefakte werden im Verzeichnis META-INF gespeichert. Prüft, ob die Erweiterung signiert ist. Weitere Informationen finden Sie unter How to get your extension .zip file ready for validation. Tabelle 4. Inhalts-XML Regelname Beschreibung XML für Inhaltsexport laden Prüft, ob die Inhalts-XML erfolgreich geladen werden kann. Informationen zur Anwendung sind gültig Prüft, ob eine Anwendung in dieser Inhalts-XML exportiert wird. Wenn ja, überprüfen Sie, ob die Informationen dieser Anwendung korrekt sind. Die QRadar-Versionsnummer hat ein gültiges Format. Prüft, ob <qradarversion>...</qradarversion> eine gültige QRadar -Version mit dem richtigen Format enthält. Dieses Feld wird von QRadarautomatisch generiert. Weitere Informationen finden Sie unter Angepasste Inhaltselemente unterschiedlicher Typen exportieren. Prüfung auf ordnungsgemäßen Zustand der benutzerdefinierten Ereigniseigenschaft Prüft, ob eine benutzerdefinierte Eigenschaft in dieser Inhalts-XML mit den veröffentlichten Erweiterungen in Konflikt steht. Wenn die Erweiterung Eigenschaften enthält, die denselben Namen wie andere veröffentlichte Erweiterungen haben, kann sie nicht ordnungsgemäß installiert werden. Um eine kollidierende benutzerdefinierte Eigenschaft zu korrigieren oder zu verhindern, können Sie IBM QRadar Custom Properties Dictionary in Ihrer QRadar -Konsole installieren und die Eigenschaft in der Konsolenbenutzerschnittstelle auswählen, um Ihre Inhalts-XML zu exportieren. Prüfung auf ordnungsgemäßen Zustand der benutzerdefinierten Suche Prüft, ob Suchattribute aufgrund einer manuellen Änderung fehlen. Prüfung auf ordnungsgemäßen Zustand der benutzerdefinierten Regel Prüft, ob Regelattribute aufgrund einer manuellen Änderung fehlen. Tabelle 5. ZIP-Datei der Anwendung Regelname Beschreibung Extraktion der ZIP-Datei der Anwendung Prüft, ob die ZIP-Datei der Anwendung erfolgreich extrahiert werden kann. Laden der Anwendung manifest.json Prüft, ob die Datei manifest.json ein gültiges JSON-Format hat. Das Format der Anwendungsversion ist gültig. Prüft, ob die Anwendungsversion (Feld Version in manifest.json) ein Sequenzformat mit drei Ziffern aufweist, wie z. B. MAJOR.MINOR.PATCH. Unterstützt von App Framework V2 Prüft, ob die Anwendung das neue Basisimage verwendet, das vom App-Framework V2 bereitgestellt wird. Weitere Informationen finden Sie unter QRadar: How to migrate applications from app framework v1 to V2. Umgebungsvariablen prüfen Prüft, ob der Wert von Umgebungsvariablen in der Datei manifest.json ein gültiges Format hat. Weitere Informationen finden Sie unter QRadar App Framework-Manifestobjekttypen-Umgebungsvariablen. Servicenamen und Ports überprüfen Prüft, ob der Wert von Umgebungsvariablen in der Datei manifest.json ein gültiges Format hat. Weitere Informationen finden Sie unter QRadar App Framework-Manifestobjekttypen-Servicetyp. Hinweis: Wenn die Erweiterung keine Apps enthält, wird die Regelprüfung in der Datei Application.zip übersprungen.Tabelle 6: Installationsscripts Regelname Beschreibung Die Ordnerstruktur ist gültig Prüft, ob die ZIP-Datei der App obligatorische Ordner enthält. Abhängigkeit von Python-Paketen sollte ohne Internetzugriff aufgelöst werden Prüft, ob die Abhängigkeit von Python-Paketen lokal aufgelöst werden kann. Es ist eine Voraussetzung, dass die Anwendung erfolgreich ohne Internetzugang installiert werden kann. Installationsscript sollte nicht auf Internet zugreifen Prüft, ob die Initialisierungs-Scripts in container/run und container/build keine Befehle für den Zugriff auf das Internet enthalten. Auf Überschreibungspakete prüfen Prüft, ob die ZIP-Datei der Anwendung eigene Versionen von OpenSSH und SQLite3 installiert. Diese Pakete werden bereits in der V2-Laufzeitumgebung der App Framework bereitgestellt. 'sudo' sollte im Initialisierungsscript nicht verwendet werden Prüft, ob der Befehl Sudo in den Scripts init in den Verzeichnissen container/run und container/build verwendet wird. Angepasste Dateien encdec.py und qpylib sollten nicht verwendet werden Prüft, ob die ZIP-Datei der Anwendung eine selbsterstellte qpylib-Bibliothek enthält. Die Bibliothek qpylib wird bereits in der V2-Laufzeitumgebung der App Framework bereitgestellt. Hinweis: Wenn die Erweiterung keine Apps enthält, wird die Regelprüfung in den Installationsscripts übersprungen.Tabelle 7: Erweiterungs- und anwendungsübergreifende Prüfung Regelname Beschreibung Inhalte können in der unterstützten Mindestversion von QRadar installiert werden. Prüft, ob Ihre Inhalts-XML in der unterstützten Mindestversion von QRadar installiert werden kann, ist im Feld min_qradar_version von manifest.txtdefiniert. Beispiele:
- min_qradar_version ist auf "7.3.2" gesetzt und die Inhalts-XML wird aus 7.3.2 Fixpack 5 exportiert (7.3.2 20191022133252).
- min_qradar_version ist auf "7.3.2" gesetzt und die Inhalts-XML wird aus 7.3.1 GA exportiert (7.3.1. 20171206222136).
- min_qradar_version wird auf "2019.14.0" (7.3.3 GA) gesetzt und die Inhalts-XML wird aus 7.3.3 Fixpack 6 exportiert (2019.14.6.20201205215722)
Hinweis:- Sie können sich über SSH bei Ihrer QRadar -Konsole anmelden, indem Sie /opt/qradar/bin/myver verwenden, um Ihre interne QRadar -Version (vierstellig) anzuzeigen.
- min_qradar_version in manifext.txt besteht aus drei Ziffern (2019.14.6) oder vier Ziffern (2019.14.6.20201205215722).
Überprüfen Sie die exportierte QRadar -Version in Content XML stellt App Framework V2 bereit. Das App-Framework V2 wird in QRadar 7.3.3 Fixpack 6 +, 7.4.1 Fixpack 2 + oder QRadar 7.4.2+ (nicht unterstützt in 7.4.0.x) bereitgestellt. Wenn Ihre Erweiterung mindestens eine Anwendung enthält, die in App Framework V2ausgeführt wird, prüft diese Regel, ob Ihre Inhalts-XML in die Liste der unterstützten QRadar -Versionen exportiert wird. Überprüfen Sie die unterstützte Mindestversion von QRadar in manifest.txt stellt App Framework V2 bereit. Wenn Ihre Erweiterung mindestens eine Anwendung enthält, die unter App Framework V2 ausgeführt wird, prüft diese Regel, ob Ihre unterstützte Mindestversion (min_qradar_version in manifest.txt) App Framework V2 bereitstellt. Tabelle 8. Sicherheitsprüfung Regelname Beschreibung Sicherheitsprüfung für Python-Codes Die App IBM QRadar Pre-Validation verwendet Bandit, um allgemeine Sicherheitsprobleme im Python -Code zu finden.
Es ist nicht ungewöhnlich, wenn Bandit oder andere automatisierte Tools falsch-positive Ergebnisse generieren. Analysieren Sie den Bericht, um die Gültigkeit der Ergebnisse zu ermitteln.