Skip to content

Commit 8676a18

Browse files
committed
add documentation.
1 parent 3cea733 commit 8676a18

14 files changed

+80
-21
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.pio
2+
.vscode
23
lib

README.md

+78-20
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,82 @@
11
# UberHid
22

3-
Wifi keylogger with keyboard and mouse injection capabilities
3+
![logo](docs/logo/logo-small.png)
44

5-
*in the firmware directory resides the firmware for the ATmega32u4 and ESP8266 (ESP-12)
6-
7-
*in the hardware directory resides the schematics (I used Eagle)
5+
Wifi keylogger with keyboard and mouse injection capabilities.
86

7+
```bash
8+
├── docs # docs and pictures
9+
├── firmware # firmware code
10+
│ ├── UberHID-ESPUSB # ESP8266 firmware
11+
│ │ └── data # ESP8266 static files
12+
│ └── UberHID-Leonardo # ATmega32u4 firmware
13+
└── hardware # hardware schematics
14+
```
915

1016
## Bill of Materials
1117

12-
| Qty. | Description | Obs. |
18+
| Qty. | Description | Obs. |
1319
|------|------------------------|-----------------------------------------------------------------|
14-
| 1 | UBERHid PCB | Designed by [@kripthor](https://github.com/kripthor/UberHid/) |
15-
| 1 | Arduino atmega32u4 | Board is designed for DM Micro AU version (Beetle with 18 pins) |
16-
| 1 | ESP8266 ESP-12E module | Chip only. To solder. |
17-
| 5 | 10kΩ Resistor | SMD. |
18-
| 2 | 33Ω Resistor | SMD. |
19-
| 2 | 18pF Capacitator | SMD. |
20-
| 1 | XTAL TXC 12Mhz | SMD. |
21-
| 1 | 2k2 Resistor | 2.2KΩ SMD. |
22-
| 1 | FTDI FT232RL | USB to TTL Serial 3.3V/5V USB Adapter or equivalent, only used to program the ESP8266. |
20+
| 1 | UBERHid PCB | Designed by [@kripthor](https://github.com/kripthor/UberHid/) |
21+
| 1 | Arduino atmega32u4 | Board is designed for DM Micro AU version (Beetle with 18 pins) |
22+
| 1 | ESP8266 ESP-12E module | Module to solder |
23+
| 1 | MAX3421EEHJ+ USB | USB Peripheral Host Controller 32-Pin |
24+
| 5 | 10kΩ Resistor | SMD. |
25+
| 2 | 33Ω Resistor | SMD. |
26+
| 2 | 18pF Capacitator | SMD. |
27+
| 1 | XTAL TXC 12Mhz | SMD. |
28+
| 1 | 2k2 Resistor | 2.2KΩ SMD. |
29+
| 1 | FTDI FT232RL | USB to TTL Serial 3.3V/5V USB Adapter or equivalent. Used to program the ESP8266. |
30+
31+
![UBERHid Parts](docs/pics/parts.jpg)
32+
33+
* All the components can be found in the usual online stores such as *Aliexpress* and *eBay*.
2334

2435
## Schematics
2536

37+
### UBERHid PCB
38+
2639
![UBERHid PCB](docs/pcb.png)
2740

41+
### UBERHid Schematic
42+
2843
![Schematic](docs/uberhid-schematic.png)
2944

45+
### UBERHid Wiring
46+
47+
Details of the wiring between the ATmega32u4 and FTDI programmer. Note that the ATmega used in this case was an SS Micro version which does not have the same pinout as the recommended DM Micro AU Beetle Leonardo, which fits directly in the PCB pinout layout.
48+
3049
![Wiring](docs/wiring.png)
3150

51+
## Soldering
52+
53+
The components must be soldered accordingly to the above schematic. Some extra details and _protips_:
54+
55+
- Start by sodering the smaller components, especially the MAX3421 chip, the SMD resistors and capacitors and the XTAL crystal.
56+
- Two pins stay right bellow the ESP8266 chip. You have to be sure that these pins do not make any contact with the ESP8266 after the soldering is completed. I used a little of heat-resistant isolator tape to avoid any contact and soldered the pins on the other side of the board.
57+
- Solder the ESP8266 before the remaining pinouts to have more space.
58+
- Finish the soldering by adding the remaining pins and the USB port.
59+
- The atmega32u4 can be soldered directly on top of the UBERHid PCB, although some jumper cables can also be used to make it possible to reuse it to other projects.
60+
- Clean the board using isopropyl alcohol.
61+
3262
## How to program the devices
3363

3464
### Using [Platformio](https://platformio.org/)
3565

3666
#### ESP8266
67+
3768
0. Connect the FTDI to the PCB pins as depicted in the wiring scheme above.
38-
1. Uncomment the follwing lines in ```platformio.ini```:
69+
1. GPIO0 is needs to be grounded to get into programming mode.
70+
2. Uncomment the follwing lines in ```platformio.ini```:
3971
```yaml
4072
src_dir = ${workspacedir}/firmware/UberHID-ESPUSB/.
41-
data_dir = ${workspacedir}/firmware/UberHID-ESPUSB/data
73+
data_dir = ${workspacedir}/firmware/UberHID-ESPUSB/data/.
4274
```
43-
2. ```$ platformio run -e esp12e``` _sanity check_
44-
3. ```$ platformio run -e esp12e --target upload --upload-port <dev/ttyUSB*>```
45-
- Replace ```<dev/ttyUSB*>``` with your device, _e.g._: ```dev/ttyUSB0```
75+
3. ```$ platformio run -e esp12e``` _sanity check_
76+
4. ```$ platformio run -e esp12e --target upload --upload-port <dev/ttyUSB*>``` _uploads firmware_
77+
- Replace ```<dev/ttyUSB*>``` with your device, _e.g._: ```dev/ttyUSB0```
78+
5. ```$ pio run -e esp12e --target uploadfs --upload-port <dev/ttyUSB*>``` _uploads filesystem (data folder)_
79+
- Replace ```<dev/ttyUSB*>``` with your device, _e.g._: ```dev/ttyUSB0```
4680

4781
#### Arduino Leonardo (atmega32u4)
4882

@@ -53,4 +87,28 @@ src_dir = ${workspacedir}/firmware/UberHID-Leonardo/.
5387
```
5488
2. ```$ platformio run -e leonardo``` _sanity check_
5589
3. ```$ platformio run -e leonardo --target upload --upload-port <dev/ttyACM*>```
56-
- Replace ```<dev/ttyACM*>``` with your device, _e.g._: ```dev/ttyACM0```
90+
- Replace ```<dev/ttyACM*>``` with your device, _e.g._: ```dev/ttyACM0```
91+
92+
93+
## How to use it?
94+
95+
0. Connect the device between a keyboard and a computer.
96+
```
97+
---------- --------- ----------
98+
|Keyboard| <-> |UBERHid| <-> |Computer|
99+
---------- --------- ----------
100+
```
101+
1. Connect to the device access point.
102+
- It can be visible or hidden depending on the configuration on file ```Config.h``` in ```firmware/UberHID-ESPUSB```. Other configurations available are the access point name and password.
103+
104+
```C
105+
#define WIFISSID "UBERHID"
106+
#define WIFIPASS "uberidiota"
107+
#define WIFICHANNEL 7
108+
#define WIFISSIDHIDDEN 0 // 0 for not hidden
109+
```
110+
2. Navigate to ```192.168.4.1```
111+
112+
![UBERHid Homepage](docs/page.png)
113+
114+
3. You can see the keystrokes in realtime and inject keyboard and mouse commands. Also, you can RickRoll your friends.
File renamed without changes.

docs/logo/logo-small.png

8.63 KB
Loading
File renamed without changes.

logo/logo.png docs/logo/logo.png

File renamed without changes.

docs/page.png

75.7 KB
Loading

docs/pics/back.jpg

587 KB
Loading

docs/pics/devices.jpg

550 KB
Loading

docs/pics/front.jpg

398 KB
Loading

docs/pics/parts.jpg

1.53 MB
Loading

docs/pics/voltage.jpg

2.32 MB
Loading

docs/pics/wiring.jpg

1.21 MB
Loading

platformio.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[platformio]
1212
;src_dir = ${workspacedir}/firmware/UberHID-Leonardo/.
1313
src_dir = ${workspacedir}/firmware/UberHID-ESPUSB/.
14-
data_dir = ${workspacedir}/firmware/UberHID-ESPUSB/data
14+
data_dir = ${workspacedir}/firmware/UberHID-ESPUSB/data/.
1515

1616
[env:esp12e]
1717
platform = espressif8266

0 commit comments

Comments
 (0)