A small lightweight network scanner, written in javascript. netmap.js is an open source penetration testing tool, written in javascript. It tries to detect local ip ranges by identifing gateways in the local network. In case an open port is found, the plugin concentrates the scans on this specific ip range. Additionally it can make guesses on the type of device, based on the list of open ports.
In case an open port is found during range detection phase, the device is saved in the local storage to provide faster gateway detection for the next scan.
- Include the following tag in the code of your website:
<script type="text/javascript" src="https://cdn.kastgroup.com/js/libs/netmap.js/1.0.0/netmap.min.js"></script>- Instantiate netmap.js
const netmap = new Netmap();- Start local ip range detection and performs port scans
netmap.scanNetwork();
A sample application of the netmap.js plugin can be found here.
You can download the source files or the compiled file by clicking here.
Preferably, you can download netmap.js by cloning the Git repository:
git clone https://github.com/PatriceKast/netmap.js.git
The official releases are hosted on a CDN by KastGroup GmbH.
https://cdn.kastgroup.com/js/libs/netmap.js/1.0.0/netmap.min.js
To use this js plugin, add the script to your webpage and create a new netmap.js object:
<html>
<head>
<script type="text/javascript" src="https://cdn.kastgroup.com/js/libs/netmap.js/1.0.0/netmap.min.js"></script>
</head>
<body>
<script>
const netmap = new Netmap(console.log); // Instantiate a new Netmap object
netmap.scanNetwork(); // Start local ip range detection and performs port scans
</script>
</body>
</html>The following ranges are defined as default:
[
"10.0.0.",
"192.168.0.",
"172.21.0.",
"172.16.0.",
"192.168.1.",
"192.168.178."
]The following gateway ips (last byte) are defined as default:
["1", "254", "20", "30", "50", "138", "227", "101", "90", "2", "3"]The following gateway ports are defined as default:
[80, 443, 8080, 8008]The following functions are avaible:
netmap.addRange("192.168.1.") // Adds a custom IP range to the detection queue
netmap.addGateways("1") // Adds a custom gateway (last byte) to the detection queue
netmap.addGatewayPorts("8008") // Adds a custom gateway port to the detection queue
netmap.scanDevice(ip, light) // Starts a portscan on a given ip, if light=true only some highly common used ports are tested
netmap.scanRange("192.168.1.", light) // Starts a portscan on a given ip range, if light=true only some highly common used ports are tested
netmap.scanNetwork() // Start local ip range detection and performs port scans on founded ragesThe following values are avaible:
netmap.scannedIps // List of scanned IPs
netmap.devices // List of found devices
netmap.gateways // List of scannable gateways
netmap.ranges // List of scannable ranges
netmap.eventEmitter // EventEmitter of netmap.jsThe EventEmitter fires on the following signals:
netmap.eventEmitter.on("add-device", ( device ) => {});
netmap.eventEmitter.on("scan-port:start", ({ ip, port }) => {});
netmap.eventEmitter.on("scan-port:end", ({ ip, port, open }) => {});
netmap.eventEmitter.on("scan-device:start", ({ ip }) => {});
netmap.eventEmitter.on("scan-device:end", ({ ip, duration, ports, portsPerSecond }) => {});
netmap.eventEmitter.on("scan-gateways:start", () => {});
netmap.eventEmitter.on("scan-gateways:end", () => {});
netmap.eventEmitter.on("scan-range:start", ({ range, light }) => {});
netmap.eventEmitter.on("scan-range:end", ({ range }) => {});
netmap.eventEmitter.on("add-local-range", ({ range, ip }) => {});The Device class has the following values:
const device = new Device();
device.ip // Get IP of this device
device.ports // Get a Set of reachable ports
device.type // DeviceType of this DeviceThe following DeviceType can be detected:
{
"SYNOLOGY_NAS": { "name": "Synology NAS", "ports": [5000, 5001] },
"DATABASE": { "name": "Database", "ports": [3306] },
"MAIL": {
"name": "Mail Server",
"ports": [25, 110, 143, 465, 587, 993, 995]
},
"LDAP": { "name": "LDAP Server", "ports": [389, 636] },
"KERBEROS": {
"name": "Kerberos Server",
"ports": [88, 464, 543, 544, 749, 750, 751, 752, 753, 754, 760, 1109, 2053, 2105]
},
"AD": { "name": "Active Directory", "ports": [445] },
"WEBSERVER": { "name": "Webserver", "ports": [80, 443] },
"DEFAULT": { "name": "Default", "ports": [] }
}
This plugin should run in the two latest versions of Chrome, Firefox and Microsoft Edge.
This Project was started by Nico Hauser and Patrice Kast, two Computer Science Students of ETH Zurich, Switzerland.
All code contributions are greatly appreciated. Just clone the Git repository, read the documentation carefully, go through the code yourself and drop us an message if you want to do an push. All pushes should contain logically improvements.
Have a look at the LICENSE file.