✉️💣 LetterBomb

Table of Contents

• Installation
  • PyPi
  • Manual
• Improvements
• Usage
  • Python
  • CLI
• Documentation
• Original source code
• License

Installation

PyPi: (recommended)

python3 -m pip install -U letterbomb

Manual: (web server, development)

git clone https://gitlab.com/whoatemybutter/letterbomb.git
cd letterbomb
python -m build

Improvements over original

Usage

Python

import letterbomb

# Write to file, include HackMii:
letterbomb.write(mac="mac address", region="region letter", output_file="letterbomb.zip")
# Write to file, exclude HackMii:
letterbomb.write(mac="mac address", region="region letter", pack_bundle=False, output_file="letterbomb.zip")

# Write to stream, include HackMii:
letterbomb.write(mac="mac address", region="region letter")
# Write to stream, exclude HackMii:
letterbomb.write(mac="mac address", region="region letter", pack_bundle=False)

# To log debug messages
letterbomb.LOGGING_LEVEL = letterbomb.logging.DEBUG
# To log output to a file
letterbomb.LOGGING_FILE = "log.txt"

CLI

# Help
python3 -m letterbomb -h

# To include HackMii, output and create a ZIP
python3 -m letterbomb MAC REGION -b -o output.zip

# To enable debug logging
python3 -m letterbomb MAC REGION -g debug -o output.zip

# To use a file for logging output instead
python3 -m letterbomb MAC REGION -l logfile.txt -o output.zip

# To stream bytes instead, and include HackMii (-b)
python3 -m letterbomb MAC REGION -b

# To stream bytes instead, and exclude HackMii
python3 -m letterbomb MAC REGION

Web service

python -m pip install letterbomb[web]
# Or...
python -m pip install letterbomb_web

See https://gitlab.com/whoatemybutter/letterbomb_web.

Documentation

Most casual users should refer to the ReadTheDocs page.

Some may want to build the documentation manually. To do this:

git clone https://gitlab.com/whoatemybutter/letterbomb.git
cd letterbomb/docs
make html
xdg-open _build/html/index.html

If you prefer one-liners, there is one below:

git clone https://gitlab.com/whoatemybutter/letterbomb.git && cd letterbomb/docs && make html && xdg-open _build/html/index.html

Before re-building the documentation, you should also run make clean to prevent stale files from remaining in newer builds.

To read about the exploit itself in more detail, please read this article.

Original source code

• The original source code can be found at https://github.com/fail0verflow/letterbomb.
• The original website can be found at https://please.hackmii.com.

Note: Original code likely will not work out-of-the-box.

License

LetterBomb is licensed under the MIT license. (included file)