Skip to content

Repository files navigation

Arsenal

Arsenal is just a quick inventory, reminder and launcher for pentest commands.
This project written by pentesters for pentesters simplify the use of all the hard-to-remember commands

In arsenal you can search for a command, select one and it's prefilled directly in your terminal. This functionality is independent of the shell used. Indeed arsenal emulates real user input (with TTY arguments and IOCTL) so arsenal works with all shells and your commands will be in the history.

You have to enter arguments if needed, but arsenal supports global variables.
For example, during a pentest we can set the variable ip to prefill all commands using an ip with the right one.

To do that you just have to enter the following command in arsenal:

>set ip=10.10.10.10

Authors:

  • Guillaume Muh
  • mayfly

This project is inspired by navi (https://github.com/denisidoro/navi) because the original version was in bash and too hard to understand to add features

Arsenal new features

  • New colors
  • Add tmux new pane support (with -t)
  • Add default values in cheatsheets commands with <argument|default_value>
  • Support description inside cheatsheets
  • New categories and Tags
  • New cheatsheets
  • Add yml support (thx @0xswitch )
  • Add fzf support with ctrl+t (thx @mgp25)
  • Add prefix to commands generated (with -f)

Install & Launch

  • with pip :
python3 -m pip install arsenal-cli
  • run (we also advice you to add this alias : alias a='arsenal')
arsenal
  • manually:
git clone https://github.com/mapegar4/arsenal-cmd.git
cd arsenal-cmd
python3 -m pip install -r requirements.txt
./run

Inside your .bashrc or .zshrc add the path to run to help you do that you could launch the addalias.sh script

./addalias.sh
  • Also if you are an Arch user you can install from the AUR:
git clone https://aur.archlinux.org/arsenal.git
cd arsenal 
makepkg -si
  • Or with an AUR helper like yay:
yay -S arsenal

Launch in tmux mode

./run -t # if you launch arsenal in a tmux window with one pane, it will split the window and send the command to the otherpane without quitting arsenal
         # if the window is already split the command will be send to the other pane without quitting arsenal
./run -t -e # just like the -t mode but with direct execution in the other pane without quitting arsenal

Add external cheatsheets

You could add your own cheatsheets inside the my_cheats folder or in the ~/.cheats folder.

You could also add additional paths to the file <arsenal_home>/arsenal/modules/config.py, arsenal reads .md (MarkDown) and .rst (RestructuredText).

CHEATS_PATHS = [
    join(BASEPATH, "cheats"), # DEFAULT
    join(HOMEPATH, "docs/my_cheats")
]

Cheatsheets examples are in <arsenal_home>/cheats: README.md and README.rst

Add a prefix commands generated

In order to prefix commands generated by arsenal you need to set the arsenal_prefix_cmd global variable.

For example if you need your commands to be prefixed with proxychains -q:

>set arsenal_prefix_cmd=proxychains -q

then you can start run arsenal with the prefix option:

arsenal -f

Troubleshooting

If you got on error on color init try :

export TERM='xterm-256color'

--

If you have the following exception when running Arsenal:

ImportError: cannot import name 'FullLoader'

First, check that requirements are installed:

pip install -r requirements.txt

If the exception is still there:

pip install -U PyYAML

--

TIOCSTI and Modern Kernels (Auto-Prefill Fix)

Modern Linux kernels disable TIOCSTI for security reasons, which breaks Arsenal's auto-prefill feature. We've implemented multiple solutions to fix this!

🎯 Recommended: Shell Integration (True Auto-Prefill)

Install shell integration for the best experience - commands are automatically prefilled in your terminal:

./install.sh

Or manually add to your shell config:

# For bash - add to ~/.bashrc
source /path/to/arsenal/arsenal_shell_integration.sh

# For zsh - add to ~/.zshrc
source /path/to/arsenal/arsenal_shell_integration.sh

Then restart your shell or run source ~/.bashrc (or ~/.zshrc).

How it works:

  • Bash: Uses read -e -i to prefill command in an interactive prompt
  • Zsh: Uses print -z to push command to the next prompt
  • You can edit the command before executing
  • Command is added to your history

Alternative Methods

If you don't want to install shell integration, Arsenal will automatically try these fallbacks:

  1. TIOCSTI - If available on old kernels (automatic)
  2. Clipboard - Copy to system clipboard via pyperclip (automatic)
  3. OSC 52 - Copy via terminal escape sequences (automatic)
  4. Print - Display command with copy instructions (automatic)

Command-line options for explicit control:

arsenal --copy     # Copy to clipboard
arsenal --exec     # Execute immediately
arsenal --tmux     # Send to tmux pane
arsenal --print    # Just print the command

Legacy workaround (not recommended):

# Only for old kernels that support it
sysctl -w dev.tty.legacy_tiocsti=1

More information in original project issue #77

Mindmap

https://orange-cyberdefense.github.io/ocd-mindmaps/img/pentest_ad_dark_2022_11.svg

  • AD mindmap black version

  • Exchange Mindmap (thx to @snovvcrash)

  • Active directory ACE mindmap

TODO cheatsheets

reverse shell

  • msfvenom
  • php
  • python
  • perl
  • powershell
  • java
  • ruby

whitebox analysis grep regex

  • php
  • nodejs
  • hash

Tools

smb

  • enum4linux
  • smbmap
  • smbget
  • rpcclient
  • rpcinfo
  • nbtscan
  • impacket

kerberos & AD

  • impacket
  • bloodhound
  • rubeus
  • powerview
  • shadow credentials attack
  • samaccountname attack

MITM

  • mitm6
  • responder

Unserialize

  • ysoserial
  • ysoserial.net

bruteforce & pass cracking

  • hydra
  • hashcat
  • john

scan

  • nmap
  • eyewitness
  • gowitness

fuzz

  • gobuster
  • ffuf
  • wfuzz

DNS

  • dig
  • dnsrecon
  • dnsenum
  • sublist3r

rpc

  • rpcbind

netbios-ssn

  • snmpwalk
  • snmp-check
  • onesixtyone

sql

  • sqlmap

oracle

  • oscanner
  • sqlplus
  • tnscmd10g

mysql

  • mysql

nfs

  • showmount

rdp

  • xfreerdp
  • rdesktop
  • ncrack

mssql

  • sqsh

winrm

  • evilwinrm

redis

  • redis-cli

postgres

  • psql
  • pgdump

vnc

  • vncviewer

x11

  • xspy
  • xwd
  • xwininfo

ldap

  • ldapsearch

https

  • sslscan

web

  • burp
  • nikto
  • tplmap

app web

  • drupwn
  • wpscan
  • nuclei

About

Arsenal is just a quick inventory and launcher for hacking programs

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages