Skip to content
C4RR0T02 edited this page Jan 22, 2024 · 6 revisions

Welcome to the AdminGuard: Strengthening OS Security from Within Wiki

πŸ’­ What is AdminGuard?

AdminGuard is a Web Application Tool which allows users to read, modify and generate scripts for fixing and checking based on the Security Technical Implementation Guide (STIG) provided by The DoD Cyber Exchange. To download the STIG guides, the following link can be used https://public.cyber.mil/stigs/downloads/
The tool also allows users to modify the Tenable Nessus Template file based on the user's STIG file. The Tenable Nessus Template File can be downloaded from the following link https://www.tenable.com/downloads/download-all-compliance-audit-files

πŸ“‹ Table Of Content

Ways to Run πŸƒ

1. Using Docker, which is the preferred option
2. Native installation

Running Dockerized 🐳

# clone repository
git clone https://github.com/C4RR0T02/CSIT_AdminGuard_Website.git

# access the AdminGuard directory
cd CSIT_AdminGuard_Website

# build the Dockerfile
docker build -t adminguard_flask .

# run the Dockerfile
docker run -p 8080:8080 adminguard_flask

Native installation

Cloning AdminGuard Repository

# clone repository
git clone https://github.com/C4RR0T02/CSIT_AdminGuard_Website.git

# access the AdminGuard directory
cd CSIT_AdminGuard_Website

Automated Installation

Execute the installation package with the following commands

Windows:

bash install.sh

Linux:

chmod +x install.sh
./install.sh

Manual Installation

To host AdminGuard on the device, the core requirements are as follows

  • Clone AdminGuard Repository
  • Install Python
  • Install Python dependencies

Installing Python

Note: Python 3.10+ is required!

The Python 3.10 version can be downloaded from the official python website https://www.python.org/downloads/release/python-3100/

Installing Python Dependencies

There's also a pip requirements.txt for pip users:

pip install -r requirements.txt

▢️ Running the Web Application

To run the Python Flask Server, execute the following commands

python -m flask --app .\app\app.py run

Navigate to the following site on your browser

http://<your ip address>:<port>

AdminGuard Home Page

Project Structure

.  
β”œβ”€β”€ app                                 # Application Files  
β”‚   β”œβ”€β”€ script                          # Back-End Logic of Application  
β”‚   β”‚   β”œβ”€β”€ __init.py__  
β”‚   β”‚   β”œβ”€β”€ nessusaudit.py              # Audit File to Python Object Script  
β”‚   β”‚   β”œβ”€β”€ powershell_commands.txt     # List of Valid Commands in PowerShell File  
β”‚   β”‚   β”œβ”€β”€ stig_script_gen.py          # STIG Script Generator Script  
β”‚   β”‚   └── template_gen.py             # Template Generator Script  
β”‚   β”œβ”€β”€ static                          # Bootstrap  
β”‚   β”œβ”€β”€ templates                       # Front-End Pages
β”‚   β”œβ”€β”€ tests                           # Automated tests and test files  
β”‚   β”œβ”€β”€ __init.py__         
β”‚   └── app.py                          # Flask application  
β”œβ”€β”€ docs                                # Documentation files  
β”œβ”€β”€ installations                       # Installation files   
β”‚   └── install.sh  
β”œβ”€β”€ wiki                                # Wiki Images  
β”‚   └── images  
β”œβ”€β”€ Dockerfile                             
β”œβ”€β”€ flake8_config.txt                   # Flake8 Config File (Rename to .flake8)  
β”œβ”€β”€ README.md  
└── requirements.txt