SimpleSecurity

Simplicité

Aide

$ 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

Vous pouvez également importer cela dans votre propre projet et utiliser l'une des fonctions des documents

Table des matières

• Exemple d'utilisation
  • Aide
• Notes du développeur
  • Générer Semgrep_Sec.yaml
• Documentation
• Installer avec pip
• Informations linguistiques
  • Construit pour
• Installez Python sur Windows
  • Chocolaté
  • Windows - Python.org
• Installez Python sur Linux
  • Apte
  • DNF
• Installez Python sur macOS
  • Homebrew
  • MacOS - python.org
• Comment courir
  • Fenêtre
  • Linux / macOS
• Bâtiment
• Essai
• Télécharger le projet
  • Cloner
    • En utilisant la ligne de commande
    • Utilisation du bureau GitHub
  • Télécharger le fichier zip
• Fichiers communautaires
  • Licence
  • Changelog
  • Code de conduite
  • Contributif
  • Sécurité
  • Soutien
  • Raisonnement

Notes du développeur

Générer Semgrep_Sec.yaml

1. Clone https://github.com/returnntocorp/semgrep-raliles

2. CD à semgrep-rules/python

3. faire

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

4. Rechercher et remplacer rules: par `` en dehors de la première instance

5. Reformat avec ctrl+shift+i

6. Remplacez Simplesecurity / Semgrep_Sec.yaml par le nouveau

Documentation

Un aperçu de haut niveau de la façon dont la documentation est organisée vous aidera à savoir où chercher certaines choses:

• La référence technique documente les API et autres aspects de la machine. Cette documentation décrit comment utiliser les classes et les fonctions à un niveau inférieur et supposer que vous avez une bonne compréhension de haut niveau du logiciel.

Installer avec pip

Build "Slim": Installer Bandit, Dlint, douteux, poésie et sécurité avec Pipx

 pip install simplesecurity

Sinon:

 pip install simplesecurity [ full ]

Dirigez-vous vers https://pypi.org/project/simplesesecurity/ pour plus d'informations

Informations linguistiques

Construit pour

Ce programme a été écrit pour les versions Python 3.8 - 3.11 et a été testée avec les deux 3,8 et 3.11

Installez Python sur Windows

Chocolaté

choco install python

Windows - Python.org

Pour installer Python, allez sur https://www.python.org/downloads/windows/ et téléchargez la dernière version.

Installez Python sur Linux

Apte

sudo apt install python3.x

DNF

sudo dnf install python3.x

Installez Python sur macOS

Homebrew

brew install [email protected]

MacOS - python.org

Pour installer Python, allez sur https://www.python.org/downloads/macos/ et téléchargez la dernière version.

Comment courir

Fenêtre

• Module py -3.x -m [module] ou [module] (si module installe un script)

• Fichier py -3.x [file] ou ./[file]

Linux / macOS

• Module python3.x -m [module] ou [module] (si module installe un script)

• Fichier python3.x [file] ou ./[file]

Bâtiment

Ce projet utilise https://github.com/fhpythonutils/fhmake pour automatiser la plupart du bâtiment. Cette commande génère la documentation, met à jour les exigences.txt et construit les artefacts de la bibliothèque

Remarque La fonctionnalité fournie par FHMake peut être approximée par les éléments suivants

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 peut être exécuté pour effectuer des chèques supplémentaires

Essai

Pour les tests avec la version de Python utilisée par la poésie Utiliser

poetry run pytest

Alternativement utiliser tox pour exécuter des tests sur Python 3.8 - 3.11

tox

Télécharger le projet

Cloner

En utilisant la ligne de commande

1. Appuyez sur le bouton Clone ou Télécharger en haut à droite

2. Copiez l'URL (lien)

3. Ouvrez la ligne de commande et modifiez le répertoire à l'endroit où vous souhaitez cloner

4. Type 'Git Clone' suivi de l'URL à l'étape 2

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

Plus d'informations peuvent être trouvées sur https://help.github.com/en/articles/cloning-a-repository

Utilisation du bureau GitHub

1. Appuyez sur le bouton Clone ou Télécharger en haut à droite
2. Cliquez sur ouvrir dans le bureau
3. Choisissez le chemin où vous voulez et cliquez sur clone

Plus d'informations peuvent être trouvées sur https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Télécharger le fichier zip

1. Téléchargez ce référentiel GitHub
2. Extraire l'archive zip
3. Copier / passer à l'emplacement souhaité

Fichiers communautaires

Licence

Copyright de licence MIT (C) Fredhappyface (voir la licence pour plus d'informations.)

Changelog

Voir le Changelog pour plus d'informations.

Code de conduite

Les communautés en ligne comprennent des personnes de nombreux horizons. Les contributeurs du projet s'engagent à fournir un environnement convivial, sûr et accueillant pour tous. Veuillez consulter le code de conduite pour plus d'informations.

Contributif

Les contributions sont les bienvenues, veuillez consulter les directives contributives pour plus d'informations.

Sécurité

Merci d'avoir amélioré la sécurité du projet, veuillez consulter la politique de sécurité pour plus d'informations.

Soutien

Merci d'utiliser ce projet, j'espère que cela vous est utile. Veuillez noter que les personnes impliquées dans le projet le font souvent pour le plaisir avec d'autres engagements (tels que le travail, la famille, etc.). Veuillez consulter la politique d'assistance pour plus d'informations.

Raisonnement

La justification agit comme un guide de divers processus concernant des projets tels que le schéma de versioning et les styles de programmation utilisés. Veuillez consulter la justification de plus d'informations.