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.3.tar.gz (16.9 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.3-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: serv_audit-1.1.3.tar.gz
  • Upload date:
  • Size: 16.9 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.3.tar.gz
Algorithm Hash digest
SHA256 9a0913826cb7a5c12a7a3d2cb4d767c4b6450621f1c4fe20c6febfc679b08737
MD5 a5e579be98f14f62c2e959255b28e707
BLAKE2b-256 7da8d9462b4c307ab2c35d11c036d7418896846e603f684dc3b2cd5ea1092475

See more details on using hashes here.

File details

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

File metadata

  • Download URL: serv_audit-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 18.2 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3ec7c66ffe9050c783ecdd6cc09194e4b68d650b5fc8288c8047db4d0d8a8443
MD5 ac04e6e685386fce7729c4cf3c98fffb
BLAKE2b-256 1a99a9c27391ca45038de1d57833326ea4ee72ce7b2a1af20b8857e6ae7a9825

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