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.4.tar.gz (71.9 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.4-py3-none-any.whl (54.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arduck-0.0.4.tar.gz
  • Upload date:
  • Size: 71.9 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.4.tar.gz
Algorithm Hash digest
SHA256 d823aafd33f230826ca68d7943813a44f379fc59b7788b58e62c8d88710c178f
MD5 13d6433cd94639e243b2c64f94682c1c
BLAKE2b-256 6db125670c7cd08e3ff63a53902c52a52cf03b2cd491414f0cfd41381da29955

See more details on using hashes here.

Provenance

The following attestation bundles were made for arduck-0.0.4.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.4-py3-none-any.whl.

File metadata

  • Download URL: arduck-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 54.0 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cdf4a78c88938f76d32f9534f56773e56bc12a1df2eb8b089f0c728ec4ba8b11
MD5 57b7d1422dae5dbe0d058714fcbbf717
BLAKE2b-256 181d0877e02b29dd78de9d1e8727c7851c774fc004bbb021e6a9f3fb7d7d44ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for arduck-0.0.4-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