SimpleSecurity

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
• ข้อมูลภาษา
  • สร้างขึ้นเพื่อ
• ติดตั้ง Python บน Windows
  • ช็อคโกแลต
  • windows - python.org
• ติดตั้ง Python บน Linux
  • เหมาะ
  • DNF
• ติดตั้ง Python บน macOS
  • โฮมบรูว์
  • macOS - python.org
• วิธีการวิ่ง
  • หน้าต่าง
  • Linux/ MacOS
• อาคาร
• การทดสอบ
• ดาวน์โหลดโครงการ
  • โคลน
    • ใช้บรรทัดคำสั่ง
    • ใช้เดสก์ท็อป GitHub
  • ดาวน์โหลดไฟล์ zip
• ไฟล์ชุมชน
  • ใบอนุญาต
  • การเปลี่ยนแปลง
  • จรรยาบรรณ
  • การบริจาค
  • ความปลอดภัย
  • สนับสนุน
  • เหตุผล

หมายเหตุนักพัฒนา

สร้าง semgrep_sec.yaml

1. โคลน https://github.com/returntocorp/semgrep-rules

2. ซีดีถึง 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" Build: ติดตั้ง Bandit, Dlint, Dodgy, Poetry และ Safety ด้วย pipx

 pip install simplesecurity

มิฉะนั้น:

 pip install simplesecurity [ full ]

มุ่งหน้าไปที่ https://pypi.org/project/simplesecurity/ สำหรับข้อมูลเพิ่มเติม

ข้อมูลภาษา

สร้างขึ้นเพื่อ

โปรแกรมนี้เขียนขึ้นสำหรับ Python Version 3.8 - 3.11 และได้รับการทดสอบด้วยทั้ง 3.8 และ 3.11

ติดตั้ง Python บน Windows

ช็อคโกแลต

choco install python

windows - python.org

ในการติดตั้ง Python ให้ไปที่ https://www.python.org/downloads/windows/ และดาวน์โหลดเวอร์ชันล่าสุด

ติดตั้ง Python บน Linux

เหมาะ

sudo apt install python3.x

DNF

sudo dnf install python3.x

ติดตั้ง Python บน macOS

โฮมบรูว์

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 เพื่อทำให้อาคารส่วนใหญ่เป็นไปโดยอัตโนมัติ คำสั่งนี้สร้างเอกสารอัพเดตข้อกำหนด. txt และสร้างสิ่งประดิษฐ์ไลบรารี

หมายเหตุฟังก์ชั่นที่จัดทำโดย 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 สามารถเรียกใช้เพื่อทำการตรวจสอบเพิ่มเติม

การทดสอบ

สำหรับการทดสอบกับรุ่น Python ที่ใช้โดยการใช้บทกวี

poetry run pytest

ใช้ tox เพื่อเรียกใช้การทดสอบผ่าน Python 3.8 - 3.11

tox

ดาวน์โหลดโครงการ

โคลน

ใช้บรรทัดคำสั่ง

1. กดปุ่มโคลนหรือดาวน์โหลดที่ด้านบนขวา

2. คัดลอก URL (ลิงค์)

3. เปิดบรรทัดคำสั่งและเปลี่ยนไดเรกทอรีเป็นที่ที่คุณต้องการโคลน

4. พิมพ์ 'git clone' ตามด้วย URL ในขั้นตอนที่ 2

   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-to-github-desktop

ดาวน์โหลดไฟล์ zip

1. ดาวน์โหลดที่เก็บ GitHub นี้
2. แยกไฟล์ zip archive
3. คัดลอก/ ย้ายไปยังตำแหน่งที่ต้องการ

ไฟล์ชุมชน

ใบอนุญาต

MIT License Copyright (c) Fredhappyface (ดูใบอนุญาตสำหรับข้อมูลเพิ่มเติม)

การเปลี่ยนแปลง

ดูการเปลี่ยนแปลงสำหรับข้อมูลเพิ่มเติม

จรรยาบรรณ

ชุมชนออนไลน์รวมถึงผู้คนจากภูมิหลังมากมาย ผู้สนับสนุน โครงการ มุ่งมั่นที่จะให้สภาพแวดล้อมที่เป็นมิตรปลอดภัยและเป็นมิตรสำหรับทุกคน โปรดดูจรรยาบรรณสำหรับข้อมูลเพิ่มเติม

การบริจาค

ยินดีต้อนรับการมีส่วนร่วมโปรดดูแนวทางการสนับสนุนสำหรับข้อมูลเพิ่มเติม

ความปลอดภัย

ขอขอบคุณที่ปรับปรุงความปลอดภัยของโครงการโปรดดูนโยบายความปลอดภัยสำหรับข้อมูลเพิ่มเติม

สนับสนุน

ขอบคุณสำหรับการใช้โครงการนี้ฉันหวังว่ามันจะใช้กับคุณ โปรดทราบว่าผู้ที่เกี่ยวข้องกับโครงการมักจะทำเพื่อความสนุกสนานพร้อมกับภาระผูกพันอื่น ๆ (เช่นงานครอบครัว ฯลฯ ) โปรดดูนโยบายการสนับสนุนสำหรับข้อมูลเพิ่มเติม

เหตุผล

เหตุผลทำหน้าที่เป็นแนวทางสำหรับกระบวนการต่าง ๆ เกี่ยวกับโครงการเช่นรูปแบบการกำหนดเวอร์ชันและรูปแบบการเขียนโปรแกรมที่ใช้ โปรดดูเหตุผลสำหรับข้อมูลเพิ่มเติม