enigma_ruby 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12988cada24f1d22f2954abae0f25f952454cb870c3886683f72f32a5fce40c9
+  data.tar.gz: dcdb04c44fb455aa150932d2ae9dc4f48f1464f958bc2fb216853fc103a1136a
+SHA512:
+  metadata.gz: 8a9c385e78a24de6d8704702b6e4d55fb2620de00316ec35e29ed9cc6d5bbf2c567c270effafbba69b8d3fd210cbca57cfc8260093a6d92d9929f0fdd3151668
+  data.tar.gz: 29c215ce716dddb4bfabb17a7f437e98df70f1d8db94a56111de720b54aa2e4dd1bfd153b37012c3ef003801bb6f9518d0d60e8216b9d55b4ec17b32dd109066

data/README.md

@@ -0,0 +1,43 @@
+## EnigmaRuby
+
+[![Minitest](https://github.com/chibicco/enigma_ruby/actions/workflows/minitest.yml/badge.svg)](https://github.com/chibicco/enigma_ruby/actions/workflows/minitest.yml)
+
+EnigmaRuby faithfully recreates the functionality of the historical Enigma machine in Ruby. 
+This gem allows you to encrypt and decrypt messages using customizable rotors, reflectors, and plugboards, offering a hands-on experience with classic cryptographic techniques.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enigma_ruby'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install enigma_ruby
+```
+
+### Usage
+
+```rub
+require 'enigma_ruby'
+
+EnigmaRuby.encrypt('HELLO WORLD')
+```
+
+### References
+
+- [Enigma Machine - Wikipedia](https://en.wikipedia.org/wiki/Enigma_machine)
+- [The_Imitation_Game](https://en.wikipedia.org/wiki/The_Imitation_Game)
+
+### License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/enigma_ruby/commands/advance_rotors_command.rb

@@ -0,0 +1,17 @@
+module EnigmaRuby
+  class AdvanceRotorsCommand < Command
+    def initialize(rotors)
+      @rotors = rotors
+    end
+
+    def execute(_)
+      @rotors[0].advance
+      @rotors.each_with_index do |rotor, i|
+        next if i == 0
+        break unless @rotors[i - 1].at_notch?
+
+        rotor.advance
+      end
+    end
+  end
+end

data/lib/enigma_ruby/commands/command.rb

@@ -0,0 +1,7 @@
+module EnigmaRuby
+  class Command
+    def execute(context)
+      raise NotImplementedError, 'Subclasses must implement execute(context)'
+    end
+  end
+end

data/lib/enigma_ruby/commands/encode_rotor_backward_command.rb

@@ -0,0 +1,13 @@
+module EnigmaRuby
+  class EncodeRotorBackwardCommand < Command
+    def initialize(rotors)
+      @rotors = rotors
+    end
+
+    def execute(context)
+      @rotors.reverse_each do |rotor|
+        context[:encoded_char] = rotor.encode_backward(context[:encoded_char])
+      end
+    end
+  end
+end

data/lib/enigma_ruby/commands/encode_rotor_forward_command.rb

@@ -0,0 +1,13 @@
+module EnigmaRuby
+  class EncodeRotorForwardCommand < Command
+    def initialize(rotors)
+      @rotors = rotors
+    end
+
+    def execute(context)
+      @rotors.each do |rotor|
+        context[:encoded_char] = rotor.encode_forward(context[:encoded_char])
+      end
+    end
+  end
+end

data/lib/enigma_ruby/commands/reflect_command.rb

@@ -0,0 +1,7 @@
+module EnigmaRuby
+  class ReflectCommand < Command
+    def execute(context)
+      context[:encoded_char] = Reflector.reflect(context[:encoded_char])
+    end
+  end
+end

data/lib/enigma_ruby/commands/swap_plugboard_command.rb

@@ -0,0 +1,7 @@
+module EnigmaRuby
+  class SwapPlugboardCommand < Command
+    def execute(context)
+      context[:encoded_char] = Plugboard.swap(context[:encoded_char])
+    end
+  end
+end

data/lib/enigma_ruby/enigma.rb

@@ -0,0 +1,37 @@
+module EnigmaRuby
+  SKIP_CHARACTERS_REGEX  = /[']/.freeze
+  NON_ENCRYPTED_CHARACTERS_REGEX  = /[ .,;0-9]/.freeze
+
+  class Enigma
+    def initialize(rotor_settings = [])
+      initialize_rotors(rotor_settings)
+      @commands = [
+        SwapPlugboardCommand.new,
+        EncodeRotorForwardCommand.new(@rotors),
+        ReflectCommand.new,
+        EncodeRotorBackwardCommand.new(@rotors),
+        SwapPlugboardCommand.new,
+        AdvanceRotorsCommand.new(@rotors)
+      ]
+    end
+
+    def encrypt(cleartext)
+      encoded_text = ''
+      cleartext.each_char do |char|
+        next if SKIP_CHARACTERS_REGEX .match?(char)
+        next encoded_text << char if NON_ENCRYPTED_CHARACTERS_REGEX .match?(char)
+
+        context = { encoded_char: char }
+        @commands.each { |command| command.execute(context) }
+        encoded_text << context[:encoded_char]
+      end
+      encoded_text
+    end
+
+    private
+
+    def initialize_rotors(rotor_settings)
+      @rotors = rotor_settings.map { |config| Rotor.new(config[:wiring], config[:position]) }
+    end
+  end
+end

data/lib/enigma_ruby/plugboard.rb

@@ -0,0 +1,14 @@
+
+module EnigmaRuby
+  class Plugboard
+    WIRING = {
+      'A' => 'F', 'F' => 'A',
+      'B' => 'E', 'E' => 'B',
+      'C' => 'D', 'D' => 'C'
+    }.freeze
+
+    def self.swap(char)
+      WIRING[char] || char
+    end
+  end
+end

data/lib/enigma_ruby/reflector.rb

@@ -0,0 +1,10 @@
+module EnigmaRuby
+  class Reflector
+    WIRING = 'YRUHQSLDPXNGOKMIEBFZCWVJAT'.freeze
+
+    def self.reflect(char)
+      index = char.ord - 'A'.ord
+      WIRING[index]
+    end
+  end
+end

data/lib/enigma_ruby/rotor.rb

@@ -0,0 +1,26 @@
+module EnigmaRuby
+  class Rotor
+    def initialize(wiring, position = 0)
+      @wiring = wiring.chars
+      @position = @notch = position
+    end
+
+    def encode_forward(char)
+      index = (char.ord - 'A'.ord + @position) % 26
+      @wiring[index]
+    end
+
+    def encode_backward(char)
+      index = @wiring.index(char)
+      ((index - @position) % 26 + 'A'.ord).chr
+    end
+
+    def advance
+      @position = (@position + 1) % 26
+    end
+
+    def at_notch?
+      @position == @notch
+    end
+  end
+end

data/lib/enigma_ruby/version.rb

@@ -0,0 +1,3 @@
+module EnigmaRuby
+  VERSION = "0.1.2"
+end

data/lib/enigma_ruby.rb

@@ -0,0 +1,23 @@
+require "enigma_ruby/version"
+require "enigma_ruby/rotor"
+require "enigma_ruby/reflector"
+require "enigma_ruby/plugboard"
+require "enigma_ruby/enigma"
+require "enigma_ruby/commands/command"
+require "enigma_ruby/commands/advance_rotors_command"
+require "enigma_ruby/commands/encode_rotor_backward_command"
+require "enigma_ruby/commands/encode_rotor_forward_command"
+require "enigma_ruby/commands/reflect_command"
+require "enigma_ruby/commands/swap_plugboard_command"
+
+module EnigmaRuby
+  DEFAULT_ROTOR_SETTINGS = [
+    { wiring: 'EKMFLGDQVZNTOWYHXUSPAIBRCJ', position: 12 },
+    { wiring: 'AJDKSIRUXBLHWTMCQGZNPYFVOE', position: 2 },
+    { wiring: 'BDFHJLCPRTXVZNYEIWGAKMUSQO', position: 10 },
+  ].freeze
+
+  def self.encrypt(cleartext, rotor_settings = DEFAULT_ROTOR_SETTINGS)
+    Enigma.new(rotor_settings).encrypt(cleartext)
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: enigma_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- chibicco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: This gem allows you to simulate the encryption process of the Enigma
+  machine.
+email:
+- me@chibicco.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/enigma_ruby.rb
+- lib/enigma_ruby/commands/advance_rotors_command.rb
+- lib/enigma_ruby/commands/command.rb
+- lib/enigma_ruby/commands/encode_rotor_backward_command.rb
+- lib/enigma_ruby/commands/encode_rotor_forward_command.rb
+- lib/enigma_ruby/commands/reflect_command.rb
+- lib/enigma_ruby/commands/swap_plugboard_command.rb
+- lib/enigma_ruby/enigma.rb
+- lib/enigma_ruby/plugboard.rb
+- lib/enigma_ruby/reflector.rb
+- lib/enigma_ruby/rotor.rb
+- lib/enigma_ruby/version.rb
+homepage: https://github.com/chibicco/enigma_ruby/
+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.5.15
+signing_key: 
+specification_version: 4
+summary: A Ruby implementation of the Enigma machine
+test_files: []