Skip to main content

Cross-platform security auditing framework for automated security assessments

Project description

Network Security Audit Framework

A cross-platform security auditing framework that performs automated security assessments on Unix/Linux and Windows systems. The framework detects security vulnerabilities, automatically remediates them, and generates structured JSON reports with detailed findings.

Features

  • Cross-Platform Support: Works on Unix/Linux and Windows environments
  • Automated Detection & Remediation: Automatically detects and fixes security vulnerabilities
  • Structured Reporting: JSON-formatted reports with MITRE ATT&CK TTPs
  • Backup System: Automatic backup creation before any modifications
  • Extensible: Easy to add new security checks

Installation

Install via pip (Recommended)

Install directly from Git repository:

pip install git+https://github.com/katerpii/OS-audit-tool.git

Install from local source:

git clone https://github.com/katerpii/OS-audit-tool.git
cd network_security
pip install .

Development mode installation (changes take effect immediately):

pip install -e .

Manual Installation (without pip)

git clone https://github.com/katerpii/OS-audit-tool.git
cd network_security

Usage

After pip installation

Run full audit:

network-security-audit

Manual execution (without pip installation)

python3 run.py

Run specific checks on Unix/Linux

cd network_security/unix
source ./includes/functions.sh
U-37  # Apache AllowOverride AuthConfig check
U-39  # Apache FollowSymLinks check

Output Locations

For installed package

Logs and reports are created in the installed package directory:

# Check installation location
python3 -c "import network_security; print(network_security.__file__)"

# Typical locations:
# ~/.local/lib/python3.x/site-packages/network_security/
# /usr/local/lib/python3.x/site-packages/network_security/

Output files:

  • Unix/Linux logs: network_security/unix/logs/U-XX.log
  • Unix/Linux reports: network_security/unix/reports/U-XX.json
  • Windows reports: network_security/windows/reports/

For manual execution

  • Unix/Linux logs: network_security/unix/logs/
  • Unix/Linux reports: network_security/unix/reports/
  • Windows reports: network_security/windows/reports/

Current Security Checks

Unix/Linux

  • U-37: Apache AllowOverride AuthConfig restriction (prevents directory traversal via .htaccess)
  • U-39: Apache FollowSymLinks restriction (prevents symbolic link exploitation)

Windows

  • Coming soon

System Requirements

  • Python: 3.7 or higher
  • Unix/Linux: bash, zsh, or sh shell
  • Windows: PowerShell
  • Permissions: Some checks and remediation require administrator/root privileges

Testing in VM

PowerShell (Windows VM)

  1. One-liner for Python install(Powershell) for Windows Server 2019
Invoke-WebRequest -Uri https://www.python.org/ftp/python/3.12.5/python-3.12.5-amd64.exe -OutFile python-installer.exe; Start-Process .\python-installer.exe -ArgumentList "/quiet InstallAllUsers=1 PrependPath=1 Include_pip=1" -Wait
  1. If Python is installed:
# Install directly from PyPI
pip install network-security-audit

# Run
network-security-audit
  1. Without Python, download directly:
# Clone repository
git clone https://github.com/katerpii/OS-audit-tool.git
cd network_security

# After installing Python
python run.py

Linux VM

# After SSH to VM
pip install git+https://github.com/katerpii/OS-audit-tool.git

# Run
network-security-audit

Uninstallation

pip uninstall network-security-audit

Development

To add new security checks, refer to the "Adding New Security Checks" section in CLAUDE.md.

License

MIT License

Contributing

Issues and pull requests are welcome.

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

serv_audit-1.1.2.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

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

serv_audit-1.1.2-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file serv_audit-1.1.2.tar.gz.

File metadata

  • Download URL: serv_audit-1.1.2.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for serv_audit-1.1.2.tar.gz
Algorithm Hash digest
SHA256 45d50c3237ec0e42110a91a573b0748085291789111f1e9dc44d15b0f494e6e9
MD5 c2f63271c9a63d5c6ded561e2389e1d0
BLAKE2b-256 f495d4af569632f14417165ab1f6c15e156e2dd68b3284ea4a59df87fd40a692

See more details on using hashes here.

File details

Details for the file serv_audit-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: serv_audit-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for serv_audit-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1e8161ff199d9310ad2833aaeb1f7120106ca9a7d796a0f84d441f5c3f76cc8b
MD5 cda7a1a609376157b3556e2126c87679
BLAKE2b-256 7767e9006695ddbd42a5da0e017287fc118879abf88c031e3a53acfa6df30470

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