Skip to content

Latest commit

 

History

History
112 lines (77 loc) · 2.28 KB

README.md

File metadata and controls

112 lines (77 loc) · 2.28 KB
Raw

NMT

A network mapper / scanner for improving the pentesters/admin/engineers knowledge of local networks (maybe public soon).

pipeline status FOSSA Status coverage License: MIT python_version

DOCUMENTATION

Jump to the documentation

QUICK START

cd docker/
docker-compose -f docker-compose-all.yml up --build

Go to localhost:8000 in your browser and login with the default credentials

You can now add the first network to scan and launch the sensor:

sudo pip3 install -r requirements.txt
cd sensor/
python3 sensor.py

The scan process will take a time, depending on your sensor.conf config file.

DEFAULT CREDENTIALS

admin / password

INSTALLATION (DEV)

git clone git@gitlab.com:gbnk0/nmt.git

DEVELOPEMENT ENV REQUIREMENTS

  • Minimum python version: 3.5
  • Install docker:
curl https://get.docker.com/|sudo sh
  • Install docker-compose:
pip3 install docker-compose
  • Install NodeJS 8 LTS:
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
  • Install requirements:
pip3 install -r requirements.txt

CORE API

LAUNCH THE API

  • Move into the core folder:
cd core/
  • The api needs a RethinkDB instance for storing hosts, networks data, we'll use docker-compose for bringing it up:
docker-compose -f docker/docker-compose.yml up #( add -d for background )
  • Now you can install dependencies, and run the api with sanic-admin:
pip3 install sanic-admin
sanic-admin api.py

LAUNCH THE SENSOR

cd sensor/
python3 sensor.py

WEB UI

LAUNCH THE WEB UI (DEV MODE)

( Soon with docker-compose UP)

cd web/
npm install # (wait...)
npm start

License

FOSSA Status