This guide assumes you already have CircuitPython installed on your Trinkey. The Trinkey ships with CircuitPython pre-installed, so if you have put Arduino on it or need to re-install CircuitPython, check out this guide.

This project only uses built-in libraries, so all you have to do is plug your Trinkey into your computer, click Download Project Bundle below and unzip it.

Now, copy code.py and duckyscript.txt over to your Trinkey and you should be all set.

You can use the script included in the project bundle which can be used to enroll a Chromebook, or you can make your own. You can find the syntax and available commands and a bunch of example scripts in the wiki.

# SPDX-FileCopyrightText: Copyright (c) 2021 Eva Herrada for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense
import time

import usb_hid
from adafruit_hid.keyboard import Keyboard
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
import adafruit_ducky

import touchio # pylint: disable=unused-import
import board
import neopixel
from digitalio import DigitalInOut, Pull # pylint: disable=unused-import

# Uncomment for Neo Trinkey
touch1 = touchio.TouchIn(board.TOUCH1)
touch2 = touchio.TouchIn(board.TOUCH2)

# Uncomment for NeoKey Trinkey
#button = DigitalInOut(board.SWITCH)
#button.switch_to_input(pull=Pull.DOWN)
#button_state = False

pixels = neopixel.NeoPixel(board.NEOPIXEL, 4)

pixels.fill((0xFFFFFF))

time.sleep(1)  # Sleep for a bit to avoid a race condition on some systems
keyboard = Keyboard(usb_hid.devices)
keyboard_layout = KeyboardLayoutUS(keyboard)  # We're in the US :)

duck = adafruit_ducky.Ducky("duckyscript.txt", keyboard, keyboard_layout)

result = True
running = False
while result is not False:
    #if button.value: # Uncomment for NeoKey Trinkey
    if any([touch1.value, touch2.value]): # Uncomment for Neo Trinkey
        running = not running
        if running:
            pixels.fill((0x00FF00))
        else:
            pixels.fill((0xFF0000))
        time.sleep(0.2)
    if running:
        result = duck.loop()

Usage

To use this device, simply plug it into the target computer and press the key switch. You can find a number of other scripts and attacks here:

Non-US Keyboard Layouts

A library of non-US keyboard layouts is available if you want to adapt this for other keyboards.

Code Run-Through

First, the code imports the required libraries.

import time

import usb_hid
from adafruit_hid.keyboard import Keyboard
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
import adafruit_ducky

import touchio # pylint: disable=unused-import
import board
import neopixel
from digitalio import DigitalInOut, Pull # pylint: disable=unused-import

The code next sets up the buttons used to control the script and the NeoPixels used to indicate the status of the script.

# Uncomment for Neo Trinkey
touch1 = touchio.TouchIn(board.TOUCH1)
touch2 = touchio.TouchIn(board.TOUCH2)

# Uncomment for NeoKey Trinkey
#button = DigitalInOut(board.SWITCH)
#button.switch_to_input(pull=Pull.DOWN)
#button_state = False

pixels = neopixel.NeoPixel(board.NEOPIXEL, 4)

pixels.fill((0xFFFFFF))

Then, the code sets up the objects required to emulate a keyboard.

time.sleep(1)  # Sleep for a bit to avoid a race condition on some systems
keyboard = Keyboard(usb_hid.devices)
keyboard_layout = KeyboardLayoutUS(keyboard)  # We're in the US :)

Before the ducky script is run, the code needs to initialize the object it will use to send the keystrokes in the script.

duck = adafruit_ducky.Ducky("duckyscript.txt", keyboard, keyboard_layout)

Finally, the code runs the script. It checks if the control button has been pressed and if it has, it runs the loop. If the button is pressed again, the script is paused.

while result is not False:
    #if button.value: # Uncomment for NeoKey Trinkey
    if any([touch1.value, touch2.value]): # Uncomment for Neo Trinkey
        running = not running
        if running:
            pixels.fill((0x00FF00))
        else:
            pixels.fill((0xFF0000))
        time.sleep(0.2)
    if running:
        result = duck.loop()

Using the Rubber Ducky

To use it, simply plug it into a computer and press the control button to run it. You'll know it's running when the NeoPixels turn green. When the script is done running, the NeoPixels will return to being white.

This guide was first published on Aug 11, 2021. It was last updated on 2021-08-11 10:56:53 -0400.

This page (Project Code) was last updated on May 24, 2022.

Text editor powered by tinymce.