rubysl-securerandom 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff8c11aa9809bb98128b216ad032db00d45ce48
-  data.tar.gz: 3198625bdd325fbc434ddbfcfe23ecc90b73fde3
+  metadata.gz: 302f7210b19637415ffe3f827bc725db6f2a8d3b
+  data.tar.gz: 5e670c291b50e6940b6e95bf402f820ebeb1fa34
 SHA512:
-  metadata.gz: bcfff7a007ad01f43da4e111ff1bd1f083866cbc980efbd17e197aefafff02f681948177b16052292d06a49f95d13d208609712c96355600e3f9122c3e0ec713
-  data.tar.gz: 2149708075a815621b504f9ba3abfebda5bd11bfb50b7fc89e83975274680c9cc16fce35a249f407fcd3fbb2e2ee31de1d327eb8bd176d5b741a3dde1691d224
+  metadata.gz: 3343644b5873052e43005122004a2af504bfa8fcfe8ec2e16e0a236decf6c58d3c298a7f3b6285a9157cf6c2a5a7e7944d02171b8940af7fdb55026a3c5dbe6a
+  data.tar.gz: 00d66d2dd39b8fc47e66ec7bbc8d2aa164676f2e1fdf6866d1aca68f27eaf7219f6473d852ad99b57dd01626d1b66b8011fbce17367a58dc2248c6e33f9c9cf6

data/.travis.yml

@@ -1,14 +1,7 @@
 language: ruby
 env:
   - RUBYLIB=lib
-  - RUBYLIB=
-script: mspec spec
+script: bundle exec mspec
 rvm:
-  - 2.0.0
-  - rbx-2.2.1
-matrix:
-  exclude:
-    - rvm: 2.0.0
-      env: RUBYLIB=lib
-    - rvm: rbx-2.2.1
-      env: RUBYLIB=
+  - 1.9.3
+  - rbx-nightly-19mode

data/lib/rubysl/securerandom/securerandom.rb

@@ -7,6 +7,7 @@
 #
 # * openssl
 # * /dev/urandom
+# * Win32
 #
 # == Example
 #
@@ -40,32 +41,37 @@ end
 module SecureRandom
   # SecureRandom.random_bytes generates a random binary string.
   #
-  # The argument n specifies the length of the result string.
+  # The argument _n_ specifies the length of the result string.
   #
-  # If n is not specified, 16 is assumed.
+  # If _n_ is not specified, 16 is assumed.
   # It may be larger in future.
   #
+  # The result may contain any byte: "\x00" - "\xff".
+  #
+  #   p SecureRandom.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
+  #   p SecureRandom.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
+  #
   # 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('.'))
+        ary = [now.to_i, now.nsec, @pid, pid]
+        OpenSSL::Random.seed(ary.to_s)
         @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?
@@ -79,20 +85,55 @@ module SecureRandom
           return ret
         }
       rescue Errno::ENOENT
-        raise NotImplementedError, "No random device"
+        @has_urandom = false
+      end
+    end
+
+    if !defined?(@has_win32)
+      begin
+        require 'Win32API'
+
+        crypt_acquire_context = Win32API.new("advapi32", "CryptAcquireContext", 'PPPII', 'L')
+        @crypt_gen_random = Win32API.new("advapi32", "CryptGenRandom", 'LIP', 'L')
+
+        hProvStr = " " * 4
+        prov_rsa_full = 1
+        crypt_verifycontext = 0xF0000000
+
+        if crypt_acquire_context.call(hProvStr, nil, nil, prov_rsa_full, crypt_verifycontext) == 0
+          raise SystemCallError, "CryptAcquireContext failed: #{lastWin32ErrorMessage}"
+        end
+        @hProv, = hProvStr.unpack('L')
+
+        @has_win32 = true
+      rescue LoadError
+        @has_win32 = false
       end
     end
+    if @has_win32
+      bytes = " ".force_encoding("ASCII-8BIT") * n
+      if @crypt_gen_random.call(@hProv, bytes.size, bytes) == 0
+        raise SystemCallError, "CryptGenRandom failed: #{lastWin32ErrorMessage}"
+      end
+      return bytes
+    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.
+  # 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.
+  # If _n_ is not specified, 16 is assumed.
   # It may be larger in future.
   #
+  # The result may contain 0-9 and a-f.
+  #
+  #   p SecureRandom.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
+  #   p SecureRandom.hex #=> "91dc3bfb4de5b11d029d376634589b61"
+  #
   # If secure random number generator is not available,
   # NotImplementedError is raised.
   def self.hex(n=nil)
@@ -101,39 +142,87 @@ module SecureRandom
 
   # 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.
+  # 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.
+  # If _n_ is not specified, 16 is assumed.
   # It may be larger in future.
   #
+  # The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
+  #
+  #   p SecureRandom.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
+  #   p SecureRandom.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
+  #
   # If secure random number generator is not available,
   # NotImplementedError is raised.
+  #
+  # See RFC 3548 for the definition of base64.
   def self.base64(n=nil)
     [random_bytes(n)].pack("m*").delete("\n")
   end
 
+  # SecureRandom.urlsafe_base64 generates a random URL-safe 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.
+  #
+  # The boolean argument _padding_ specifies the padding.
+  # If it is false or nil, padding is not generated.
+  # Otherwise padding is generated.
+  # By default, padding is not generated because "=" may be used as a URL delimiter.
+  #
+  # The result may contain A-Z, a-z, 0-9, "-" and "_".
+  # "=" is also used if _padding_ is true.
+  #
+  #   p SecureRandom.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
+  #   p SecureRandom.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
+  #
+  #   p SecureRandom.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
+  #   p SecureRandom.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
+  #
+  # If secure random number generator is not available,
+  # NotImplementedError is raised.
+  #
+  # See RFC 3548 for the definition of URL-safe base64.
+  def self.urlsafe_base64(n=nil, padding=false)
+    s = [random_bytes(n)].pack("m*")
+    s.delete!("\n")
+    s.tr!("+/", "-_")
+    s.delete!("=") if !padding
+    s
+  end
+
   # SecureRandom.random_number generates a random number.
   #
-  # If an positive integer is given as n,
+  # If a positive integer is given as _n_,
   # SecureRandom.random_number returns an integer:
   # 0 <= SecureRandom.random_number(n) < n.
   #
+  #   p SecureRandom.random_number(100) #=> 15
+  #   p SecureRandom.random_number(100) #=> 88
+  #
   # If 0 is given or an argument is not given,
-  # SecureRandom.random_number returns an float:
+  # SecureRandom.random_number returns a float:
   # 0.0 <= SecureRandom.random_number() < 1.0.
+  #
+  #   p SecureRandom.random_number #=> 0.596506046187744
+  #   p SecureRandom.random_number #=> 0.350621695741409
+  #
   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 = bin[0].ord
       mask |= mask >> 1
       mask |= mask >> 2
       mask |= mask >> 4
       begin
         rnd = SecureRandom.random_bytes(bin.length)
-        rnd[0] = (rnd[0] & mask).chr
+        rnd[0] = (rnd[0].ord & mask).chr
       end until rnd < bin
       rnd.unpack("H*")[0].hex
     else
@@ -142,4 +231,35 @@ module SecureRandom
       Math.ldexp(i64 >> (64-Float::MANT_DIG), -Float::MANT_DIG)
     end
   end
+
+  # SecureRandom.uuid generates a v4 random UUID (Universally Unique IDentifier).
+  #
+  #   p SecureRandom.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
+  #   p SecureRandom.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+  #   p SecureRandom.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
+  #
+  # The version 4 UUID is purely random (except the version).
+  # It doesn't contain meaningful information such as MAC address, time, etc.
+  #
+  # See RFC 4122 for details of UUID.
+  #
+  def self.uuid
+    ary = self.random_bytes(16).unpack("NnnnnN")
+    ary[2] = (ary[2] & 0x0fff) | 0x4000
+    ary[3] = (ary[3] & 0x3fff) | 0x8000
+    "%08x-%04x-%04x-%04x-%04x%08x" % ary
+  end
+
+  # Following code is based on David Garamond's GUID library for Ruby.
+  def self.lastWin32ErrorMessage # :nodoc:
+    get_last_error = Win32API.new("kernel32", "GetLastError", '', 'L')
+    format_message = Win32API.new("kernel32", "FormatMessageA", 'LPLLPLPPPPPPPP', 'L')
+    format_message_ignore_inserts = 0x00000200
+    format_message_from_system    = 0x00001000
+
+    code = get_last_error.call
+    msg = "\0" * 1024
+    len = format_message.call(format_message_ignore_inserts + format_message_from_system, 0, code, 0, msg, 1024, nil, nil, nil, nil, nil, nil, nil, nil)
+    msg[0, len].tr("\r", '').chomp
+  end
 end

data/lib/rubysl/securerandom/version.rb

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

data/rubysl-securerandom.gemspec

@@ -16,10 +16,7 @@ Gem::Specification.new do |spec|
   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

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-securerandom
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2013-09-06 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
@@ -73,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -98,17 +84,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Ruby standard lib securerandom.