-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from itsOwen/main
readme fix
- Loading branch information
Showing
1 changed file
with
61 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,89 @@ | ||
| # Netgotchi | ||
|  | ||
| # 🛡️ Netgotchi | ||
|
|
||
|  | ||
|
|
||
| reversed pwnagotchi : Netgotchi lives to protect your network | ||
| > Netgotchi: Your network's loyal guardian! 🐾 | ||
| A small arduino .ino script with some great functions to detect intruders or breach in the network, it pings periodically the network and report if any new device. It also has a rudimental "Honeypot" functionality with a rudimental exposed service, once someone reach the honeypot it will trigger an alarm. Please contribute to the repository via pull requests! | ||
|
|
||
| *Tested with nmap, service scan / intense scan will trigger the alert.* | ||
| Tested with nmap, service scan / intense scan will trigger the alert. | ||
|
|
||
| ## 🌟 Features | ||
|
|
||
|   | ||
| - 🔍 Periodic network scanning | ||
| - 🍯 Built-in "Honeypot" functionality | ||
| - 🚨 Intrusion detection and alerting | ||
| - 🔄 Supports both ESP8266 and ESP32 | ||
|
|
||
| Get an official build and support the development from : | ||
|   | ||
|
|
||
| ## 🛒 Get an Official Build | ||
|
|
||
| Support the development by getting an official Netgotchi: | ||
| - [Netgotchi on Bonanza](https://www.bonanza.com/listings/NETGOTCHI-pwnagotchi-older-brother-scans-and-protect-your-network-/1657032899?fref=WCsgHJd3) | ||
| - [Amazon](https://amzn.to/4dd5yjA) | ||
| - [Etsy](https://olleadventures.etsy.com/listing/1752764124) | ||
| - [Amazon](https://amzn.to/4dd5yjA) | ||
| - [Etsy](https://olleadventures.etsy.com/listing/1752764124) | ||
|
|
||
| ## 🛠️ Requirements | ||
|
|
||
| - ESP8266 or ESP32 | ||
| - SSD1306 OLED display (I2C version) | ||
| - USB cable | ||
| - Optional: 3D printed case ([Community case for Wemos D1](https://www.printables.com/model/510481-terminal-for-ssd1306-096-oled-and-wemos-d1-mini)) | ||
|
|
||
| ## 📊 Wiring Diagram | ||
|
|
||
|  | ||
|
|
||
| ## 📚 Libraries | ||
|
|
||
| # Requirements | ||
| - ESP8266 ( any ) | ||
| - SSD1306 display ( ic version ) | ||
| - Usb cable | ||
| - optional 3d printed parts ( from thingiverse.com) | ||
| - Community cases: Wemos d1 https://www.printables.com/model/510481-terminal-for-ssd1306-096-oled-and-wemos-d1-mini ( thanks porkcube for the link) | ||
| - Modified ESP8266FtpServer (for ESP8266) or ESP32FtpServer (for ESP32) | ||
| - Adafruit_SSD1306 | ||
| - ESPping | ||
| - WiFiManager | ||
|
|
||
| ## 🚀 How to Use | ||
|
|
||
| # Diagram | ||
|  | ||
| 1. Open the `.ino` file and select your board type (ESP8266 or ESP32) by commenting/uncommenting the appropriate `#define` at the top of the file. | ||
| 2. Install the required libraries via the Arduino Library Manager. | ||
| 3. Flash the code to your ESP8266 or ESP32. | ||
| 4. On first boot, Netgotchi will create a WiFi hotspot named "AutoConnectAP" for you to set up your WiFi credentials. | ||
| 5. Once connected, Netgotchi will start guarding your network! | ||
|
|
||
| ## 🖥️ Headless Mode (for Cyberdecks) | ||
|
|
||
| # Libraries | ||
| - It uses a modified version of ESP8266FtpServer ( replace your local one in Arduino>Libraries with this one) | ||
| - Adafruit_SSD1306 standard ( install from Library manager) | ||
| - ESPping Standard ( install from Library manager) | ||
| - WiFiManager standard ( install from Library manager) | ||
|  | ||
|
|
||
| # How to use | ||
| 1. ~~open .ino file , choose your subnet ( just change the value or add your own)~~ Not necessary due to Autodetect subnet function after v.0.7 | ||
| 2. optionally you can input your Wifi credential in the .ino file or use the WifiManager library ( default is WifiManager) | ||
| 1. Open `utils/cyberdeck/pyserial_cyberdeck.py` | ||
| 2. Change the COM port on line 5 (e.g., `/dev/ttyUSB0` for Linux, `COMx` for Windows) | ||
| 3. Run the script | ||
|
|
||
| ## 🔎 Vulnerability Scanning | ||
|
|
||
| 3. Install libraries and flash the file in the esp8266 ( connect the display first) | ||
| 4. On first status WiFiManager library will create an hostpot where you can set your wifi credentials | ||
| "AutoConnectAP" | ||
| As of v0.9, Netgotchi scans for potentially vulnerable services including: | ||
| - Telnet (23) | ||
| - FTP (21) | ||
| - SSH (22) | ||
| - VNC (5900) | ||
| - RDP (3389) | ||
| - SMB (445) | ||
| - HTTP (80) | ||
| - HTTPS (443) | ||
|
|
||
| 5. Netgotchi now lives in your network, it will scan periodically using pings and report potential breach of the honeypot | ||
|
|
||
| Vulnerable hosts are marked with "WRNG!". This feature can be toggled with the `securityScanActive` flag. | ||
|
|
||
| ## 😊 Join us on Discord | ||
|
|
||
| # Headless mode ( for Cyberdecks ) | ||
|  | ||
| - open script pyserial_cyberdeck and change line 5: /dev/ttyUSB0 to your COM port ( on linux is usually /dev/ttyUSB0 ) | ||
| - run script utils/cyberdeck/pyserial_cyberdeck.py | ||
| Discord Server: [Join Now](https://discord.gg/qucvvgkv3B) | ||
|
|
||
| # Scan for Vulnerabilities in the network ( v0.9 update ) | ||
| - Netgotchi now scan your network for services like quick-scan of NMAP - it will scan host for know vulnerables services including : | ||
| { "Telnet", 23 }, | ||
| { "FTP", 21 }, | ||
| { "SSH", 22 }, | ||
| { "VNC", 5900 }, | ||
| { "RDP", 3389 }, | ||
| { "SMB", 445 }, | ||
| { "HTTP", 80 }, | ||
| { "HTTPS", 443 } | ||
| - report any vulnerabilities and vulnerable hosts with a "WRNG!" | ||
| - *This may trigger other Netgotchi in the same network* , so there is a flag enabled by default to skip the FTP scan. | ||
| - can be disabled from the *securityScanActive* flag | ||
| ## 🤝 Contributing | ||
|
|
||
| # Suppor the project | ||
| Enjoy your Netgotchi ! | ||
| Please contribute to the project,and let's save our network! | ||
| Thank you to all contributors and supporters! (^///^)9 | ||
| We welcome contributions! Please submit your pull requests to help make Netgotchi even better. | ||
|
|
||
| Join our [reddit/r/Netgotchi](https://www.reddit.com/r/Netgotchi/) | ||
| Join our [Reddit community](https://www.reddit.com/r/Netgotchi/)! | ||
|
|
||
| # License | ||
| GNU General Public License v3.0 | ||
| Created by MG ( MXZZ ) | ||
| ## 📜 License | ||
|
|
||
| GNU General Public License v3.0 | ||
|
|
||
| Created with ❤️ by MG [MXZZ](https://github.com/MXZZ) | ESP32 Port Created by [itsOwen](https://github.com/itsOwen) |