rubber-ducky 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22874993488bcf36f82ffa62a02c4b8a21b5f614796e90cad6cb31595105a3b4
+  data.tar.gz: bb0393a3dcc732e203cafe4ca3455c462ebe287291cf7d70265b56c7736cbfb8
+SHA512:
+  metadata.gz: ffdad9467899f70fbd6848dc2e5df3c76850fcfa1f09e2abafd9a77d1e34feb5e74719f83a029b2475ab4d3a19cf345c565c418e20b79fa1dc09f9fdd89eb139
+  data.tar.gz: ec3487204efb29e3a461d7b85f06b0d840700ac4ee49bd0042dcabe9827b29eebee92cb871c5c6234d3ec75393f715a75ffa0c549674c6a79edf9b23768372b9

data/.github/workflows/gem-push.yml

@@ -0,0 +1,48 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 2.6
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: 2.6.10
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+name: Build + Publish
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      matrix:
+        ruby-version: ['2.7.8', '3.2.2']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run tests
+      run: bundle exec rspec
+
+    - name: Build and publish
+      run: gem build rubber-ducky.gemspec && gem push rubber-ducky-*.gem
+      env:
+        RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,55 @@
+# Ignore bundler config
+/.bundle
+
+# Ignore the installed gems
+/vendor/bundle
+
+# Ignore the Gemfile.lock, since it's usually generated and not necessary to track
+/Gemfile.lock
+
+# Ignore log files and temp files
+/log/*
+/tmp/*
+!/log/.keep
+
+# Ignore compiled output
+/*.o
+/*.so
+/*.log
+/*.out
+/*.bin
+
+# Ignore test coverage files
+/coverage/
+
+# Ignore spec and test files
+/spec/tmp/
+/spec/*.bin
+
+# Ignore IDE files
+.idea/
+.vscode/
+
+# Ignore system files
+.DS_Store
+
+# Ignore Ruby-specific files
+.ruby-version
+.ruby-gemset
+
+# Ignore Rake files
+/rdoc/
+/.rake_tasks~
+
+# Ignore the gem build artifacts
+/pkg/
+rubber-ducky-*.gem
+
+# Ignore byebug history file
+.byebug_history
+
+# Ignore dotenv environment variable files
+.env
+
+# Ignore node_modules if any JavaScript is used
+/node_modules/

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+rvm:
+  - 3.0.0
+  - 2.7.2
+
+# Run the script only on the default branch (usually master/main)
+branches:
+  only:
+    - main
+
+# Install dependencies
+before_install:
+  - gem install bundler
+
+# Run the script
+script:
+  - bundle exec rspec
+
+# Cache bundler dependencies to speed up future builds
+cache: bundler
+
+# Notifications (optional)
+notifications:
+  email:
+    recipients:
+      - qppn@hotmail.com
+    on_success: change
+    on_failure: always

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial release of the `rubber-ducky` gem.
+- Support for encoding Rubber Ducky scripts into binary files.
+- Support for decoding binary files back into Rubber Ducky scripts.
+- Multi-language support for different keyboard layouts.
+- Customizable encoding and decoding options.
+- Basic error handling and validation for input files.
+- Integration with Ruby projects and applications.
+
+### Changed
+- Updated documentation with detailed usage examples for beginners and professionals.
+- Improved error messages for common issues during encoding/decoding.
+
+### Fixed
+- Resolved issues with decoding specific characters in non-English keyboard layouts.
+
+## [1.0] - 2024-08-16
+### Added
+- Basic encoding and decoding functionalities.
+- Support for multiple keyboard layouts (languages).
+- Comprehensive unit tests for core functionality.
+
+### Changed
+- Initial creation of the project structure and essential files.
+
+### Fixed
+- Initial bug fixes during development and testing phase.
+
+---
+
+For more details on each change, please refer to the commit history or the project's GitHub repository.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,39 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to Rubber Ducky Ruby Library
+
+First off, thank you for considering contributing to the Rubber Ducky Ruby Library! Your contributions are highly appreciated.
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please create an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue, and if possible, a minimal code example demonstrating the problem.
+
+### Suggesting Features
+
+We are open to new ideas! If you have a feature request, please create an issue on GitHub with a detailed description of the feature, how it would work, and why it would be beneficial.
+
+### Submitting Changes
+
+1. **Fork the Repository**: Create a personal fork of the repository on GitHub.
+
+2. **Create a Branch**: Create a new branch on your fork to work on your changes. Use a descriptive name for your branch (e.g., `fix-typo-in-readme`, `add-new-feature`).
+
+3. **Make Changes**: Make your changes to the codebase. Ensure that your code follows the existing coding standards and passes all tests.
+
+4. **Run Tests**: Before submitting your changes, make sure all tests pass. You can run the tests using `bundle exec rspec`.
+
+5. **Commit Your Changes**: Write clear, descriptive commit messages. If your change fixes an issue, include `Fixes #issue_number` in your commit message.
+
+6. **Push Your Changes**: Push your changes to your forked repository.
+
+7. **Create a Pull Request**: Go to the original repository and create a pull request. Describe your changes in detail, and reference any relevant issues.
+
+### Code Style
+
+Please follow the coding style used in the project. We recommend using RuboCop to ensure that your code meets the Ruby style guide.
+
+### Testing
+
+Make sure that your changes are covered by tests. If you're adding a new feature, add new tests. If you're fixing a bug, add a test that verifies the fix.
+
+### Documentation
+
+Ensure that your changes are documented. This includes updating the README if necessary, as well as any other relevant documentation files.
+
+## Code of Conduct
+
+Please note that this project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+Thank you for your contributions!

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+group :development, :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MAVEN
+
+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.

data/README.md

@@ -0,0 +1,177 @@
+
+[![Gem Version](https://badge.fury.io/rb/rubber-ducky.svg)](https://badge.fury.io/rb/rubber-ducky)
+[![License: MIT](https://cdn.prod.website-files.com/5e0f1144930a8bc8aace526c/65dd9eb5aaca434fac4f1c34_License-MIT-blue.svg)](/LICENSE)
+
+
+# [join to our telegram for more Rubber Ducky scripts]('https://t.me/@DuckyScript1') <a href="https://t.me/@DuckyScript1" target="blank"><img align="center" src="https://raw.githubusercontent.com/AliSawari/github-profile-readme-generator/master/src/images/icons/Social/telegram.svg" alt="Telegram: maxbarsukov" height="25" width="30" /></a>
+# Rubber Ducky Ruby Library
+
+Welcome to the `rubber-ducky` Ruby library! This library provides an easy-to-use interface for encoding and decoding Rubber Ducky scripts into binary files and vice versa. Whether you're a beginner or a seasoned developer, this README will guide you through everything you need to know to get started and make the most of this library.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+  - [Encoding a Script](#encoding-a-script)
+  - [Decoding a Binary File](#decoding-a-binary-file)
+- [Advanced Usage](#advanced-usage)
+  - [Customizing Encoding and Decoding](#customizing-encoding-and-decoding)
+  - [Working with Different Languages](#working-with-different-languages)
+- [Professional Tips and Tricks](#professional-tips-and-tricks)
+  - [Integrating with Other Tools](#integrating-with-other-tools)
+  - [Error Handling](#error-handling)
+  - [Best Practices](#best-practices)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To install the `rubber-ducky` gem, simply add it to your Gemfile or install it directly using `gem`:
+
+```bash
+gem install rubber-ducky
+```
+
+Alternatively, you can include it in your `Gemfile`:
+
+```ruby
+gem 'rubber-ducky'
+```
+
+Then, run `bundle install` to install the gem.
+
+## Basic Usage
+
+Let's start with the basics. The `rubber-ducky` library allows you to encode and decode Rubber Ducky scripts. Here’s how to use it:
+
+### Encoding a Script
+
+To encode a Rubber Ducky script, you'll first need a script written in a plain text file. Let's assume you have a file named `payload.txt` with the following content:
+
+```text
+DELAY 500
+GUI r
+DELAY 500
+STRING cmd
+CTRL-SHIFT ENTER
+DELAY 1000
+ALT y
+DELAY 500
+STRING netsh advfirewall set allprofiles state off
+ENTER
+```
+
+To encode this script into a binary file, use the following code:
+
+```ruby
+require 'rubber-ducky'
+
+Rubber::Ducky.encode('payload.txt', output: 'inject.bin', language: 'us')
+```
+
+This will generate a binary file named `inject.bin` that can be used with a Rubber Ducky USB device.
+
+### Decoding a Binary File
+
+Decoding a binary file back to its script form is just as easy. Assuming you have a binary file named `inject.bin`, you can decode it like this:
+
+```ruby
+require 'rubber-ducky'
+
+decoded_script = Rubber::Ducky.decode('inject.bin', output: 'payload-decode.txt', language: 'us')
+puts "Decoded content:"
+puts decoded_script
+```
+
+This will output the decoded script to the console and save it to `payload-decode.txt`.
+
+## Advanced Usage
+
+Now that you're familiar with the basics, let's dive into some advanced features.
+
+### Customizing Encoding and Decoding
+
+You can customize the encoding and decoding processes by directly manipulating the content before encoding or after decoding. For example:
+
+```ruby
+require 'rubber-ducky'
+
+# Read the script from a file
+script = File.read('payload.txt')
+
+# Modify the script if needed
+script.gsub!('500', '1000') # Change all delays from 500ms to 1000ms
+
+# Encode the modified script
+Rubber::Ducky.encode(script, output: 'inject.bin', language: 'us')
+
+# Decode it back to verify the changes
+decoded_script = Rubber::Ducky.decode('inject.bin')
+puts decoded_script
+```
+
+### Working with Different Languages
+
+The library supports multiple keyboard layouts. You can specify the language using the `language` option. For example, to encode a script using the German keyboard layout:
+
+```ruby
+Rubber::Ducky.encode('payload.txt', output: 'inject.bin', language: 'de')
+```
+
+Similarly, to decode a file encoded with the German layout:
+
+```ruby
+decoded_script = Rubber::Ducky.decode('inject.bin', language: 'de')
+```
+
+## Professional Tips and Tricks
+
+For advanced users, here are some tips to make the most of the `rubber-ducky` library.
+
+### Integrating with Other Tools
+
+You can easily integrate this library with other Ruby tools and frameworks. For example, you can use it in a Rails application to generate payloads on the fly:
+
+```ruby
+class PayloadsController < ApplicationController
+  def create
+    script = params[:script]
+    file_path = Rails.root.join('tmp', 'inject.bin')
+
+    Rubber::Ducky.encode(script, output: file_path, language: 'us')
+
+    send_file file_path, type: 'application/octet-stream', filename: 'inject.bin'
+  end
+end
+```
+
+### Error Handling
+
+The library is designed to be robust, but you should still handle potential errors gracefully:
+
+```ruby
+begin
+  Rubber::Ducky.encode('payload.txt', output: 'inject.bin', language: 'us')
+rescue StandardError => e
+  puts "An error occurred during encoding: #{e.message}"
+end
+```
+
+### Best Practices
+
+- **Test your payloads**: Always test your payloads in a safe environment before deploying them.
+- **Use version control**: Keep your scripts under version control to track changes and collaborate with others.
+- **Stay updated**: Keep the library and your Ruby version up to date to avoid compatibility issues.
+
+## Contributing
+
+We welcome contributions! If you'd like to contribute to this project, please fork the repository and submit a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+Whether you're automating tasks with a Rubber Ducky or exploring new ways to interact with devices, the `rubber-ducky` Ruby library offers a powerful and flexible toolset to get the job done. Happy coding!
+# rubber-ducky

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+# Task to run tests using RSpec
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+# Task to install the gem locally
+desc "Build and install the gem locally"
+task :install do
+  sh "gem build rubber-ducky.gemspec"
+  sh "gem install rubber-ducky-#{Rubber::Ducky::VERSION}.gem"
+end
+
+# Task to run RuboCop for code linting
+desc "Run RuboCop for code quality"
+task :rubocop do
+  sh "rubocop"
+end
+
+# Task to generate documentation using Yard
+desc "Generate YARD documentation"
+task :yard do
+  sh "yard doc"
+end
+
+# Task to release the gem to RubyGems
+desc "Release the gem to RubyGems"
+task :release => [:install] do
+  sh "gem push rubber-ducky-#{Rubber::Ducky::VERSION}.gem"
+end
+
+# Default task is to run tests
+task :default => :test

data/examples/example1.rb

@@ -0,0 +1,10 @@
+require_relative 'rubber-ducky'
+
+# لتشفير المحتوى من ملف وكتابته إلى ملف
+encode = Rubber::Ducky.encode('payload.txt', output: 'inject.bin', language: 'us') # or without language to set by default
+
+# لفك تشفير الملف وكتابة المحتوى المفكك إلى ملف
+decode = Rubber::Ducky.decode('inject.bin', output: 'payload-decode.txt', language: 'us')
+
+puts "Decoded content:"
+puts decode