tux-00 / network_miner

Network Miner generates a network map by sending SNMP requests (LLDP/CDP/EDP).

Network Miner

Network Miner generates a network map by sending SNMP requests (LLDP/CDP/EDP).

Table of contents:

• Installation
• Test files
• Roadmap
• Wiki

Installation

Prerequisite

• LLDP, EDP or CDP need to be enabled on your SNMP devices.

• You need a web server with the php snmp plugin/package enabled.

• SNMP SysName need to be matching with a DNS record.

Installation

• Clone this repository into your sites location (e.g. /var/www/) :

git clone https://github.com/tux-00/network_miner.git

• Download dependencies :

cd network_miner

bower install

Refer to bower.io for informations about installation.

• Run index.php in your web browser.

Docker

To use the docker image just pull the repository : docker pull tofu00/network_miner

and run the image : docker run -d -it -p 80:80 tofu00/network_miner

You can change the port mapping with the -p paramater.

Test files

You can test the Network Miner rendering without the appropriate environment.

To test Network Miner, you need first to overwrite data/snmp_data.json with the content of a test file located in test/data/.

Now comment these lines in data_mining.php to avoid the scan and the overwrite of snmp_data.json:

recursive_search($FIRST_DEVICE, 1);

file_put_contents('./data/snmp_data.json', json_encode(array('nodes' => $nodes,
 'links' => $links)),
 LOCK_EX);

JSON data faker

If you want to submit data for testing purpose you can use the json_data_faker.py Python 2.7 script to fake every device names in your JSON file.

To use this script you need to install faker module with pip install fake-factory.

Just put the script at your json files location and execute it: python json_data_faker.py.

The script will scan the current folder, find the json files and replace device names.

Roadmap

• Get SNMP informations from a specific device
• Autorefresh map data
• Save maps as PDF, PNG ...
• Icinga plugin

Wiki

For more information, see the Wiki section.

network_miner's Issues

Cisco Discovery Protocol (CDP) and LLDP integration

Search corresponding OID from Cisco mib.

Starting device and community inputs

Size of D3.js SVG relative to the window size

Update network data automatically

Watch this example : http://bl.ocks.org/d3noob/6bd13f974d6516f3e491

Do not run D3.js if no nodes was found ?

Popover error is displaying when there is an ip

Multiple scan at a time : may cause false data due to only one json data file

Solution (data_mining.php) : check if snmp_data.json is locked. If locked, pass the process and return error. If not locked continue.

This need to lock the file at the start of the process.

PHP7

Include SNMP v1 & v3

Port to Node.js ?

snmp2_walk return '.' when the device cannot be joined

Input for starting node and community

Include zoom possibility

Example : http://bl.ocks.org/mbostock/6123708

Add demo website

Stop recursive search when there is no more nodes

Display SNMP errors

Display after the svg

NetworkMiner already exist. Need to change name.

http://www.netresec.com/?page=NetworkMiner

Use bower instead of pushing libs to the repository ?

Possibility to save svg/pdf/png

Build docker container

Option to display name or links