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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5fb994058c4b0d50ebc34f189b60d24cdce9112b61e7ed55920aa3233c9f87ee
|
|
| MD5 |
2eda45c178b62d2f20936c78ef884111
|
|
| BLAKE2b-256 |
83024c1bda4ceede3e57006674d541a40297399e2fb66046a3f9b710068863ab
|
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e5ffed42ce449e3ad8a402324fdb6f9831e9c9f8f863c92b77251378b30b156
|
|
| MD5 |
04f215c272ebe67e6fa0c1747a444310
|
|
| BLAKE2b-256 |
2a2d414e8d204cb2e1126ba1d405d4160a7c1213b7797c8f46a520abdfc36c15
|