ShadowDuck_Firmware/README.md

53 lines
2.8 KiB
Markdown

# ShadowDuck Firmware
<!-- Repo Cover Image -->
<p align="center">
<img align="center" src="https://github.com/KobolSystems/ShadowDuck_Firmware/blob/main/repoLogo.png?raw=true" width="450px"/>
</p>
## Something
The Shadow Duck is a hardware platform designed for performing keystroke injection attacks. Our goal with this platform is to provide a budget-friendly, educational, and ethical pen-testing tool that resembles a legitimate USB stick, avoiding unnecessary scrutiny. We aim to give newcomers to cybersecurity the opportunity to experiment with these tools and eventually apply their skills in legitimate, professional roles within the industry.
## Changelog <img alt="" align="right" src="https://img.shields.io/github/last-commit/KobolSystems/ShadowDuck_Firmware" />
All notable changes to this project will be documented in this file.
## 1.0 2024-05-22
- Migrated Arduino INO project to PlatformIO
- USBNova.ino renamed to main.cpp
- Added includes for Arduino.h to main.cpp
- Moved all "src" files to "Includes" folder and updated main.cpp
- Moved "config.h" and "debug.h" to includes folder
- Updated "hid.h" reference for config.h
- Included external libries "adafruit/SdFat - Adafruit Fork@^2.2.3", "adafruit/Adafruit TinyUSB Library@^3.1.4" in lib_deps
## Current Builds <img alt="" align="right" src="https://img.shields.io/github/v/release/KobolSystems/ShadowDuck%20Firmware" />
## Latest Build Status
<p align="right">
<img align="center" src="https://cdn.platformio.org/images/platformio-logo.17fdc3bc.png" width="125px"/>
</p>
```C++
Insert PlatformIO Buil Log Here
```
## Licencing <img alt="" align="right" src="https://img.shields.io/badge/Licence-MIT-informational?style=flat&logoColor=white&color=FF9421" />
**MIT - LICENCE**
Copyright (c) 2024 Kobol Systems
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.