Home

Awesome

NOTICE

The Legion repository is moving to https://github.com/hackman238/legion. All future releases, updates, etc will occur from there. Big improvements on the way! This repo under this organiztion will no longer be maintained.

alt tag

✨ About

Legion, a fork of SECFORCE's Sparta, is an open source, easy-to-use, super-extensible, and semi-automated network penetration testing framework that aids in discovery, reconnaissance, and exploitation of information systems.

Fix NMAP 7.92 Sefgaults under Kali

Install NMAP 7.93 using the following:

sudo apt install snapd -y
sudo systemctl enable --now snapd.apparmor
sudo systemctl start snapd
sudo snap install nmap
sudo mv /usr/bin/nmap /usr/bin/nmap-7.92
sudo ln -s /snap/bin/nmap /usr/bin/nmap

Then verify the version is 7.93 with: nmap -v

Update the apparmor profile: vi /var/lib/snapd/apparmor/profiles/snap.nmap.nmap

Goto line 300, create new line and add in:

owner @{HOME}/.local/share/legion/tmp/** rw,
/etc/ssl/kali.cnf r,

Reboot

🍿 Features

Notable changes from Sparta

🌉 Supported Distributions

Docker runIt script support

RunIt script (docker/runIt.sh) supports:

It is possible to run the docker image on any Linux distribution, however, different distributions have different hoops to jump through to get a docker app to be able to connect to the X server. Everyone is welcome to try to figure those hoops out and create a PR for runIt.

Traditional installation support

We can only promise correct operation on Ubuntu 20.04 using the traditional installation at this time. While it should work on ParrotOS, Kali, and others, until we have Legion packaged and placed into the repos for each of these distros, it is musical chairs in regard to platform updates changing and breaking dependencies. Native a native package exists and is included by default on Kali.

💻 Installation

Two installation methods available:

It is preferable to use the Docker method over a traditional installation. This is because of all the dependency requirements and the complications that occur in environments which differ from a clean, non-default installation.

NOTE: Docker versions of Legion are unlikely to work when run as root or under a root X!

Docker method

Docker method includes support for various environments, choose the one that works for you.

Linux with local X11

Assumes Docker and X11 are installed and set up (including running Docker commands as a non-root user).

It is critical to follow all the instructions for running as a non-root user. Skipping any of them will result in complications getting Docker to communicate with the X server.

See detailed instructions to set up Docker here and enable running containers as non-root users and granting Docker group SSH rights here.

Within Terminal:

git clone https://github.com/GoVanguard/legion.git
cd legion/docker
chmod +x runIt.sh
./runIt.sh

Linux with remote X11

Assumes Docker and X11 are installed and set up.

Replace X.X.X.X with the IP address of the remote running X11.

Within Terminal:

git clone https://github.com/GoVanguard/legion.git
cd legion/docker
chmod +x runIt.sh
./runIt.sh X.X.X.X

Windows under WSL using Xming and Docker Desktop

Assumes:

See detailed Docker instructions here

Replace X.X.X.X with the IP address with which Xming has registered itself. Right click Xming in system tray -> View log and see IP next to "XdmcpRegisterConnection: newAddress"

Within Terminal:

git clone https://github.com/GoVanguard/legion.git
cd legion/docker
sudo chmod +x runIt.sh
sudo ./runIt.sh X.X.X.X

Windows using Xming and Docker Desktop without WSL

Why? Don't do this. :)

OSX using XQuartz

Not yet in runIt.sh script. Possible to set up using socat. See instructions here

Configuring Docker

Setting up Docker on Linux

To install Docker components typically needed and add set up the environment for Docker, under a term, run:

sudo apt-get update
sudo apt-get install -y docker.io python3-pip -y
sudo groupadd docker
pip install --user docker-compose

Setup Docker to allow non-root users

To enable non-root users to run Docker commands, under a term, run:

sudo usermod -aG docker $USER
sudo chmod 666 /var/run/docker.sock
sudo xhost +local:docker

Setup Hyper-V, Docker Desktop, Xming and WSL

The order is important for port reservation reasons. If you have WSL, HyperV, or Docker Desktop installed then please uninstall those features before proceeding.

Traditional installation method

Please use the Docker image where possible! It's becoming very difficult to support all the various platforms and their own quirks.

Assumes Ubuntu, Kali or Parrot Linux is being used with Python 3.6 installed.

Within Terminal:

git clone https://github.com/GoVanguard/legion.git
cd legion
sudo chmod +x startLegion.sh
sudo ./startLegion.sh

🏗 Development

Executing test cases

To run all test cases, execute the following in root directory:

python -m unittest

Modifying Configuration

The configuration of selected ports and associated terminal actions can be easily modified by editing the legion.conf file.

[StagedNmapSettings] defines what ports will be scanned in sequential order as well as any NSE scripts that will be called.

[SchedulerSettings] defines what actions will occur automatically based upon port scan results.

sudoedit /root/.local/share/legion/legion.conf

⚖️ License

Legion is licensed under the GNU General Public License v3.0. Take a look at the LICENSE for more information.

⭐️ Attribution