securerandom 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5369e43862e4524d9261f2c50b175c1bb99958cb2abfba54bae9fec715556133
-  data.tar.gz: cbe246fd3da662ace60c0ffe53a5175227611a4ed74d5c4ac84fde64c44d9ebb
+  metadata.gz: 4d1e553e66963e86b8c31aeaca8030543f034770d4c91652e905e7d24101a267
+  data.tar.gz: b9088d38e62d77718b8cdf44f12e5027763bfc49d08e98e2190cac40217a53e7
 SHA512:
-  metadata.gz: b416a144b9d4a134212b215ad45d03a80a1cc07d866ea7714363250d6f5f665bbf09410b37856ced86ebc2a7b5e16b3b04f4cab64b1b5ff05c1b4a223f3fcc7a
-  data.tar.gz: 174eb8f33e98f66f61c8792d512f04feedb9881ff4a79a39040da625b7b973f4c4796857cd1c132d16435df57ad74a229a1f7ec959cb66aac969d084496ee691
+  metadata.gz: dd175de6c33318073d7eeae18ed42bbd797f425ebcfcddcfd4d91cc9256fcd9b4ee96d9ef409e2817a49cdfc5f3a85496018a5642ce62124d09212c8b48348c8
+  data.tar.gz: 51914a9cfa12a128634135d650b9213a5aab22005542ad1fd79fa74b1456a3388def2ba1d13255262437a22e971fd888eeaaac63121111fa5a245b2429d99889

data/{LICENSE.txt → BSDL}

@@ -4,10 +4,10 @@ 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.
+   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.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/lib/securerandom.rb

@@ -1,6 +1,8 @@
 # -*- coding: us-ascii -*-
 # frozen_string_literal: true
 
+require 'random/formatter'
+
 # == Secure random number generator interface.
 #
 # This library is an interface to secure random number generators which are
@@ -31,63 +33,40 @@
 # * uuid
 #
 # These methods are usable as class methods of SecureRandom such as
-# `SecureRandom.hex`.
-#
-# === Examples
-#
-# Generate random hexadecimal strings:
-#
-#   require 'securerandom'
-#
-#   SecureRandom.hex(10) #=> "52750b30ffbc7de3b362"
-#   SecureRandom.hex(10) #=> "92b15d6c8dc4beb5f559"
-#   SecureRandom.hex(13) #=> "39b290146bea6ce975c37cfc23"
-#
-# Generate random base64 strings:
-#
-#   SecureRandom.base64(10) #=> "EcmTPZwWRAozdA=="
-#   SecureRandom.base64(10) #=> "KO1nIU+p9DKxGg=="
-#   SecureRandom.base64(12) #=> "7kJSM/MzBJI+75j8"
-#
-# Generate random binary strings:
-#
-#   SecureRandom.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
-#   SecureRandom.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
-#
-# Generate alphanumeric strings:
-#
-#   SecureRandom.alphanumeric(10) #=> "S8baxMJnPl"
-#   SecureRandom.alphanumeric(10) #=> "aOxAg8BAJe"
-#
-# Generate UUIDs:
-#
-#   SecureRandom.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
-#   SecureRandom.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+# +SecureRandom.hex+.
 #
+# If a secure random number generator is not available,
+# +NotImplementedError+ is raised.
 
 module SecureRandom
+
+  # The version
+  VERSION = "0.4.1"
+
   class << self
+    # Returns a random binary string containing +size+ bytes.
+    #
+    # See Random.bytes
     def bytes(n)
       return gen_random(n)
     end
 
+    # Compatibility methods for Ruby 3.2, we can remove this after dropping to support Ruby 3.2
+    def alphanumeric(n = nil, chars: ALPHANUMERIC)
+      n = 16 if n.nil?
+      choose(chars, n)
+    end if RUBY_VERSION < '3.3'
+
     private
 
+    # :stopdoc:
+
+    # Implementation using OpenSSL
     def gen_random_openssl(n)
-      @pid = 0 unless defined?(@pid)
-      pid = $$
-      unless @pid == pid
-        now = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
-        OpenSSL::Random.random_add([now, @pid, pid].join(""), 0.0)
-        seed = Random.urandom(16)
-        if (seed)
-          OpenSSL::Random.random_add(seed, 16)
-        end
-        @pid = pid
-      end
       return OpenSSL::Random.random_bytes(n)
     end
 
+    # Implementation using system random device
     def gen_random_urandom(n)
       ret = Random.urandom(n)
       unless ret
@@ -99,8 +78,11 @@ module SecureRandom
       ret
     end
 
-    ret = Random.urandom(1)
-    if ret.nil?
+    begin
+      # Check if Random.urandom is available
+      Random.urandom(1)
+      alias gen_random gen_random_urandom
+    rescue RuntimeError
       begin
         require 'openssl'
       rescue NoMethodError
@@ -108,209 +90,12 @@ module SecureRandom
       else
         alias gen_random gen_random_openssl
       end
-    else
-      alias gen_random gen_random_urandom
     end
 
-    public :gen_random
-  end
-end
-
-module Random::Formatter
-
-  # SecureRandom.random_bytes generates a random binary string.
-  #
-  # The argument _n_ specifies the length of the result string.
-  #
-  # If _n_ is not specified or is nil, 16 is assumed.
-  # It may be larger in future.
-  #
-  # The result may contain any byte: "\x00" - "\xff".
-  #
-  #   require 'securerandom'
-  #
-  #   SecureRandom.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
-  #   SecureRandom.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
-  #
-  # If a secure random number generator is not available,
-  # +NotImplementedError+ is raised.
-  def random_bytes(n=nil)
-    n = n ? n.to_int : 16
-    gen_random(n)
-  end
-
-  # SecureRandom.hex generates a random hexadecimal string.
-  #
-  # The argument _n_ specifies the length, in bytes, of the random number to be generated.
-  # The length of the resulting hexadecimal string is twice of _n_.
-  #
-  # If _n_ is not specified or is nil, 16 is assumed.
-  # It may be larger in the future.
-  #
-  # The result may contain 0-9 and a-f.
-  #
-  #   require 'securerandom'
-  #
-  #   SecureRandom.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
-  #   SecureRandom.hex #=> "91dc3bfb4de5b11d029d376634589b61"
-  #
-  # If a secure random number generator is not available,
-  # +NotImplementedError+ is raised.
-  def hex(n=nil)
-    random_bytes(n).unpack("H*")[0]
-  end
-
-  # SecureRandom.base64 generates a random base64 string.
-  #
-  # The argument _n_ specifies the length, in bytes, of the random number
-  # to be generated. The length of the result string is about 4/3 of _n_.
-  #
-  # If _n_ is not specified or is nil, 16 is assumed.
-  # It may be larger in the future.
-  #
-  # The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
-  #
-  #   require 'securerandom'
-  #
-  #   SecureRandom.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
-  #   SecureRandom.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
-  #
-  # If a secure random number generator is not available,
-  # +NotImplementedError+ is raised.
-  #
-  # See RFC 3548 for the definition of base64.
-  def base64(n=nil)
-    [random_bytes(n)].pack("m0")
-  end
-
-  # SecureRandom.urlsafe_base64 generates a random URL-safe base64 string.
-  #
-  # The argument _n_ specifies the length, in bytes, of the random number
-  # to be generated. The length of the result string is about 4/3 of _n_.
-  #
-  # If _n_ is not specified or is nil, 16 is assumed.
-  # It may be larger in the 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.
-  #
-  #   require 'securerandom'
-  #
-  #   SecureRandom.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
-  #   SecureRandom.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
-  #
-  #   SecureRandom.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
-  #   SecureRandom.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
-  #
-  # If a secure random number generator is not available,
-  # +NotImplementedError+ is raised.
-  #
-  # See RFC 3548 for the definition of URL-safe base64.
-  def urlsafe_base64(n=nil, padding=false)
-    s = [random_bytes(n)].pack("m0")
-    s.tr!("+/", "-_")
-    s.delete!("=") unless padding
-    s
-  end
-
-  # SecureRandom.uuid generates a random v4 UUID (Universally Unique IDentifier).
-  #
-  #   require 'securerandom'
-  #
-  #   SecureRandom.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
-  #   SecureRandom.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
-  #   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 addresses, timestamps, etc.
-  #
-  # The result contains 122 random bits (15.25 random bytes).
-  #
-  # See RFC 4122 for details of UUID.
-  #
-  def uuid
-    ary = 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
-
-  private def gen_random(n)
-    self.bytes(n)
-  end
+    # :startdoc:
 
-  # SecureRandom.choose generates a string that randomly draws from a
-  # source array of characters.
-  #
-  # The argument _source_ specifies the array of characters from which
-  # to generate the string.
-  # The argument _n_ specifies the length, in characters, of the string to be
-  # generated.
-  #
-  # The result may contain whatever characters are in the source array.
-  #
-  #   require 'securerandom'
-  #
-  #   SecureRandom.choose([*'l'..'r'], 16) #=> "lmrqpoonmmlqlron"
-  #   SecureRandom.choose([*'0'..'9'], 5)  #=> "27309"
-  #
-  # If a secure random number generator is not available,
-  # +NotImplementedError+ is raised.
-  private def choose(source, n)
-    size = source.size
-    m = 1
-    limit = size
-    while limit * size <= 0x100000000
-      limit *= size
-      m += 1
-    end
-    result = ''.dup
-    while m <= n
-      rs = random_number(limit)
-      is = rs.digits(size)
-      (m-is.length).times { is << 0 }
-      result << source.values_at(*is).join('')
-      n -= m
-    end
-    if 0 < n
-      rs = random_number(limit)
-      is = rs.digits(size)
-      if is.length < n
-        (n-is.length).times { is << 0 }
-      else
-        is.pop while n < is.length
-      end
-      result.concat source.values_at(*is).join('')
-    end
-    result
-  end
-
-  ALPHANUMERIC = [*'A'..'Z', *'a'..'z', *'0'..'9']
-  # SecureRandom.alphanumeric generates a random alphanumeric string.
-  #
-  # The argument _n_ specifies the length, in characters, of the alphanumeric
-  # string to be generated.
-  #
-  # If _n_ is not specified or is nil, 16 is assumed.
-  # It may be larger in the future.
-  #
-  # The result may contain A-Z, a-z and 0-9.
-  #
-  #   require 'securerandom'
-  #
-  #   SecureRandom.alphanumeric     #=> "2BuBuLf3WfSKyQbR"
-  #   SecureRandom.alphanumeric(10) #=> "i6K93NdqiH"
-  #
-  # If a secure random number generator is not available,
-  # +NotImplementedError+ is raised.
-  def alphanumeric(n=nil)
-    n = 16 if n.nil?
-    choose(ALPHANUMERIC, n)
+    # Generate random data bytes for Random::Formatter
+    public :gen_random
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: securerandom
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Tanaka Akira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies: []
 description: Interface for secure random number generator.
 email:
@@ -17,16 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
+- BSDL
+- COPYING
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/securerandom.rb
-- securerandom.gemspec
 homepage: https://github.com/ruby/securerandom
 licenses:
 - Ruby
@@ -42,14 +36,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Interface for secure random number generator.

data/.github/workflows/test.yml

@@ -1,24 +0,0 @@
-name: build
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
-    strategy:
-      matrix:
-        ruby: [ 2.7, 2.6, 2.5, head ]
-        os: [ ubuntu-latest, macos-latest ]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: |
-        gem install bundler --no-document
-        bundle install
-    - name: Run test
-      run: rake compile test

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem "rake"
-gem "test-unit"

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-task :default => :test

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "securerandom"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/securerandom.gemspec

@@ -1,22 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name          = "securerandom"
-  spec.version       = "0.1.0"
-  spec.authors       = ["Tanaka Akira"]
-  spec.email         = ["akr@fsij.org"]
-
-  spec.summary       = %q{Interface for secure random number generator.}
-  spec.description   = %q{Interface for secure random number generator.}
-  spec.homepage      = "https://github.com/ruby/securerandom"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-  spec.licenses      = ["Ruby", "BSD-2-Clause"]
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end