SimpleSecurity

Simpulveridad

Ayuda

$ 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

También puede importar esto a su propio proyecto y usar cualquiera de las funciones en los documentos

Tabla de contenido

• Ejemplo de uso
  • Ayuda
• Notas de desarrollador
  • Generar SEMGREP_SEC.YAML
• Documentación
• Instalar con pip
• Información del idioma
  • Construido para
• Instale Python en Windows
  • Chocolate
  • Windows - python.org
• Instale Python en Linux
  • Apto
  • DNF
• Instalar python en macOS
  • Cerveza casera
  • MacOS - python.org
• Cómo correr
  • Windows
  • Linux/ macOS
• Edificio
• Pruebas
• Descargar proyecto
  • Clon
    • Usando la línea de comando
    • Usando el escritorio de Github
  • Descargar el archivo zip
• Archivos comunitarios
  • Licencia
  • Colegio de cambios
  • Código de conducta
  • Que contribuye
  • Seguridad
  • Apoyo
  • Razón fundamental

Notas de desarrollador

Generar SEMGREP_SEC.YAML

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

2. CD a semgrep-rules/python

3. hacer

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

4. Busque y reemplace rules: con `` aparte de la primera instancia

5. Reformatear con ctrl+shift+i

6. Reemplace SimplePleSecurity/SemGrep_Sec.yaml con el nuevo

Documentación

Una descripción general de alto nivel de cómo se organiza la documentación organizada lo ayudará a saber dónde buscar ciertas cosas:

• La referencia técnica documenta API y otros aspectos de la maquinaria. Esta documentación describe cómo usar las clases y funciones en un nivel inferior y suponga que tiene una buena comprensión de alto nivel del software.

Instalar con pip

"Slim" Build: Instale Bandit, Dlint, Dodgy, Poetry y Seguridad con Pipx

 pip install simplesecurity

De lo contrario:

 pip install simplesecurity [ full ]

Dirígete a https://pypi.org/project/simplessecurity/ para más información

Información del idioma

Construido para

Este programa ha sido escrito para las versiones de Python 3.8 - 3.11 y ha sido probado con 3.8 y 3.11

Instale Python en Windows

Chocolate

choco install python

Windows - python.org

Para instalar Python, vaya a https://www.python.org/downloads/windows/ y descargue la última versión.

Instale Python en Linux

Apto

sudo apt install python3.x

DNF

sudo dnf install python3.x

Instalar python en macOS

Cerveza casera

brew install [email protected]

MacOS - python.org

Para instalar Python, vaya a https://www.python.org/downloads/macos/ y descargue la última versión.

Cómo correr

Windows

• Módulo py -3.x -m [module] o [module] (si el módulo instala un script)

• Archivo py -3.x [file] o ./[file]

Linux/ macOS

• Módulo python3.x -m [module] o [module] (si el módulo instala un script)

• Archivo python3.x [file] o ./[file]

Edificio

Este proyecto utiliza https://github.com/fhpythonutils/fhmake para automatizar la mayor parte del edificio. Este comando genera la documentación, actualiza los requisitos.txt y construye los artefactos de la biblioteca

Tenga en cuenta que la funcionalidad proporcionada por FHMake puede ser aproximada por lo siguiente

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 se puede ejecutar para realizar cheques adicionales

Pruebas

Para probar con la versión de Python utilizada por uso de poesía

poetry run pytest

Alternativamente, use tox para ejecutar pruebas sobre Python 3.8 - 3.11

tox

Descargar proyecto

Clon

Usando la línea de comando

1. Presione el clon o el botón Descargar en la parte superior derecha

2. Copie la URL (enlace)

3. Abra la línea de comando y cambie el directorio a donde desee clonar para

4. Escriba 'clon git' seguido de URL en el paso 2

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

Se puede encontrar más información en https://help.github.com/en/articles/cloning-a---repository

Usando el escritorio de Github

1. Presione el clon o el botón de descarga en la parte superior derecha
2. Haga clic en Abrir en el escritorio
3. Elija la ruta para donde desee y haga clic en Clon

Se puede encontrar más información en https://help.github.com/en/desktop/contributing-to-projects/cloning-a---Repository-from-github-to-github-desktop

Descargar el archivo zip

1. Descargue este repositorio de Github
2. Extraer el archivo zip
3. Copiar/ moverse a la ubicación deseada

Archivos comunitarios

Licencia

Copyright de licencia MIT (c) Fredhappyface (consulte la licencia para obtener más información).

Colegio de cambios

Consulte The ChangeLog para obtener más información.

Código de conducta

Las comunidades en línea incluyen personas de muchos orígenes. Los contribuyentes del proyecto se comprometen a proporcionar un ambiente amigable, seguro y acogedor para todos. Consulte el código de conducta para obtener más información.

Que contribuye

Las contribuciones son bienvenidas, consulte las pautas de contribución para obtener más información.

Seguridad

Gracias por mejorar la seguridad del proyecto, consulte la política de seguridad para obtener más información.

Apoyo

Gracias por usar este proyecto, espero que sea útil para usted. Tenga en cuenta que los involucrados con el proyecto a menudo lo hacen por diversión junto con otros compromisos (como el trabajo, la familia, etc.). Consulte la Política de soporte para obtener más información.

Razón fundamental

La justificación actúa como una guía para varios procesos con respecto a proyectos como el esquema de versiones y los estilos de programación utilizados. Consulte la justificación para obtener más información.