STRUCTURE.md

This is not a user guide

This is a work in progress

Structure Guide

This is the in-depth guide for understanding how the code works, this is not meant to be a readme file. For that you can look at the README file.

Table of Contents

• Usage Guide
• Table of Contents
• /.github
• /.vscode
• /docs
• /lib
  • Toolbox
    • toolbox.rb
    • toolbox
  • Cryptography
  • Enumeration and Exploitation
  • Forensics
  • Log Analysis
  • Network Traffic Analysis
  • Open Source Intelligence
  • Password Cracking
  • Scanning and Reconnaissance
  • Web Application Exploitation
  • Wireless Access Exploitation
• .rubocop.yml
• Gemfile
• Gemfile.lock
• main.rb

---

/.github

Go to /.github

Houses Github specific configurations, usually autogenerated by Github and tailored for the projects scope.

/ISSUE_TEMPLATE

Go to /ISSUE_TEMPLATE

Houses issue templates for Github to use when someone creates a new issue

bug_report.md

bug_report.md

In this file, it is the markdown for a simple bug report for if a user wants to submit one. It was autogenerated by Github with minor modifications.

/.vscode

Go to /.vscode

These are the config file for Visual Studio Code, right now it just hosts the words for cSpell to ignore. That file is settings.json

/.docs

Go to /docs

This directory hosts all of the documentation for the project. It all uses markdown to properly format the files for Github.

/lib

Go to /lib

Toolbox

Toolbox contains two files, toolbox.rb, and toolbox_ascii_art.rb.

toolbox.rb

This file has

[]

Cryptography

Enumeration and Exploitation

Forensics

Log Analysis

Network Traffic Analysis

Open Source Intelligence

Password Cracking

Scanning and Reconnaissance

Web Application Exploitation

Wireless Access Exploitation

](/.rubocop.yml)

---

/.rubocop.yml

Go to /.rubocop.yml

Gemfile

Go to Gemfile

Gemfile.lock

Go to Gemfile.lock

main.rb

Go to main.rb