securerandom 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 396cd8fff3b7710c09c49c19017c3b32b81810ab7aa4d4d468e88e0231294da4
-  data.tar.gz: c0a2fa9b2e657eff48a221877b49a3c7d20d18ca955cfcc90594b28a4adcef74
+  metadata.gz: 1e5fca1a0e74f7d256340e2b2e12196ed97adc8ebc512697473d56c110fe682c
+  data.tar.gz: 19d45327f812eede26a7a1432381e8c43d114ca0268ea1697b727db5c94c5ca9
 SHA512:
-  metadata.gz: 7f562481a1134ea11d151e3167c700b9995767aa7f643c8d95b112af872c9a2884e74194550329b618a05081b05bc96e21d1e7c7e117940c4a8edbb5a94897d7
-  data.tar.gz: 81aea2e28ad6406656700f8b2df92f9a87d1b6eca6ab5b2edd9753dcf444968bdbedda317a1785ad781ddf4ddbdefac117cc91871466f1a8c7af4f36d7ed1f15
+  metadata.gz: e36e2adb4f23bf29d52a519e68e89dd5c947803399fd493bdab26c452e38142f11d7af03ef436f70c6f7a3c8881cee75b179167b5376556dfc91e4ab3f8ccc46
+  data.tar.gz: 0e86593665d73afc22c91f6964df05f6134dc3b75b443932dde93ee38d296c692478b456a95110e042c4ff7dc54ccefb6cad84847dcd8a3e97d47736a6f25a6c

data/.github/workflows/test.yml

@@ -1,17 +1,24 @@
-name: build
+name: test
 
 on: [push, pull_request]
 
 jobs:
-  build:
+  ruby-versions:
+    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      engine: cruby
+      min_version: 2.6
+
+  test:
+    needs: ruby-versions
     name: build (${{ matrix.ruby }} / ${{ matrix.os }})
     strategy:
       matrix:
-        ruby: [ head, '3.0', '2.7', '2.6' ]
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
         os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/lib/random/formatter.rb

@@ -1,9 +1,14 @@
 # -*- coding: us-ascii -*-
 # frozen_string_literal: true
 
-# == Random number formatter.
+# == \Random number formatter.
 #
-# Formats generated random numbers in many manners.
+# Formats generated random numbers in many manners. When <tt>'random/formatter'</tt>
+# is required, several methods are added to empty core module <tt>Random::Formatter</tt>,
+# making them available as Random's instance and module methods.
+#
+# Standard library SecureRandom is also extended with the module, and the methods
+# described below are available as a module methods in it.
 #
 # === Examples
 #
@@ -11,34 +16,45 @@
 #
 #   require 'random/formatter'
 #
+#   prng = Random.new
 #   prng.hex(10) #=> "52750b30ffbc7de3b362"
 #   prng.hex(10) #=> "92b15d6c8dc4beb5f559"
 #   prng.hex(13) #=> "39b290146bea6ce975c37cfc23"
+#   # or just
+#   Random.hex #=> "1aed0c631e41be7f77365415541052ee"
 #
 # Generate random base64 strings:
 #
 #   prng.base64(10) #=> "EcmTPZwWRAozdA=="
 #   prng.base64(10) #=> "KO1nIU+p9DKxGg=="
 #   prng.base64(12) #=> "7kJSM/MzBJI+75j8"
+#   Random.base64(4) #=> "bsQ3fQ=="
 #
 # Generate random binary strings:
 #
 #   prng.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
 #   prng.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
+#   Random.random_bytes(6) #=> "\xA1\xE6Lr\xC43"
 #
 # Generate alphanumeric strings:
 #
 #   prng.alphanumeric(10) #=> "S8baxMJnPl"
 #   prng.alphanumeric(10) #=> "aOxAg8BAJe"
+#   Random.alphanumeric #=> "TmP9OsJHJLtaZYhP"
 #
 # Generate UUIDs:
 #
 #   prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
 #   prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+#   Random.uuid #=> "f14e0271-de96-45cc-8911-8910292a42cd"
+#
+# All methods are available in the standard library SecureRandom, too:
+#
+#   SecureRandom.hex #=> "05b45376a30c67238eb93b16499e50cf"
 
 module Random::Formatter
 
-  # Random::Formatter#random_bytes generates a random binary string.
+  # Generate a random binary string.
   #
   # The argument _n_ specifies the length of the result string.
   #
@@ -49,14 +65,16 @@ module Random::Formatter
   #
   #   require 'random/formatter'
   #
-  #   prng.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
+  #   Random.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
+  #   # or
+  #   prng = Random.new
   #   prng.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
   def random_bytes(n=nil)
     n = n ? n.to_int : 16
     gen_random(n)
   end
 
-  # Random::Formatter#hex generates a random hexadecimal string.
+  # Generate 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_.
@@ -68,13 +86,15 @@ module Random::Formatter
   #
   #   require 'random/formatter'
   #
-  #   prng.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
+  #   Random.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
+  #   # or
+  #   prng = Random.new
   #   prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
   def hex(n=nil)
     random_bytes(n).unpack1("H*")
   end
 
-  # Random::Formatter#base64 generates a random base64 string.
+  # Generate 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_.
@@ -86,7 +106,9 @@ module Random::Formatter
   #
   #   require 'random/formatter'
   #
-  #   prng.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
+  #   Random.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
+  #   # or
+  #   prng = Random.new
   #   prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
   #
   # See RFC 3548 for the definition of base64.
@@ -94,7 +116,7 @@ module Random::Formatter
     [random_bytes(n)].pack("m0")
   end
 
-  # Random::Formatter#urlsafe_base64 generates a random URL-safe base64 string.
+  # Generate 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_.
@@ -112,7 +134,9 @@ module Random::Formatter
   #
   #   require 'random/formatter'
   #
-  #   prng.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
+  #   Random.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
+  #   # or
+  #   prng = Random.new
   #   prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
   #
   #   prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
@@ -126,12 +150,14 @@ module Random::Formatter
     s
   end
 
-  # Random::Formatter#uuid generates a random v4 UUID (Universally Unique IDentifier).
+  # Generate a random v4 UUID (Universally Unique IDentifier).
   #
   #   require 'random/formatter'
   #
-  #   prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
-  #   prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+  #   Random.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
+  #   Random.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+  #   # or
+  #   prng = Random.new
   #   prng.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
   #
   # The version 4 UUID is purely random (except the version).
@@ -139,7 +165,7 @@ module Random::Formatter
   #
   # The result contains 122 random bits (15.25 random bytes).
   #
-  # See RFC 4122 for details of UUID.
+  # See RFC4122[https://datatracker.ietf.org/doc/html/rfc4122] for details of UUID.
   #
   def uuid
     ary = random_bytes(16).unpack("NnnnnN")
@@ -148,11 +174,130 @@ module Random::Formatter
     "%08x-%04x-%04x-%04x-%04x%08x" % ary
   end
 
+  alias uuid_v4 uuid
+
+  # Generate a random v7 UUID (Universally Unique IDentifier).
+  #
+  #   require 'random/formatter'
+  #
+  #   Random.uuid_v7 # => "0188d4c3-1311-7f96-85c7-242a7aa58f1e"
+  #   Random.uuid_v7 # => "0188d4c3-16fe-744f-86af-38fa04c62bb5"
+  #   Random.uuid_v7 # => "0188d4c3-1af8-764f-b049-c204ce0afa23"
+  #   Random.uuid_v7 # => "0188d4c3-1e74-7085-b14f-ef6415dc6f31"
+  #   #                    |<--sorted-->| |<----- random ---->|
+  #
+  #   # or
+  #   prng = Random.new
+  #   prng.uuid_v7 # => "0188ca51-5e72-7950-a11d-def7ff977c98"
+  #
+  # The version 7 UUID starts with the least significant 48 bits of a 64 bit
+  # Unix timestamp (milliseconds since the epoch) and fills the remaining bits
+  # with random data, excluding the version and variant bits.
+  #
+  # This allows version 7 UUIDs to be sorted by creation time.  Time ordered
+  # UUIDs can be used for better database index locality of newly inserted
+  # records, which may have a significant performance benefit compared to random
+  # data inserts.
+  #
+  # The result contains 74 random bits (9.25 random bytes).
+  #
+  # Note that this method cannot be made reproducable with Kernel#srand, which
+  # can only affect the random bits.  The sorted bits will still be based on
+  # Process.clock_gettime.
+  #
+  # See draft-ietf-uuidrev-rfc4122bis[https://datatracker.ietf.org/doc/draft-ietf-uuidrev-rfc4122bis/]
+  # for details of UUIDv7.
+  #
+  # ==== Monotonicity
+  #
+  # UUIDv7 has millisecond precision by default, so multiple UUIDs created
+  # within the same millisecond are not issued in monotonically increasing
+  # order.  To create UUIDs that are time-ordered with sub-millisecond
+  # precision, up to 12 bits of additional timestamp may added with
+  # +extra_timestamp_bits+.  The extra timestamp precision comes at the expense
+  # of random bits.  Setting <tt>extra_timestamp_bits: 12</tt> provides ~244ns
+  # of precision, but only 62 random bits (7.75 random bytes).
+  #
+  #   prng = Random.new
+  #   Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 12) }
+  #   # =>
+  #   ["0188d4c7-13da-74f9-8b53-22a786ffdd5a",
+  #    "0188d4c7-13da-753b-83a5-7fb9b2afaeea",
+  #    "0188d4c7-13da-754a-88ea-ac0baeedd8db",
+  #    "0188d4c7-13da-7557-83e1-7cad9cda0d8d"]
+  #   # |<--- sorted --->| |<-- random --->|
+  #
+  #   Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 8) }
+  #   # =>
+  #   ["0188d4c7-3333-7a95-850a-de6edb858f7e",
+  #    "0188d4c7-3333-7ae8-842e-bc3a8b7d0cf9",  # <- out of order
+  #    "0188d4c7-3333-7ae2-995a-9f135dc44ead",  # <- out of order
+  #    "0188d4c7-3333-7af9-87c3-8f612edac82e"]
+  #   # |<--- sorted -->||<---- random --->|
+  #
+  # Any rollbacks of the system clock will break monotonicity.  UUIDv7 is based
+  # on UTC, which excludes leap seconds and can rollback the clock.  To avoid
+  # this, the system clock can synchronize with an NTP server configured to use
+  # a "leap smear" approach.  NTP or PTP will also be needed to synchronize
+  # across distributed nodes.
+  #
+  # Counters and other mechanisms for stronger guarantees of monotonicity are
+  # not implemented.  Applications with stricter requirements should follow
+  # {Section 6.2}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-07.html#monotonicity_counters]
+  # of the specification.
+  #
+  def uuid_v7(extra_timestamp_bits: 0)
+    case (extra_timestamp_bits = Integer(extra_timestamp_bits))
+    when 0 # min timestamp precision
+      ms = Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond)
+      rand = random_bytes(10)
+      rand.setbyte(0, rand.getbyte(0) & 0x0f | 0x70) # version
+      rand.setbyte(2, rand.getbyte(2) & 0x3f | 0x80) # variant
+      "%08x-%04x-%s" % [
+        (ms & 0x0000_ffff_ffff_0000) >> 16,
+        (ms & 0x0000_0000_0000_ffff),
+        rand.unpack("H4H4H12").join("-")
+      ]
+
+    when 12 # max timestamp precision
+      ms, ns = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
+        .divmod(1_000_000)
+      extra_bits = ns * 4096 / 1_000_000
+      rand = random_bytes(8)
+      rand.setbyte(0, rand.getbyte(0) & 0x3f | 0x80) # variant
+      "%08x-%04x-7%03x-%s" % [
+        (ms & 0x0000_ffff_ffff_0000) >> 16,
+        (ms & 0x0000_0000_0000_ffff),
+        extra_bits,
+        rand.unpack("H4H12").join("-")
+      ]
+
+    when (0..12) # the generic version is slower than the special cases above
+      rand_a, rand_b1, rand_b2, rand_b3 = random_bytes(10).unpack("nnnN")
+      rand_mask_bits = 12 - extra_timestamp_bits
+      ms, ns = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
+        .divmod(1_000_000)
+      "%08x-%04x-%04x-%04x-%04x%08x" % [
+        (ms & 0x0000_ffff_ffff_0000) >> 16,
+        (ms & 0x0000_0000_0000_ffff),
+        0x7000 |
+          ((ns * (1 << extra_timestamp_bits) / 1_000_000) << rand_mask_bits) |
+          rand_a & ((1 << rand_mask_bits) - 1),
+        0x8000 | (rand_b1 & 0x3fff),
+        rand_b2,
+        rand_b3
+      ]
+
+    else
+      raise ArgumentError, "extra_timestamp_bits must be in 0..12"
+    end
+  end
+
   private def gen_random(n)
     self.bytes(n)
   end
 
-  # Random::Formatter#choose generates a string that randomly draws from a
+  # Generate a string that randomly draws from a
   # source array of characters.
   #
   # The argument _source_ specifies the array of characters from which
@@ -196,22 +341,31 @@ module Random::Formatter
   end
 
   ALPHANUMERIC = [*'A'..'Z', *'a'..'z', *'0'..'9']
-  # Random::Formatter#alphanumeric generates a random alphanumeric string.
+  # Generate a random alphanumeric string.
   #
   # The argument _n_ specifies the length, in characters, of the alphanumeric
   # string to be generated.
+  # The argument _chars_ specifies the character list which the result is
+  # consist of.
   #
   # 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.
+  # The result may contain A-Z, a-z and 0-9, unless _chars_ is specified.
   #
   #   require 'random/formatter'
   #
-  #   prng.alphanumeric     #=> "2BuBuLf3WfSKyQbR"
+  #   Random.alphanumeric     #=> "2BuBuLf3WfSKyQbR"
+  #   # or
+  #   prng = Random.new
   #   prng.alphanumeric(10) #=> "i6K93NdqiH"
-  def alphanumeric(n=nil)
+  #
+  #   Random.alphanumeric(4, chars: [*"0".."9"]) #=> "2952"
+  #   # or
+  #   prng = Random.new
+  #   prng.alphanumeric(10, chars: [*"!".."/"]) #=> ",.,++%/''."
+  def alphanumeric(n = nil, chars: ALPHANUMERIC)
     n = 16 if n.nil?
-    choose(ALPHANUMERIC, n)
+    choose(chars, n)
   end
 end

data/lib/securerandom.rb

@@ -39,6 +39,9 @@ require 'random/formatter'
 # +NotImplementedError+ is raised.
 
 module SecureRandom
+
+  VERSION = "0.3.0"
+
   class << self
     def bytes(n)
       return gen_random(n)
@@ -47,17 +50,6 @@ module SecureRandom
     private
 
     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
 

data/securerandom.gemspec

@@ -1,6 +1,13 @@
+name = File.basename(__FILE__, ".gemspec")
+version = ["lib", Array.new(name.count("-")+1).join("/")].find do |dir|
+  break File.foreach(File.join(__dir__, dir, "#{name.tr('-', '/')}.rb")) do |line|
+    /^\s*VERSION\s*=\s*"(.*)"/ =~ line and break $1
+  end rescue nil
+end
+
 Gem::Specification.new do |spec|
-  spec.name          = "securerandom"
-  spec.version       = "0.2.1"
+  spec.name          = name
+  spec.version       = version
   spec.authors       = ["Tanaka Akira"]
   spec.email         = ["akr@fsij.org"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: securerandom
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Tanaka Akira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies: []
 description: Interface for secure random number generator.
 email:
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Interface for secure random number generator.