rubysl-securerandom 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ff8c11aa9809bb98128b216ad032db00d45ce48
+  data.tar.gz: 3198625bdd325fbc434ddbfcfe23ecc90b73fde3
+SHA512:
+  metadata.gz: bcfff7a007ad01f43da4e111ff1bd1f083866cbc980efbd17e197aefafff02f681948177b16052292d06a49f95d13d208609712c96355600e3f9122c3e0ec713
+  data.tar.gz: 2149708075a815621b504f9ba3abfebda5bd11bfb50b7fc89e83975274680c9cc16fce35a249f407fcd3fbb2e2ee31de1d327eb8bd176d5b741a3dde1691d224

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+env:
+  - RUBYLIB=lib
+  - RUBYLIB=
+script: mspec spec
+rvm:
+  - 2.0.0
+  - rbx-2.2.1
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      env: RUBYLIB=lib
+    - rvm: rbx-2.2.1
+      env: RUBYLIB=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubysl-securerandom.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2013, Brian Shirai
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the library nor the names of its contributors may be
+   used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,29 @@
+# Rubysl::Securerandom
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubysl-securerandom'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubysl-securerandom
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rubysl/securerandom.rb

@@ -0,0 +1,2 @@
+require "rubysl/securerandom/securerandom"
+require "rubysl/securerandom/version"

data/lib/rubysl/securerandom/securerandom.rb

@@ -0,0 +1,145 @@
+# = Secure random number generator interface.
+#
+# This library is an interface for secure random number generator which is
+# suitable for generating session key in HTTP cookies, etc.
+#
+# It supports following secure random number generators.
+#
+# * openssl
+# * /dev/urandom
+#
+# == Example
+#
+# # random hexadecimal string.
+# p SecureRandom.hex(10) #=> "52750b30ffbc7de3b362"
+# p SecureRandom.hex(10) #=> "92b15d6c8dc4beb5f559"
+# p SecureRandom.hex(11) #=> "6aca1b5c58e4863e6b81b8"
+# p SecureRandom.hex(12) #=> "94b2fff3e7fd9b9c391a2306"
+# p SecureRandom.hex(13) #=> "39b290146bea6ce975c37cfc23"
+# ...
+#
+# # random base64 string.
+# p SecureRandom.base64(10) #=> "EcmTPZwWRAozdA=="
+# p SecureRandom.base64(10) #=> "9b0nsevdwNuM/w=="
+# p SecureRandom.base64(10) #=> "KO1nIU+p9DKxGg=="
+# p SecureRandom.base64(11) #=> "l7XEiFja+8EKEtY="
+# p SecureRandom.base64(12) #=> "7kJSM/MzBJI+75j8"
+# p SecureRandom.base64(13) #=> "vKLJ0tXBHqQOuIcSIg=="
+# ...
+#
+# # random binary string.
+# p SecureRandom.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
+# p SecureRandom.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
+# ...
+
+begin
+  require 'openssl'
+rescue LoadError
+end
+
+module SecureRandom
+  # SecureRandom.random_bytes generates a random binary string.
+  #
+  # The argument n specifies the length of the result string.
+  #
+  # If n is not specified, 16 is assumed.
+  # It may be larger in future.
+  #
+  # If secure random number generator is not available,
+  # NotImplementedError is raised.
+  def self.random_bytes(n=nil)
+    n ||= 16
+    if defined? OpenSSL::Random
+      @pid = 0 if !defined?(@pid)
+      pid = $$
+      if @pid != pid
+        now = Time.now
+        ary = [now.to_i, now.usec, @pid, pid]
+        OpenSSL::Random.seed(ary.join('.'))
+        @pid = pid
+      end
+      return OpenSSL::Random.random_bytes(n)
+    end
+    if !defined?(@has_urandom) || @has_urandom
+      @has_urandom = false
+      flags = File::RDONLY
+      flags |= File::NONBLOCK if defined? File::NONBLOCK
+      flags |= File::NOCTTY if defined? File::NOCTTY
+      flags |= File::NOFOLLOW if defined? File::NOFOLLOW
+      begin
+        File.open("/dev/urandom", flags) {|f|
+          unless f.stat.chardev?
+            raise Errno::ENOENT
+          end
+          @has_urandom = true
+          ret = f.readpartial(n)
+          if ret.length != n
+            raise NotImplementedError, "Unexpected partial read from random device"
+          end
+          return ret
+        }
+      rescue Errno::ENOENT
+        raise NotImplementedError, "No random device"
+      end
+    end
+    raise NotImplementedError, "No random device"
+  end
+
+  # SecureRandom.hex generates a random hex string.
+  #
+  # The argument n specifies the length of the random length.
+  # The length of the result string is twice of n.
+  #
+  # If n is not specified, 16 is assumed.
+  # It may be larger in future.
+  #
+  # If secure random number generator is not available,
+  # NotImplementedError is raised.
+  def self.hex(n=nil)
+    random_bytes(n).unpack("H*")[0]
+  end
+
+  # SecureRandom.base64 generates a random base64 string.
+  #
+  # The argument n specifies the length of the random length.
+  # The length of the result string is about 4/3 of n.
+  #
+  # If n is not specified, 16 is assumed.
+  # It may be larger in future.
+  #
+  # If secure random number generator is not available,
+  # NotImplementedError is raised.
+  def self.base64(n=nil)
+    [random_bytes(n)].pack("m*").delete("\n")
+  end
+
+  # SecureRandom.random_number generates a random number.
+  #
+  # If an positive integer is given as n,
+  # SecureRandom.random_number returns an integer:
+  # 0 <= SecureRandom.random_number(n) < n.
+  #
+  # If 0 is given or an argument is not given,
+  # SecureRandom.random_number returns an float:
+  # 0.0 <= SecureRandom.random_number() < 1.0.
+  def self.random_number(n=0)
+    if 0 < n
+      hex = n.to_s(16)
+      hex = '0' + hex if (hex.length & 1) == 1
+      bin = [hex].pack("H*")
+      mask = bin[0]
+      mask |= mask >> 1
+      mask |= mask >> 2
+      mask |= mask >> 4
+      begin
+        rnd = SecureRandom.random_bytes(bin.length)
+        rnd[0] = (rnd[0] & mask).chr
+      end until rnd < bin
+      rnd.unpack("H*")[0].hex
+    else
+      # assumption: Float::MANT_DIG <= 64
+      i64 = SecureRandom.random_bytes(8).unpack("Q")[0]
+      Math.ldexp(i64 >> (64-Float::MANT_DIG), -Float::MANT_DIG)
+    end
+  end
+end

data/lib/rubysl/securerandom/version.rb

@@ -0,0 +1,5 @@
+module RubySL
+  module SecureRandom
+    VERSION = "1.0.0"
+  end
+end

data/lib/securerandom.rb

@@ -0,0 +1 @@
+require "rubysl/securerandom"

data/rubysl-securerandom.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+require './lib/rubysl/securerandom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-securerandom"
+  spec.version       = RubySL::SecureRandom::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard lib securerandom.}
+  spec.summary       = %q{Ruby standard lib securerandom.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-securerandom"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 1.8.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
+end

data/spec/base64_spec.rb

@@ -0,0 +1,56 @@
+
+ruby_version_is "1.8.7" do
+  require 'securerandom'
+
+  describe "SecureRandom.base64" do
+    it "generates a random base64 string out of specified number of random bytes" do
+      (16..128).each do |idx|
+        base64 = SecureRandom.base64(idx)
+        base64.should be_kind_of(String)
+        base64.length.should < 2 * idx
+        base64.should =~ /^[A-Za-z0-9\+\/]+={0,2}$/
+      end
+
+      base64 = SecureRandom.base64(16.5)
+      base64.should be_kind_of(String)
+      base64.length.should < 2 * 16
+    end
+
+    it "returns an empty string when argument is 0" do
+      SecureRandom.base64(0).should == ""
+    end
+
+    it "generates different base64 strings with subsequent invocations" do
+      # quick and dirty check, but good enough
+      values = []
+      256.times do
+        base64 = SecureRandom.base64
+        # make sure the random values are not repeating
+        values.include?(base64).should == false
+        values << base64
+      end
+    end
+
+    it "generates a random base64 string out of 32 random bytes" do
+      SecureRandom.base64.should be_kind_of(String)
+      SecureRandom.base64.length.should < 32 * 2
+    end
+
+    it "treats nil agrument as default one and generates a random base64 string" do
+      SecureRandom.base64(nil).should be_kind_of(String)
+      SecureRandom.base64(nil).length.should < 32 * 2
+    end
+
+    it "raises ArgumentError on negative arguments" do
+      lambda {
+        SecureRandom.base64(-1)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "tries to convert the passed argument to an Integer using #to_int" do
+      obj = mock("to_int")
+      obj.should_receive(:to_int).and_return(5)
+      SecureRandom.base64(obj).size.should < 10
+    end
+  end
+end

data/spec/hex_spec.rb

@@ -0,0 +1,55 @@
+
+ruby_version_is "1.8.7" do
+  require 'securerandom'
+
+  describe "SecureRandom.hex" do
+    it "generates a random hex string of length twice the specified argement" do
+      (1..64).each do |idx|
+        hex = SecureRandom.hex(idx)
+        hex.should be_kind_of(String)
+        hex.length.should == 2 * idx
+      end
+
+      base64 = SecureRandom.hex(5.5)
+      base64.should be_kind_of(String)
+      base64.length.should eql(10)
+    end
+
+    it "returns an empty string when argument is 0" do
+      SecureRandom.hex(0).should == ""
+    end
+
+    it "generates different hex strings with subsequent invocations" do
+      # quick and dirty check, but good enough
+      values = []
+      256.times do
+        hex = SecureRandom.hex
+        # make sure the random values are not repeating
+        values.include?(hex).should == false
+        values << hex
+      end
+    end
+
+    it "generates a random hex string of length 32 if no argument is provided" do
+      SecureRandom.hex.should be_kind_of(String)
+      SecureRandom.hex.length.should == 32
+    end
+
+    it "treats nil agrument as default one and generates a random hex string of length 32" do
+      SecureRandom.hex(nil).should be_kind_of(String)
+      SecureRandom.hex(nil).length.should == 32
+    end
+
+    it "raises ArgumentError on negative arguments" do
+      lambda {
+        SecureRandom.hex(-1)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "tries to convert the passed argument to an Integer using #to_int" do
+      obj = mock("to_int")
+      obj.should_receive(:to_int).and_return(5)
+      SecureRandom.hex(obj).size.should eql(10)
+    end
+  end
+end

data/spec/random_bytes_spec.rb

@@ -0,0 +1,51 @@
+
+ruby_version_is "1.8.7" do
+  require 'securerandom'
+
+  describe "SecureRandom.random_bytes" do
+    it "generates a random binary string of length 16 if no argument is provided" do
+      bytes = SecureRandom.random_bytes
+      bytes.should be_kind_of(String)
+      bytes.length.should == 16
+    end
+
+    it "generates a random binary string of length 16 if argument is nil" do
+      bytes = SecureRandom.random_bytes(nil)
+      bytes.should be_kind_of(String)
+      bytes.length.should == 16
+    end
+
+    it "generates a random binary string of specified length" do
+      (1..64).each do |idx|
+        bytes = SecureRandom.random_bytes(idx)
+        bytes.should be_kind_of(String)
+        bytes.length.should == idx
+      end
+
+      SecureRandom.random_bytes(2.2).length.should eql(2)
+    end
+
+    it "generates different binary strings with subsequent invocations" do
+      # quick and dirty check, but good enough
+      values = []
+      256.times do
+        val = SecureRandom.random_bytes
+        # make sure the random bytes are not repeating
+        values.include?(val).should == false
+        values << val
+      end
+    end
+
+    it "raises ArgumentError on negative arguments" do
+      lambda {
+        SecureRandom.random_bytes(-1)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "tries to convert the passed argument to an Integer using #to_int" do
+      obj = mock("to_int")
+      obj.should_receive(:to_int).and_return(5)
+      SecureRandom.random_bytes(obj).size.should eql(5)
+    end
+  end
+end

data/spec/random_number_spec.rb

@@ -0,0 +1,48 @@
+
+ruby_version_is "1.8.7" do
+  require 'securerandom'
+
+  describe "SecureRandom.random_number" do
+    it "generates a random positive number smaller then the positive integer argument" do
+      (1..64).each do |idx|
+        num = SecureRandom.random_number(idx)
+        num.should be_kind_of(Fixnum)
+        (0 <= num).should == true
+        (num < idx).should == true
+      end
+    end
+
+    it "generates a random float number between 0.0 and 1.0 if no argument provided" do
+      64.times do
+        num = SecureRandom.random_number
+        num.should be_kind_of(Float)
+        (0.0 <= num).should == true
+        (num < 1.0).should == true
+      end
+    end
+
+    it "generates a random float number between 0.0 and 1.0 if argument is negative" do
+      num = SecureRandom.random_number(-10)
+      num.should be_kind_of(Float)
+      (0.0 <= num).should == true
+      (num < 1.0).should == true
+    end
+
+    it "generates different float numbers with subsequent invocations" do
+      # quick and dirty check, but good enough
+      values = []
+      256.times do
+        val = SecureRandom.random_number
+        # make sure the random values are not repeating
+        values.include?(val).should == false
+        values << val
+      end
+    end
+
+    it "raises ArgumentError if the argument is non-numeric" do
+      lambda {
+        SecureRandom.random_number(Object.new)
+      }.should raise_error(ArgumentError)
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rubysl-securerandom
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Shirai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubysl-prettyprint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby standard lib securerandom.
+email:
+- brixen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rubysl/securerandom.rb
+- lib/rubysl/securerandom/securerandom.rb
+- lib/rubysl/securerandom/version.rb
+- lib/securerandom.rb
+- rubysl-securerandom.gemspec
+- spec/base64_spec.rb
+- spec/hex_spec.rb
+- spec/random_bytes_spec.rb
+- spec/random_number_spec.rb
+homepage: https://github.com/rubysl/rubysl-securerandom
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby standard lib securerandom.
+test_files:
+- spec/base64_spec.rb
+- spec/hex_spec.rb
+- spec/random_bytes_spec.rb
+- spec/random_number_spec.rb