Getting Started - kaotickj/NetSentinel GitHub Wiki

🏁 Getting Started with NetSentinel

Welcome to NetSentinel — a covert internal reconnaissance framework designed for red team operators and post-exploitation scenarios. This page will walk you through installing NetSentinel, setting up your environment, and running your first scan.

⚠️ DISCLAIMER: NetSentinel is intended for authorized penetration testing and red team engagements only. Unauthorized use is illegal and unethical.


🔧 Prerequisites

✅ Operating System

  • Linux (preferred for impacket and Scapy compatibility)

  • Tested on: Kali Linux, Ubuntu 22.04+, Parrot OS

  • Windows support is possible but not recommended for initial use

✅ Python Environment

  • Python 3.7+

  • Virtual environments recommended (venv, virtualenv, or pyenv)


📦 Installation

1. Clone the Repository

git clone https://github.com/kaotickj/netsentinel.git
cd netsentinel

2. Set Up a Virtual Environment (Optional but Recommended)

python3 -m venv venv
source venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt

Dependencies include: scapy, impacket, ldap3, colorama.


📁 Directory Structure Overview

netsentinel/
├── core/                # Recon modules: network, SMB, Kerberos
├── utils/               # Logger, configuration, and port list
├── tests/               # (Optional) Test harnesses for modules
├── main.py              # CLI entry point
├── config.json          # Optional config override (or use env vars)
├── requirements.txt     # Python dependencies
├── setup.py             # Install script (optional)
├── README.md            # High-level overview

⚙️ Configuration

NetSentinel supports configuration via:

  1. Environment Variables (preferred for operational use)

  2. config.json (fallback config file for Kerberos scanning)

Required for --kerberos-scan:

Variable Description Example
NETSENTINEL_DOMAIN AD domain name corp.local
NETSENTINEL_USER AD username with basic privileges lowpriv
NETSENTINEL_PASS User password Spring2025!
NETSENTINEL_DC Domain controller IP 10.0.0.5

📌 Example: Full Recon + Export

python3 main.py \
  --target 10.0.0.0/24 \
  --resolve-hostnames \
  --smb-enum \
  --kerberos-scan \
  --export-json netsentinel-output.json

📃 Logging

All output is logged with timestamps and severity levels using the internal logger module. Logs appear directly in the terminal, colorized for readability.


🧠 Next Steps

Once you're familiar with running scans, check out the following pages to get more out of NetSentinel:


Let me know if you'd like me to generate additional pages for the rest of the wiki scaffold (Usage Guide, Creating Modules, etc.), or integrate inline help for terminal users (--help formatting cleanup, etc.).

⚠️ **GitHub.com Fallback** ⚠️