easy_sast

Einfacher Sast

easy_sast ist ein Docker -Container für die Verwendung in Integrationspipelines, um die Build -Artefakte einer Anwendung an ein statisches Analyse -Tool einzureichen. Dies wurde in einer Weise entwickelt, um als Build -Muster für andere Behälter zu dienen, die eine ähnliche Funktionalität erleichtern sollen, und integriert sich nativ in das statische Analyseprodukt von Veracode.

• Merkmale
• QuickStart
• Verwendung
• Beitragen

easy_sast ist bei Docker Hub erhältlich, indem docker pull seiso/easy_sast ausgeführt wird

Weitere Informationen und weitere Informationen finden Sie im Wiki.

Merkmale

Diese Codebasis wurde im Einklang mit dem robusten Manifest entwickelt. Als solches ist es:

• Einfach zu bedienen : mit Workflow -Optionen und Konfigurationen, die DevOps intuitiv verstehen.
• Einfach konfigurierbar : Praktische Standardeinstellungen und zahlreiche Konfigurationsoptionen wie eine Konfigurationsdatei, Umgebungsvariablen und/oder CLI -Argumente.
• Löschen und verständlicher Code : Die regelmäßige Verwendung von Typ -Hinweisen, Keyword -Argumenten und eines normalisierten Codestils erleichtert das Verständnis der Code -Absicht.
• Entwickelt, um robust zu sein : Fehlerbehandlung, automatisierte Sicherheitsvalidierung und allgegenwärtige Validierung.
• 100% getestet : 100% Codeabdeckung für Unit -Tests bei allen Commits.
• 100% konsequent formatiert : Linie von Docker, Make, Yaml und Python auf allen Commits.

QuickStart

Voraussetzungen

Um dieses Projekt zu erstellen und auszuführen, empfehlen wir Ihnen, Docker 18.09 oder neuer, zu finden, Git, GNU Make und Python 3 zu finden.

Aufstellen

Integrationsanforderungen

Um sich in Veracode zu integrieren, müssen Sie:

• In der Lage sein, einen Debug -Aufbau Ihrer Anwendung zu erstellen.

• Sie haben ein gültiges Konto und eine gültige Lizenz zur Verwendung von SAST -Produkt -APIs von Veracode, die unten beschrieben sind.

• Haben Sie eine Anwendung im Analysezentrum von Veracode, das Sie verwenden möchten.

• Exportieren Sie Ihre Veracode -Anmeldeinformationen als Umgebungsvariablen:

   export VERACODE_API_KEY_ID=EXAMPLE
   export VERACODE_API_KEY_SECRET=EXAMPLE
  

Erste Schritte

1. Erstellen Sie das Docker -Bild:

   make build

2. Führen Sie den Docker -Container aus, übergeben Sie ihn Ihre API -Anmeldeinformationen und steigen Sie mit dem Verzeichnis mit Ihren Build -Artefakten in /bauen:

   docker run --env-file <( env | grep ^VERACODE_API_KEY_ ) -v " /path/to/build " :/build seiso/easy_sast:latest

Weitere Details und Konfigurationsoptionen sind in der Verwendung und im Wiki umrissen.

Verwendung

Befehlszeile

usage: main.py [-h] [--config-file CONFIG_FILE] [--version]
               [--debug | --verbose]

optional arguments:
  -h, --help                          show this help message and exit
  --config-file CONFIG_FILE           specify a config file
  --version                           show program ' s version number and exit
  --debug                             enable debug level logging
  --verbose                           enable info level logging

Zur Laufzeit gibt es zwei empfohlene Methoden, um Informationen an easy_sast zu übergeben:

1. Umgebungsvariablen zu docker run mit --env-file . Zum Beispiel:

   docker run --env-file <( env | grep VERACODE_API_KEY_ ) -v " /path/to/build " :/build seiso/easy_sast:latest

2. Möglicherweise möchten Sie auch ein Argument an den Python im Container weitergeben, indem Sie Ihre Argumente an docker run anhängen. Zum Beispiel:

   docker run -e VERACODE_API_KEY_ID=EXAMPLE -e VERACODE_API_KEY_SECRET=EXAMPLE seiso/easy_sast:latest --debug

Möchten Sie mehr über fortgeschrittene Nutzung erfahren, z. B. die Optimierung von SAST für Pull -Anfragen? Schauen Sie sich das Wiki an.

Unterstützte Veracode -APIs

• API hochladen
• Ergebnisse API

Beachten Sie, dass Ihr Veracode -Benutzer mindestens die Berechtigung haben muss, auf die Upload -API und den Endpunkt von GetApplist.do zuzugreifen.

Wenn Sie Unterstützung für weitere Veracode -APIs oder Workflows sehen möchten, um mit diesen APIs zu interagieren, öffnen Sie bitte ein Problem und lassen Sie es uns wissen!

Beitragen

1. Geben Sie das Repository auf
2. Erstellen Sie eine Funktionszweig über git checkout -b feature/description
3. Nehmen Sie Ihre Änderungen vor
4. Bestimmen Sie Ihre Änderungen über git commit -am 'Summarize the changes here'
5. Erstellen Sie eine neue Pull-Anfrage (Anleitungen)