hak5
/
usbrubberducky-payloads
mirror of https://github.com/hak5/usbrubberducky-payloads.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #204 from pirxthepilot/piano_player 

Piano player payload generator
pull/210/head
Dallas Winger 2023-01-10 20:21:37 -05:00 committed by GitHub
parent efc5dc983d 148e5e49ff
commit 879632e211
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 3434 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
payloads/library/general/Piano_Player/README.md Normal file
View File

@ -0,0 +1,112 @@
# Hak5 USB Rubber Ducky Piano Player
Script that converts music notation written in tracker-like style into payload code for the Hak5 USB Rubber Ducky
* **[Demo video!](https://hachyderm.io/@pirx/109641159141747124)**
## Usage
Runs on Python 3.x.
```
usage: piano_player.py [-h] [-p] NOTES_FILE PAYLOAD_FILE
positional arguments:
NOTES_FILE Path to notes file
PAYLOAD_FILE Save payload code to this file
optional arguments:
-h, --help show this help message and exit
-p, --press-mode Deploy with press mode
```
Example:
```
$ python3 piano_player.py notes.txt payload.txt
```
First, create the notes file. Then run the tool which creates the payload code file. You can then copy and paste that code into the HAK5 [payload encoder](https://encoder.hak5.org).
See example notes and payload files in the [examples](./examples/) directory.
## Notes file format
The notes file looks like this:
```
50ms
https://www.onlinepianist.com/virtual-piano
c-3=q c#3=2 d-3=w d#3=3 e-3=e f-3=r f#3=5 g-3=t g#3=6 a-3=y a#3=7 b-3=u c-4=i c#4=9 d-4=o d#4=0 e-4=p f-4=z f#4=s g-4=x g#4=d a-4=c a#4=f b-4=v c-5=b c#5=h d-5=n d#5=j e-5=m f-5=, f#5=l g-5=. g#5=; a-5=/ a#5='
d-3 f#3 e-5
d-3 f#3 e-5
--- --- ---
d-3 f#3 e-5
--- --- ---
d-3 f#3 c-5
d-3 f#3 e-5
--- --- ---
g-3 b-3 g-5
--- --- ---
--- --- ---
--- --- ---
g-3 --- g-4
```
* Line 1: Tick duration (more on this later)
* Line 2: URL of the piano (or other virtual instrument) app
* Line 3: Space-separated note maps. Left hand side is the actual note, right hand is the corresponding keyboard keypress
* Line 4: Leave blank
* Line 5 until end: Notes and rests in tracker-like notation
### About the tracker-like notation
I thought an easy way to write music is something reminiscent of [tracker interface](https://en.wikipedia.org/wiki/Music_tracker) where notes are played by rows. All notes in the same row are played "simultaneously" (or in this case, gives the illusion that it is).
Each row plays at approximately the tick duration (there will be some accumulated delay depending on number of keys held at the same time, etc.).
You would typically make one row equivalent to the duration of a 16th note in your piece, but this is by no means the rule.
The tracker can have one or more columns ("tracks"), but I have only tested it with up to three. Four or more might introduce significant enough delays to make the tempo unstable.
Each element in the tracker is three characters long. A natural note looks like `d-3` and a sharp `d#3`. Flats can be used too as long as it's declared in the note maps.
A rest is represented as `---`.
There should always be **two spaces** between notes or rests in the same row.
For a very simple example, this is the first two bars of _Twinkle, Twinkle, Little Star_:
```
c-4
c-4
g-4
g-4
a-4
a-4
g-4
---
```
In this case each row is equivalent to a quarter note.
## Payload Behavior
### Press mode OFF (default)
By default, the generated payload works as such:
1. Insert rubber ducky into USB port
2. Default browser is opened and navigates to the piano webapp URL specified in the notes file
3. Rubber ducky plays the piano
### Press mode ON
When press mode is enabled (`-p` or `--press-mode` flag), the rubber ducky does not open a browser nor go to the piano webapp URL automatically upon insertion. Instead, the note sequence starts playing only when the rubber ducky button is pressed.
The linked demo video above is operating in press mode.

233
payloads/library/general/Piano_Player/examples/game_of_thrones_notes.txt Normal file
View File

@ -0,0 +1,233 @@
65ms
https://www.onlinepianist.com/virtual-piano
c-3=q c#3=2 d-3=w d#3=3 e-3=e f-3=r f#3=5 g-3=t g#3=6 a-3=y a#3=7 b-3=u c-4=i c#4=9 d-4=o d#4=0 e-4=p f-4=z f#4=s g-4=x g#4=d a-4=c a#4=f b-4=v c-5=b c#5=h d-5=n d#5=j e-5=m f-5=, f#5=l g-5=. g#5=; a-5=/ a#5='
c-3 g-3 g-5
--- --- ---
--- --- c-5
--- --- ---
--- --- d#5
--- --- f-5
c-3 g-3 g-5
--- --- ---
--- --- c-5
--- --- ---
--- --- e-5
--- --- f-5
c-3 g-3 g-5
--- --- ---
--- --- c-5
--- --- ---
--- --- e-5
--- --- f-5
c-3 g-3 g-5
--- --- ---
--- --- c-5
--- --- ---
--- --- e-5
--- --- f-5
c-3 g-3 g-4
--- --- ---
--- --- ---
--- --- ---
--- --- ---
--- --- ---
c-3 g-3 c-4
--- --- ---
--- --- ---
--- --- ---
--- --- ---
--- --- ---
c-3 g-3 d#4
--- --- f-4
--- --- g-4
--- --- ---
--- --- ---
--- --- ---
c-3 g-3 c-4
--- --- ---
--- --- ---
--- --- ---
--- --- d#4
--- --- f-4
d-3 g-3 d-5
--- --- ---
--- --- g-4
--- --- ---
--- --- a#4
--- --- c-5
d-3 g-3 d-5
--- --- ---
--- --- g-4
--- --- ---
--- --- a#4
--- --- c-5
d-3 g-3 d-5
--- --- ---
--- --- g-4
--- --- ---
--- --- a#4
--- --- c-5
d-3 g-3 d-5
--- --- ---
d-3 g-3 g-4
--- --- ---
d-3 g-3 a#4
--- --- ---
f-3 a#3 f-4
--- --- ---
--- --- ---
--- --- ---
--- --- ---
--- --- ---
d-3 f-3 a#3
--- --- ---
--- --- ---
--- --- ---
--- --- ---
--- --- ---
f-3 a#3 d#4
--- --- d-4
--- --- f-4
--- --- ---
--- --- ---
--- --- ---
d-3 f-3 a#3
--- --- ---
--- --- ---
--- --- ---
--- --- d#4
--- --- d-4
c-3 f-3 c-5
--- --- ---
--- --- f-4
--- --- ---
--- --- g#4
--- --- a#4
c-3 f-3 c-5
--- --- ---
--- --- f-4
--- --- ---
--- --- g#4
--- --- a#4
c-3 f-3 c-5
--- --- ---
--- --- f-4
--- --- ---
--- --- g#4
--- --- a#4
c-3 f-3 c-5
--- --- ---
c-3 f-3 f-4
--- --- ---
c-3 f-3 g#4
--- --- ---
d#3 g#3 c-5
--- --- ---
--- --- d#4
--- --- ---
d#3 g#3 g#4
--- --- a#4
d#3 g#3 c-5
--- --- ---
--- --- d#4
--- --- ---
d#3 g#3 a#4
--- --- c-5
d#3 a#3 a#4
--- --- ---
--- --- d#4
--- --- ---
d#3 a#3 g-4
--- --- g#4
d#3 a#3 a#4
--- --- ---
--- --- d#4
--- --- ---
d#3 a#3 g#4
--- --- a#4
c-3 f-3 g#4
--- --- ---
--- --- c-4
--- --- ---
c-3 f-3 f-4
--- --- g-4
c-3 f-3 g#4
--- --- ---
--- --- c-4
--- --- ---
c-3 f-3 g-4
--- --- g#4
c-3 g-3 g-4
--- --- ---
--- --- c-4
--- --- ---
c-3 g-3 d#4
--- --- f-4
c-3 g-3 g-4
--- --- ---
--- --- c-4
--- --- ---
c-3 g-3 d#4
--- --- f-4
d#3 g#3 d#5
--- --- ---
--- --- g#4
--- --- ---
d#3 g#3 c-5
--- --- d-5
d#3 g#3 d#5
--- --- ---
--- --- g#4
--- --- ---
d#3 g#3 c-5
--- --- d#5
d-3 g-3 d-5
--- --- ---
--- --- g-4
--- --- ---
d-3 g-3 a#4
--- --- ---
d-3 g-3 d-5
--- --- ---
--- --- d-5
--- --- ---
d-3 g-3 a#4
--- --- ---
c-3 g-3 c-5
--- --- ---
--- --- g-4
--- --- ---
c-3 g-3 g#4
--- --- a#4
c-3 g-3 c-5
--- --- ---
--- --- g-4
--- --- ---
c-3 g-3 g#4
--- --- a#4
c-3 g-3 c-5
--- --- ---
--- --- g-4
--- --- ---
c-3 g-3 g#4
--- --- a#4
c-3 g-3 c-5
--- --- ---
c-3 g-3 g-4
--- --- ---
c-3 g-3 g#4
--- --- a#4
--- --- c-5
--- --- ---
--- --- g-4
--- --- ---
--- --- g#4
--- --- a#4
--- --- c-5
--- --- ---
--- --- g-4
--- --- ---
--- --- g#4
--- --- a#4
--- --- c-5

1177
payloads/library/general/Piano_Player/examples/game_of_thrones_payload.txt Normal file
View File

File diff suppressed because it is too large Load Diff

295
payloads/library/general/Piano_Player/examples/super_mario_notes.txt Normal file
View File

@ -0,0 +1,295 @@
50ms
https://www.onlinepianist.com/virtual-piano
c-3=q c#3=2 d-3=w d#3=3 e-3=e f-3=r f#3=5 g-3=t g#3=6 a-3=y a#3=7 b-3=u c-4=i c#4=9 d-4=o d#4=0 e-4=p f-4=z f#4=s g-4=x g#4=d a-4=c a#4=f b-4=v c-5=b c#5=h d-5=n d#5=j e-5=m f-5=, f#5=l g-5=. g#5=; a-5=/ a#5='
d-3 f#3 e-5
d-3 f#3 e-5
--- --- ---
d-3 f#3 e-5
--- --- ---
d-3 f#3 c-5
d-3 f#3 e-5
--- --- ---
g-3 b-3 g-5
--- --- ---
--- --- ---
--- --- ---
g-3 --- g-4
--- --- ---
--- --- ---
--- --- ---
g-3 e-4 c-5
--- --- ---
--- --- ---
e-3 --- g-4
--- --- ---
--- --- ---
c-3 --- e-4
--- --- ---
--- --- ---
f-3 --- a-4
--- --- ---
g-3 --- b-4
--- --- ---
f#3 --- a#4
f-3 --- a-4
--- --- ---
e-3 --- g-4
c-4 --- e-5
--- --- ---
e-4 --- g-5
f-4 --- a-5
--- --- ---
d-4 --- f-5
e-4 --- g-5
--- --- ---
c-4 --- e-5
--- --- ---
a-3 --- c-5
b-3 --- d-5
g-3 --- b-4
--- --- ---
--- --- ---
g-3 e-4 c-5
--- --- ---
--- --- ---
e-3 --- g-4
--- --- ---
--- --- ---
c-3 --- e-4
--- --- ---
--- --- ---
f-3 --- a-4
--- --- ---
g-3 --- b-4
--- --- ---
f#3 --- a#4
f-3 --- a-4
--- --- ---
e-3 --- g-4
c-4 --- e-5
--- --- ---
e-4 --- g-5
f-4 --- a-5
--- --- ---
d-4 --- f-5
e-4 --- g-5
--- --- ---
c-4 --- e-5
--- --- ---
a-3 --- c-5
b-3 --- d-5
g-3 --- b-4
--- --- ---
--- --- ---
c-3 --- ---
--- --- ---
--- e-5 g-5
e-3 --- f#5
--- d-5 f-5
--- b-4 d-5
c-4 --- ---
--- c-5 e-5
f-3 --- ---
--- e-4 g#4
--- f-4 a-4
c-4 --- c-5
--- --- ---
--- c-4 a-4
f-4 --- c-5
--- f-4 d-5
c-3 --- ---
--- --- ---
--- e-5 g-5
e-3 --- f#5
--- d-5 f-5
--- b-4 d-5
g-3 --- ---
c-4 --- e-5
--- --- ---
c-5 f-5 g-5
--- --- ---
c-5 f-5 g-5
c-5 f-5 g-5
--- --- ---
g-3 --- ---
--- --- ---
c-3 --- ---
--- --- ---
--- e-5 g-5
e-3 --- f#5
--- d-5 f-5
--- b-4 d-5
c-4 --- ---
--- c-5 e-5
f-3 --- ---
--- e-4 g#4
--- f-4 a-4
c-4 --- c-5
--- --- ---
--- c-4 a-4
f-4 --- c-5
--- f-4 d-5
c-3 --- ---
--- --- ---
g#3 g#4 d#5
--- --- ---
--- --- ---
a#3 f-4 d-5
--- --- ---
--- --- ---
c-4 e-4 c-5
--- --- ---
--- --- ---
g-3 --- ---
g-3 --- ---
--- --- ---
c-3 --- ---
--- --- ---
g#3 g#4 c-5
--- g#4 c-5
--- --- ---
d#3 g#4 c-5
--- --- ---
--- --- c-5
g#3 --- d-5
--- --- ---
g-3 g-4 e-5
--- --- c-5
--- --- ---
c-3 --- a-4
--- --- g-4
--- --- ---
g-3 --- ---
--- --- ---
g#3 g#4 c-5
--- g#4 c-5
--- --- ---
d#3 g#4 c-5
--- --- ---
--- --- c-5
g#3 --- d-5
--- g-4 e-5
g-3 --- ---
--- --- ---
--- --- ---
c-3 --- ---
--- --- ---
--- --- ---
g-3 --- ---
--- --- ---
g#3 g#4 c-5
--- g#4 c-5
--- --- ---
d#3 g#4 c-5
--- --- ---
--- --- c-5
g#3 --- d-5
--- --- ---
g-3 g-4 e-5
--- --- c-5
--- --- ---
c-3 --- a-4
--- --- g-4
--- --- ---
g-3 --- ---
--- --- ---
d-3 f#3 e-5
d-3 f#3 e-5
--- --- ---
d-3 f#3 e-5
--- --- ---
d-3 f#3 c-5
d-3 f#3 e-5
--- --- ---
g-3 b-3 g-5
--- --- ---
--- --- ---
--- --- ---
g-3 --- g-4
--- --- ---
--- --- ---
--- --- ---
c-3 --- e-5
--- a-4 c-5
--- --- ---
g-3 e-4 g-4
--- --- ---
--- --- ---
c-4 --- g#4
--- --- ---
f-3 --- a-4
--- c-5 f-5
f-3 --- ---
--- c-5 f-5
c-4 --- a-4
c-4 --- ---
f-3 --- ---
--- --- ---
d-3 --- b-4
--- f-5 a-5
--- --- ---
g-3 f-5 a-5
--- f-5 a-5
--- --- ---
b-3 --- g-5
--- d-5 f-5
g-3 --- e-5
--- a-4 c-5
g-3 --- ---
--- f-4 a-4
c-4 --- g-4
c-4 --- ---
g-3 --- ---
--- --- ---
c-3 --- e-5
--- a-4 c-5
--- --- ---
g-3 e-4 g-4
--- --- ---
--- --- ---
c-4 --- g#4
--- --- ---
f-3 --- a-4
--- c-5 f-5
f-3 --- ---
--- c-5 f-5
c-4 --- a-4
c-4 --- ---
f-3 --- ---
--- --- ---
g-3 --- b-4
--- d-5 f-5
--- --- ---
g-3 d-5 f-5
g-3 --- f-5
--- --- ---
a-3 --- e-5
b-3 b-4 d-5
c-4 g-4 c-5
--- e-4 ---
g-3 --- ---
--- e-4 ---
c-3 --- c-4
--- --- ---
--- --- ---
--- --- ---
g-3 e-4 c-5
--- --- ---
--- --- ---
e-3 --- g-4
--- --- ---
--- --- ---
c-3 --- e-4
--- --- ---
f-3 --- a-4
--- --- b-4
--- --- ---
--- --- a-4
c#3 f-4 g#4
--- --- a#4
--- --- ---
--- --- a-4
c-3 e-4 g-4
--- --- f-4
c-3 e-4 g-4

1523
payloads/library/general/Piano_Player/examples/super_mario_payload.txt Normal file
View File

File diff suppressed because it is too large Load Diff

94
payloads/library/general/Piano_Player/piano_player.py Normal file
View File

@ -0,0 +1,94 @@
import argparse
from pathlib import Path
OS_DETECT_EXTENSION = Path(__file__).resolve().parents[4] / "payloads" / "extensions" / "os_detect.txt"
def parse_args():
parser = argparse.ArgumentParser()
parser.add_argument("notes", metavar="NOTES_FILE", help="Path to notes file")
parser.add_argument("payload", metavar="PAYLOAD_FILE", help="Save payload code to this file")
parser.add_argument("-p", "--press-mode", help="Deploy with press mode", action="store_true")
return parser.parse_args()
def generate_keymap(maps: str) -> dict:
keymap = {}
for exp in maps.split(" "):
note, key = exp.split("=")
keymap[note] = key
return keymap
def notes_to_code(roll: list, keymap: dict, tick: int, url: str, press_mode: bool) -> str:
# Adjust tick to account for note held duration
adjusted_tick = tick - 20
if adjusted_tick < 20:
raise Exception(f"tick ({tick}) is too low! Must be at least 40ms.")
code = ""
indent = ""
# Head
if not press_mode:
with open(OS_DETECT_EXTENSION) as f:
code += f.read() + "\n"
code += f"""IF ($_OS == WINDOWS) THEN
GUI r
ELSE IF ($_OS == MACOS) THEN
COMMAND SPACE
ELSE IF ($_OS == LINUX) THEN
CONTROL ESCAPE
ELSE
GUI
END_IF
DELAY 1000
STRING {url}
ENTER
DELAY 2000\n
"""
else:
indent = " "
code += "ATTACKMODE HID STORAGE\n\n"
# Function (common)
code += f"""FUNCTION tick()
DELAY {adjusted_tick}
END_FUNCTION\n
"""
if press_mode:
code += """WHILE TRUE
WAIT_FOR_BUTTON_PRESS
"""
# Each row is one or more note press, or a rest. Notes and rests are
# held for 20ms (not configurable), but the total interval between rows is
# approx. the specified tick time.
for row in roll:
notes = [n for n in row.split(" ") if n != "---"]
for note in notes:
code += f"{indent}HOLD {keymap[note]}\n"
code += f"{indent}DELAY 20\n"
for note in notes:
code += f"{indent}RELEASE {keymap[note]}\n"
code += f"{indent}tick()\n"
if press_mode:
code += "END_WHILE"
return code
if __name__ == "__main__":
args = parse_args()
with open(args.notes) as f:
notes = [line.strip() for line in f.readlines()]
tick = int(notes[0].split("ms")[0])
url = notes[1]
keymap = generate_keymap(notes[2])
roll = notes[4:]
with open(args.payload, "w") as f:
f.write(notes_to_code(roll, keymap, tick, url, args.press_mode))