keylogger 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1df41c3a960330c021587440a8f140347a2043a416c6f071ed81054203621d93
+  data.tar.gz: 539b1685543681da269d088092bc1e762ca1de5d468395743e3529975aa18d42
+SHA512:
+  metadata.gz: ec8a85cf6e3924bbfb7189b9c77a7b4f5ba3c2cf42659d3e78095851676aa02bf2316c436b439585ca4a0ff30939c843fbb4ceba1e1ffb5debbefd6b858223a4
+  data.tar.gz: 515eadb80cd8436dbac8e27f1d3b71e3c15d2b47f9eabd22fc01bed19644c756f1055f2790d11a844d091b9233aefc8419190cb27dc4cd47925d70ac25299f86

data/.circleci/config.yml

@@ -0,0 +1,54 @@
+# Ruby CircleCI 2.0 configuration file
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:3.0.0
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler:2.2.5
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # run rubocop
+      - run:
+          name: run rubocop
+          command: |
+            bundle exec rubocop .
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  NewCops: disable
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+# This is causing breaking changes:
+Style/ExpandPathArguments:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem"s dependencies in seri.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    keylogger (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  keylogger!
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.82)
+
+BUNDLED WITH
+   2.2.28

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 grdw
+
+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,29 @@
+# Keylogger
+
+[![CircleCI](https://circleci.com/gh/grdw/keylogger.svg?style=svg)](https://circleci.com/gh/grdw/keylogger)
+
+A simple keylogger for logging keyboard events. Only works on these Ruby platforms:
+
+```
+x86_64-linux
+x86_64-linux-gnu
+```
+
+More platforms will be added in the future.
+
+## Usage:
+
+```ruby
+Keylogger.new("Name of keyboard").listen do |key|
+  puts key
+end
+```
+
+You can find the name of your keyboard in `cat /proc/bus/input/devices`.
+
+
+## FAQ
+
+Q: I get a "permission denied", what do I do?
+
+A: Check which group owns these files: `ls -l /dev/input/` and add your own user to that group.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/keylogger.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "keylogger"
+  spec.version       = "0.0.2"
+  spec.authors       = ["grdw"]
+  spec.email         = ["gerard@grdw.nl"]
+
+  spec.summary       = "A basic keylogger"
+  spec.description   = "A basic keylogger for linux"
+  spec.homepage      = "https://github.com/grdw/keylogger"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "pry", "~> 0.13"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.82"
+end

data/lib/input_devices.rb

@@ -0,0 +1,31 @@
+class Keylogger
+  module InputDevices
+    KEYBOARD_EV = "120013".freeze
+    DEVICE_REGEX = /
+      N:\sName="(?<name>.+)"(\n|.)*
+      H:\sHandlers=.*event(?<event_id>[0-9]+).*(\n|.)*
+      B:\sEV=(?<ev>[0-9]+)
+    /x.freeze
+
+    Device = Struct.new(:name, :event_id, :ev, keyword_init: true)
+
+    def self.find_by_name(name)
+      devices.detect do |device|
+        device.name == name && device.ev == KEYBOARD_EV
+      end
+    end
+
+    # Pick the first keyboard out of the list
+    def self.default
+      devices.detect { |device| device.ev == KEYBOARD_EV }
+    end
+
+    def self.devices
+      contents = File.read("/proc/bus/input/devices")
+      contents.split("\n\n").map do |device|
+        blob = DEVICE_REGEX.match(device).named_captures
+        Device.new(blob)
+      end
+    end
+  end
+end

data/lib/keylogger.rb

@@ -0,0 +1,31 @@
+require_relative "input_devices"
+class Keylogger
+  SUPPORTED_PLATFORMS = %w[x86_64-linux x86_64-linux-gnu].freeze
+  FORMAT = "l!<l!<HHI!<".freeze
+  MIN_ID = 0
+  MAX_ID = 59
+
+  DeviceNotFoundError = Class.new(StandardError)
+  WrongPlatformError = Class.new(StandardError)
+
+  def initialize(name = nil)
+    @device = InputDevices.find_by_name(name) || InputDevices.default
+
+    unless SUPPORTED_PLATFORMS.include?(RUBY_PLATFORM)
+      raise WrongPlatformError,
+            "platform #{RUBY_PLATFORM} not supported"
+    end
+
+    raise DeviceNotFoundError unless @device
+  end
+
+  def listen
+    file = File.open("/dev/input/event" + @device.event_id, "rb")
+    loop do
+      line = file.read(24)
+      value = line.unpack(FORMAT).last
+
+      yield value if value > MIN_ID && value < MAX_ID
+    end
+  end
+end

data/logger.rb

@@ -0,0 +1,65 @@
+require_relative "lib/main"
+
+QWERTY_MAP = {
+  2 => "1",
+  3 => "2",
+  4 => "3",
+  5 => "4",
+  6 => "5",
+  7 => "6",
+  8 => "7",
+  9 => "8",
+  10 => "9",
+  11 => "0",
+  12 => "-",
+  13 => "=",
+  14 => "[BACKSPACE]",
+  15 => "[TAB]",
+  16 => "a",
+  17 => "z",
+  18 => "e",
+  19 => "r",
+  20 => "t",
+  21 => "y",
+  22 => "u",
+  23 => "i",
+  24 => "o",
+  25 => "p",
+  26 => "^",
+  27 => "$",
+  28 => "\n",
+  29 => "[CTRL]",
+  30 => "q",
+  31 => "s",
+  32 => "d",
+  33 => "f",
+  34 => "g",
+  35 => "h",
+  36 => "j",
+  37 => "k",
+  38 => "l",
+  39 => "m",
+  40 => "ù",
+  41 => "*",
+  42 => "[SHIFT]",
+  43 => "<",
+  44 => "w",
+  45 => "x",
+  46 => "c",
+  47 => "v",
+  48 => "b",
+  49 => "n",
+  50 => ",",
+  51 => ";",
+  52 => " =>",
+  53 => "!",
+  54 => "[SHIFT]",
+  55 => "FN",
+  56 => "ALT",
+  57 => " ",
+  58 => "[CAPSLOCK]"
+}.freeze
+
+Keylogger.new(ARGV[0]).listen do |key|
+  puts [QWERTY_MAP[key], key].inspect
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: keylogger
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- grdw
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+description: A basic keylogger for linux
+email:
+- gerard@grdw.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- keylogger.gemspec
+- lib/input_devices.rb
+- lib/keylogger.rb
+- logger.rb
+homepage: https://github.com/grdw/keylogger
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A basic keylogger
+test_files: []