sysrandom 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5f7c224e0fa238e8e70ef0103397f3247a6b485
-  data.tar.gz: 70e999ad3fc3d1f55b616cf4ddcc4a415c48a7db
+  metadata.gz: 45c1dd03f5f7845b10731b29830035e09e8ccb8f
+  data.tar.gz: 758b5a0669875cad1a90cc6b8f3c685ab1c9002f
 SHA512:
-  metadata.gz: a6cb73cb0c93e7726f1b46ce690835ba9e3d214b71f7adbc69607c9133c0bdae0dd871a16c8a1d7bb472cb77863b49c7948cfa478ae81210c6305c3090c3034b
-  data.tar.gz: e28618bea44417379350e1475c34cebe0fd7bfdf6697a3210296c88a8065d8e4200e582da79a04bc441018c4bf91751eb072de9959e872e4c0adf73b0365a384
+  metadata.gz: 2546ede22a85b518248a0e81ad21bedb5a3267c2cd358500498be82b0582ded90cf28908dc8cdfab64f8b33e8567e03e525179acf3a4d184aefcc7d54790527c
+  data.tar.gz: 52489195938140051a78dc8e005de1c9e09eb4614a396e9206cb60acad5f7b7f39fca3ff8e8da7e87123a43cad6b77ac6237858e55934e443d8c9ea375ac9542

data/.rubocop.yml

@@ -26,9 +26,3 @@ Metrics/MethodLength:
 
 Metrics/AbcSize:
   Max: 20
-
-AllCops:
-  Include:
-    - '**/Rakefile'
-  Exclude:
-    - 'spec/**/*'

data/CHANGES.md

@@ -1,3 +1,18 @@
+## 1.0.1 (2016-05-29)
+
+* [#11](https://github.com/cryptosphere/sysrandom/pull/11)
+  Use NativePRNGNonBlocking for JRuby if available.
+  ([@coda])
+
+* [#8](https://github.com/cryptosphere/sysrandom/pull/8)
+  Upstream libsodium change: wait for `/dev/random` to be seeded before reading from `/dev/urandom`.
+  ([@tarcieri])
+
+
 ## 1.0.0 (2016-05-28)
 
 * Initial release.
+
+
+[@tarcieri]: https://github.com/tarcieri
+[@coda]: https://github.com/coda

data/README.md

@@ -6,10 +6,19 @@
 
 Secure random number generation for Ruby using system RNG facilities e.g. `/dev/urandom`, `getrandom(2)`
 
-## Description
+## Why?
+
+System/OS-level random number generators like `/dev/urandom` and `getrandom(2)`
+provide the best option for generating cryptographically secure random numbers.
+
+Ruby's built-in SecureRandom does not provide this, but instead uses OpenSSL's
+userspace RNG. This has been a [source of vulnerabilities][emboss] in Ruby, and
+an [open Ruby bug ticket][bug] contains much discussion on the issue with no
+clear path to resolution.
 
-[Concerns have been raised][concerns] about the current implementation of Ruby's built-in
-`SecureRandom` functionality, as it presently leverages the poorly reputed OpenSSL RNG.
+This gem aims to solve the problem.
+
+## Description
 
 In cryptography circles, [the prevailing advice is to use OS RNG functionality][/dev/urandom],
 namely `/dev/urandom` or equivalent calls which use an OS-level CSPRNG to
@@ -22,21 +31,22 @@ cryptographic keys, initialization vectors, or nonces.
 
 The following random number generators are utilized:
 
-| OS      | RNG                                                               |
-|---------|-------------------------------------------------------------------|
-| Linux   | [getrandom(2)] if available, otherwise [/dev/urandom]             |
-| Windows | [RtlGenRandom]                                                    |
-| OpenBSD | [arc4random(3)] with ChaCha20 CSPRNG (not RC4)                    |
-| JRuby   | [SecureRandom.getInstanceStrong] if available, otherwise SHA1PRNG |
-| Others  | [/dev/urandom]                                                    |
+| Platform | RNG                                                    |
+|----------|--------------------------------------------------------|
+| Linux    | [getrandom(2)] if available, otherwise [/dev/urandom]  |
+| Windows  | [RtlGenRandom] CryptGenRandom without CryptoAPI deps   |
+| OpenBSD  | [arc4random(3)] with ChaCha20 CSPRNG (not RC4)         |
+| JRuby    | [NativePRNGNonBlocking] on Java 8, otherwise SHA1PRNG  |
+| Others   | [/dev/urandom]                                         |
 
-[concerns]:      https://bugs.ruby-lang.org/issues/9569
+[emboss]:        https://emboss.github.io/blog/2013/08/21/openssl-prng-is-not-really-fork-safe/
+[bug]:           https://bugs.ruby-lang.org/issues/9569
 [libsodium]:     https://github.com/jedisct1/libsodium
 [getrandom(2)]:  http://man7.org/linux/man-pages/man2/getrandom.2.html
 [/dev/urandom]:  http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers/
 [RtlGenRandom]:  https://msdn.microsoft.com/en-us/library/windows/desktop/aa387694(v=vs.85).aspx
 [arc4random(3)]: http://man.openbsd.org/arc4random.3
-[SecureRandom.getInstanceStrong]: https://docs.oracle.com/javase/8/docs/api/java/security/SecureRandom.html#getInstanceStrong--
+[NativePRNGNonBlocking]: https://tersesystems.com/2015/12/17/the-right-way-to-use-securerandom/
 
 ## Supported Platforms
 

data/ext/sysrandom/randombytes_sysrandom.c

@@ -1,5 +1,5 @@
 /*
- * __randombytes_sysrandom.c: adapted from libsodium
+ * randombytes_sysrandom.c: adapted from libsodium
  * Copyright (c) 2013-2016 Frank Denis <j at pureftpd dot org>
  * https://github.com/jedisct1/libsodium
  */
@@ -12,6 +12,7 @@
 #endif
 #ifdef __linux__
 # include <sys/syscall.h>
+# include <poll.h>
 #endif
 
 #include <assert.h>
@@ -102,6 +103,33 @@ safe_read(const int fd, void * const buf_, size_t size)
 #endif
 
 #ifndef _WIN32
+# if defined(__linux__) && !defined(USE_BLOCKING_RANDOM)
+static int
+randombytes_block_on_dev_random(void)
+{
+    struct pollfd pfd;
+    int           fd;
+    int           pret;
+
+    fd = open("/dev/random", O_RDONLY);
+    if (fd == -1) {
+        return 0;
+    }
+    pfd.fd = fd;
+    pfd.events = POLLIN;
+    pfd.revents = 0;
+    do {
+        pret = poll(&pfd, 1, -1);
+    } while (pret < 0 && (errno == EINTR || errno == EAGAIN));
+    if (pret != 1) {
+        (void) close(fd);
+        errno = EIO;
+        return -1;
+    }
+    return close(fd);
+}
+# endif
+
 static int
 __randombytes_sysrandom_random_dev_open(void)
 {
@@ -116,6 +144,11 @@ __randombytes_sysrandom_random_dev_open(void)
     const char **      device = devices;
     int                fd;
 
+# if defined(__linux__) && !defined(USE_BLOCKING_RANDOM)
+    if (randombytes_block_on_dev_random() != 0) {
+        return -1;
+    }
+# endif
     do {
         fd = open(*device, O_RDONLY);
         if (fd != -1) {
@@ -145,7 +178,7 @@ __randombytes_sysrandom_random_dev_open(void)
 /* LCOV_EXCL_STOP */
 }
 
-# ifdef SYS_getrandom
+# if defined(SYS_getrandom) && defined(__NR_getrandom)
 static int
 _randombytes_linux_getrandom(void * const buf, const size_t size)
 {
@@ -186,7 +219,7 @@ __randombytes_sysrandom_init(void)
 {
     const int     errno_save = errno;
 
-# ifdef SYS_getrandom
+# if defined(SYS_getrandom) && defined(__NR_getrandom)
     {
         unsigned char fodder[16];
 
@@ -240,7 +273,7 @@ __randombytes_sysrandom_buf(void * const buf, const size_t size)
     assert(size <= ULONG_LONG_MAX);
 #endif
 #ifndef _WIN32
-# ifdef SYS_getrandom
+# if defined(SYS_getrandom) && defined(__NR_getrandom)
     if (stream.getrandom_available != 0) {
         if (randombytes_linux_getrandom(buf, size) != 0) {
             abort();

data/lib/sysrandom/version.rb

@@ -1,3 +1,3 @@
 module Sysrandom
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
 end

data/lib/sysrandom.rb

@@ -12,10 +12,13 @@ module Sysrandom
   if defined?(JRUBY_VERSION)
     require "java"
 
-    if java.security.SecureRandom.respond_to?(:getInstanceStrong)
-      @_java_secure_random = java.security.SecureRandom.getInstanceStrong
-    else
-      @_java_secure_random = java.security.SecureRandom.getInstance("SHA1PRNG")
+    begin
+      # Try to use the new NativePRNGNonBlocking algorithm introduced in Java 8.
+      @_java_secure_random = java.security.SecureRandom.getInstance("NativePRNGNonBlocking")
+    rescue
+      # If unavailable, fall back to the default configuration. This will
+      # probably be SHA1PRNG, but it depends on the JRE's configuration.
+      @_java_secure_random = java.security.SecureRandom.new
     end
 
     # Random uint32, used by random_number. The C extension provides an equivalent method

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sysrandom
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-29 00:00:00.000000000 Z
+date: 2016-05-30 00:00:00.000000000 Z
 dependencies: []
 description: Sysrandom generates secure random numbers using /dev/urandom, getrandom(),
   etc