Skip to main content

Easy-to-use keystroke injection payload generator for the Arduino.

Project description

📦 arduck

License: GPL v3 Python version: 3.12+ Common Changelog

Overview

This package provides a simple and flexible way to generate keystroke injection scripts. It supports a variety of boards and keyboard layouts.

Rather than relying on expensive proprietary devices (rubberducky cough cough), you can use any Arduino-compatible board that supports the Keyboard.h library.

Installation

Install the package from PyPI by running:

$ pip install arduck

Usage

Start generating payloads right away with the duck console script:

$ duck "helloworld!\n"

This will create a sketch.ino file in the current working directory. Compiling and uploading the code to an Arduino board will make it emulate the keystrokes when plugged into a computer. Be ready to quickly disconnect the board to avoid triggering the payload on your machine.

Special Keys

To inject special keys (e.g. CAPS_LOCK), wrap them in <>. When specifying a special key, the KEY_ prefix can be omitted.

$ duck "<F1>"

All default special keys are listed here. Note that some keyboards may have support for other non-standard keys.

Key Combinations

To emulate pressing multiple keys at once wrap them in <>, separated by a +.

$ duck "<LEFT_GUI+r>calc.exe\n"

Add delays

An optional delay in milliseconds can be added in between strings in the input.

$ duck "<LEFT_GUI+r>" 700 "notepad.exe\n" 500 "hello\n" "world!\n"

More Features

Check out the official documentation for a more comprehensive list of features.

A Word of Caution

Be careful when using and testing arduino scripts that emulate keyboard and mouse presses, because they might make it difficult to program your board. And please, always ask for permission from the owner of the machine before plugging in any external devices. Keep in mind that, if abused, this tool has the potential to cause serious harm.

This software is distributed ‘as is’ and without warranties of any kind, either express or implied. Use of the software is at your own risk.

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arduck-0.0.2.tar.gz (71.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arduck-0.0.2-py3-none-any.whl (52.6 kB view details)

Uploaded Python 3

File details

Details for the file arduck-0.0.2.tar.gz.

File metadata

  • Download URL: arduck-0.0.2.tar.gz
  • Upload date:
  • Size: 71.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for arduck-0.0.2.tar.gz
Algorithm Hash digest
SHA256 134f91fff7ccd05bd1d013c89395aa541c098a52c6fa759f3955465d60847c5e
MD5 53f8f9fe311bfba1e21b295108b761ed
BLAKE2b-256 87098d1c8f4301edb6d2a02ab28cf32df07e7220ba1b5dd3288d84c7ee82a876

See more details on using hashes here.

Provenance

The following attestation bundles were made for arduck-0.0.2.tar.gz:

Publisher: release.yaml on x55xaa/arduck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file arduck-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: arduck-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 52.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for arduck-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e855d941739f2019c8652c044f4c368e86b4ff0af97c6dd6513a502b09c736b3
MD5 3f77b9f4bb3283890811f13cbfae7147
BLAKE2b-256 5a1741dee9f779d094e30bef3f10b783dd7d69eb0b2453b20c27866be15d17a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for arduck-0.0.2-py3-none-any.whl:

Publisher: release.yaml on x55xaa/arduck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page