chaocipher 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://www.rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+(MIT License)
+
+Copyright (c) 2010 Adam Prescott
+
+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,47 @@
+ChaoCipher
+==========
+
+ChaoCipher is a Ruby implementation of the Chaocipher cipher, invented by J. F. Byrne; the algorithm was disclosed in 2010, hence this small bit of code!
+
+The Algorithm
+-------------
+
+You can find more about the Chaocipher at [Wikipedia/Chaocipher](http://en.wikipedia.org/wiki/Chaocipher), and you can read the [online PDF](http://www.mountainvistasoft.com/chaocipher/ActualChaocipher/Chaocipher-Revealed-Algorithm.pdf) which contains details about the algorithm itself, upon which this code is based. The algorithm isn't that involved and is actually quite rudimentary.
+
+# How do I use this thing?
+
+To install from RubyGems:
+
+    gem install chaocipher
+
+To get the source:
+
+    git clone https://github.com/aprescott/chaocipher.git
+
+To run the tests with the source:
+
+    rake test
+
+To contribute:
+
+* Fork it
+* Make a new feature branch: `git checkout -b some-new-thing master`
+* Hack away and add tests
+* Pull request
+
+## Basic usage
+
+The Chaocipher works off two alphabets, a "left" and a "right" alphabet which are used for look-up during ciphering and deciphering. The initial two alphabets are all that is required to have a working cipher. For more details, it's probably best that you just read the PDF linked above.
+
+    require "chaocipher"
+    
+    ciphertext_alphabet = "HXUCZVAMDSLKPEFJRIGTWOBNYQ"
+    plaintext_alphabet = "PTLNBQDEOYSFAVZKGJRIHWXUMC"
+    
+    cipher = ChaoCipher::Cipher.new(ciphertext_alphabet, plaintext_alphabet)
+    
+    cipher.encrypt("WELLDONEISBETTERTHANWELLSAID") #=> "OAHQHCNYNXTSZJRRHJBYHQKSOUJY"
+
+# Cryptographic security
+
+I have no idea what the strength of this cipher is, so I wouldn't encrypt anything of utter importance with it, personally.

data/chaocipher.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name         = "chaocipher"
+  s.version      = "0.0.1"
+  s.authors      = ["Adam Prescott"]
+  s.email        = ["adam@aprescott.com"]
+  s.homepage     = "https://github.com/aprescott/chaocipher"
+  s.summary      = "A Ruby implementation of the Chaocipher cipher."
+  s.description  = "ChaoCipher is a Ruby implementation of the Chaocipher cipher, invented by J. F. Byrne; the algorithm was disclosed in 2010."
+  s.files        = Dir["{lib/**/*,test/**/*}"] + %w[LICENSE Gemfile rakefile README.md chaocipher.gemspec .gemtest]
+  s.require_path = "lib"
+  s.test_files   = Dir["test/*"]
+  s.add_development_dependency "rake"
+end

data/lib/chaocipher.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2010 Adam Prescott
+# Licensed under the MIT license. See LICENSE.
+
+# Ruby 1.8
+unless Array.new.respond_to?(:rotate)
+  class Array
+    def rotate(n = 1)
+      rotate_amount = n % size
+      return self if rotate_amount < 1 # will be true if n < 1 or size < 2
+      self[rotate_amount..-1] + self[0..rotate_amount-1]
+    end
+  end
+end
+
+module ChaoCipher
+  ZENITH_INDEX = 0
+  NADIR_INDEX = 13
+  ZENITH_POSITION = ZENITH_INDEX + 1
+  NADIR_POSITION = NADIR_INDEX + 1
+  
+  VERSION_TINY = 1
+  VERSION_MINOR = 0
+  VERSION_MAJOR = 0
+  
+  VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_TINY].join(".")
+end
+
+require "chaocipher/alphabet"
+require "chaocipher/cipher"

data/lib/chaocipher/alphabet.rb

@@ -0,0 +1,44 @@
+module ChaoCipher
+  class Alphabet
+    attr_reader :characters, :type
+    
+    def initialize(characters, kind)
+      @type = kind
+      @characters = characters
+      raise(ArgumentError, "given alphabet is not a permutation of A-Z") unless self.class.valid?(@characters)
+    end
+    
+    def zenith
+      @characters.first
+    end
+    
+    def nadir
+      @characters[NADIR_INDEX]
+    end
+    
+    def permute(new_zenith)
+      self.class.permute(@characters, new_zenith, type)
+    end
+    
+    def permute!(new_zenith)
+      @characters.replace(permute(new_zenith))
+    end
+    
+    def self.permute(characters, new_zenith, type)
+      if type == :ciphertext
+        amount_to_skip = 1
+      else
+        amount_to_skip = 2
+      end
+      
+      permuted_characters = characters.rotate(characters.index(new_zenith))
+      permuted_characters = permuted_characters.rotate unless type == :ciphertext
+      
+      permuted_characters[0..amount_to_skip-1] + permuted_characters[amount_to_skip..NADIR_INDEX].rotate + permuted_characters[NADIR_INDEX+1..-1]
+    end
+    
+    def self.valid?(characters)
+      characters.sort.join("") =~ /[a-z]/i
+    end
+  end
+end

data/lib/chaocipher/cipher.rb

@@ -0,0 +1,53 @@
+module ChaoCipher
+  class Cipher    
+    def initialize(ciphertext_alphabet, plaintext_alphabet)
+      @original_ciphertext_alphabet = ciphertext_alphabet
+      @original_plaintext_alphabet = plaintext_alphabet
+      @ciphertext_alphabet = Alphabet.new(ciphertext_alphabet.upcase.chars.to_a, :ciphertext)
+      @plaintext_alphabet = Alphabet.new(plaintext_alphabet.upcase.chars.to_a, :plaintext)
+    end
+    
+    def reinitialize!
+      @ciphertext_alphabet = Alphabet.new(@original_ciphertext_alphabet.upcase.chars.to_a, :ciphertext)
+      @plaintext_alphabet = Alphabet.new(@original_plaintext_alphabet.upcase.chars.to_a, :plaintext)
+    end
+    
+    def plaintext_letter_for(ciphertext_letter)
+      @plaintext_alphabet.characters[@ciphertext_alphabet.characters.index(ciphertext_letter)]
+    end
+    
+    def ciphertext_letter_for(plaintext_letter)
+      @ciphertext_alphabet.characters[@plaintext_alphabet.characters.index(plaintext_letter)]
+    end
+        
+    def cipher(mode, text)
+      reinitialize!
+      
+      converted_text = ""
+      
+      text.chars.each do |character|
+        if mode == :encrypt
+          @last_converted_letter = ciphertext_letter_for(character)
+          @ciphertext_alphabet.permute!(@last_converted_letter)
+          @plaintext_alphabet.permute!(character)
+        else
+          @last_converted_letter = plaintext_letter_for(character)
+          @ciphertext_alphabet.permute!(character)
+          @plaintext_alphabet.permute!(@last_converted_letter)
+        end
+        
+        converted_text << @last_converted_letter
+      end
+      
+      converted_text
+    end
+    
+    def encrypt(plaintext)
+      cipher(:encrypt, plaintext)
+    end
+    
+    def decrypt(ciphertext)
+      cipher(:decrypt, ciphertext)
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,7 @@
+require "rake"
+
+task :test do
+  system("ruby -I lib -I test test/test_chaocipher.rb")
+end
+
+task :default => :test

data/test/test_chaocipher.rb

@@ -0,0 +1,30 @@
+require "test/unit"
+
+require "chaocipher"
+
+class TestChaoCipher < Test::Unit::TestCase
+  def setup
+    ciphertext_alphabet = "HXUCZVAMDSLKPEFJRIGTWOBNYQ"
+    plaintext_alphabet = "PTLNBQDEOYSFAVZKGJRIHWXUMC"
+    @cipher = ChaoCipher::Cipher.new(ciphertext_alphabet, plaintext_alphabet)
+  end
+  
+  def test_encryption
+    assert_equal "OAHQHCNYNXTSZJRRHJBYHQKSOUJY", @cipher.encrypt("WELLDONEISBETTERTHANWELLSAID")
+  end
+  
+  def test_decryption
+    assert_equal "WELLDONEISBETTERTHANWELLSAID", @cipher.decrypt("OAHQHCNYNXTSZJRRHJBYHQKSOUJY")
+  end
+  
+  def test_reversible
+    ciphertext_alphabet = ("A".."Z").to_a.shuffle.join("")
+    plaintext_alphabet = ("A".."Z").to_a.shuffle.join("")
+    
+    cipher = ChaoCipher::Cipher.new(ciphertext_alphabet, plaintext_alphabet)
+    
+    str = ("A".."Z").to_a.shuffle.join("")
+    
+    assert_equal str, cipher.decrypt(cipher.encrypt(str))
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: chaocipher
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Prescott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: ChaoCipher is a Ruby implementation of the Chaocipher cipher, invented by J. F. Byrne; the algorithm was disclosed in 2010.
+email: 
+- adam@aprescott.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/chaocipher/alphabet.rb
+- lib/chaocipher/cipher.rb
+- lib/chaocipher.rb
+- test/test_chaocipher.rb
+- LICENSE
+- Gemfile
+- rakefile
+- README.md
+- chaocipher.gemspec
+- .gemtest
+homepage: https://github.com/aprescott/chaocipher
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: A Ruby implementation of the Chaocipher cipher.
+test_files: 
+- test/test_chaocipher.rb