SimpleSecurity

SimplesEcurity

Ajuda

$ 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

Você também pode importar isso para seu próprio projeto e usar qualquer uma das funções nos documentos

Índice

• Exemplo de uso
  • Ajuda
• Notas do desenvolvedor
  • Gere sumgrep_sec.yaml
• Documentação
• Instale com pip
• Informações do idioma
  • Construído para
• Instale o Python no Windows
  • Chocolatey
  • Windows - python.org
• Instale o Python no Linux
  • Apt
  • DNF
• Instale o python no macOS
  • Homebrew
  • MacOS - python.org
• Como correr
  • Windows
  • Linux/ MacOS
• Prédio
• Teste
• Projeto de download
  • Clone
    • Usando a linha de comando
    • Usando o GitHub Desktop
  • Baixe o arquivo zip
• Arquivos comunitários
  • Licença
  • Changelog
  • Código de Conduta
  • Contribuindo
  • Segurança
  • Apoiar
  • Justificativa

Notas do desenvolvedor

Gere sumgrep_sec.yaml

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

2. CD para semgrep-rules/python

3. fazer

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

4. Encontre e substitua rules: com `` além da primeira instância

5. Reformato com ctrl+shift+i

6. Substitua o SimpleSecurity/SEMGREP_SEC.yaml pelo novo

Documentação

Uma visão geral de alto nível de como a documentação é organizada ajudará você a saber onde procurar certas coisas:

• As APIs de documentos de referência técnica e outros aspectos da maquinaria. Esta documentação descreve como usar as classes e funções em um nível mais baixo e assume que você tem um bom entendimento de alto nível do software.

Instale com pip

"Slim" Build: Instale Bandit, Dlint, Dodgy, Poesia e Segurança com PiPx

 pip install simplesecurity

De outra forma:

 pip install simplesecurity [ full ]

Vá para https://pypi.org/project/simpleSecurity/ para mais informações

Informações do idioma

Construído para

Este programa foi escrito para versões Python 3.8 - 3.11 e foi testado com 3.8 e 3.11

Instale o Python no Windows

Chocolatey

choco install python

Windows - python.org

Para instalar o Python, acesse https://www.python.org/downloads/windows/ e faça o download da versão mais recente.

Instale o Python no Linux

Apt

sudo apt install python3.x

DNF

sudo dnf install python3.x

Instale o python no macOS

Homebrew

brew install [email protected]

MacOS - python.org

Para instalar o Python, acesse https://www.python.org/downloads/macos/ e faça o download da versão mais recente.

Como correr

Windows

• Módulo py -3.x -m [module] ou [module] (se o módulo instalar um script)

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

Linux/ MacOS

• Módulo python3.x -m [module] ou [module] (se o módulo instalar um script)

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

Prédio

Este projeto usa https://github.com/fhpythonutils/fhmake para automatizar a maior parte do edifício. Este comando gera a documentação, atualiza os requisitos.txt e constrói os artefatos da biblioteca

Observe que a funcionalidade fornecida pelo FHMake pode ser aproximada pelo seguinte

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 pode ser executada para executar verificações adicionais

Teste

Para testar com a versão do Python usada pelo uso de poesia

poetry run pytest

Alternativamente, use tox para executar testes sobre o Python 3.8 - 3.11

tox

Projeto de download

Clone

Usando a linha de comando

1. Pressione o botão Clone ou Download no canto superior direito

2. Copie o URL (link)

3. Abra a linha de comando e altere o diretório para onde você deseja clonar

4. Digite 'Git Clone' seguido de URL na etapa 2

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

Mais informações podem ser encontradas em https://help.github.com/en/articles/cloning-a-repository

Usando o GitHub Desktop

1. Pressione o botão Clone ou Download no canto superior direito
2. Clique em Abrir na área de trabalho
3. Escolha o caminho para onde você deseja e clique em Clone

Mais informações podem ser encontradas em https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Baixe o arquivo zip

1. Baixe este repositório do GitHub
2. Extraia o arquivo zípeiro
3. Copie/ mova para o local desejado

Arquivos comunitários

Licença

MIT Licença Copyright (c) FredHappyface (consulte a licença para obter mais informações.)

Changelog

Veja o Changelog para obter mais informações.

Código de Conduta

As comunidades on -line incluem pessoas de várias origens. Os colaboradores do projeto estão comprometidos em fornecer um ambiente amigável, seguro e acolhedor para todos. Consulte o código de conduta para obter mais informações.

Contribuindo

As contribuições são bem -vindas, consulte as diretrizes contribuintes para obter mais informações.

Segurança

Obrigado por melhorar a segurança do projeto, consulte a política de segurança para obter mais informações.

Apoiar

Obrigado por usar este projeto, espero que seja útil para você. Esteja ciente de que os envolvidos com o projeto geralmente o fazem por diversão, juntamente com outros compromissos (como trabalho, família etc.). Consulte a política de suporte para obter mais informações.

Justificativa

A lógica atua como um guia para vários processos em relação a projetos como o esquema de versão e os estilos de programação usados. Consulte a lógica para obter mais informações.