Skip to main content

Security Hygiene Scanner (SHS) โ€“ Windows and Linux security auditing tool

Project description

๐Ÿ›ก๏ธ Security Hygiene Scanner (SHS) โ€“ Windows & Linux

Security Hygiene Scanner (SHS) is a Windows and Linux CLI-based defensive security tool that performs a quick security hygiene check on a system.

It helps users understand whether essential security controls are enabled and highlights common weak security practices.

Think of SHS as a security health check-up for your machine ๐Ÿฉบ๐Ÿ’ป โ€” simple, fast, safe, and read-only.

๐Ÿ“‹ Overview

SHS scans a Windows or Linux system and provides a clear security snapshot by checking important areas such as:

  • Firewall status
  • Antivirus / endpoint protection availability
  • System configuration
  • User privilege hygiene
  • File and permission hygiene

The tool is designed strictly for defensive security awareness and system hygiene validation.

๐Ÿšซ No exploitation
๐Ÿšซ No intrusive scanning
๐Ÿšซ No offensive security actions

โš™๏ธ Windows Features

  • ๐Ÿ›ก๏ธ Windows Firewall status check
  • ๐Ÿ” Antivirus detection (installed and active)
  • ๐Ÿ’ป System and OS information scan
  • ๐Ÿ‘ค User and privilege hygiene checks
  • ๐Ÿ“ File and permission hygiene checks
  • ๐Ÿ“Š Weighted security risk scoring
  • โšก Fast, lightweight, and safe to run

๐Ÿง Linux Features

  • ๐Ÿ”ฅ Firewall detection (ufw / firewalld / nftables / iptables)
  • ๐Ÿ›ก๏ธ Antivirus presence detection (ClamAV & others if installed)
  • ๐Ÿ’ป Linux OS & kernel information
  • ๐Ÿ‘ค User & sudo privilege hygiene
  • ๐Ÿ“ Sensitive file & permission hygiene checks

๐Ÿ–ฅ๏ธ Supported Platforms

๐ŸชŸ Windows

  • Windows 10
  • Windows 11

๐Ÿง Linux

  • Ubuntu
  • Kali Linux
  • Debian-based distributions
  • RHEL/CentOS/Fedora
  • Alpine, Arch, openSUSE

๐Ÿš€ Installation

This installation method works for both Windows and Linux systems.

๐Ÿ”ง Requirements

  • Python 3.10 or higher

  • pip package manager

๐Ÿ“ฆ Install from PyPI

pip install shs

โœ… Verify Installation

After installation, verify SHS is available:

shs --help

If installed correctly, the help menu will be displayed.

โ–ถ๏ธ Usage

๐Ÿ” Run a full system security hygiene scan

shs scan

๐Ÿ”ง Run specific security checks

shs scan --system
shs scan --network
shs scan --users
shs scan --files

๐Ÿ“Š Security Scoring

SHS uses a weighted severity scoring system to measure the overall security health of a system. Each detected issue is classified by severity and assigned a numerical weight.

Severity Weight
CRITICAL 10
HIGH 7
MEDIUM 4
LOW 1

All findings are aggregated into a Security Score (0โ€“100%) with descriptive labels:

  • Excellent
  • Good
  • Needs Attention
  • High Risk
  • Critical Risk

๐Ÿ“ Project Structure

SHS/
โ”œโ”€โ”€ .venv/                     # Python virtual environment
โ”œโ”€โ”€ build/                     # Build artifacts
โ”œโ”€โ”€ dist/                      # Distribution packages
โ”œโ”€โ”€ docs/                      # Technical documentation
โ”œโ”€โ”€ documentation/             # User guides and reports
โ”œโ”€โ”€ exe_build/                 # Executable build output
โ”œโ”€โ”€ pipelines/                 # CI/CD pipelines and scripts
โ”œโ”€โ”€ release/                   # Release-ready packages
โ”œโ”€โ”€ reports/                   # Generated scan reports
โ”œโ”€โ”€ shs/                       # Core SHS source code
โ”œโ”€โ”€ shs_security.egg-info/     # Package metadata (security build)
โ”œโ”€โ”€ shs.egg-info/              # Package metadata
โ”œโ”€โ”€ tests/                     # Unit and integration tests
โ”‚
โ”œโ”€โ”€ .gitignore                 # Git ignore rules
โ”œโ”€โ”€ network_scan_test.py       # Network scan test script
โ”œโ”€โ”€ pyproject.toml             # Modern Python project configuration
โ”œโ”€โ”€ README.md                  # Project README
โ”œโ”€โ”€ requirements.txt           # Project dependencies
โ”œโ”€โ”€ run_integration_test.py    # Integration testing script
โ”œโ”€โ”€ setup.py                   # Package setup configuration
โ”œโ”€โ”€ shs_report.html            # Sample HTML security report
โ”œโ”€โ”€ shs_report.json            # Sample JSON security report
โ”œโ”€โ”€ shs.py                     # Main CLI entry point
โ”œโ”€โ”€ shs.spec                   # PyInstaller build specification

๐Ÿ”’ Safety & Ethics

SHS is designed with security and ethics in mind:

  • โœ… Read-only by default
  • โŒ No malware behavior
  • โŒ No data exfiltration
  • โŒ No exploitation or intrusive scanning

This tool is intended only for defensive security hygiene assessment.

๐Ÿ›ฃ๏ธ Future Improvements

  • More Windows and Linuxโ€“specific security checks

  • Improved scoring logic

  • Scheduled scan support

  • Enhanced report visualization

  • Optional enterprise features

๐Ÿ™Œ Author

Mahima Kumawat Cybersecurity & System Security Enthusiast

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shs-1.0.2.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shs-1.0.2-py3-none-any.whl (86.0 kB view details)

Uploaded Python 3

File details

Details for the file shs-1.0.2.tar.gz.

File metadata

  • Download URL: shs-1.0.2.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for shs-1.0.2.tar.gz
Algorithm Hash digest
SHA256 5fb994058c4b0d50ebc34f189b60d24cdce9112b61e7ed55920aa3233c9f87ee
MD5 2eda45c178b62d2f20936c78ef884111
BLAKE2b-256 83024c1bda4ceede3e57006674d541a40297399e2fb66046a3f9b710068863ab

See more details on using hashes here.

File details

Details for the file shs-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: shs-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 86.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for shs-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e5ffed42ce449e3ad8a402324fdb6f9831e9c9f8f863c92b77251378b30b156
MD5 04f215c272ebe67e6fa0c1747a444310
BLAKE2b-256 2a2d414e8d204cb2e1126ba1d405d4160a7c1213b7797c8f46a520abdfc36c15

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page