diff --git a/README.md b/README.md index 239d6a77..7abf9914 100644 --- a/README.md +++ b/README.md @@ -9,44 +9,36 @@

-**bettercap** is the Swiss Army knife for 802.11, BLE and Ethernet networks reconnaissance and attacks. +bettercap is a powerful, easily extensible and portable framework written in Go which aims to offer to security researchers, red teamers and reverse engineers an **easy to use**, **all-in-one solution** with all the features they might possibly need for performing reconnaissance and attacking [WiFi](https://www.bettercap.org/modules/wifi/) networks, [Bluetooth Low Energy](https://www.bettercap.org/modules/ble/) devices, wireless [HID](https://www.bettercap.org/modules/hid/) devices and [Ethernet](https://www.bettercap.org/modules/ethernet) networks. -## How to Install +## Main Features -

- - Get it from the Snap Store - -

+* **WiFi** networks scanning, [deauthentication attack](https://www.evilsocket.net/2018/07/28/Project-PITA-Writeup-build-a-mini-mass-deauther-using-bettercap-and-a-Raspberry-Pi-Zero-W/), [clientless PMKID association attack](https://www.evilsocket.net/2019/02/13/Pwning-WiFi-networks-with-bettercap-and-the-PMKID-client-less-attack/) and automatic WPA/WPA2 client handshakes capture. +* **Bluetooth Low Energy** devices scanning, characteristics enumeration, reading and writing. +* 2.4Ghz wireless devices scanning and **MouseJacking** attacks with over-the-air HID frames injection (with DuckyScript support). +* Passive and active IP network hosts probing and recon. +* **ARP, DNS and DHCPv6 spoofers** for MITM attacks on IP based networks. +* **Proxies at packet level, TCP level and HTTP/HTTPS** application level fully scriptable with easy to implement **javascript plugins**. +* A powerful **network sniffer** for **credentials harvesting** which can also be used as a **network protocol fuzzer**. +* A very fast port scanner. +* A powerful [REST API](https://www.bettercap.org/modules/core/api.rest/) with support for asynchronous events notification on websocket to orchestrate your attacks easily. +* [More!](https://www.bettercap.org/modules/) -A [precompiled version is available](https://github.com/bettercap/bettercap/releases) for each release, alternatively you can use the latest version of the source code from this repository in order to build your own binary. +## About the 1.x Legacy Version -Make sure you have a correctly configured **Go >= 1.8** environment, that `$GOPATH/bin` is in `$PATH`, that the `libusb-1.0`, `libpcap-dev`, `libnetfilter-queue-dev` (this one is only required on Linux) package installed for your system and then: +While the first version (up to 1.6.2) of bettercap was implemented in Ruby and only offered basic MITM, sniffing and proxying capabilities, the 2.x is a complete reimplementation using the [Go programming language](https://golang.org/). - $ go get github.com/bettercap/bettercap - $ cd $GOPATH/src/github.com/bettercap/bettercap - $ make build && sudo make install +This ground-up rewrite offered several advantages: -This command will download bettercap, install its dependencies, compile it and move the `bettercap` executable to `/usr/local/bin`. +* bettercap can now be distributed as a **single binary** with very few dependencies, for basically **any OS and any architecture**. +* 1.x proxies, altough highly optimized and event based, **[used to bottleneck the entire network](https://en.wikipedia.org/wiki/Global_interpreter_lock)** when performing a MITM attack, while the new version adds almost no overhead. +* Due to such **performance and functional limitations**, most of the features that the 2.x version is offering were simply impossible to implement properly (read as: without killing the entire network ... or your computer). -Now you can use `sudo bettercap -h` to show the basic command line options and just `sudo bettercap` to start an -[interactive session](https://github.com/bettercap/bettercap/wiki/Interactive-Mode) on your default network interface, otherwise you can [load a caplet](https://github.com/bettercap/bettercap/wiki/Caplets). - -Once bettercap is installed, you can download/update system caplet with the command: - - sudo bettercap -eval "caplets.update; q" - -## Update - -In order to update to an unstable but bleeding edge release from this repository, run the commands below: - - $ go get -u github.com/bettercap/bettercap - $ cd $GOPATH/src/github.com/bettercap/bettercap - $ make build && sudo make install +For this reason, **any version prior to 2.x is considered deprecated** and any type of support has been dropped in favor of the new implementation. An archived copy of the legacy documentation is [available here](https://www.bettercap.org/legacy/), however **it is strongly suggested to upgrade**. ## Documentation and Examples -The project is documented [in this wiki](https://github.com/bettercap/bettercap/wiki). +The project is documented [here](https://www.bettercap.org/). ## License