SimpleSecurity

간단한 보안

돕다

$ 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

이것을 자신의 프로젝트로 가져 와서 문서의 기능을 사용할 수도 있습니다.

목차

• 예제 사용
  • 돕다
• 개발자 노트
  • semgrep_sec.yaml을 생성합니다
• 선적 서류 비치
• PIP로 설치하십시오
• 언어 정보
  • 구축
• Windows에 Python을 설치하십시오
  • 초콜릿
  • Windows -Python.org
• Linux에 Python을 설치하십시오
  • 적절한
  • DNF
• MacOS에 Python을 설치하십시오
  • 홈브류
  • macos -python.org
• 달리는 방법
  • 창
  • Linux/ MacOS
• 건물
• 테스트
• 프로젝트 다운로드
  • 클론
    • 명령 줄을 사용합니다
    • Github 데스크탑 사용
  • zip 파일을 다운로드하십시오
• 커뮤니티 파일
  • 특허
  • changelog
  • 행동 강령
  • 기여
  • 보안
  • 지원하다
  • 이론적 해석

개발자 노트

semgrep_sec.yaml을 생성합니다

1. 복제 https://github.com/returntocorp/semgrep-rules

2. CD에서 semgrep-rules/python

3. 하다

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

4. rules: ``첫 번째 인스턴스와는 별도로

5. ctrl+shift+i 로 개혁

6. SIMPLESECURITY/SEMGREP_SEC.YAML을 새 것으로 교체하십시오

선적 서류 비치

문서를 구성하는 방법에 대한 높은 수준의 개요는 특정 사항을 찾아야 할 곳을 알 수 있도록 도와줍니다.

• 기술 참조는 API 및 기계의 다른 측면을 문서화합니다. 이 문서는 클래스와 기능을 낮은 수준에서 사용하는 방법을 설명하고 소프트웨어에 대한 높은 수준의 이해가 있다고 가정합니다.

PIP로 설치하십시오

"Slim"빌드 : PIPX를 사용한 Bandit, Dlint, Dodgy, Poetry 및 Safety를 설치

 pip install simplesecurity

그렇지 않으면:

 pip install simplesecurity [ full ]

자세한 내용은 https://pypi.org/project/simplesecurity/로 이동하십시오

언어 정보

구축

이 프로그램은 Python 버전 3.8-3.11 용으로 작성되었으며 3.8 및 3.11로 테스트되었습니다.

Windows에 Python을 설치하십시오

초콜릿

choco install python

Windows -Python.org

Python을 설치하려면 https://www.python.org/downloads/windows/로 이동하여 최신 버전을 다운로드하십시오.

Linux에 Python을 설치하십시오

적절한

sudo apt install python3.x

DNF

sudo dnf install python3.x

MacOS에 Python을 설치하십시오

홈브류

brew install [email protected]

macos -python.org

Python을 설치하려면 https://www.python.org/downloads/macos/로 이동하여 최신 버전을 다운로드하십시오.

달리는 방법

창

• 모듈 py -3.x -m [module] 또는 [module] (모듈이 스크립트를 설치하는 경우)

• 파일 py -3.x [file] 또는 ./[file]

Linux/ MacOS

• 모듈 python3.x -m [module] 또는 [module] (모듈이 스크립트를 설치하는 경우)

• 파일 python3.x [file] 또는 ./[file]

건물

이 프로젝트는 https://github.com/fhpythonutils/fhmake를 사용하여 대부분의 건물을 자동화합니다. 이 명령은 문서를 생성하고 요구 사항을 업데이트하고 도서관 인공물을 구축합니다.

FHMake에서 제공하는 기능은 다음과 근접 할 수 있습니다.

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 실행하여 추가 점검을 수행 할 수 있습니다

테스트

시를 사용하여 사용하는 파이썬 버전으로 테스트하기 위해

poetry run pytest

또는 tox 사용하여 Python 3.8-3.11에서 테스트를 실행하십시오.

tox

프로젝트 다운로드

클론

명령 줄을 사용합니다

1. 오른쪽 상단의 복제 또는 다운로드 버튼을 누릅니다.

2. URL 복사 (링크)

3. 명령 줄을 열고 복제하려는 위치로 디렉토리를 변경하십시오.

4. 2 단계에서 'Git Clone'과 URL을 입력하십시오

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

자세한 내용은 https://help.github.com/en/articles/cloning-a-repository를 참조하십시오

Github 데스크탑 사용

1. 오른쪽 상단의 복제 또는 다운로드 버튼을 누릅니다.
2. 데스크탑에서 열기를 클릭하십시오
3. 원하는 위치를 선택하고 클론을 클릭하십시오.

자세한 내용은 https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github--github-desktop을 참조하십시오

zip 파일을 다운로드하십시오

1. 이 Github 저장소를 다운로드하십시오
2. Zip Archive를 추출하십시오
3. 원하는 위치로 복사/ 이동하십시오

커뮤니티 파일

특허

MIT 라이센스 저작권 (C) Fredhappyface (자세한 내용은 라이센스 참조).

changelog

자세한 내용은 ChangElog를 참조하십시오.

행동 강령

온라인 커뮤니티에는 많은 배경을 가진 사람들이 포함됩니다. 프로젝트 기고자들은 모두에게 친절하고 안전하며 환영하는 환경을 제공하기 위해 노력하고 있습니다. 자세한 내용은 행동 강령을 참조하십시오.

기여

기부금을 환영합니다. 자세한 내용은 기고 가이드 라인을 참조하십시오.

보안

프로젝트의 보안을 개선해 주셔서 감사합니다. 자세한 내용은 보안 정책을 참조하십시오.

지원하다

이 프로젝트를 사용해 주셔서 감사합니다. 여러분에게 사용되기를 바랍니다. 프로젝트와 관련된 사람들은 종종 다른 약속 (예 : 직장, 가족 등)과 함께 재미를 위해 그렇게합니다. 자세한 내용은 지원 정책을 참조하십시오.

이론적 해석

이론적 근거는 버전 작성 체계 및 사용 된 프로그래밍 스타일과 같은 프로젝트에 관한 다양한 프로세스에 대한 가이드 역할을합니다. 자세한 내용은 근거를 참조하십시오.