Description • How To Use • Modules • Configuration File • Requirements • Logging • Contributing • Project Architecture • License
Sandmap is a tool supporting network and system reconnaissance using the massive Nmap engine. It provides a user-friendly interface, automates and speeds up scanning and allows you to easily use many advanced scanning techniques.
- simple CLI with the ability to run pure Nmap engine
- predefined scans included in the modules
- support Nmap Scripting Engine (NSE)
- TOR support (with proxychains)
- multiple scans at one time
- at this point: 7 modules with 84 scan profiles
It's simple:
# Clone this repository
git clone https://github.com/trimstray/sandmap
# Go into the repository
cd sandmap
# Install
./setup.sh install
# Run the app
sandmap
- symlink to
bin/sandmap
is placed in/usr/local/bin
- man page is placed in
/usr/local/man/man8
Available modules: 7
Available scan profiles: 84
NSE Modules: 1
NSE Profiles: 43
The etc/main.cfg
configuration file has the following structure:
# shellcheck shell=bash
# Specifies the default destination.
# Examples:
# - dest="127.0.0.1,8.8.8.8"
dest="127.0.0.1"
# Specifies the default port number.
# Examples:
# - port="80"
port="80"
# Specifies the default MAC address.
# Examples:
# - iface="eth0"
iface="eth0"
# Specifies the default network interface.
# Examples:
# - hwaddr="00:01:02:03:04:05"
hwaddr=""
# Specifies the default output type and path.
# Examples:
# - report="xml"
report=""
# Specifies the TOR connection.
# Examples:
# - tor="true"
tor=""
# Specifies the terminal type.
# Examples:
# - terminal="internal"
terminal="internal"
Sandmap uses external utilities to be installed before running:
After running the script, the log/
directory is created and in it the following files with logs:
<script_name>.<date>.log
- all_logger()
function calls are saved in itstdout.log
- a standard output and errors from the_init_cmd()
function are written in it. If you want to redirect the output from command, use the following structure:your_command >>"$_log_stdout" 2>&1 &
See CONTRIBUTING.md.
|-- LICENSE.md # GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007
|-- README.md # this simple documentation
|-- CONTRIBUTING.md # principles of project support
|-- .gitignore # ignore untracked files
|-- .travis.yml # continuous integration with Travis CI
|-- setup.sh # install sandmap on the system
|-- bin
|-- sandmap # main script (init)
|-- doc # includes documentation, images and manuals
|-- man8
|-- sandmap.8 # man page for sandmap
|-- img # images (eg. gif)
|-- etc # contains configuration files
|-- lib # libraries, external functions
|-- log # contains logs, created after init
|-- modules # contains modules
|-- src # includes external project files
|-- helpers # contains core functions
|-- import # appends the contents of the lib directory
|-- __init__ # contains the __main__ function
|-- settings # contains sandmap settings
|-- templates # contains examples and template files
|-- tmp # contains temporary files (mktemp)
GPLv3 : http://www.gnu.org/licenses/
Free software, Yeah!