SimpleSecurity

Simples

Helfen

$ simplesecurity --help
usage: simplesecurity [-h] [--scan-dir SCAN_DIR] [--format FORMAT] [--plugin PLUGIN] [--file FILE] [--level LEVEL]
                      [--confidence CONFIDENCE] [--no-colour] [--high-contrast] [--fast] [--zero]

Combine multiple popular python security tools and generate reports or output
into different formats...

options:
  -h, --help            show this help message and exit
  --scan-dir SCAN_DIR, -s SCAN_DIR
                        Pass a path to the scan directory (optional)
  --format FORMAT, -f FORMAT
                        Output format. One of ansi, json, markdown, csv. default=ansi
  --plugin PLUGIN, -p PLUGIN
                        Plugin to use. One of bandit, safety, dodgy, dlint, semgrep, all, default=all
  --file FILE, -o FILE  Filename to write to (omit for stdout)
  --level LEVEL, -l LEVEL
                        Minimum severity/ level to show
  --confidence CONFIDENCE, -c CONFIDENCE
                        Minimum confidence to show
  --no-colour, -z       No ANSI colours
  --high-contrast, -Z   High contrast colours
  --fast, --skip        Skip long running jobs. Will omit plugins with long run time (applies to -p all only)
  --zero, -0            Return non zero exit code if any security vulnerabilities are found

Sie können dies auch in Ihr eigenes Projekt importieren und eine der Funktionen in den DOCs verwenden

Inhaltsverzeichnis

• Beispiel Verwendung
  • Helfen
• Entwicklernotizen
  • Generieren semgrep_sec.yaml
• Dokumentation
• Mit PIP einbauen
• Sprachinformationen
  • Gebaut für
• Installieren Sie Python unter Windows
  • Schokoladig
  • Windows - python.org
• Installieren Sie Python unter Linux
  • Geeignet
  • DNF
• Installieren Sie Python auf MacOS
  • Homebrew
  • Macos - python.org
• Wie man rennt
  • Fenster
  • Linux/ macos
• Gebäude
• Testen
• Projekt herunterladen
  • Klon
    • Verwenden der Befehlszeile
    • Verwenden von Github Desktop
  • Download der ZIP -Datei
• Community -Dateien
  • Lizenz
  • Changelog
  • Verhaltenskodex
  • Beitragen
  • Sicherheit
  • Unterstützung
  • Begründung

Entwicklernotizen

Generieren semgrep_sec.yaml

1. Clone https://github.com/returntocorp/semgrep-rules

2. CD zu semgrep-rules/python

3. Tun

   cat ** /security/ ** / * .yaml >> semgrep_sec.yaml
   cat ** /security/ * .yaml >> semgrep_sec.yaml

4. rules: mit `` abgesehen von der ersten Instanz

5. Reformat mit ctrl+shift+i

6. Ersetzen Sie die Simplescurity/semgrep_sec.yaml durch das neue

Dokumentation

Ein hochrangiger Überblick darüber, wie die Dokumentation organisiert ist, hilft Ihnen, zu wissen, wo Sie nach bestimmten Dingen suchen müssen:

• Die technischen Referenz dokumentieren APIs und andere Aspekte der Maschinen. In dieser Dokumentation wird beschrieben, wie die Klassen und Funktionen auf einer niedrigeren Ebene verwendet werden und davon ausgehen, dass Sie ein gutes Verständnis der Software auf hoher Ebene haben.

Mit PIP einbauen

"Slim" Build: Installieren Sie Bandit, Dlint, zwielichtig, Poesie und Sicherheit mit PIPX

 pip install simplesecurity

Ansonsten:

 pip install simplesecurity [ full ]

Gehen Sie zu https://pypi.org/project/simplescurity/ für weitere Informationen

Sprachinformationen

Gebaut für

Dieses Programm wurde für Python -Versionen 3.8 - 3.11 geschrieben und mit 3.8 und 3.11 getestet

Installieren Sie Python unter Windows

Schokoladig

choco install python

Windows - python.org

Um Python zu installieren, besuchen Sie https://www.python.org/downloads/windows/ und laden Sie die neueste Version herunter.

Installieren Sie Python unter Linux

Geeignet

sudo apt install python3.x

DNF

sudo dnf install python3.x

Installieren Sie Python auf MacOS

Homebrew

brew install [email protected]

Macos - python.org

Um Python zu installieren, besuchen Sie https://www.python.org/downloads/macos/ und laden Sie die neueste Version herunter.

Wie man rennt

Fenster

• Modul py -3.x -m [module] oder [module] (wenn das Modul ein Skript installiert)

• Datei py -3.x [file] oder ./[file]

Linux/ macos

• Modul python3.x -m [module] oder [module] (wenn das Modul ein Skript installiert)

• Datei python3.x [file] oder ./[file]

Gebäude

Dieses Projekt verwendet https://github.com/fhpythonutils/fhmake, um den größten Teil des Gebäudes zu automatisieren. Dieser Befehl generiert die Dokumentation, aktualisiert die Anforderungen.

Beachten Sie die von FHMAKE bereitgestellte Funktionalität kann durch Folgendes angenähert werden

handsdown  --cleanup -o documentation/reference
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --with dev --output requirements_optional.txt
poetry build

fhmake audit kann ausgeführt werden, um zusätzliche Schecks durchzuführen

Testen

Zum Testen mit der Version von Python, die durch die Verwendung von Poesie verwendet wird

poetry run pytest

Alternativ verwenden Sie tox , um Tests über Python 3.8 - 3.11 auszuführen

tox

Projekt herunterladen

Klon

Verwenden der Befehlszeile

1. Drücken Sie die Klon- oder Download -Taste oben rechts

2. Kopieren Sie die URL (Link)

3. Öffnen Sie die Befehlszeile und ändern Sie das Verzeichnis, an das Sie klonen möchten

4. Geben Sie 'Git -Klon' an, gefolgt von der URL in Schritt 2

   git clone https://github.com/FHPythonUtils/SimpleSecurity

Weitere Informationen finden Sie unter https://help.github.com/en/articles/cloning-a-repository

Verwenden von Github Desktop

1. Drücken Sie die Klon- oder Download -Taste oben rechts
2. Klicken Sie auf dem Desktop öffnen
3. Wählen Sie den Pfad für den gewünschten Ort und klicken Sie auf Klon

Weitere Informationen finden Sie unter https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-t-github-desktop

Download der ZIP -Datei

1. Laden Sie dieses GitHub -Repository herunter
2. Extrahieren Sie das Zip -Archiv
3. Kopieren/ Umziehen zum gewünschten Ort

Community -Dateien

Lizenz

MIT -Lizenz Copyright (c) Fredhappyface (Weitere Informationen finden Sie in der Lizenz.)

Changelog

Weitere Informationen finden Sie im Changelog.

Verhaltenskodex

Online -Communities umfassen Menschen mit vielen Hintergründen. Die Mitwirkenden für Projekte sind bestrebt, ein freundliches, sicheres und einladendes Umfeld für alle zu bieten. Weitere Informationen finden Sie im Verhaltenskodex.

Beitragen

Beiträge sind willkommen. Weitere Informationen finden Sie in den beitragenden Richtlinien.

Sicherheit

Vielen Dank für die Verbesserung der Sicherheit des Projekts. Weitere Informationen finden Sie in der Sicherheitsrichtlinie.

Unterstützung

Vielen Dank, dass Sie dieses Projekt verwendet haben, ich hoffe, es ist für Sie von Nutzen. Bitte beachten Sie, dass diejenigen, die am Projekt beteiligt sind, dies häufig zum Spaß zusammen mit anderen Verpflichtungen (wie Arbeit, Familie usw.) tun. Weitere Informationen finden Sie in der Support -Richtlinie.

Begründung

Die Begründung fungiert als Leitfaden für verschiedene Prozesse in Bezug auf Projekte wie das Versionsverfahren und die verwendeten Programmierstile. Weitere Informationen finden Sie in der Begründung.