Merge branch 'main' of https://github.com/cecio/USBvalve

STL files for 1.2 PCB and 32 display cover.

.gitignore

@@ -50,3 +50,5 @@ modules.order
 Module.symvers
 Mkfile.old
 dkms.conf
+
+USBvalve_out

Dockerfile

@@ -0,0 +1,38 @@
+#
+# To Build:
+#       docker build -t usbvalve/arduino-cli .
+#
+# To Run:
+#       docker run --rm --name usbvalve -v $PWD:/mnt usbvalve/arduino-cli /mnt/USBvalve
+#
+
+FROM ubuntu:22.04
+WORKDIR /app
+
+# OS setup
+RUN apt-get update -y \ 
+    && apt-get install -y git wget python3 \
+    && apt-get autoremove -y \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# arduino-cli setup
+RUN cd /app \
+    && git clone --recursive https://github.com/arduino/arduino-cli.git \
+    && cd arduino-cli \
+    && ./install.sh \
+    && export PATH=$PATH:/app/arduino-cli/bin \
+    && arduino-cli  --additional-urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json core search 2040 \
+    && arduino-cli --additional-urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json core install rp2040:rp2040 \
+    && arduino-cli lib install "Adafruit TinyUSB Library" \
+    && arduino-cli lib install "ssd1306" \
+    && arduino-cli lib install "Pico PIO USB" \
+    && arduino-cli lib install "SSD1306Ascii"
+
+# Compilation setup
+RUN echo  "#!/bin/bash" > /app/entrypoint.sh \
+    && echo  "export PATH=\$PATH:/app/arduino-cli/bin" >> /app/entrypoint.sh \
+    && echo  "arduino-cli compile --fqbn rp2040:rp2040:rpipico --board-options \"usbstack=tinyusb\" --board-options \"freq=240\" --output-dir \"/mnt/USBvalve_out\" \"\$1\"" >> /app/entrypoint.sh \
+    && chmod +x /app/entrypoint.sh
+
+ENTRYPOINT ["/app/entrypoint.sh"]

README.md

@@ -1,5 +1,6 @@
-# USBvalve
-*Expose USB activity on the fly*
+<h1><img width="200" alt="logo, landscape, dark text, transparent background" src="https://github.com/cecio/USBvalve/blob/main/pictures/USBvalve_logo_scaled.png"></a></h1>
+
+### *Expose USB activity on the fly*
 
 <img src="https://github.com/cecio/USBvalve/blob/main/pictures/versions.png" alt="The two models" width="30%" height="30%" />
 
@@ -127,16 +128,59 @@ To flash the firmware, follow these steps:
 
 It's done!
 
+### Anti-Detection
+
+I don't know if it will ever be the case, but you may want to customize the firmware in order to avoid detection done by *USBvalve-aware* malware :-)
+
+I grouped most of the variables you may want to modify in this section ([see Dockerfile below for rebuilding](https://github.com/cecio/USBvalve#dockerfile))
+
+```C
+// Anti-Detection settings.
+//
+// Set USB IDs strings and numbers, to avoid possible detections.
+// Remember that you can cusotmize FAKE_DISK_BLOCK_NUM as well
+// for the same reason. Also DISK_LABEL in ramdisk.h can be changed.
+//
+// You can see here for inspiration: https://the-sz.com/products/usbid/
+//
+// Example:
+//             0x0951 0x16D5    VENDORID_STR: Kingston   PRODUCTID_STR: DataTraveler
+//
+#define USB_VENDORID 0x0951               // This override the Pi Pico default 0x2E8A
+#define USB_PRODUCTID 0x16D5              // This override the Pi Pico default 0x000A
+#define USB_DESCRIPTOR "DataTraveler"     // This override the Pi Pico default "Pico"
+#define USB_MANUF "Kingston"              // This override the Pi Pico default "Raspberry Pi"
+#define USB_SERIAL "123456789A"           // This override the Pi Pico default. Disabled by default. \
+                                          // See "setSerialDescriptor" in setup() if needed
+#define USB_VENDORID_STR "Kingston"       // Up to 8 chars
+#define USB_PRODUCTID_STR "DataTraveler"  // Up to 16 chars
+#define USB_VERSION_STR "1.0"             // Up to 4 chars
+```
+
+
 ### Building your firmware
 
 Obviously you can also build your own firmware. To build the *standard* one I used:
 
-- Arduino IDE 2.1.0
+- Arduino IDE 2.1.1
 - ~~as board I used `Raspberry Pi Pico - Arduino MBED OS RP2040` version `4.0.2`~~
 - ~~`Adafruit TinyUSB Library` version `1.14.4`. Newer versions are not working because the RPI SDK of the board is stick to an older version.  May be migrate the entire project directly on Raspberry Pi Pico SDK is the solution here.~~
-- `Adafruit TinyUSB Library` version `2.2.0` and Board `Raspberry Pi RP2040 (2.7.0)` setting clock at 240MHz (overclock)
+- `Adafruit TinyUSB Library` version `2.2.2` and Board `Raspberry Pi RP2040 (3.3.0)` setting clock at 240MHz (overclock)
 - `ssd1306` OLED library version `1.8.3`
 
 If you want to re-create a new fake filesystem, you may want to have a look to the `utils` folder, where I placed some utilities to build a new one.
 
-**NOTE**: if you have ideas or improvements in your mind, I encourage you to open an issue so that we can improve the project together! Thanks!
+#### Dockerfile
+
+If you want to build your own firmware, after you customized it, I provide a `Dockerfile` which builds a complete **Arduino** environment and compile the firmware. Enter the following commands in the main `USBvalve` folder:
+
+```
+docker build -t usbvalve/arduino-cli .
+docker run --rm --name usbvalve -v $PWD:/mnt usbvalve/arduino-cli /mnt/USBvalve 
+```
+
+The firmware will be placed with extension `uf2` in folder `USBvalve_out`.
+
+### Contribute
+
+If you have ideas or improvements in your mind, I encourage you to open an issue so that we can improve the project together! Thanks!

USBvalve/USBvalve.ino

@@ -74,12 +74,34 @@ bool activeState = false;
 //
 // USBvalve globals
 //
-#define VERSION "USBvalve - 0.9.0"
+#define VERSION "USBvalve - 0.12.1"
 boolean readme = false;
 boolean autorun = false;
 boolean written = false;
 boolean written_reported = false;
-int x = 2;
+boolean hid_sent = false;
+boolean hid_reported = false;
+
+// Anti-Detection settings.
+//
+// Set USB IDs strings and numbers, to avoid possible detections.
+// Remember that you can cusotmize FAKE_DISK_BLOCK_NUM as well
+// for the same reason. Also DISK_LABEL in ramdisk.h can be changed.
+//
+// You can see here for inspiration: https://the-sz.com/products/usbid/
+//
+// Example:
+//             0x0951 0x16D5    VENDORID_STR: Kingston   PRODUCTID_STR: DataTraveler
+//
+#define USB_VENDORID 0x0951               // This override the Pi Pico default 0x2E8A
+#define USB_PRODUCTID 0x16D5              // This override the Pi Pico default 0x000A
+#define USB_DESCRIPTOR "DataTraveler"     // This override the Pi Pico default "Pico"
+#define USB_MANUF "Kingston"              // This override the Pi Pico default "Raspberry Pi"
+#define USB_SERIAL "123456789A"           // This override the Pi Pico default. Disabled by default. \
+                                          // See "setSerialDescriptor" in setup() if needed
+#define USB_VENDORID_STR "Kingston"       // Up to 8 chars
+#define USB_PRODUCTID_STR "DataTraveler"  // Up to 16 chars
+#define USB_VERSION_STR "1.0"             // Up to 4 chars
 
 #define BLOCK_AUTORUN 102       // Block where Autorun.inf file is saved
 #define BLOCK_README 100        // Block where README.txt file is saved
@@ -89,20 +111,28 @@ int x = 2;
 
 // Burned hash to check consistency
 u8 valid_hash[WIDTH] = {
-  0x35, 0x98, 0x95, 0x97, 0xC7, 0x70, 0xD3, 0xE4,
-  0xDD, 0x84, 0x71, 0x1D, 0x55, 0xD2, 0xE5, 0xA4,
-  0x6C, 0x28, 0x84, 0xF6, 0xE1, 0x02, 0xD1, 0x74,
-  0x2F, 0xE9, 0x92, 0xAD, 0xAD, 0x74, 0x71, 0xF0,
-  0x37, 0xFF, 0x79, 0x39, 0xDC, 0x20, 0x56, 0x26,
-  0xFE, 0xC7, 0x9A, 0x4E, 0x3A, 0x27, 0x65, 0x81
+  0x60, 0xFB, 0x68, 0xB5, 0xB9, 0xE6, 0xF4, 0xB7,
+  0x5F, 0xAD, 0x3C, 0x0D, 0xD3, 0x85, 0x01, 0x74,
+  0xED, 0x70, 0x55, 0x55, 0xE8, 0x1D, 0xE4, 0xBB,
+  0x4F, 0xC7, 0x2C, 0xA6, 0x7C, 0xC7, 0x79, 0x79,
+  0xEF, 0x21, 0x81, 0xB0, 0xEB, 0xD1, 0xF1, 0x71,
+  0x72, 0x37, 0x13, 0x0C, 0x28, 0x39, 0xC0, 0xB0
 };
 
 u8 computed_hash[WIDTH] = { 0x00 };
 
 // Core 0 Setup: will be used for the USB mass device functions
 void setup() {
+  // Change all the USB Pico settings
+  TinyUSBDevice.setID(USB_VENDORID, USB_PRODUCTID);
+  TinyUSBDevice.setProductDescriptor(USB_DESCRIPTOR);
+  TinyUSBDevice.setManufacturerDescriptor(USB_MANUF);
+  // This could be used to change the serial number as well
+  // TinyUSBDevice.setSerialDescriptor(USB_SERIAL);
+
   // Check consistency of RAM FS
-  quark(computed_hash, msc_disk[BYTES_TO_HASH_OFFSET], BYTES_TO_HASH);
+  // Add 11 bytes to skip the DISK_LABEL from the hashing
+  quark(computed_hash, msc_disk[BYTES_TO_HASH_OFFSET] + 11, BYTES_TO_HASH);
 
 #if defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_RP2040)
   // Manual begin() is required on core without built-in support for TinyUSB such as
@@ -111,7 +141,7 @@ void setup() {
 #endif
 
   // Set disk vendor id, product id and revision with string up to 8, 16, 4 characters respectively
-  usb_msc.setID("Watchdog", "USBvalve", "0.1");
+  usb_msc.setID(USB_VENDORID_STR, USB_PRODUCTID_STR, USB_VERSION_STR);
 
   // Set disk size (using the "fake" size)
   usb_msc.setCapacity(FAKE_DISK_BLOCK_NUM, DISK_BLOCK_SIZE);
@@ -127,8 +157,6 @@ void setup() {
   usb_msc.setReadyCallback(msc_ready_callback);
 #endif
 
-  usb_msc.begin();
-
   // Screen Init
   Wire.begin();
   Wire.setClock(400000L);
@@ -147,18 +175,20 @@ void setup() {
 #endif
 
   oled.setFont(Adafruit5x7);
+  oled.setScrollMode(SCROLL_MODE_AUTO);
   cls();  // Clear display
 
   if (memcmp(computed_hash, valid_hash, WIDTH) == 0) {
-    oled.println("[+] Selftest: OK");
-    x++;
+    oled.print("\n[+] Selftest: OK");
   } else {
-    oled.println("[!] Selftest: KO");
-    oled.println("[!] Stopping...");
+    oled.print("\n[!] Selftest: KO");
+    oled.print("\n[!] Stopping...");
     while (1) {
       delay(1000);  // Loop forever
     }
   }
+
+  usb_msc.begin();
 }
 
 // Core 1 Setup: will be used for the USB host functions for BADUSB detector
@@ -179,26 +209,31 @@ void setup1() {
 void loop() {
 
   if (readme == true) {
-    if (x == OLED_LINES) cls();
-    oled.println("[!] README (R)");
-    x++;
+    oled.print("\n[!] README (R)");
     readme = false;
   }
 
   if (autorun == true) {
-    if (x == OLED_LINES) cls();
-    oled.println("[+] AUTORUN (R)");
-    x++;
+    oled.print("\n[+] AUTORUN (R)");
     autorun = false;
   }
 
   if (written == true && written_reported == false) {
-    if (x == OLED_LINES) cls();
-    oled.println("[!] WRITING");
-    x++;
+    oled.print("\n[!] WRITING");
     written = false;
     written_reported = true;
   }
+
+  if (hid_sent == true && hid_reported == false) {
+    oled.print("\n[!!] HID Sending data");
+    hid_sent = false;
+    hid_reported = true;
+  }
+
+  if (BOOTSEL) {
+    oled.print("\n[+] RESETTING");
+    swreset();
+  }
 }
 
 // Main Core1 loop: managing USB Host
@@ -289,9 +324,8 @@ bool msc_ready_callback(void) {
 // Clear display
 void cls(void) {
   oled.clear();
-  oled.println(VERSION);
-  oled.println("----------------");
-  x = 2;
+  oled.print(VERSION);
+  oled.print("\n-----------------");
 }
 
 // HexDump
@@ -330,6 +364,13 @@ void hexDump(unsigned char* data, size_t size) {
   SerialTinyUSB.println();
 }
 
+// Reset the Pico
+void swreset()
+{
+    watchdog_enable(1500, 1);
+    while(1);
+}
+
 //
 // BADUSB detector section
 //
@@ -346,9 +387,7 @@ void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_re
 
   tuh_vid_pid_get(dev_addr, &vid, &pid);
 
-  if (x == OLED_LINES) cls();
-  oled.println("[++] HID Device");
-  x++;
+  oled.print("\n[!!] HID Device");
 
   SerialTinyUSB.printf("HID device address = %d, instance = %d mounted\r\n", dev_addr, instance);
   SerialTinyUSB.printf("VID = %04x, PID = %04x\r\n", vid, pid);
@@ -362,6 +401,10 @@ void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_re
 // Invoked when device with hid interface is un-mounted
 void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance) {
   SerialTinyUSB.printf("HID device address = %d, instance = %d unmounted\r\n", dev_addr, instance);
+
+  // Reset HID sent flag
+  hid_sent = false;
+  hid_reported = false;
 }
 
 // Invoked when received report from device
@@ -370,9 +413,8 @@ void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t cons
   static bool kbd_printed = false;
   static bool mouse_printed = false;
 
-  if (x == OLED_LINES) cls();
-  oled.println("[!!] HID Sending data");
-  x++;
+  // Used in main loop to write output to OLED
+  hid_sent = true;
   
   // Read the HID protocol
   uint8_t const itf_protocol = tuh_hid_interface_protocol(dev_addr, instance);
@@ -504,9 +546,9 @@ static void process_mouse_report(hid_mouse_report_t const* report) {
   uint8_t button_changed_mask = report->buttons ^ prev_report.buttons;
   if (button_changed_mask & report->buttons) {
     SerialTinyUSB.printf("MOUSE: %c%c%c ",
-           report->buttons & MOUSE_BUTTON_LEFT ? 'L' : '-',
-           report->buttons & MOUSE_BUTTON_MIDDLE ? 'M' : '-',
-           report->buttons & MOUSE_BUTTON_RIGHT ? 'R' : '-');
+                         report->buttons & MOUSE_BUTTON_LEFT ? 'L' : '-',
+                         report->buttons & MOUSE_BUTTON_MIDDLE ? 'M' : '-',
+                         report->buttons & MOUSE_BUTTON_RIGHT ? 'R' : '-');
   }
 
   cursor_movement(report->x, report->y, report->wheel);

USBvalve/ramdisk.h

@@ -1,5 +1,7 @@
 /*
   USBvalve
+
+  RAMDISK file written by Cesare Pizzi
 */
 
 /*
@@ -35,9 +37,15 @@
 //    README.TXT
 //    System Volume Information
 //
+
+// Keep 11 chars
+#define DISK_LABEL 'M', 'y', 'D', 'r', 'i', 'v', 'e', ' ', ' ', ' ', ' '
+
+// Do not change this here, it is just for reference
 #define README_CONTENTS \
   "...nuke the entire site from orbit. It's the only way to be sure."
 
+// Do not change this here, it is just for reference
 #define AUTORUN_CONTENTS \
   "[autorun]\r\nopen=calc.exe\r\nicon=icon.ico\r\n"
 
@@ -134,7 +142,7 @@ uint8_t msc_disk[DISK_BLOCK_NUM][DISK_BLOCK_SIZE] = {
 },
 { 
 //------------- Block 7: -------------//
-0x55, 0x53, 0x42, 0x56, 0x41, 0x4c, 0x56, 0x45, 0x20, 0x20, 0x20, 0x08, 0x00, 0x00, 0xaf, 0x60, 
+DISK_LABEL, 0x08, 0x00, 0x00, 0xaf, 0x60, 
 0x6d, 0x55, 0x6d, 0x55, 0x00, 0x00, 0xaf, 0x60, 0x6d, 0x55, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
 0x41, 0x55, 0x54, 0x4f, 0x52, 0x55, 0x4e, 0x20, 0x49, 0x4e, 0x46, 0x20, 0x00, 0x9d, 0xef, 0x58, 
 0x6d, 0x55, 0x6b, 0x55, 0x00, 0x00, 0xef, 0x58, 0x6d, 0x55, 0x60, 0x00, 0x2a, 0x00, 0x00, 0x00, 
@@ -601,7 +609,38 @@ uint8_t msc_disk[DISK_BLOCK_NUM][DISK_BLOCK_SIZE] = {
 },
 { 
 //------------- Block 85: -------------//
-0x00
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x35, 0xc3, 0x28, 0x56, 0xaa, 0x10, 0x9b, 0xd7, 0xd2, 0x75, 0x6e, 0xcf, 0x1e, 0x1e, 0x21, 0xaf, 
+0xcc, 0x52, 0x04, 0xe4, 0xc3, 0x7d, 0x3e, 0xee, 0xf7, 0xf1, 0x7d, 0xe0, 0x09, 0x95, 0x11, 0x6c, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
 },
 { 
 //------------- Block 86: -------------//