Pico W Support (#137)

* Refactor code to support Pico W board

* Updates for Pico W support

* Update based on changes in CircuitPython v8.0.0 beta 6

* Updated bundle download to 8.x, fixed a few typos

* Updating documentation for web interface

* Update support for CircuitPython 8.0.0, fix many bugs

* Document multiple payload options

* Update copyright dates

* Fixed typo

Author: dbisu

README.md

@@ -22,49 +22,82 @@ Install and have your USB Rubber Ducky working in less than 5 minutes.
 
 1. Clone the repo to get a local copy of the files. `git clone https://github.com/dbisu/pico-ducky.git`
 
-2. Download [CircuitPython for the Raspberry Pi Pico](https://circuitpython.org/board/raspberry_pi_pico/). *Updated to 7.0.0
+2. Download [CircuitPython for the Raspberry Pi Pico](https://circuitpython.org/board/raspberry_pi_pico/). *Updated to 8.0.0  
+   Download [CircuitPython for the Raspberry Pi Pico W](https://circuitpython.org/board/raspberry_pi_pico_w/). *Updated to 8.0.0
 
 3. Plug the device into a USB port while holding the boot button. It will show up as a removable media device named `RPI-RP2`.
 
 4. Copy the downloaded `.uf2` file to the root of the Pico (`RPI-RP2`). The device will reboot and after a second or so, it will reconnect as `CIRCUITPY`.
 
-5. Download `adafruit-circuitpython-bundle-7.x-mpy-YYYYMMDD.zip` [here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest) and extract it outside the device.
+5. Download `adafruit-circuitpython-bundle-8.x-mpy-YYYYMMDD.zip` [here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest) and extract it outside the device.
 
 6. Navigate to `lib` in the recently extracted folder and copy `adafruit_hid` to the `lib` folder on your Raspberry Pi Pico.
 
 7. Copy `adafruit_debouncer.mpy` and `adafruit_ticks.mpy` to the `lib` folder on your Raspberry Pi Pico.
 
 8. Copy `asyncio` to the `lib` folder on your Pico.
 
-9. Copy `boot.py` from your clone to the root of your Pico.
+9. Copy `adafruit_wsgi` to the `lib` folder on your Pico.
 
-10. Copy `duckyinpython.py` as `code.py` in the root of the Raspberry Pi Pico, overwriting the previous file.  
-     Linux: `cp duckyinpython.py </path/to/pico/code.py`
+10. Copy `boot.py` from your clone to the root of your Pico.
 
-11. Find a script [here](https://github.com/hak5/usbrubberducky-payloads) or [create your own one using Ducky Script](https://docs.hak5.org/hak5-usb-rubber-ducky/duckyscript-tm-quick-reference) and save it as `payload.dd` in the Pico.
+11. Copy `duckyinpython.py`, `code.py`, `webapp.py`, `wsgiserver.py` to the root folder of the Pico.
 
-12. Be careful, if your device isn't in [setup mode](#setup-mode), the device will reboot and after half a second, the script will run.
+12. Find a script [here](https://github.com/hak5/usbrubberducky-payloads) or [create your own one using Ducky Script](https://docs.hak5.org/hak5-usb-rubber-ducky/ducky-script-basics/hello-world) and save it as `payload.dd` in the Pico. Currently, pico-ducky only supports DuckScript 1.0, not 3.0.
+
+13. Be careful, if your device isn't in [setup mode](#setup-mode), the device will reboot and after half a second, the script will run.
+
+14. **Please note:** by default Pico W will not show as a USB drive
+
+### Pico W Web Service
+The Pico W AP defaults to ip address `192.168.4.1`.  You should be able to find the webservice at `http://192.168.4.1:80`  
+
+The following endpoints are available on the webservice:
+```
+/
+/new
+/ducky
+/edit/<filename>
+/write/<filename>
+/run/<filename>
+```
+
+API endpoints
+```
+/api/run/<filenumber>
+```
 
 ### Setup mode
 
 To edit the payload, enter setup mode by connecting the pin 1 (`GP0`) to pin 3 (`GND`), this will stop the pico-ducky from injecting the payload in your own machine.
-The easiest way to so is by using a jumper wire between those pins as seen bellow.
+The easiest way to do so is by using a jumper wire between those pins as seen bellow.
 
 ![Setup mode with a jumper](images/setup-mode.png)
 
 ### USB enable/disable mode
 
 If you need the pico-ducky to not show up as a USB mass storage device for stealth, follow these instructions.  
-Enter setup mode.    
-Copy your payload script to the pico-ducky.  
-Disconnect the pico from your host PC.
-Connect a jumper wire between pin 18 (`GND`) and pin 20 (`GPIO15`).  
+- Enter setup mode.    
+- Copy your payload script to the pico-ducky.  
+- Disconnect the pico from your host PC.
+- Connect a jumper wire between pin 18 (`GND`) and pin 20 (`GPIO15`).  
 This will prevent the pico-ducky from showing up as a USB drive when plugged into the target computer.  
-Remove the jumper and reconnect to your PC to reprogram.
-The default mode is USB mass storage enabled.   
+- Remove the jumper and reconnect to your PC to reprogram.  
+
+Pico: The default mode is USB mass storage enabled.   
+Pico W: The default mode is USB mass storage **disabled**  
 
 ![USB enable/disable mode](images/usb-boot-mode.png)
 
+### Multiple payloads
+
+Multiple payloads can be stored on the Pico and Pico W.  
+To select a payload, ground one of these pins:
+- GP4 - payload.dd
+- GP5 - payload2.dd
+- GP10 - payload3.dd
+- GP11 - payload4.dd
+
 ### Changing Keyboard Layouts
 
 Copied from [Neradoc/Circuitpython_Keyboard_Layouts](https://github.com/Neradoc/Circuitpython_Keyboard_Layouts/blob/main/PICODUCKY.md)  

boot.py

@@ -1,13 +1,38 @@
+# License : GPLv2.0
+# copyright (c) 2023  Dave Bailey
+# Author: Dave Bailey (dbisu, @daveisu)
+# Pico and Pico W board support
+
 from board import *
+import board
 import digitalio
 import storage
 
-noStorageStatus = False
+noStorage = False
 noStoragePin = digitalio.DigitalInOut(GP15)
 noStoragePin.switch_to_input(pull=digitalio.Pull.UP)
-noStorageStatus = not noStoragePin.value
+noStorageStatus = noStoragePin.value
+
+# If GP15 is not connected, it will default to being pulled high (True)
+# If GP is connected to GND, it will be low (False)
+
+# Pico:
+#   GP15 not connected == USB visible
+#   GP15 connected to GND == USB not visible
+
+# Pico W:
+#   GP15 not connected == USB NOT visible
+#   GP15 connected to GND == USB visible
+
+if(board.board_id == 'raspberry_pi_pico'):
+    # On Pi Pico, default to USB visible
+    noStorage = not noStorageStatus
+elif(board.board_id == 'raspberry_pi_pico_w'):
+    # on Pi Pico W, default to USB hidden by default
+    # so webapp can access storage
+    noStorage = noStorageStatus
 
-if(noStorageStatus == True):
+if(noStorage == True):
     # don't show USB drive to host PC
     storage.disable_usb_drive()
     print("Disabling USB drive")

code.py

@@ -0,0 +1,94 @@
+# License : GPLv2.0
+# copyright (c) 2023  Dave Bailey
+# Author: Dave Bailey (dbisu, @daveisu)
+# Pico and Pico W board support
+
+
+import usb_hid
+from adafruit_hid.keyboard import Keyboard
+
+# comment out these lines for non_US keyboards
+from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS as KeyboardLayout
+from adafruit_hid.keycode import Keycode
+
+# uncomment these lines for non_US keyboards
+# replace LANG with appropriate language
+#from keyboard_layout_win_LANG import KeyboardLayout
+#from keycode_win_LANG import Keycode
+
+import supervisor
+
+
+import time
+import digitalio
+from board import *
+import board
+from duckyinpython import *
+if(board.board_id == 'raspberry_pi_pico_w'):
+    import wifi
+    from webapp import *
+
+
+# sleep at the start to allow the device to be recognized by the host computer
+time.sleep(.5)
+
+def startWiFi():
+    import ipaddress
+    # Get wifi details and more from a secrets.py file
+    try:
+        from secrets import secrets
+    except ImportError:
+        print("WiFi secrets are kept in secrets.py, please add them there!")
+        raise
+
+    print("Connect wifi")
+    #wifi.radio.connect(secrets['ssid'],secrets['password'])
+    wifi.radio.start_ap(secrets['ssid'],secrets['password'])
+
+    HOST = repr(wifi.radio.ipv4_address_ap)
+    PORT = 80        # Port to listen on
+    print(HOST,PORT)
+
+# turn off automatically reloading when files are written to the pico
+#supervisor.disable_autoreload()
+supervisor.runtime.autoreload = False
+
+if(board.board_id == 'raspberry_pi_pico'):
+    led = pwmio.PWMOut(board.LED, frequency=5000, duty_cycle=0)
+elif(board.board_id == 'raspberry_pi_pico_w'):
+    led = digitalio.DigitalInOut(board.LED)
+    led.switch_to_output()
+
+
+progStatus = False
+progStatus = getProgrammingStatus()
+print("progStatus", progStatus)
+if(progStatus == False):
+    print("Finding payload")
+    # not in setup mode, inject the payload
+    payload = selectPayload()
+    print("Running ", payload)
+    runScript(payload)
+
+    print("Done")
+else:
+    print("Update your payload")
+
+led_state = False
+
+async def main_loop():
+    global led,button1
+
+    button_task = asyncio.create_task(monitor_buttons(button1))
+    if(board.board_id == 'raspberry_pi_pico_w'):
+        pico_led_task = asyncio.create_task(blink_pico_w_led(led))
+        print("Starting Wifi")
+        startWiFi()
+        print("Starting Web Service")
+        webservice_task = asyncio.create_task(startWebService())
+        await asyncio.gather(pico_led_task, button_task, webservice_task)
+    else:
+        pico_led_task = asyncio.create_task(blink_pico_led(led))
+        await asyncio.gather(pico_led_task, button_task)
+
+asyncio.run(main_loop())

duckyinpython.py

@@ -1,7 +1,16 @@
 # License : GPLv2.0
-# copyright (c) 2021  Dave Bailey
+# copyright (c) 2023  Dave Bailey
 # Author: Dave Bailey (dbisu, @daveisu)
 
+
+import time
+import digitalio
+from digitalio import DigitalInOut, Pull
+from adafruit_debouncer import Debouncer
+import board
+from board import *
+import pwmio
+import asyncio
 import usb_hid
 from adafruit_hid.keyboard import Keyboard
 
@@ -14,34 +23,6 @@
 #from keyboard_layout_win_LANG import KeyboardLayout
 #from keycode_win_LANG import Keycode
 
-import supervisor
-
-import time
-import digitalio
-from digitalio import DigitalInOut, Pull
-from adafruit_debouncer import Debouncer
-from board import *
-import pwmio
-import asyncio
-
-led = pwmio.PWMOut(LED, frequency=5000, duty_cycle=0)
-
-def led_pwm_up(led):
-    for i in range(100):
-        # PWM LED up and down
-        if i < 50:
-            led.duty_cycle = int(i * 2 * 65535 / 100)  # Up
-        time.sleep(0.01)
-def led_pwm_down(led):
-    for i in range(100):
-        # PWM LED up and down
-        if i >= 50:
-            led.duty_cycle = 65535 - int((i - 50) * 2 * 65535 / 100)  # Down
-        time.sleep(0.01)
-
-# led = digitalio.DigitalInOut(LED)
-# led.direction = digitalio.Direction.OUTPUT
-
 duckyCommands = {
     'WINDOWS': Keycode.WINDOWS, 'GUI': Keycode.GUI,
     'APP': Keycode.APPLICATION, 'MENU': Keycode.APPLICATION, 'SHIFT': Keycode.SHIFT,
@@ -123,13 +104,8 @@ def parseLine(line):
 kbd = Keyboard(usb_hid.devices)
 layout = KeyboardLayout(kbd)
 
-# turn off automatically reloading when files are written to the pico
-supervisor.disable_autoreload()
 
-# sleep at the start to allow the device to be recognized by the host computer
-time.sleep(.5)
 
-led_pwm_up(led)
 
 #init button
 button1_pin = DigitalInOut(GP22) # defaults to input
@@ -191,7 +167,6 @@ def selectPayload():
     payload3State = not payload3Pin.value
     payload4State = not payload4Pin.value
 
-
     if(payload1State == True):
         payload = "payload.dd"
 
@@ -209,17 +184,22 @@ def selectPayload():
         # default to payload1
         payload = "payload.dd"
 
-
     return payload
 
+async def blink_led(led):
+    print("Blink")
+    if(board.board_id == 'raspberry_pi_pico'):
+        blink_pico_led(led)
+    elif(board.board_id == 'raspberry_pi_pico_w'):
+        blink_pico_w_led(led)
 
 async def blink_pico_led(led):
     print("starting blink_pico_led")
     led_state = False
     while True:
         if led_state:
             #led_pwm_up(led)
-            print("led up")
+            #print("led up")
             for i in range(100):
                 # PWM LED up and down
                 if i < 50:
@@ -228,7 +208,7 @@ async def blink_pico_led(led):
             led_state = False
         else:
             #led_pwm_down(led)
-            print("led down")
+            #print("led down")
             for i in range(100):
                 # PWM LED up and down
                 if i >= 50:
@@ -237,6 +217,22 @@ async def blink_pico_led(led):
             led_state = True
         await asyncio.sleep(0)
 
+async def blink_pico_w_led(led):
+    print("starting blink_pico_w_led")
+    led_state = False
+    while True:
+        if led_state:
+            #print("led on")
+            led.value = 1
+            await asyncio.sleep(0.5)
+            led_state = False
+        else:
+            #print("led off")
+            led.value = 0
+            await asyncio.sleep(0.5)
+            led_state = True
+        await asyncio.sleep(0.5)
+
 async def monitor_buttons(button1):
     global inBlinkeyMode, inMenu, enableRandomBeep, enableSirenMode,pixel
     print("starting monitor_buttons")
@@ -266,28 +262,3 @@ async def monitor_buttons(button1):
             button1Down = False
 
         await asyncio.sleep(0)
-
-
-
-progStatus = False
-progStatus = getProgrammingStatus()
-
-if(progStatus == False):
-    # not in setup mode, inject the payload
-    payload = selectPayload()
-    print("Running ", payload)
-    runScript(payload)
-
-    print("Done")
-else:
-    print("Update your payload")
-
-led_state = False
-
-async def main_loop():
-    global led,button1
-    pico_led_task = asyncio.create_task(blink_pico_led(led))
-    button_task = asyncio.create_task(monitor_buttons(button1))
-    await asyncio.gather(pico_led_task, button_task)
-
-asyncio.run(main_loop())