bai-crypt-isaac 0.9.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2009 beawesomeinstead
+
+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.rdoc

@@ -0,0 +1,51 @@
+Crypt::ISAAC README
+============
+
+ISAAC is a cryptographically secure PRNG for generating high quality random numbers. Detailed information about the
+algorithm can be found at: http://burtleburtle.net/bob/rand/isaac.html
+
+This is a pure Ruby implementation of the algorithm. It is reasonably fast for a pure Ruby implementation. On an 800Mhz
+PIII computer running Ruby 1.8.2, and while the machine is also serving as general desktop, the library seems to
+consistently generate between 15000 and 16000 random numbers per second.
+
+Ruby uses the Mersenne Twister as its PRNG, and while this the Twister is a fast PRNG that produces highly random
+numbers, it is not strong for cryptographic purposes, nor is it suitable when one needs multiple independent streams of
+random numbers. Crypt::ISAAC is suitable for either purpose.
+
+
+Requirements
+------------
+
+  * Ruby 1.6
+  * Ruby 1.8
+  * Ruby 1.9
+
+
+Install
+-------
+
+If you have never installed Crypt::ISAAC, you may run the testsuite to confirm that it works with:
+
+  # rake test
+
+
+Usage
+-----
+
+  require 'crypt-isaac'
+
+  rng = Crypt::ISAAC.new
+
+  r1 = rng.rand() # returns a floating point between 0 and 1
+  r2 = rng.rand(1000) # returns an integer between 0 and 999
+
+rand() should work identically to the Kernel.rand().
+
+Enjoy it. Let me know if you find anything that can be improved or that needs to be fixed.
+
+
+License
+-------
+
+The Crypt::ISAAC library is licensed with an MIT style licence. See the LICENSE file for details. As for the ISAAC
+algorithm itself, see: http://burtleburtle.net/bob/rand/isaac.html

data/VERSION

@@ -0,0 +1 @@
+0.9.2

data/crypt-isaac.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{crypt-isaac}
+  s.version = "0.9.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["beawesomeinstead"]
+  s.date = %q{2009-07-07}
+  s.email = %q{beawesomeinstead@yahoo.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "VERSION",
+     "crypt-isaac.gemspec",
+     "lib/crypt-isaac.rb",
+     "rakefile",
+     "test/crypt-isaac_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/bai/crypt-isaac}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Ruby implementation of the ISAAC PRNG}
+  s.test_files = [
+    "test/crypt-isaac_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/crypt-isaac.rb

@@ -0,0 +1,158 @@
+module Crypt
+  # ISAAC is a fast, strong random number generator. Details on the algorithm can be found
+  # here: http://burtleburtle.net/bob/rand/isaac.html
+  # This provides a consistent and capable algorithm for producing independent streams of quality random numbers.
+  class ISAAC
+    attr_accessor :randrsl, :randcnt
+    attr_accessor :mm, :aa, :bb, :cc
+
+    # When a Crypt::ISAAC object is created, it needs to be seeded for random number generation. If the system has a
+    # /dev/urandom file, that will be used to do the seeding by default. If false is explictly passed when creating the
+    # object, it will instead use /dev/random to generate its seeds. Be warned that this may make for SLOW
+    # initialization. If the requested source (/dev/urandom or /dev/random) do not exist, the system will fall back to
+    # a simplistic initialization mechanism using the builtin Mersenne Twister PRNG.
+    def initialize(noblock = true)
+      @mm = []
+      @randrsl = []
+      # Best initialization of the generator would be by pulling numbers from /dev/random.
+      rnd_source = noblock ? '/dev/urandom' : '/dev/random'
+      if (FileTest.exist? rnd_source)
+        File.open(rnd_source,'r') do |r|
+          256.times do |t|
+            z = r.read(4)
+            x = z.unpack('V')[0]
+            @randrsl[t] = x
+          end
+        end
+      else
+        # If urandom isn't available, the standard Ruby PRNG makes an adequate fallback.
+        256.times do |t|
+          @randrsl[t] = Kernel.rand(4294967295)
+        end
+      end
+      randinit(true)
+      nil
+    end
+
+    # Works just like the standard rand() function. If called with an integer argument, rand() will return positive
+    # random number in the range of 0 to (argument - 1). If called without an integer argument, rand() returns a
+    # positive floating point number less than 1.
+    def rand(*num)
+      if (@randcnt == 1)
+        isaac
+        @randcnt = 256
+      end
+      @randcnt -= 1
+      if num[0].to_i > 0
+        @randrsl[@randcnt].modulo(num[0])
+      else
+        ".#{@randrsl[@randcnt]}".to_f
+      end
+    end
+
+    def isaac
+      i = 0
+      x = 0
+      y = 0
+
+      @cc += 1
+      @bb += @cc
+      @bb & 0xffffffff
+
+      while (i < 256) do 
+        x = @mm[i]
+        @aa = (@mm[(i + 128) & 255] + (@aa^(@aa << 13)) ) & 0xffffffff
+        @mm[i] = y = (@mm[(x>>2)&255] + @aa + @bb ) & 0xffffffff
+        @randrsl[i] = @bb = (@mm[(y>>10)&255] + x ) & 0xffffffff
+        i += 1
+
+        x = @mm[i]
+        @aa = (@mm[(i+128)&255] + (@aa^(0x03ffffff & (@aa >> 6))) ) & 0xffffffff
+        @mm[i] = y = (@mm[(x>>2)&255] + @aa + @bb ) & 0xffffffff
+        @randrsl[i] = @bb = (@mm[(y>>10)&255] + x ) & 0xffffffff
+        i += 1
+
+        x = @mm[i]
+        @aa = (@mm[(i + 128)&255] + (@aa^(@aa << 2)) ) & 0xffffffff
+        @mm[i] = y = (@mm[(x>>2)&255] + @aa + @bb ) & 0xffffffff
+        @randrsl[i] = @bb = (@mm[(y>>10)&255] + x ) & 0xffffffff
+        i += 1
+
+        x = @mm[i]
+        @aa = (@mm[(i+128)&255] + (@aa^(0x0000ffff & (@aa >> 16))) ) & 0xffffffff
+        @mm[i] = y = (@mm[(x>>2)&255] + @aa + @bb ) & 0xffffffff
+        @randrsl[i] = @bb = (@mm[(y>>10)&255] + x ) & 0xffffffff
+        i += 1
+      end
+    end
+
+    def randinit(flag)
+      i = 0
+      a = 0
+      b = 0
+      c = 0
+      d = 0
+      e = 0
+      f = 0
+      g = 0
+      @aa = @bb = @cc = 0
+      a = b = c = d = e = f = g = h = 0x9e3779b9
+
+      while (i < 4) do
+        a ^= b<<1; d += a; b += c
+        b ^= 0x3fffffff & (c>>2); e += b; c += d
+        c ^= d << 8; f += c; d += e
+        d ^= 0x0000ffff & (e >> 16); g += d; e += f
+        e ^= f << 10; h += e; f += g
+        f ^= 0x0fffffff & (g >> 4); a += f; g += h
+        g ^= h << 8; b += g; h += a
+        h ^= 0x007fffff & (a >> 9); c += h; a += b
+        i += 1
+      end
+
+      i = 0
+      while (i < 256) do
+        if (flag)
+          a+=@randrsl[i  ].to_i; b+=@randrsl[i+1].to_i;
+          c+=@randrsl[i+2]; d+=@randrsl[i+3];
+          e+=@randrsl[i+4]; f+=@randrsl[i+5];
+          g+=@randrsl[i+6]; h+=@randrsl[i+7];
+        end
+
+        a^=b<<11; d+=a; b+=c;
+        b^=0x3fffffff & (c>>2);  e+=b; c+=d;
+        c^=d<<8;  f+=c; d+=e;
+        d^=0x0000ffff & (e>>16); g+=d; e+=f;
+        e^=f<<10; h+=e; f+=g;
+        f^=0x0fffffff & (g>>4);  a+=f; g+=h;
+        g^=h<<8;  b+=g; h+=a;
+        h^=0x007fffff & (a>>9);  c+=h; a+=b;
+        @mm[i]=a;@mm[i+1]=b; @mm[i+2]=c; @mm[i+3]=d;
+        @mm[i+4]=e; @mm[i+5]=f; @mm[i+6]=g; @mm[i+7]=h;
+        i += 8
+      end
+
+      if flag
+        i = 0
+        while (i < 256)
+          a+=@mm[i  ]; b+=@mm[i+1]; c+=@mm[i+2]; d+=@mm[i+3];
+          e+=@mm[i+4]; f+=@mm[i+5]; g+=@mm[i+6]; h+=@mm[i+7];
+          a^=b<<11; d+=a; b+=c;
+          b^=0x3fffffff & (c>>2);  e+=b; c+=d;
+          c^=d<<8;  f+=c; d+=e;
+          d^=0x0000ffff & (e>>16); g+=d; e+=f;
+          e^=f<<10; h+=e; f+=g;
+          f^=0x0fffffff & (g>>4);  a+=f; g+=h;
+          g^=h<<8;  b+=g; h+=a;
+          h^=0x007fffff & (a>>9);  c+=h; a+=b;
+          @mm[i  ]=a; @mm[i+1]=b; @mm[i+2]=c; @mm[i+3]=d;
+          @mm[i+4]=e; @mm[i+5]=f; @mm[i+6]=g; @mm[i+7]=h;
+          i += 8
+        end
+      end
+
+      isaac()
+       @randcnt=256;        # /* prepare to use the first set of results */
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "crypt-isaac"
+    gem.summary = %q(Ruby implementation of the ISAAC PRNG)
+    gem.email = "beawesomeinstead@yahoo.com"
+    gem.homepage = "http://github.com/bai/crypt-isaac"
+    gem.authors = ["beawesomeinstead"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "crypt-isaac #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/test/crypt-isaac_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class CryptIsaacTest < Test::Unit::TestCase
+  def setup
+    assert_nothing_raised("Failed to create a Crypt::ISAAC object.") do
+      @generator = Crypt::ISAAC.new
+    end
+  end
+
+  def test_kind
+    assert_kind_of(Crypt::ISAAC, @generator, "The created object is not a Crypt::ISAAC or subclass thereof.")
+  end
+
+  def test_integer
+    assert_nothing_raised("Failed while generating an integer random number.") do
+      mynum = @generator.rand(1000000)
+      assert_kind_of(Integer, mynum, "The generator failed to return an integer number in response to @generator.rand(1000000).")
+      assert((mynum >= 0), "The generator returned a number that is less than 0 (#{mynum}).")
+      assert((mynum < 1000000), "The generator returned a number that is greater than or equal to 1000000 (#{mynum}).")
+    end
+  end
+
+  def test_float
+    assert_nothing_raised("Failed while generating a floating point random number.") do
+      mynum = @generator.rand()
+      assert_kind_of(Float, mynum, "The generator failed to return a floating point number in response to @generator.rand().")
+      assert((mynum >= 0), "The generator returned a number that is less than 0 (#{mynum}).")
+      assert((mynum < 1), "The generator returned a number that is greater than or equal to 1 (#{mynum}).")
+    end
+  end
+
+  def test_iterations
+    puts
+    count = 0
+    assert_nothing_raised("Failed on iteration #{count} while trying to generate 100000 random numbers.") do
+      100000.times do
+        count += 1
+        x = @generator.rand(4294967295)
+        print [x].pack('V').unpack('H8') if count % 1000 == 0
+        if (count % 7000) == 0
+          print "\n"
+        else
+          print " " if count % 1000 == 0
+        end
+      end
+      puts "\n100000 numbers generated"
+    end
+  end
+
+  def test_dual_streams
+    g1 = nil
+    g2 = nil
+    assert_nothing_raised("Failed to pull numbers from two independent streams.") do
+      g1 = Crypt::ISAAC.new
+      g2 = Crypt::ISAAC.new
+      assert((g1 != g2),"The generators are the same. This should not happen.")
+      1000.times do
+        g1.rand(4294967295)
+        g2.rand(4294967295)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'crypt-isaac'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: bai-crypt-isaac
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- beawesomeinstead
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: beawesomeinstead@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- VERSION
+- crypt-isaac.gemspec
+- lib/crypt-isaac.rb
+- rakefile
+- test/crypt-isaac_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bai/crypt-isaac
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Ruby implementation of the ISAAC PRNG
+test_files: 
+- test/crypt-isaac_test.rb
+- test/test_helper.rb