This is a keystroke injection device (also called badusb). It is similar to a well-known
USB rubber ducky made by hak5, but has much extended functionality, lower price
and is also completely open source. It looks and feels like an ordinary USB flash drive,
but acts as a keyboard that types in a preprogrammed payload. This payload can do anything
from configuring a network to installing a reverse shell, since the device can basically
do whatever an admin can with a terminal, but taking only a few seconds. This makes
it a very powerful tool for automating sysadmin tasks or use in penetration testing.

Here is quick summary of how PocketAdmin is different from USB rubber ducky (and many others):

1. Made from inexpensive off-the-shelf parts, with not only open source firmware,
   but hardware design files as well. This allows the user to do substantial
   modifications to the design, as well as provides an option to build your own units.

2. Has a built-in interpreter (compatible with existing ducky script) which takes text files directly,
   so you never have to install any encoder software and keep converting payload.txt to inject.bin.

3. Has USB mass storage capability, allowing for better payloads; the memory chip is integrated,
   so there is no need to keep sticking SD card in/out of various devices while developing payloads.

4. Has an OS detection mechanism, which allows you to store multiple on-insertion payloads
   simultaneously and have the device automatically pick the correct payload to run.

5. You can save up to 17 extra on-demand payloads and execute them by tapping on a capslock key
   the appropriate number of times. You can also use this functionality for more convenient device
   operation, such as rebooting into mass storage of DFU modes without taking the device apart.

6. Extended set of commands for extra functionality, such as: mouse control, commands to hold
   and release keys, dynamic delays, ability to repeat blocks of commands; you can have several
   non-modifier keys pressed simultaneously and you are not limited in keyword order or by a set
   of hardcoded key combinations, only by the maximum of 10 commands on a single line.

7. User has several configuration options available, none of which require a firmware update.
   You can set which serial number and VID / PID values to use, how the device should show up
   (keyboard+mouse+disk or keyboard+mouse only), change keyboard layout, hide a particular
   memory region on the USB disk, show fake storage capacity to the host, etc.

CHECK THE WIKI FOR HOW-TO-USE INFORMATION

project is designed using KiCad 5.1.5
check KiCad pcb file for PCB manufacturing info
check KiCad sch file + BOM.txt for component info

Uses integrated full-speed (12Mbit/s) USB2.0 peripheral, with
96MiB of available on-board flash memory for data storage;
measured speeds for MSD access: read 800-850 KiB/s, write 700-750 KiB/s

There is an LED and a pushbutton on the device. The LED is a mass storage
status indicator, which lights up any time the device reads or writes flash
memory. It is recommended to make sure this LED is turned off before pulling
the device out of host machine, to prevent filesystem corruption.
The pushbutton on the device is referred to as MSD-only button. Normally
the payload is run whenever you plug the device into a PC. But if you press
and hold this button while inserting the device, it prevents any keystrokes
from being typed in and makes the device show up as a flash drive. It also
prevents the use of camouflage features like hidden region or fake capacity.

Fully assembled unit has dimensions of 59x18x9mm and weight of 8 grams.
When opening up the case, be careful no to break the plastic studs near
the USB connector and at the opposite (from USB) end of enclosure.

hardware programmer device used in this project is ST-Link V2
For instructions on how to build and flash the device go check this video:
https://www.youtube.com/watch?v=cfud5Dq_w2M

programming language used = C
flashing software used = openocd
IDE used = emacs text editor + Makefile

the firmware was developed on debian 10.3 system, using gcc-arm-none-eabi toolchain
(compiler, linker, binutils) and it does use gcc specific extentions.
it was successfully compiled and tested with arm-none-eabi-gcc version 7.3.1

depends on libgcc.a, which is included in this repository. linker script,
startup code and openocd configuration files are included here as well.

files usb_rodata.h, hid_rodata.h, msd_rodata.h are not really
headers, but integral parts of usb.c, main.c, msd.c respectively.
they are not intended to be included in any other files.

for easy in-field updates, you can use the DFU bootloader. There is a dfu
firmware image available in /firmware/firmware_RRNNN.dfu file. The name
format is this: RR stands for board revision (13 = rev 1.3) , NNN stands
for firmware version. For example, firmware_13000.dfu means board
revision 1.3, firmware version 0

To automate firmware build process you can use make utility. If you
open terminal in /firmware/ directory, you could run these commands:

make
make upload
make dfu
make clean

"make" will compile source code and create several files, among them
is firmware.bin which contains firmware to flash. "make upload" will
flash this file via St-Link V2 programmer. Make sure to connect the
programmer to the board properly, before you plug it in and run the
command. "make dfu" will create a DFU firmware image from firmware.bin
which can be used later by DFU flashing software. "make clean" will
delete all the compiled or temporary files created by previous commands.

/firmware/cmsis/ ------- header files from CMSIS compliant STM32F0xx standard peripherals library
/firmware/stdlib/ ---------- standard statically linked libraries (libgcc.a)
/firmware/openocd/ ------- standard configuration files for openocd
/firmware/fatfs/ ---------- chan fatfs filesystem module + custom W25N01GVZEIG disk driver
/firmware/usb/ ------------ custom USB stack, implementation of MSD and HID class devices
/firmware/main/ ------- main application file, interrupt vector table, IRQ handlers and startup code
/firmware/dfuse-pack.py ------- python script to create .dfu firmware images
/firmware/firmware_13NNN.dfu ------ pre-compiled firmware image in DfuSe format (STM32)

/hardware/PocketAdmin.symbols/ -- project specific symbol library
/hardware/PocketAdmin.pretty/ --- project specific footprint library
/hardware/gerbers/ ----------- gerber+excellon fabrication output files
/hardware/BOM.txt --------- list of parts needed for DIY assembly

/extra/pictures/ ---------------- photos and mechanical drawings
/extra/wiki/ ------------------ github wiki pages
/extra/payloads/ ----------- example and test payloads for PocketAdmin
/extra/payloads/fingerprinterTest/fingerdb/ -- example OS fingerprint database
/extra/payloads/layoutTest/kblayout/ --- alternative keyboard layout files

if you have a problem / question / feature request, here are your options for contacting me:
send me an email to [email protected]
create a new github issue (check closed issues first)
also, you can check out my youtube channel

For extra security, you could use my PGP public key saved in /extra/pubkey.asc.

My tindie store: https://www.tindie.com/stores/krakrukra/