Skip to content

Commit c1d7874

Browse files
aleff-githubaleff-github
committed
Other doc stuff
1 parent 0950181 commit c1d7874

8 files changed

Lines changed: 326 additions & 16 deletions

File tree

‎out/commands/button.js‎

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎out/commands/button.js.map‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎out/commands/general.js‎

Lines changed: 42 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎out/commands/general.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/commands/attackmode.ts‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
import * as vscode from 'vscode';
2+
import { CommandInfo } from './structure'
3+
4+
5+
export const ATTACKMODE_COMMANDS: CommandInfo[] = [
6+
{
7+
label: "",
8+
detail: "List of all attack mode commands",
9+
doc: new vscode.MarkdownString(`
10+
# ATTACKMODE
11+
12+
An attack mode is the device type that a USB Rubber Ducky, is functioning as or emulating. If no \`ATTACKMODE\` command is specified as the first command (excluding \`REM\`), the \`HID\` attack mode will execute, allowing the device to function as a keyboard. The \`ATTACKMODE\` command may be run multiple times within a payload, which may cause the device to be re-enumerated by the target if the attack mode changes.
13+
14+
## Required Parameters
15+
16+
|**ATTACKMODE Parameter**|**Description**|
17+
|--|--|
18+
|\`HID\`|*Functions as a Human Interface Device, or Keyboard, for keystroke injection.*|
19+
|\`STORAGE\`|*Functions as USB Mass Storage, or a Flash Drive, for copying files to/from the target.*|
20+
|\`HID STORAGE\`|*Functions as both USB Mass Storage and Human Interface Device*|
21+
|\`OFF\`|*Will not function as any device. May be used to disconnect the device from the target.*|
22+
23+
\`\`\`
24+
ATTACKMODE HID STORAGE
25+
REM The USB Rubber Ducky will act as both a flash drive and keyboard
26+
\`\`\`
27+
28+
## Optional Parameters
29+
30+
When using these optional parameters, \`VID\` and \`PID\` must be used as a set. Further, \`MAN\`, \`PROD\` and \`SERIAL\` must also be used as a set.
31+
32+
|**ATTACKMODE Parameter**|**Description**|
33+
|--|--|
34+
|\`VID_\`|*Vendor ID (16-bit HEX)*|
35+
|\`PID_\`|*Product ID (16-bit HEX)*|
36+
|\`MAN_\`|*Manufacturer (32 alphanumeric characters)*|
37+
|\`PROD_\`|*Product (32 alphanumeric characters)*|
38+
|\`SERIAL_\`|*Serial (12 digits)*|
39+
40+
\`\`\`
41+
ATTACKMODE HID VID_046D PID_C31C MAN_HAK5 PROD_DUCKY SERIAL_1337
42+
REM Emulated a Keyboard with the following values:
43+
REM - Vendor ID: 046D
44+
REM - Product ID: C31C
45+
REM - Manufacturer: HAK5
46+
REM - Product: DUCKY
47+
REM - Serial: 1337
48+
\`\`\`
49+
50+
`),
51+
text: "ATTACKMODE "
52+
},{
53+
label: "ATTACKMODE.SAVE_ATTACKMODE",
54+
detail: "",
55+
doc: new vscode.MarkdownString(`
56+
# SAVE_ATTACKMODE
57+
58+
The \`SAVE_ATTACKMODE\` command will save the currently running \`ATTACKMODE\` state (including any specified \`VID\`, \`PID\`, \`MAN\`, \`PROD\` and \`SERIAL\` parameters) such that it may be later restored.
59+
60+
`),
61+
text: "SAVE_ATTACKMODE"
62+
},{
63+
label: "ATTACKMODE.RESTORE_ATTACKMODE",
64+
detail: "",
65+
doc: new vscode.MarkdownString(`
66+
# RESTORE_ATTACKMODE
67+
68+
The \`RESTORE_ATTACKMODE\` command will restore a previously saved \`ATTACKMODE\` state.
69+
70+
\`\`\`
71+
ATTACKMODE HID VID_046D PID_C31C MAN_HAK5 PROD_DUCKY SERIAL_1337
72+
DELAY 2000
73+
SAVE_ATTACKMODE
74+
STRING Hello
75+
ATTACKMODE OFF
76+
DELAY 5000
77+
RESTORE_ATTACKMODE
78+
DELAY 2000
79+
STRING , World!
80+
\`\`\`
81+
`),
82+
text: "RESTORE_ATTACKMODE"
83+
}
84+
];

‎src/commands/button.ts‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
import * as vscode from 'vscode';
2+
import { CommandInfo } from './structure'
3+
4+
5+
export const BUTTON_COMMANDS: CommandInfo[] = [
6+
{
7+
label: "BUTTON-COMMANDS",
8+
detail: "List of all button commands",
9+
doc: new vscode.MarkdownString(`
10+
# BUTTON COMMANDS
11+
12+
By default, if no other button command is currently in use, pressing the button during payload execution will make the USB Rubber Ducky stop any further keystroke injection. It will then become an ordinary USB flash drive, commonly referred to as "arming mode".
13+
14+
\`WAIT_FOR_BUTTON_PRESS\`
15+
16+
\`BUTTON_DEF\`
17+
18+
\`DISABLE_BUTTON\`
19+
20+
\`ENABLE_BUTTON\`
21+
22+
`),
23+
text: ""
24+
},{
25+
label: "BUTTON.WAIT_FOR_BUTTON_PRESS",
26+
detail: "Wait until button is pressed",
27+
doc: new vscode.MarkdownString(`
28+
# BUTTON COMMANDS
29+
30+
Halts payload execution until a button press is detected. When this command is reached in the payload, no further execution will occur.
31+
32+
\`\`\`
33+
STRING Press the button...
34+
WAIT_FOR_BUTTON_PRESS
35+
STRING The button was pressed!
36+
\`\`\`
37+
38+
`),
39+
text: "WAIT_FOR_BUTTON_PRESS"
40+
},{
41+
label: "BUTTON.BUTTON_DEF",
42+
detail: "Define button",
43+
doc: new vscode.MarkdownString(`
44+
# BUTTON_DEF
45+
46+
The \`BUTTON_DEF\` command defines a function which will execute when the button is pressed anytime within the payload so long as the button control is not already in use by the WAIT_FOR_BUTTON_PRESS command or other such function.
47+
48+
\`\`\`
49+
BUTTON_DEF
50+
STRINGLN The button was pressed.
51+
END_BUTTON
52+
53+
STRINGLN Press the button with the next 10 seconds
54+
DELAY 10000
55+
\`\`\`
56+
57+
`),
58+
text: "BUTTON_DEF\n\tREM Hello World!\nEND_BUTTON"
59+
},{
60+
label: "BUTTON.DISABLE_BUTTON",
61+
detail: "Disable button",
62+
doc: new vscode.MarkdownString(`
63+
# DISABLE_BUTTON
64+
65+
The \`DISABLE_BUTTON\` command prevents the button from calling the \`BUTTON_DEF\`.
66+
67+
`),
68+
text: "DISABLE_BUTTON"
69+
},{
70+
label: "BUTTON.ENABLE_BUTTON",
71+
detail: "",
72+
doc: new vscode.MarkdownString(`
73+
# ENABLE BUTTON
74+
75+
The \`ENABLE_BUTTON\` command allows pressing the button to call the \`BUTTON_DEF\`.
76+
77+
`),
78+
text: "ENABLE_BUTTON"
79+
}
80+
81+
];

‎src/commands/general.ts‎

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ STRING The quick brown fox jumps over the lazy dog
6161
The \`STRINGLN\` command, like \`STRING\`, will inject a series of keystrokes then terminate with a carriage return (\`ENTER\`).
6262
6363
\`\`\`
64-
STRINGLN _ _ _ USB _ _ _
64+
STRINGLN _ _ _ USB _ _ _
6565
STRINGLN __(.)< __(.)> __(.)= Rubber >(.)__ <(.)__ =(.)__
66-
STRINGLN \___) \___) \___) Ducky! (___/ (___/ (___/
66+
STRINGLN \___) \___) \___) Ducky! (___/ (___/ (___/
6767
\`\`\`
6868
6969
`),
@@ -97,18 +97,18 @@ Or in this case: \`STRING abc\`
9797
`),
9898
text: "STRING\n\tHello \n\tWorld!\nEND_STRING"
9999
},{
100-
label: "STRINGLN BLOCK",
101-
detail: "A block of strings and enter",
102-
doc: new vscode.MarkdownString(`
100+
label: "STRINGLN BLOCK",
101+
detail: "A block of strings and enter",
102+
doc: new vscode.MarkdownString(`
103103
# STRINGLN BLOCK
104104
105105
\`STRINGLN\` blocks can be used like [here-doc](https://en.wikipedia.org/wiki/Here_document); allowing you to inject multiple lines as they are written in the payload.
106106
107107
\`\`\`
108108
STRINGLN
109-
a
110-
b
111-
c
109+
a
110+
b
111+
c
112112
END_STRINGLN
113113
\`\`\`
114114
@@ -131,6 +131,43 @@ c
131131
\`\`\`
132132
133133
`),
134-
text: "STRINGLN\n\tHello \n\tWorld!\nEND_STRINGLN"
135-
}
134+
text: "STRINGLN\n\tHello \n\tWorld!\nEND_STRINGLN"
135+
},{
136+
label: "DELAY",
137+
detail: "Difficult to see. Always in motion is the future...",
138+
doc: new vscode.MarkdownString(`
139+
# DELAY
140+
141+
The \`DELAY\` command instructs the USB Rubber Ducky to momentarily pause execution of the payload. This is useful when deploying a payload which must "wait" for an element — such as a window — to load. The \`DELAY\` command accepts the time parameter in milliseconds.
142+
143+
\`\`\`
144+
DELAY for 100 milliseconds (one tenth of a second)
145+
DELAY 100
146+
\`\`\`
147+
148+
**The minimum delay value is 20!**
149+
150+
The \`DELAY\` command may also accept an integer variable.
151+
152+
\`\`\`
153+
VAR $WAIT = 500
154+
DELAY $WAIT
155+
\`\`\`
156+
`),
157+
text: "DELAY"
158+
},{
159+
label: "INJECT_MOD",
160+
detail: "Standalone Modifier Keys",
161+
doc: new vscode.MarkdownString(`
162+
# INJECT_MOD
163+
164+
Injecting a modifier key alone without another key — such as pressing the \`WINDOWS\` key — may be achieved by prepending the modifier key with the \`INJECT_MOD\` command.
165+
166+
\`\`\`
167+
REM Example pressing Windows key alone
168+
INJECT_MOD WINDOWS
169+
\`\`\`
170+
`),
171+
text: "INJECT_MOD"
172+
}
136173
];

0 commit comments

Comments
 (0)