mirror of
https://github.com/dbisu/pico-ducky.git
synced 2026-01-21 17:26:00 +00:00
Compare commits
3 Commits
delay-refa
...
kronos
| Author | SHA1 | Date | |
|---|---|---|---|
|
af822e3f01 | ||
|
|
fb4189bb20 | ||
|
|
f246853c5d |
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,34 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the bug**
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**To Reproduce**
|
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Debug info**
|
|
||||||
If possible, include debug serial data.
|
|
||||||
On Windows, use PuTTY, connect to the debug serial port (commonly COM3, but could vary)
|
|
||||||
|
|
||||||
On Linux, use minicom (minicom -b 115200 -o -D /dev/ttyACM0, where ttyACM0 corresponds to your device)
|
|
||||||
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context about the problem here.
|
|
||||||
29
.github/ISSUE_TEMPLATE/not-working.md
vendored
29
.github/ISSUE_TEMPLATE/not-working.md
vendored
@@ -1,29 +0,0 @@
|
|||||||
---
|
|
||||||
name: Not Working
|
|
||||||
about: Create a report if something is not working correctly
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the issue**
|
|
||||||
A clear and concise description of the symptoms
|
|
||||||
|
|
||||||
**To Reproduce**
|
|
||||||
Steps to reproduce the behavior:
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Debug info**
|
|
||||||
If possible, include debug serial data.
|
|
||||||
On Windows, use PuTTY, connect to the debug serial port (commonly COM3, but could vary)
|
|
||||||
|
|
||||||
On Linux, use minicom (minicom -b 115200 -o -D /dev/ttyACM0, where ttyACM0 corresponds to your device)
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context about the problem here.
|
|
||||||
213
README.md
213
README.md
@@ -16,226 +16,39 @@
|
|||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
## Quick Start Guide
|
## Install
|
||||||
Install and have your USB Rubber Ducky working in less than 5 minutes.
|
|
||||||
|
|
||||||
1. Download the latest release from the [Releases](https://github.com/dbisu/pico-ducky/releases) page.
|
|
||||||
|
|
||||||
2. Plug the device into a USB port while holding the boot button. It will show up as a removable media device named RPI-RP2.
|
|
||||||
|
|
||||||
3. Install CircutlPython on the Pico or Pico W
|
|
||||||
|
|
||||||
If using a Pico board:
|
|
||||||
|
|
||||||
Copy the adafruit-circuitpython-raspberry_pi_pico-en_US-8.0.0.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.
|
|
||||||
|
|
||||||
If using a Pico W board:
|
|
||||||
|
|
||||||
Copy the adafruit-circuitpython-raspberry_pi_pico_w-en_US-8.0.0.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.
|
|
||||||
|
|
||||||
4. Copy the lib folder to the root of the CIRCUITPY
|
|
||||||
|
|
||||||
5. Copy *.py to the root of the CIRCUITPY
|
|
||||||
|
|
||||||
6. Follow the instructions in README.md to enter setup mode
|
|
||||||
|
|
||||||
7. Copy your payload as payload.dd to the root of the CIRCUITPY
|
|
||||||
|
|
||||||
8. Unplug the device from the USB port and remove the setup jumper.
|
|
||||||
|
|
||||||
Enjoy your Pico-Ducky.
|
|
||||||
|
|
||||||
## 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 do so is by using a jumper wire between those pins as seen bellow.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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`).
|
|
||||||
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.
|
|
||||||
|
|
||||||
Pico: The default mode is USB mass storage enabled.
|
|
||||||
Pico W: The default mode is USB mass storage **disabled**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
# Full Install Instructions
|
|
||||||
|
|
||||||
Install and have your USB Rubber Ducky working in less than 5 minutes.
|
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`
|
1. Download [CircuitPython for the Raspberry Pi Pico](https://circuitpython.org/board/raspberry_pi_pico/).
|
||||||
|
|
||||||
2. Download [CircuitPython for the Raspberry Pi Pico](https://circuitpython.org/board/raspberry_pi_pico/). *Updated to 8.0.0
|
2. Plug the device into a USB port. It will show up as a removable media device named `RPI-RP2`.
|
||||||
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`.
|
3. 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`.
|
||||||
|
|
||||||
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`.
|
4. Download `adafruit-circuitpython-bundle-6.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.
|
5. Navigate to `lib` in the recently extracted folder and copy `adafruit_hid` to the `lib` folder in your Raspberry Pi Pico.
|
||||||
|
|
||||||
6. Navigate to `lib` in the recently extracted folder and copy `adafruit_hid` to the `lib` folder on your Raspberry Pi Pico.
|
6. Click [here](https://raw.githubusercontent.com/dbisu/pico-ducky/main/duckyinpython.py), press CTRL + S and save the file as `code.py` in the root of the Raspberry Pi Pico, overwriting the previous file.
|
||||||
|
|
||||||
7. Copy `adafruit_debouncer.mpy` and `adafruit_ticks.mpy` to the `lib` folder on your Raspberry Pi Pico.
|
7. Find a script [here](https://github.com/hak5darren/USB-Rubber-Ducky/wiki/Payloads) or [create your own one using Ducky Script](https://github.com/hak5darren/USB-Rubber-Ducky/wiki/Duckyscript) and save it as `payload.dd` in the Pico.
|
||||||
|
|
||||||
8. Copy `asyncio` to the `lib` folder on your Pico.
|
8. 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.
|
||||||
|
|
||||||
9. Copy `adafruit_wsgi` to the `lib` folder on your Pico.
|
### Setup mode
|
||||||
|
|
||||||
10. Copy `boot.py` from your clone to the root of your Pico.
|
|
||||||
|
|
||||||
11. Copy `duckyinpython.py`, `code.py`, `webapp.py`, `wsgiserver.py` to the root folder of the Pico.
|
|
||||||
|
|
||||||
12. *For Pico W Only* Create the file `secrets.py` in the root of the Pico W. This contains the AP name and password to be created by the Pico W.
|
|
||||||
`secrets = { 'ssid' : "BadAPName", 'password' : "badpassword" }`
|
|
||||||
|
|
||||||
13. 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 DuckyScript 1.0, not 3.0.
|
|
||||||
|
|
||||||
14. 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.
|
|
||||||
|
|
||||||
15. **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.
|
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 do so is by using a jumper wire between those pins as seen bellow.
|
The easiest way to so is by using a jumper wire between those pins as seen bellow.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## USB enable/disable mode
|
## Adding non-US keybaords
|
||||||
|
|
||||||
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`).
|
|
||||||
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.
|
|
||||||
|
|
||||||
Pico: The default mode is USB mass storage enabled.
|
|
||||||
Pico W: The default mode is USB mass storage **disabled**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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)
|
|
||||||
|
|
||||||
#### How to use one of these layouts with the pico-ducky repository.
|
|
||||||
|
|
||||||
**Go to the [latest release page](https://github.com/Neradoc/Circuitpython_Keyboard_Layouts/releases/latest), look if your language is in the list.**
|
|
||||||
|
|
||||||
#### If your language/layout is in the bundle
|
|
||||||
|
|
||||||
Download the `py` zip, named `circuitpython-keyboard-layouts-py-XXXXXXXX.zip`
|
|
||||||
|
|
||||||
**NOTE: You can use the mpy version targetting the version of Circuitpython that is on the device, but on Raspberry Pi Pico you don't need it - they only reduce file size and memory use on load, which the pico has plenty of.**
|
|
||||||
|
|
||||||
#### If your language/layout is not in the bundle
|
|
||||||
|
|
||||||
Try the online generator, it should get you a zip file with the bundles for yout language
|
|
||||||
|
|
||||||
https://www.neradoc.me/layouts/
|
|
||||||
|
|
||||||
#### Now you have a zip file
|
|
||||||
|
|
||||||
#### Find your language/layout in the lib directory
|
|
||||||
|
|
||||||
For a language `LANG`, copy the following files from the zip's `lib` folder to the `lib` directory of the board.
|
|
||||||
**DO NOT** modify the adafruit_hid directory. Your files go directly in `lib`.
|
|
||||||
**DO NOT** change the names or extensions of the files. Just pick the right ones.
|
|
||||||
Replace `LANG` with the letters for your language of choice.
|
|
||||||
|
|
||||||
- `keyboard_layout_win_LANG.py`
|
|
||||||
- `keycode_win_LANG.py`
|
|
||||||
|
|
||||||
Don't forget to get [the adafruit_hid library](https://github.com/adafruit/Adafruit_CircuitPython_HID/releases/latest).
|
|
||||||
|
|
||||||
This is what it should look like **if your language is French for example**.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Modify the pico-ducky code to use your language file:
|
|
||||||
|
|
||||||
At the start of the file comment out these lines:
|
|
||||||
|
|
||||||
```py
|
|
||||||
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS as KeyboardLayout
|
|
||||||
from adafruit_hid.keycode import Keycode
|
|
||||||
```
|
|
||||||
|
|
||||||
Uncomment these lines:
|
|
||||||
*Replace `LANG` with the letters for your language of choice. The name must match the file (without the py or mpy extension).*
|
|
||||||
```py
|
|
||||||
from keyboard_layout_win_LANG import KeyboardLayout
|
|
||||||
from keycode_win_LANG import Keycode
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Example: Set to German Keyboard (WIN_DE)
|
|
||||||
|
|
||||||
```py
|
|
||||||
from keyboard_layout_win_de import KeyboardLayout
|
|
||||||
from keycode_win_de import Keycode
|
|
||||||
```
|
|
||||||
|
|
||||||
Copy the files keyboard_layout_win_de.mpy and keycode_win_de.mpy to the /lib folder on the Pico board
|
|
||||||
```
|
|
||||||
adafruit_hid/
|
|
||||||
keyboard_layout_win_de.mpy
|
|
||||||
keycode_win_de.mpy
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
Instructions for adding non-US keyboards can be found [here](keyboard-layouts.md).
|
||||||
|
|
||||||
## Useful links and resources
|
## Useful links and resources
|
||||||
|
|
||||||
### How to recover your Pico if it becomes corrupted or doesn't boot.
|
|
||||||
|
|
||||||
[Reset Instructions](RESET.md)
|
|
||||||
|
|
||||||
### Installation Tool
|
|
||||||
|
|
||||||
[raspberrydeveloper](https://github.com/raspberrydeveloper) Created a tool to convert a blank RPi Pico to a ducky.
|
|
||||||
You can find the tool [here](https://github.com/raspberrydeveloper/pyducky)
|
|
||||||
|
|
||||||
### Docs
|
### Docs
|
||||||
|
|
||||||
[CircuitPython](https://circuitpython.readthedocs.io/en/6.3.x/README.html)
|
[CircuitPython](https://circuitpython.readthedocs.io/en/6.3.x/README.html)
|
||||||
|
|||||||
7
RESET.md
7
RESET.md
@@ -1,7 +0,0 @@
|
|||||||
# Instructions on how to reset a Raspberry Pi Pico
|
|
||||||
Follow these instructions if your Pico ends up in an odd state
|
|
||||||
|
|
||||||
1. Download the reset firmware from [flash_nuke.uf2](https://datasheets.raspberrypi.com/soft/flash_nuke.uf2)
|
|
||||||
2. While holding the BOOTSEL button on the Pico, plug in the USB cable to your computer.
|
|
||||||
3. When the RPI-RP2 drive shows up on your computer, copy the flash_nuke.uf2 file to the Pico
|
|
||||||
4. After the device reboots, follow the Install instructions [here](https://github.com/dbisu/pico-ducky/blob/main/README.md)
|
|
||||||
41
boot.py
41
boot.py
@@ -1,41 +0,0 @@
|
|||||||
# 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
|
|
||||||
|
|
||||||
noStorage = False
|
|
||||||
noStoragePin = digitalio.DigitalInOut(GP15)
|
|
||||||
noStoragePin.switch_to_input(pull=digitalio.Pull.UP)
|
|
||||||
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(noStorage == True):
|
|
||||||
# don't show USB drive to host PC
|
|
||||||
storage.disable_usb_drive()
|
|
||||||
print("Disabling USB drive")
|
|
||||||
else:
|
|
||||||
# normal boot
|
|
||||||
print("USB drive enabled")
|
|
||||||
85
code.py
85
code.py
@@ -1,85 +0,0 @@
|
|||||||
# License : GPLv2.0
|
|
||||||
# copyright (c) 2023 Dave Bailey
|
|
||||||
# Author: Dave Bailey (dbisu, @daveisu)
|
|
||||||
# Pico and Pico W board support
|
|
||||||
|
|
||||||
|
|
||||||
import supervisor
|
|
||||||
|
|
||||||
|
|
||||||
import time
|
|
||||||
import digitalio
|
|
||||||
from board import *
|
|
||||||
import board
|
|
||||||
import duckyinpython
|
|
||||||
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)
|
|
||||||
duckyinpython.fileToRun = 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))
|
|
||||||
script_task = asyncio.create_task(runScriptTask())
|
|
||||||
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, script_task)
|
|
||||||
else:
|
|
||||||
pico_led_task = asyncio.create_task(blink_pico_led(led))
|
|
||||||
await asyncio.gather(pico_led_task, button_task, script_task)
|
|
||||||
|
|
||||||
asyncio.run(main_loop())
|
|
||||||
277
duckyinpython.py
277
duckyinpython.py
@@ -1,70 +1,46 @@
|
|||||||
# License : GPLv2.0
|
|
||||||
# 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
|
import usb_hid
|
||||||
from adafruit_hid.keyboard import Keyboard
|
from adafruit_hid.keyboard import Keyboard
|
||||||
|
kblayout = "DE"
|
||||||
|
|
||||||
# comment out these lines for non_US keyboards
|
if kblayout == "DE":
|
||||||
|
from keyboard_layout_win_de import KeyboardLayout
|
||||||
|
from keycode_win_de import Keycode
|
||||||
|
elif kblayout == "BR":
|
||||||
|
from keyboard_layout_win_br import KeyboardLayout
|
||||||
|
from keycode_win_br import Keycode
|
||||||
|
else:
|
||||||
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS as KeyboardLayout
|
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS as KeyboardLayout
|
||||||
from adafruit_hid.keycode import Keycode
|
from adafruit_hid.keycode import Keycode
|
||||||
|
import time
|
||||||
|
import digitalio
|
||||||
|
from board import *
|
||||||
|
|
||||||
# uncomment these lines for non_US keyboards
|
duckyCommands = ["WINDOWS", "GUI", "APP", "MENU", "SHIFT", "ALT", "CONTROL", "CTRL", "DOWNARROW", "DOWN",
|
||||||
# replace LANG with appropriate language
|
"LEFTARROW", "LEFT", "RIGHTARROW", "RIGHT", "UPARROW", "UP", "BREAK", "PAUSE", "CAPSLOCK", "DELETE", "END",
|
||||||
#from keyboard_layout_win_LANG import KeyboardLayout
|
"ESC", "ESCAPE", "HOME", "INSERT", "NUMLOCK", "PAGEUP", "PAGEDOWN", "PRINTSCREEN", "SCROLLLOCK", "SPACE",
|
||||||
#from keycode_win_LANG import Keycode
|
"TAB", "ENTER", " a", " b", " c", " d", " e", " f", " g", " h", " i", " j", " k", " l", " m", " n", " o", " p", " q", " r", " s", " t",
|
||||||
|
" u", " v", " w", " x", " y", " z", " A", " B", " C", " D", " E", " F", " G", " H", " I", " J", " K", " L", " M", " N", " O", " P",
|
||||||
|
" Q", " R", " S", " T", " U", " V", " W", " X", " Y", " Z", "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12"]
|
||||||
|
|
||||||
duckyCommands = {
|
keycodeCommands = [Keycode.WINDOWS, Keycode.GUI, Keycode.APPLICATION, Keycode.APPLICATION, Keycode.SHIFT, Keycode.ALT, Keycode.CONTROL,
|
||||||
'WINDOWS': Keycode.WINDOWS, 'GUI': Keycode.GUI,
|
Keycode.CONTROL, Keycode.DOWN_ARROW, Keycode.DOWN_ARROW ,Keycode.LEFT_ARROW, Keycode.LEFT_ARROW, Keycode.RIGHT_ARROW, Keycode.RIGHT_ARROW,
|
||||||
'APP': Keycode.APPLICATION, 'MENU': Keycode.APPLICATION, 'SHIFT': Keycode.SHIFT,
|
Keycode.UP_ARROW, Keycode.UP_ARROW, Keycode.PAUSE, Keycode.PAUSE, Keycode.CAPS_LOCK, Keycode.DELETE, Keycode.END, Keycode.ESCAPE,
|
||||||
'ALT': Keycode.ALT, 'CONTROL': Keycode.CONTROL, 'CTRL': Keycode.CONTROL,
|
Keycode.ESCAPE, Keycode.HOME, Keycode.INSERT, Keycode.KEYPAD_NUMLOCK, Keycode.PAGE_UP, Keycode.PAGE_DOWN, Keycode.PRINT_SCREEN,
|
||||||
'DOWNARROW': Keycode.DOWN_ARROW, 'DOWN': Keycode.DOWN_ARROW, 'LEFTARROW': Keycode.LEFT_ARROW,
|
Keycode.SCROLL_LOCK, Keycode.SPACE, Keycode.TAB, Keycode.ENTER, Keycode.A, Keycode.B, Keycode.C, Keycode.D, Keycode.E, Keycode.F, Keycode.G,
|
||||||
'LEFT': Keycode.LEFT_ARROW, 'RIGHTARROW': Keycode.RIGHT_ARROW, 'RIGHT': Keycode.RIGHT_ARROW,
|
Keycode.H, Keycode.I, Keycode.J, Keycode.K, Keycode.L, Keycode.M, Keycode.N, Keycode.O, Keycode.P, Keycode.Q, Keycode.R, Keycode.S, Keycode.T,
|
||||||
'UPARROW': Keycode.UP_ARROW, 'UP': Keycode.UP_ARROW, 'BREAK': Keycode.PAUSE,
|
Keycode.U, Keycode.V, Keycode.W, Keycode.X, Keycode.Y, Keycode.Z, Keycode.A, Keycode.B, Keycode.C, Keycode.D, Keycode.E, Keycode.F,
|
||||||
'PAUSE': Keycode.PAUSE, 'CAPSLOCK': Keycode.CAPS_LOCK, 'DELETE': Keycode.DELETE,
|
Keycode.G, Keycode.H, Keycode.I, Keycode.J, Keycode.K, Keycode.L, Keycode.M, Keycode.N, Keycode.O, Keycode.P,
|
||||||
'END': Keycode.END, 'ESC': Keycode.ESCAPE, 'ESCAPE': Keycode.ESCAPE, 'HOME': Keycode.HOME,
|
Keycode.Q, Keycode.R, Keycode.S, Keycode.T, Keycode.U, Keycode.V, Keycode.W, Keycode.X, Keycode.Y, Keycode.Z,
|
||||||
'INSERT': Keycode.INSERT, 'NUMLOCK': Keycode.KEYPAD_NUMLOCK, 'PAGEUP': Keycode.PAGE_UP,
|
Keycode.F1, Keycode.F2, Keycode.F3, Keycode.F4, Keycode.F5, Keycode.F6, Keycode.F7, Keycode.F8, Keycode.F9,
|
||||||
'PAGEDOWN': Keycode.PAGE_DOWN, 'PRINTSCREEN': Keycode.PRINT_SCREEN, 'ENTER': Keycode.ENTER,
|
Keycode.F10, Keycode.F11, Keycode.F12]
|
||||||
'SCROLLLOCK': Keycode.SCROLL_LOCK, 'SPACE': Keycode.SPACE, 'TAB': Keycode.TAB,
|
|
||||||
'BACKSPACE': Keycode.BACKSPACE,
|
|
||||||
'A': Keycode.A, 'B': Keycode.B, 'C': Keycode.C, 'D': Keycode.D, 'E': Keycode.E,
|
|
||||||
'F': Keycode.F, 'G': Keycode.G, 'H': Keycode.H, 'I': Keycode.I, 'J': Keycode.J,
|
|
||||||
'K': Keycode.K, 'L': Keycode.L, 'M': Keycode.M, 'N': Keycode.N, 'O': Keycode.O,
|
|
||||||
'P': Keycode.P, 'Q': Keycode.Q, 'R': Keycode.R, 'S': Keycode.S, 'T': Keycode.T,
|
|
||||||
'U': Keycode.U, 'V': Keycode.V, 'W': Keycode.W, 'X': Keycode.X, 'Y': Keycode.Y,
|
|
||||||
'Z': Keycode.Z, 'F1': Keycode.F1, 'F2': Keycode.F2, 'F3': Keycode.F3,
|
|
||||||
'F4': Keycode.F4, 'F5': Keycode.F5, 'F6': Keycode.F6, 'F7': Keycode.F7,
|
|
||||||
'F8': Keycode.F8, 'F9': Keycode.F9, 'F10': Keycode.F10, 'F11': Keycode.F11,
|
|
||||||
'F12': Keycode.F12,
|
|
||||||
|
|
||||||
}
|
|
||||||
def convertLine(line):
|
def convertLine(line):
|
||||||
newline = []
|
newline = []
|
||||||
# print(line)
|
print(line)
|
||||||
# loop on each key - the filter removes empty values
|
for j in range(len(keycodeCommands)):
|
||||||
for key in filter(None, line.split(" ")):
|
if line.find(duckyCommands[j]) != -1:
|
||||||
key = key.upper()
|
newline.append(keycodeCommands[j])
|
||||||
# find the keycode for the command in the list
|
print(newline)
|
||||||
command_keycode = duckyCommands.get(key, None)
|
|
||||||
if command_keycode is not None:
|
|
||||||
# if it exists in the list, use it
|
|
||||||
newline.append(command_keycode)
|
|
||||||
elif hasattr(Keycode, key):
|
|
||||||
# if it's in the Keycode module, use it (allows any valid keycode)
|
|
||||||
newline.append(getattr(Keycode, key))
|
|
||||||
else:
|
|
||||||
# if it's not a known key name, show the error for diagnosis
|
|
||||||
print(f"Unknown key: <{key}>")
|
|
||||||
# print(newline)
|
|
||||||
return newline
|
return newline
|
||||||
|
|
||||||
def runScriptLine(line):
|
def runScriptLine(line):
|
||||||
@@ -76,27 +52,17 @@ def sendString(line):
|
|||||||
layout.write(line)
|
layout.write(line)
|
||||||
|
|
||||||
def parseLine(line):
|
def parseLine(line):
|
||||||
global defaultDelay
|
|
||||||
if(line[0:3] == "REM"):
|
if(line[0:3] == "REM"):
|
||||||
# ignore ducky script comments
|
# ignore ducky script comments
|
||||||
pass
|
pass
|
||||||
#elif(line[0:5] == "DELAY"):
|
elif(line[0:5] == "DELAY"):
|
||||||
# time.sleep(float(line[6:])/1000)
|
time.sleep(float(line[6:])/1000)
|
||||||
elif(line[0:6] == "STRING"):
|
elif(line[0:6] == "STRING"):
|
||||||
sendString(line[7:])
|
sendString(line[7:])
|
||||||
elif(line[0:5] == "PRINT"):
|
|
||||||
print("[SCRIPT]: " + line[6:])
|
|
||||||
elif(line[0:6] == "IMPORT"):
|
|
||||||
runScript(line[7:])
|
|
||||||
elif(line[0:13] == "DEFAULT_DELAY"):
|
elif(line[0:13] == "DEFAULT_DELAY"):
|
||||||
defaultDelay = int(line[14:]) * 10
|
defaultDelay = int(line[14:]) * 10
|
||||||
elif(line[0:12] == "DEFAULTDELAY"):
|
elif(line[0:12] == "DEFAULTDELAY"):
|
||||||
defaultDelay = int(line[13:]) * 10
|
defaultDelay = int(line[13:]) * 10
|
||||||
elif(line[0:3] == "LED"):
|
|
||||||
if(led.value == True):
|
|
||||||
led.value = False
|
|
||||||
else:
|
|
||||||
led.value = True
|
|
||||||
else:
|
else:
|
||||||
newScriptLine = convertLine(line)
|
newScriptLine = convertLine(line)
|
||||||
runScriptLine(newScriptLine)
|
runScriptLine(newScriptLine)
|
||||||
@@ -104,180 +70,35 @@ def parseLine(line):
|
|||||||
kbd = Keyboard(usb_hid.devices)
|
kbd = Keyboard(usb_hid.devices)
|
||||||
layout = KeyboardLayout(kbd)
|
layout = KeyboardLayout(kbd)
|
||||||
|
|
||||||
|
# sleep at the start to allow the device to be recognized by the host computer
|
||||||
|
time.sleep(.5)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#init button
|
|
||||||
button1_pin = DigitalInOut(GP22) # defaults to input
|
|
||||||
button1_pin.pull = Pull.UP # turn on internal pull-up resistor
|
|
||||||
button1 = Debouncer(button1_pin)
|
|
||||||
|
|
||||||
#init payload selection switch
|
|
||||||
payload1Pin = digitalio.DigitalInOut(GP4)
|
|
||||||
payload1Pin.switch_to_input(pull=digitalio.Pull.UP)
|
|
||||||
payload2Pin = digitalio.DigitalInOut(GP5)
|
|
||||||
payload2Pin.switch_to_input(pull=digitalio.Pull.UP)
|
|
||||||
payload3Pin = digitalio.DigitalInOut(GP10)
|
|
||||||
payload3Pin.switch_to_input(pull=digitalio.Pull.UP)
|
|
||||||
payload4Pin = digitalio.DigitalInOut(GP11)
|
|
||||||
payload4Pin.switch_to_input(pull=digitalio.Pull.UP)
|
|
||||||
|
|
||||||
def getProgrammingStatus():
|
|
||||||
# check GP0 for setup mode
|
# check GP0 for setup mode
|
||||||
# see setup mode for instructions
|
# see setup mode for instructions
|
||||||
|
progStatus = False
|
||||||
progStatusPin = digitalio.DigitalInOut(GP0)
|
progStatusPin = digitalio.DigitalInOut(GP0)
|
||||||
progStatusPin.switch_to_input(pull=digitalio.Pull.UP)
|
progStatusPin.switch_to_input(pull=digitalio.Pull.UP)
|
||||||
progStatus = not progStatusPin.value
|
progStatus = not progStatusPin.value
|
||||||
return(progStatus)
|
|
||||||
|
|
||||||
|
|
||||||
defaultDelay = 0
|
defaultDelay = 0
|
||||||
|
if(progStatus == False):
|
||||||
async def runScriptTask():
|
# not in setup mode, inject the payload
|
||||||
global defaultDelay, fileToRun
|
duckyScriptPath = "payload.dd"
|
||||||
print("starting runScript")
|
f = open(duckyScriptPath,"r",encoding='utf-8')
|
||||||
while True:
|
print("Running payload.dd")
|
||||||
#print("Checking for file", fileToRun)
|
|
||||||
if fileToRun is not None:
|
|
||||||
duckyScriptPath = fileToRun
|
|
||||||
print("starting",duckyScriptPath)
|
|
||||||
with open(duckyScriptPath,"r",encoding='utf-8') as f:
|
|
||||||
|
|
||||||
previousLine = ""
|
previousLine = ""
|
||||||
for line in f:
|
duckyScript = f.readlines()
|
||||||
|
for line in duckyScript:
|
||||||
line = line.rstrip()
|
line = line.rstrip()
|
||||||
if(line[0:6] == "REPEAT"):
|
if(line[0:6] == "REPEAT"):
|
||||||
for i in range(int(line[7:])):
|
for i in range(int(line[7:])):
|
||||||
#repeat the last command
|
#repeat the last command
|
||||||
parseLine(previousLine)
|
parseLine(previousLine)
|
||||||
await asyncio.sleep_ms(defaultDelay)
|
time.sleep(float(defaultDelay)/1000)
|
||||||
elif(line[0:5] == "DELAY"):
|
|
||||||
delay = int(line[6:])
|
|
||||||
#print("sleeping for ",delay)
|
|
||||||
#print(type(delay))
|
|
||||||
await asyncio.sleep_ms(delay)
|
|
||||||
previousLine = line
|
|
||||||
else:
|
else:
|
||||||
#print("parsing line", line)
|
|
||||||
parseLine(line)
|
parseLine(line)
|
||||||
previousLine = line
|
previousLine = line
|
||||||
#print("sleeping",defaultDelay)
|
time.sleep(float(defaultDelay)/1000)
|
||||||
await asyncio.sleep_ms(defaultDelay)
|
|
||||||
#print("done sleeping")
|
|
||||||
|
|
||||||
print("ending",duckyScriptPath)
|
|
||||||
|
|
||||||
fileToRun = None
|
|
||||||
await asyncio.sleep(1)
|
|
||||||
|
|
||||||
print("ending runScript")
|
|
||||||
|
|
||||||
def selectPayload():
|
|
||||||
global payload1Pin, payload2Pin, payload3Pin, payload4Pin
|
|
||||||
payload = "payload.dd"
|
|
||||||
# check switch status
|
|
||||||
# payload1 = GPIO4 to GND
|
|
||||||
# payload2 = GPIO5 to GND
|
|
||||||
# payload3 = GPIO10 to GND
|
|
||||||
# payload4 = GPIO11 to GND
|
|
||||||
payload1State = not payload1Pin.value
|
|
||||||
payload2State = not payload2Pin.value
|
|
||||||
payload3State = not payload3Pin.value
|
|
||||||
payload4State = not payload4Pin.value
|
|
||||||
|
|
||||||
if(payload1State == True):
|
|
||||||
payload = "payload.dd"
|
|
||||||
|
|
||||||
elif(payload2State == True):
|
|
||||||
payload = "payload2.dd"
|
|
||||||
|
|
||||||
elif(payload3State == True):
|
|
||||||
payload = "payload3.dd"
|
|
||||||
|
|
||||||
elif(payload4State == True):
|
|
||||||
payload = "payload4.dd"
|
|
||||||
|
|
||||||
else:
|
|
||||||
# if all pins are high, then no switch is present
|
|
||||||
# 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")
|
|
||||||
for i in range(100):
|
|
||||||
# PWM LED up and down
|
|
||||||
if i < 50:
|
|
||||||
led.duty_cycle = int(i * 2 * 65535 / 100) # Up
|
|
||||||
await asyncio.sleep(0.01)
|
|
||||||
led_state = False
|
|
||||||
else:
|
|
||||||
#led_pwm_down(led)
|
|
||||||
#print("led down")
|
|
||||||
for i in range(100):
|
|
||||||
# PWM LED up and down
|
|
||||||
if i >= 50:
|
|
||||||
led.duty_cycle = 65535 - int((i - 50) * 2 * 65535 / 100) # Down
|
|
||||||
await asyncio.sleep(0.01)
|
|
||||||
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, fileToRun
|
|
||||||
print("starting monitor_buttons")
|
|
||||||
button1Down = False
|
|
||||||
while True:
|
|
||||||
button1.update()
|
|
||||||
|
|
||||||
button1Pushed = button1.fell
|
|
||||||
button1Released = button1.rose
|
|
||||||
button1Held = not button1.value
|
|
||||||
|
|
||||||
if(button1Pushed):
|
|
||||||
print("Button 1 pushed")
|
|
||||||
button1Down = True
|
|
||||||
if(button1Released):
|
|
||||||
print("Button 1 released")
|
|
||||||
if(button1Down):
|
|
||||||
print("push and released")
|
|
||||||
|
|
||||||
if(button1Released):
|
|
||||||
if(button1Down):
|
|
||||||
# Run selected payload
|
|
||||||
payload = selectPayload()
|
|
||||||
print("Running ", payload)
|
|
||||||
#runScript(payload)
|
|
||||||
fileToRun = payload
|
|
||||||
print("Done")
|
print("Done")
|
||||||
button1Down = False
|
else:
|
||||||
|
print("Update your payload")
|
||||||
await asyncio.sleep(0)
|
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 2.1 MiB |
26
keyboard-layouts.md
Normal file
26
keyboard-layouts.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
## How to install non-US keyboard layouts
|
||||||
|
|
||||||
|
Clone Circuitpython_Keyboard_Layouts
|
||||||
|
`git clone https://github.com/Neradoc/Circuitpython_Keyboard_Layouts`
|
||||||
|
|
||||||
|
`cd Circuitpython_Keyboard_Layouts`
|
||||||
|
|
||||||
|
Install dependencies
|
||||||
|
`pip3 install -r requirements-modules.txt`
|
||||||
|
|
||||||
|
Install build dependencies
|
||||||
|
`pip3 install -r requirements-dev.txt`
|
||||||
|
|
||||||
|
Build layouts
|
||||||
|
`python3 build.py`
|
||||||
|
|
||||||
|
Copy libraries to pico
|
||||||
|
`cp _build/circuitpython-keyboard-layouts-6.x-mpy-<date>/lib/*.mpy /<Pico mount point>/lib`
|
||||||
|
|
||||||
|
Update duckyinpython.py
|
||||||
|
Change
|
||||||
|
`kblayout="US"`
|
||||||
|
to
|
||||||
|
`kblayout="<keyboard layout>"`
|
||||||
|
|
||||||
|
Update `if kblayout ==` block to include the new keyboard layout if not already included
|
||||||
246
webapp.py
246
webapp.py
@@ -1,246 +0,0 @@
|
|||||||
# License : GPLv2.0
|
|
||||||
# copyright (c) 2023 Dave Bailey
|
|
||||||
# Author: Dave Bailey (dbisu, @daveisu)
|
|
||||||
# FeatherS2 board support
|
|
||||||
|
|
||||||
import socketpool
|
|
||||||
import time
|
|
||||||
import os
|
|
||||||
import storage
|
|
||||||
|
|
||||||
import wsgiserver as server
|
|
||||||
from adafruit_wsgi.wsgi_app import WSGIApp
|
|
||||||
import wifi
|
|
||||||
|
|
||||||
import duckyinpython
|
|
||||||
from duckyinpython import *
|
|
||||||
|
|
||||||
payload_html = """<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head> <title>Pico W Ducky</title> </head>
|
|
||||||
<body> <h1>Pico W Ducky</h1>
|
|
||||||
<table border="1"> <tr><th>Payload</th><th>Actions</th></tr> {} </table>
|
|
||||||
<br>
|
|
||||||
<a href="/new">New Script</a>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
"""
|
|
||||||
|
|
||||||
edit_html = """<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>Script Editor</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<form action="/write/{}" method="POST">
|
|
||||||
<textarea rows="5" cols="60" name="scriptData">{}</textarea>
|
|
||||||
<br/>
|
|
||||||
<input type="submit" value="submit"/>
|
|
||||||
</form>
|
|
||||||
<br>
|
|
||||||
<a href="/ducky">Home</a>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
"""
|
|
||||||
|
|
||||||
new_html = """<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>New Script</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<form action="/new" method="POST">
|
|
||||||
Script Name<br>
|
|
||||||
<textarea rows="1" cols="60" name="scriptName"></textarea>
|
|
||||||
Script<br>
|
|
||||||
<textarea rows="5" cols="60" name="scriptData"></textarea>
|
|
||||||
<br/>
|
|
||||||
<input type="submit" value="submit"/>
|
|
||||||
</form>
|
|
||||||
<br>
|
|
||||||
<a href="/ducky">Home</a>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
"""
|
|
||||||
|
|
||||||
response_html = """<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head> <title>Pico W Ducky</title> </head>
|
|
||||||
<body> <h1>Pico W Ducky</h1>
|
|
||||||
{}
|
|
||||||
<br>
|
|
||||||
<a href="/ducky">Home</a>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
"""
|
|
||||||
|
|
||||||
newrow_html = "<tr><td>{}</td><td><a href='/edit/{}'>Edit</a> / <a href='/run/{}'>Run</a></tr>"
|
|
||||||
|
|
||||||
def setPayload(payload_number):
|
|
||||||
if(payload_number == 1):
|
|
||||||
payload = "payload.dd"
|
|
||||||
|
|
||||||
else:
|
|
||||||
payload = "payload"+str(payload_number)+".dd"
|
|
||||||
|
|
||||||
return(payload)
|
|
||||||
|
|
||||||
|
|
||||||
def ducky_main(request):
|
|
||||||
print("Ducky main")
|
|
||||||
payloads = []
|
|
||||||
rows = ""
|
|
||||||
files = os.listdir()
|
|
||||||
#print(files)
|
|
||||||
for f in files:
|
|
||||||
if ('.dd' in f) == True:
|
|
||||||
payloads.append(f)
|
|
||||||
newrow = newrow_html.format(f,f,f)
|
|
||||||
#print(newrow)
|
|
||||||
rows = rows + newrow
|
|
||||||
|
|
||||||
response = payload_html.format(rows)
|
|
||||||
|
|
||||||
return(response)
|
|
||||||
|
|
||||||
_hexdig = '0123456789ABCDEFabcdef'
|
|
||||||
_hextobyte = None
|
|
||||||
|
|
||||||
def cleanup_text(string):
|
|
||||||
"""unquote('abc%20def') -> b'abc def'."""
|
|
||||||
global _hextobyte
|
|
||||||
|
|
||||||
if not string:
|
|
||||||
return b''
|
|
||||||
|
|
||||||
if isinstance(string, str):
|
|
||||||
string = string.encode('utf-8')
|
|
||||||
|
|
||||||
bits = string.split(b'%')
|
|
||||||
if len(bits) == 1:
|
|
||||||
return string
|
|
||||||
|
|
||||||
res = [bits[0]]
|
|
||||||
append = res.append
|
|
||||||
|
|
||||||
if _hextobyte is None:
|
|
||||||
_hextobyte = {(a + b).encode(): bytes([int(a + b, 16)])
|
|
||||||
for a in _hexdig for b in _hexdig}
|
|
||||||
|
|
||||||
for item in bits[1:]:
|
|
||||||
try:
|
|
||||||
append(_hextobyte[item[:2]])
|
|
||||||
append(item[2:])
|
|
||||||
except KeyError:
|
|
||||||
append(b'%')
|
|
||||||
append(item)
|
|
||||||
|
|
||||||
return b''.join(res).decode().replace('+',' ')
|
|
||||||
|
|
||||||
web_app = WSGIApp()
|
|
||||||
|
|
||||||
@web_app.route("/ducky")
|
|
||||||
def duck_main(request):
|
|
||||||
response = ducky_main(request)
|
|
||||||
return("200 OK", [('Content-Type', 'text/html')], response)
|
|
||||||
|
|
||||||
@web_app.route("/edit/<filename>")
|
|
||||||
def edit(request, filename):
|
|
||||||
print("Editing ", filename)
|
|
||||||
f = open(filename,"r",encoding='utf-8')
|
|
||||||
textbuffer = ''
|
|
||||||
for line in f:
|
|
||||||
textbuffer = textbuffer + line
|
|
||||||
f.close()
|
|
||||||
response = edit_html.format(filename,textbuffer)
|
|
||||||
#print(response)
|
|
||||||
|
|
||||||
return("200 OK",[('Content-Type', 'text/html')], response)
|
|
||||||
|
|
||||||
@web_app.route("/write/<filename>",methods=["POST"])
|
|
||||||
def write_script(request, filename):
|
|
||||||
|
|
||||||
data = request.body.getvalue()
|
|
||||||
fields = data.split("&")
|
|
||||||
form_data = {}
|
|
||||||
for field in fields:
|
|
||||||
key,value = field.split('=')
|
|
||||||
form_data[key] = value
|
|
||||||
|
|
||||||
#print(form_data)
|
|
||||||
storage.remount("/",readonly=False)
|
|
||||||
f = open(filename,"w",encoding='utf-8')
|
|
||||||
textbuffer = form_data['scriptData']
|
|
||||||
textbuffer = cleanup_text(textbuffer)
|
|
||||||
#print(textbuffer)
|
|
||||||
for line in textbuffer:
|
|
||||||
f.write(line)
|
|
||||||
f.close()
|
|
||||||
storage.remount("/",readonly=True)
|
|
||||||
response = response_html.format("Wrote script " + filename)
|
|
||||||
return("200 OK",[('Content-Type', 'text/html')], response)
|
|
||||||
|
|
||||||
@web_app.route("/new",methods=['GET','POST'])
|
|
||||||
def write_new_script(request):
|
|
||||||
response = ''
|
|
||||||
if(request.method == 'GET'):
|
|
||||||
response = new_html
|
|
||||||
else:
|
|
||||||
data = request.body.getvalue()
|
|
||||||
fields = data.split("&")
|
|
||||||
form_data = {}
|
|
||||||
for field in fields:
|
|
||||||
key,value = field.split('=')
|
|
||||||
form_data[key] = value
|
|
||||||
#print(form_data)
|
|
||||||
filename = form_data['scriptName']
|
|
||||||
textbuffer = form_data['scriptData']
|
|
||||||
textbuffer = cleanup_text(textbuffer)
|
|
||||||
storage.remount("/",readonly=False)
|
|
||||||
f = open(filename,"w",encoding='utf-8')
|
|
||||||
for line in textbuffer:
|
|
||||||
f.write(line)
|
|
||||||
f.close()
|
|
||||||
storage.remount("/",readonly=True)
|
|
||||||
response = response_html.format("Wrote script " + filename)
|
|
||||||
return("200 OK",[('Content-Type', 'text/html')], response)
|
|
||||||
|
|
||||||
@web_app.route("/run/<filename>")
|
|
||||||
def run_script(request, filename):
|
|
||||||
print("run_script ", filename)
|
|
||||||
response = response_html.format("Running script " + filename)
|
|
||||||
#print(response)
|
|
||||||
#runScript(filename)
|
|
||||||
duckyinpython.fileToRun = filename
|
|
||||||
return("200 OK",[('Content-Type', 'text/html')], response)
|
|
||||||
|
|
||||||
@web_app.route("/")
|
|
||||||
def index(request):
|
|
||||||
response = ducky_main(request)
|
|
||||||
return("200 OK", [('Content-Type', 'text/html')], response)
|
|
||||||
|
|
||||||
@web_app.route("/api/run/<filenumber>")
|
|
||||||
def run_script(request, filenumber):
|
|
||||||
filename = setPayload(int(filenumber))
|
|
||||||
print("run_script ", filenumber)
|
|
||||||
response = response_html.format("Running script " + filename)
|
|
||||||
#print(response)
|
|
||||||
#runScript(filename)
|
|
||||||
duckyinpython.fileToRun = filename
|
|
||||||
return("200 OK",[('Content-Type', 'text/html')], response)
|
|
||||||
|
|
||||||
async def startWebService():
|
|
||||||
|
|
||||||
HOST = repr(wifi.radio.ipv4_address_ap)
|
|
||||||
PORT = 80 # Port to listen on
|
|
||||||
print(HOST,PORT)
|
|
||||||
|
|
||||||
wsgiServer = server.WSGIServer(80, application=web_app)
|
|
||||||
|
|
||||||
print(f"open this IP in your browser: http://{HOST}:{PORT}/")
|
|
||||||
|
|
||||||
# Start the server
|
|
||||||
wsgiServer.start()
|
|
||||||
while True:
|
|
||||||
wsgiServer.update_poll()
|
|
||||||
await asyncio.sleep(0)
|
|
||||||
286
wsgiserver.py
286
wsgiserver.py
@@ -1,286 +0,0 @@
|
|||||||
# SPDX-FileCopyrightText: Copyright (c) 2019 Matt Costi for Adafruit Industries
|
|
||||||
#
|
|
||||||
# SPDX-License-Identifier: MIT
|
|
||||||
|
|
||||||
"""
|
|
||||||
`adafruit_esp32spi_wsgiserver`
|
|
||||||
================================================================================
|
|
||||||
|
|
||||||
A simple WSGI (Web Server Gateway Interface) server that interfaces with the ESP32 over SPI.
|
|
||||||
Opens a specified port on the ESP32 to listen for incoming HTTP Requests and
|
|
||||||
Accepts an Application object that must be callable, which gets called
|
|
||||||
whenever a new HTTP Request has been received.
|
|
||||||
|
|
||||||
The Application MUST accept 2 ordered parameters:
|
|
||||||
1. environ object (incoming request data)
|
|
||||||
2. start_response function. Must be called before the Application
|
|
||||||
callable returns, in order to set the response status and headers.
|
|
||||||
|
|
||||||
The Application MUST return a single string in a list,
|
|
||||||
which is the response data
|
|
||||||
|
|
||||||
Requires update_poll being called in the applications main event loop.
|
|
||||||
|
|
||||||
For more details about Python WSGI see:
|
|
||||||
https://www.python.org/dev/peps/pep-0333/
|
|
||||||
|
|
||||||
* Author(s): Matt Costi
|
|
||||||
"""
|
|
||||||
# pylint: disable=no-name-in-module
|
|
||||||
|
|
||||||
import io
|
|
||||||
import gc
|
|
||||||
from micropython import const
|
|
||||||
import socketpool
|
|
||||||
import wifi
|
|
||||||
|
|
||||||
class BadRequestError(Exception):
|
|
||||||
"""Raised when the client sends an unexpected empty line"""
|
|
||||||
pass
|
|
||||||
|
|
||||||
_BUFFER_SIZE = 32
|
|
||||||
buffer = bytearray(_BUFFER_SIZE)
|
|
||||||
def readline(socketin):
|
|
||||||
"""
|
|
||||||
Implement readline() for native wifi using recv_into
|
|
||||||
"""
|
|
||||||
data_string = b""
|
|
||||||
while True:
|
|
||||||
try:
|
|
||||||
num = socketin.recv_into(buffer, 1)
|
|
||||||
data_string += str(buffer, 'utf8')[:num]
|
|
||||||
if num == 0:
|
|
||||||
return data_string
|
|
||||||
if data_string[-2:] == b"\r\n":
|
|
||||||
return data_string[:-2]
|
|
||||||
except OSError as ex:
|
|
||||||
# if ex.errno == 9: # [Errno 9] EBADF
|
|
||||||
# return None
|
|
||||||
if ex.errno == 11: # [Errno 11] EAGAIN
|
|
||||||
continue
|
|
||||||
raise
|
|
||||||
|
|
||||||
|
|
||||||
def read(socketin,length = -1):
|
|
||||||
total = 0
|
|
||||||
data_string = b""
|
|
||||||
try:
|
|
||||||
if length > 0:
|
|
||||||
while total < length:
|
|
||||||
reste = length - total
|
|
||||||
num = socketin.recv_into(buffer, min(_BUFFER_SIZE, reste))
|
|
||||||
#
|
|
||||||
if num == 0:
|
|
||||||
# timeout
|
|
||||||
# raise OSError(110)
|
|
||||||
return data_string
|
|
||||||
#
|
|
||||||
data_string += buffer[:num]
|
|
||||||
total = total + num
|
|
||||||
return data_string
|
|
||||||
else:
|
|
||||||
while True:
|
|
||||||
num = socketin.recv_into(buffer, 1)
|
|
||||||
data_string += str(buffer, 'utf8')[:num]
|
|
||||||
if num == 0:
|
|
||||||
return data_string
|
|
||||||
except OSError as ex:
|
|
||||||
if ex.errno == 11: # [Errno 11] EAGAIN
|
|
||||||
return data_string
|
|
||||||
raise
|
|
||||||
|
|
||||||
def parse_headers(sock):
|
|
||||||
"""
|
|
||||||
Parses the header portion of an HTTP request/response from the socket.
|
|
||||||
Expects first line of HTTP request/response to have been read already
|
|
||||||
return: header dictionary
|
|
||||||
rtype: Dict
|
|
||||||
"""
|
|
||||||
headers = {}
|
|
||||||
while True:
|
|
||||||
line = readline(sock)
|
|
||||||
if not line or line == b"\r\n":
|
|
||||||
break
|
|
||||||
|
|
||||||
#print("**line: ", line)
|
|
||||||
title, content = line.split(b': ', 1)
|
|
||||||
if title and content:
|
|
||||||
title = str(title.lower(), 'utf-8')
|
|
||||||
content = str(content, 'utf-8')
|
|
||||||
headers[title] = content
|
|
||||||
return headers
|
|
||||||
|
|
||||||
|
|
||||||
pool = socketpool.SocketPool(wifi.radio)
|
|
||||||
|
|
||||||
NO_SOCK_AVAIL = const(255)
|
|
||||||
|
|
||||||
# pylint: disable=invalid-name
|
|
||||||
class WSGIServer:
|
|
||||||
"""
|
|
||||||
A simple server that implements the WSGI interface
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, port=80, debug=False, application=None):
|
|
||||||
self.application = application
|
|
||||||
self.port = port
|
|
||||||
self._server_sock = None
|
|
||||||
self._client_sock = None
|
|
||||||
self._debug = debug
|
|
||||||
|
|
||||||
self._response_status = None
|
|
||||||
self._response_headers = []
|
|
||||||
|
|
||||||
def start(self):
|
|
||||||
"""
|
|
||||||
starts the server and begins listening for incoming connections.
|
|
||||||
Call update_poll in the main loop for the application callable to be
|
|
||||||
invoked on receiving an incoming request.
|
|
||||||
"""
|
|
||||||
self._server_sock = pool.socket(pool.AF_INET,pool.SOCK_STREAM)
|
|
||||||
HOST = repr(wifi.radio.ipv4_address_ap)
|
|
||||||
self._server_sock.bind((repr(wifi.radio.ipv4_address_ap), self.port))
|
|
||||||
self._server_sock.listen(1)
|
|
||||||
# if self._debug:
|
|
||||||
# ip = _the_interface.pretty_ip(_the_interface.ip_address)
|
|
||||||
# print("Server available at {0}:{1}".format(ip, self.port))
|
|
||||||
# print(
|
|
||||||
# "Sever status: ",
|
|
||||||
# _the_interface.get_server_state(self._server_sock.socknum),
|
|
||||||
# )
|
|
||||||
|
|
||||||
def pretty_ip(self):
|
|
||||||
return f"http://{wifi.radio.ipv4_address_ap}:{self.port}"
|
|
||||||
|
|
||||||
def update_poll(self):
|
|
||||||
"""
|
|
||||||
Call this method inside your main event loop to get the server
|
|
||||||
check for new incoming client requests. When a request comes in,
|
|
||||||
the application callable will be invoked.
|
|
||||||
"""
|
|
||||||
self.client_available()
|
|
||||||
if self._client_sock:
|
|
||||||
try:
|
|
||||||
environ = self._get_environ(self._client_sock)
|
|
||||||
result = self.application(environ, self._start_response)
|
|
||||||
self.finish_response(result)
|
|
||||||
except BadRequestError:
|
|
||||||
self._start_response("400 Bad Request", [])
|
|
||||||
self.finish_response([])
|
|
||||||
|
|
||||||
def finish_response(self, result):
|
|
||||||
"""
|
|
||||||
Called after the application callbile returns result data to respond with.
|
|
||||||
Creates the HTTP Response payload from the response_headers and results data,
|
|
||||||
and sends it back to client.
|
|
||||||
|
|
||||||
:param string result: the data string to send back in the response to the client.
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
response = "HTTP/1.1 {0}\r\n".format(self._response_status)
|
|
||||||
for header in self._response_headers:
|
|
||||||
response += "{0}: {1}\r\n".format(*header)
|
|
||||||
response += "\r\n"
|
|
||||||
self._client_sock.send(response.encode("utf-8"))
|
|
||||||
for data in result:
|
|
||||||
if isinstance(data, str):
|
|
||||||
data = data.encode("utf-8")
|
|
||||||
elif not isinstance(data, bytes):
|
|
||||||
data = str(data).encode("utf-8")
|
|
||||||
bytes_sent = 0
|
|
||||||
while bytes_sent < len(data):
|
|
||||||
try:
|
|
||||||
bytes_sent += self._client_sock.send(data[bytes_sent:])
|
|
||||||
except OSError as ex:
|
|
||||||
if ex.errno != 11: # [Errno 11] EAGAIN
|
|
||||||
raise
|
|
||||||
gc.collect()
|
|
||||||
except OSError as ex:
|
|
||||||
if ex.errno != 104: # [Errno 104] ECONNRESET
|
|
||||||
raise
|
|
||||||
finally:
|
|
||||||
#print("closing")
|
|
||||||
self._client_sock.close()
|
|
||||||
self._client_sock = None
|
|
||||||
|
|
||||||
def client_available(self):
|
|
||||||
"""
|
|
||||||
returns a client socket connection if available.
|
|
||||||
Otherwise, returns None
|
|
||||||
:return: the client
|
|
||||||
:rtype: Socket
|
|
||||||
"""
|
|
||||||
sock = None
|
|
||||||
if not self._server_sock:
|
|
||||||
print("Server has not been started, cannot check for clients!")
|
|
||||||
elif not self._client_sock:
|
|
||||||
self._server_sock.setblocking(False)
|
|
||||||
try:
|
|
||||||
self._client_sock, addr = self._server_sock.accept()
|
|
||||||
except OSError as ex:
|
|
||||||
if ex.errno != 11: # [Errno 11] EAGAIN
|
|
||||||
raise
|
|
||||||
|
|
||||||
return None
|
|
||||||
|
|
||||||
def _start_response(self, status, response_headers):
|
|
||||||
"""
|
|
||||||
The application callable will be given this method as the second param
|
|
||||||
This is to be called before the application callable returns, to signify
|
|
||||||
the response can be started with the given status and headers.
|
|
||||||
|
|
||||||
:param string status: a status string including the code and reason. ex: "200 OK"
|
|
||||||
:param list response_headers: a list of tuples to represent the headers.
|
|
||||||
ex ("header-name", "header value")
|
|
||||||
"""
|
|
||||||
self._response_status = status
|
|
||||||
self._response_headers = [("Server", "esp32WSGIServer")] + response_headers
|
|
||||||
|
|
||||||
def _get_environ(self, client):
|
|
||||||
"""
|
|
||||||
The application callable will be given the resulting environ dictionary.
|
|
||||||
It contains metadata about the incoming request and the request body ("wsgi.input")
|
|
||||||
|
|
||||||
:param Socket client: socket to read the request from
|
|
||||||
"""
|
|
||||||
env = {}
|
|
||||||
line = readline(client).decode("utf-8")
|
|
||||||
try:
|
|
||||||
(method, path, ver) = line.rstrip("\r\n").split(None, 2)
|
|
||||||
except ValueError:
|
|
||||||
raise BadRequestError("Unknown request from client.")
|
|
||||||
|
|
||||||
env["wsgi.version"] = (1, 0)
|
|
||||||
env["wsgi.url_scheme"] = "http"
|
|
||||||
env["wsgi.multithread"] = False
|
|
||||||
env["wsgi.multiprocess"] = False
|
|
||||||
env["wsgi.run_once"] = False
|
|
||||||
|
|
||||||
env["REQUEST_METHOD"] = method
|
|
||||||
env["SCRIPT_NAME"] = ""
|
|
||||||
env["SERVER_NAME"] = str(wifi.radio.ipv4_address_ap)
|
|
||||||
env["SERVER_PROTOCOL"] = ver
|
|
||||||
env["SERVER_PORT"] = self.port
|
|
||||||
if path.find("?") >= 0:
|
|
||||||
env["PATH_INFO"] = path.split("?")[0]
|
|
||||||
env["QUERY_STRING"] = path.split("?")[1]
|
|
||||||
else:
|
|
||||||
env["PATH_INFO"] = path
|
|
||||||
|
|
||||||
headers = parse_headers(client)
|
|
||||||
if "content-type" in headers:
|
|
||||||
env["CONTENT_TYPE"] = headers.get("content-type")
|
|
||||||
if "content-length" in headers:
|
|
||||||
env["CONTENT_LENGTH"] = headers.get("content-length")
|
|
||||||
body = read(client, int(env["CONTENT_LENGTH"]))
|
|
||||||
env["wsgi.input"] = io.StringIO(body)
|
|
||||||
else:
|
|
||||||
body = read(client)
|
|
||||||
env["wsgi.input"] = io.StringIO(body)
|
|
||||||
for name, value in headers.items():
|
|
||||||
key = "HTTP_" + name.replace("-", "_").upper()
|
|
||||||
if key in env:
|
|
||||||
value = "{0},{1}".format(env[key], value)
|
|
||||||
env[key] = value
|
|
||||||
|
|
||||||
return env
|
|
||||||
Reference in New Issue
Block a user