SimpleSecurity

SIMPLESSECURITY

Membantu

$ 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

Anda juga dapat mengimpor ini ke proyek Anda sendiri dan menggunakan salah satu fungsi di dokumen

Daftar isi

• Contoh Penggunaan
  • Membantu
• Catatan Pengembang
  • Menghasilkan semgrep_sec.yaml
• Dokumentasi
• Pasang dengan pip
• Informasi bahasa
  • Dibangun untuk
• Instal Python di Windows
  • Cokelat
  • Windows - python.org
• Instal Python di Linux
  • Tepat
  • Dnf
• Instal Python di MacOS
  • Homebrew
  • MacOS - Python.org
• Bagaimana menjalankan
  • Windows
  • Linux/ MacOS
• Bangunan
• Pengujian
• Proyek Unduh
  • Klon
    • Menggunakan baris perintah
    • Menggunakan desktop GitHub
  • Unduh file zip
• File komunitas
  • Lisensi
  • Changelog
  • Kode Etik
  • Berkontribusi
  • Keamanan
  • Mendukung
  • Alasan

Catatan Pengembang

Menghasilkan semgrep_sec.yaml

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

2. CD ke semgrep-rules/python

3. Mengerjakan

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

4. Temukan dan ganti rules: dengan `` terpisah dari contoh pertama

5. Memformat ulang dengan ctrl+shift+i

6. Ganti SimpleSecurity/semgrep_sec.yaml dengan yang baru

Dokumentasi

Tinjauan tingkat tinggi tentang bagaimana dokumentasi diorganisir akan membantu Anda mengetahui di mana harus mencari hal-hal tertentu:

• API Dokumen Referensi Teknis dan aspek -aspek lain dari mesin. Dokumentasi ini menjelaskan cara menggunakan kelas dan fungsi di tingkat yang lebih rendah dan menganggap bahwa Anda memiliki pemahaman tingkat tinggi yang baik tentang perangkat lunak.

Pasang dengan pip

"Slim" Build: Instal Bandit, Dlint, Dodgy, Puisi, dan Keselamatan dengan PIPX

 pip install simplesecurity

Jika tidak:

 pip install simplesecurity [ full ]

Pergilah ke https://pypi.org/project/simlesecurity/ untuk info lebih lanjut

Informasi bahasa

Dibangun untuk

Program ini telah ditulis untuk versi Python 3.8 - 3.11 dan telah diuji dengan 3,8 dan 3.11

Instal Python di Windows

Cokelat

choco install python

Windows - python.org

Untuk menginstal Python, kunjungi https://www.python.org/downloads/windows/ dan unduh versi terbaru.

Instal Python di Linux

Tepat

sudo apt install python3.x

Dnf

sudo dnf install python3.x

Instal Python di MacOS

Homebrew

brew install [email protected]

MacOS - Python.org

Untuk menginstal Python, kunjungi https://www.python.org/downloads/macos/ dan unduh versi terbaru.

Bagaimana menjalankan

Windows

• Modul py -3.x -m [module] atau [module] (jika modul menginstal skrip)

• File py -3.x [file] atau ./[file]

Linux/ MacOS

• Modul python3.x -m [module] atau [module] (jika modul menginstal skrip)

• File python3.x [file] atau ./[file]

Bangunan

Proyek ini menggunakan https://github.com/fhpythonutils/fhmake untuk mengotomatisasi sebagian besar bangunan. Perintah ini menghasilkan dokumentasi, memperbarui persyaratan.txt dan membangun artefak perpustakaan

Perhatikan fungsionalitas yang disediakan oleh FHMake dapat diperkirakan dengan yang berikut ini

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 dapat dijalankan untuk melakukan pemeriksaan tambahan

Pengujian

Untuk pengujian dengan versi python yang digunakan oleh penggunaan puisi

poetry run pytest

Atau gunakan tox untuk menjalankan tes lebih dari Python 3.8 - 3.11

tox

Proyek Unduh

Klon

Menggunakan baris perintah

1. Tekan tombol klon atau unduh di kanan atas

2. Salin URL (tautan)

3. Buka baris perintah dan ubah direktori ke tempat yang ingin Anda klon

4. Ketik 'klon git' diikuti oleh URL di Langkah 2

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

Informasi lebih lanjut dapat ditemukan di https://help.github.com/en/articles/cloning-a-repository

Menggunakan desktop GitHub

1. Tekan tombol klon atau unduh di kanan atas
2. Klik Buka di Desktop
3. Pilih jalur yang Anda inginkan dan klik klon

Informasi lebih lanjut dapat ditemukan di https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Unduh file zip

1. Unduh repositori github ini
2. Ekstrak arsip zip
3. Salin/ Pindah ke lokasi yang diinginkan

File komunitas

Lisensi

Lisensi MIT Hak Cipta (C) Fredhappyface (lihat lisensi untuk informasi lebih lanjut.)

Changelog

Lihat Changelog untuk informasi lebih lanjut.

Kode Etik

Komunitas online termasuk orang -orang dari banyak latar belakang. Kontributor proyek berkomitmen untuk menyediakan lingkungan yang ramah, aman dan ramah untuk semua. Silakan lihat Kode Etik untuk informasi lebih lanjut.

Berkontribusi

Kontribusi dipersilakan, silakan lihat pedoman yang berkontribusi untuk informasi lebih lanjut.

Keamanan

Terima kasih telah meningkatkan keamanan proyek, silakan lihat kebijakan keamanan untuk informasi lebih lanjut.

Mendukung

Terima kasih telah menggunakan proyek ini, saya harap ini berguna bagi Anda. Perlu diketahui bahwa mereka yang terlibat dengan proyek sering melakukannya untuk bersenang -senang bersama dengan komitmen lain (seperti pekerjaan, keluarga, dll). Silakan lihat Kebijakan Dukungan untuk informasi lebih lanjut.

Alasan

Alasan bertindak sebagai panduan untuk berbagai proses mengenai proyek -proyek seperti skema versi dan gaya pemrograman yang digunakan. Silakan lihat alasan untuk informasi lebih lanjut.