franjsco
/
lscanbot
mirror of https://github.com/franjsco/lscanbot
1
0
Fork 0
Code Issues Releases Wiki Activity
17 Commits 11 Branches 2 Tags 2.4 MiB
JavaScript 100%
Go to file
dependabot[bot] 3128b53f44
Bump js-yaml from 3.12.0 to 3.13.1 
Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.12.0 to 3.13.1.
- [Release notes](https://github.com/nodeca/js-yaml/releases)
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/3.12.0...3.13.1)

Signed-off-by: dependabot[bot] <support@github.com>
 		2019-11-03 09:31:30 +00:00
.gitignore add .gitignore 2019-02-12 21:50:37 +01:00
LICENSE Initial commit 2018-09-24 21:21:53 +02:00
README.md edit user ref 2019-07-23 22:21:23 +02:00
config.json Initial commit 2018-09-24 21:21:53 +02:00
db.js Initial commit 2018-09-24 21:21:53 +02:00
index.js refactoring promises 2019-02-12 22:15:43 +01:00
logger.js Initial commit 2018-09-24 21:21:53 +02:00
package-lock.json Bump js-yaml from 3.12.0 to 3.13.1 2019-11-03 09:31:30 +00:00
package.json edit user ref 2019-07-23 22:21:23 +02:00
scanner.js refactoring promises 2019-02-12 22:15:43 +01:00
screenshot.png edit user ref 2019-07-23 22:21:23 +02:00
utils.js edit user ref 2019-07-23 22:21:23 +02:00

README.md

lscanbot

An opensource telegram bot to find devices on your LAN.

The bot is written in Node.js.

Usage

lscanbot scans devices with arp-scan, showing only devices registered in the inventory.

Scan

Before scanning, you must insert the devices into the inventory (to track it):

/add [Device name] ; [Owner] ; [MAC Address]

(use ; to split arguments)

example: (/add My device; Me; AB:CC:MY:MC:AD)

After that, you can scan:

/scan

It will send back the devices connected to your network.

Remove

/remove [MAC Address]

Installation

In order to use this bot is required that the code is hosted on a GNU/Linux system connected to your LAN (Raspberry Pi would be a good choice)

Prerequisites

  • Node.js
  • npm
  • GNU/Linux

Step by step

  1. Install arp-scan package on your linux system.
  2. Configure arp-scan to use without sudo. (chmod u+s)
  3. Clone this repository on your system.
  4. Install dependecies with npm install.
  5. Create new bot with BotFather on Telegram.
  6. Insert your token (app.token) into config.json.
  7. Insert your TelegramID (app.authorizedUsers) into config.json.
  8. Insert your network device (scanner.interface) into config.json.
  9. Start with npm start.

License

GPLv3

Made with ❤️ by Francesco Esposito (@frsposito)