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.4.tar.gz (17.1 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.4-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: serv_audit-1.1.4.tar.gz
  • Upload date:
  • Size: 17.1 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.4.tar.gz
Algorithm Hash digest
SHA256 33a886f3a4c091d071bce9233da6cd1a04bd4e964fe79f55566274a9331f5d0d
MD5 1c13b7e55653c146e53eaa9b0e4aaa48
BLAKE2b-256 f1a2ef5516d6639c5029cc3b7daef8d1ec2362ac8a2bca1470906ed5333d342d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: serv_audit-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 18.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3676f61167873c79a620a3c928e0cfb11f5f2a1534db2e2b14eb6a9dde675e16
MD5 610ae83a3173921cc071176d5c89f5b2
BLAKE2b-256 99452cd8fceb727bcfefc36b78c6b777da2c0b0e9c750fedd0e1996b7c1910ba

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