Sandmap

Sandmap is a tool supporting network and system reconnaissance using the massive Nmap engine.

Description • How To Use • Modules • Configuration File • Requirements • Logging • Contributing • Project Architecture • License • Wiki

_{Created by trimstray and contributors}

Description

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.

Key Features

• 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: 31 modules with 459 scan profiles

How To Use

It's simple:

# Clone this repository
git clone --recursive 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

Modules

Available modules: 31
Available scan profiles: 459

If you want to create your own modules, take a look Modules.

Internal modules

Sandmap supports the NSE scripts provided with Nmap. This is transparent for the user.

External modules

You can also provide external NSE modules that are in the data/nse_external directory. from version v1.1.1 there are 4 NSE scripts available:

git submodule
 34579f2b0f6110a934c1fc9527e21551a5016528 data/nse_external/michenriksen (heads/master)
 441c7a6d6c004356fd20314552d94b1f21ae62f1 data/nse_external/s4n7h0 (heads/master)
 391d88e547af1ee223bf4e5a865dfe012c7f859f data/nse_external/vulners (v1.2-release)
 a7938fb82952dc1bdda7757fdc0fc06c314d6543 data/nse_external/vulscan (heads/master)

In order to download them when cloning the repository, add the --recursive parameter.

Configuration file

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 extended Nmap parameters.
# Examples:
#   - params="--script ssl-ccs-injection -p 443"
params=""

# 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"

Requirements

Sandmap uses external utilities to be installed before running:

• nmap
• xterm
• proxychains

Logging

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 it
• stdout.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 &

Contributing

See CONTRIBUTING.md.

Project architecture

|-- 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)
|-- data
    |-- nse_external           # external nse scripts
|-- 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)

License

GPLv3 : http://www.gnu.org/licenses/

Free software, Yeah!