try tuning JRuby's SecureRandom preferred instance logic a bit

- default to Windows-PRNG on Windows - empty setting will simply use `new SecureRandom()` - include some debug logging around fall-backs
jruby · Jul 25, 2017 · 9c2a464 · 9c2a464
1 parent df0b4e3
commit 9c2a464
Showing 1 changed file with 27 additions and 5 deletions.
diff --git a/src/main/java/org/jruby/ext/openssl/Random.java b/src/main/java/org/jruby/ext/openssl/Random.java
@@ -65,7 +65,7 @@ private static Holder createHolderImpl() {
         if (HOLDER_TYPE.equals("shared")) {
             return new SharedHolder();
         }
-        if (HOLDER_TYPE.equals("strong")) {
+        if (HOLDER_TYPE.equals("strong")) { // TODO strong (thread-local) makes sense
             return new StrongHolder();
         }
         if (ThreadLocalHolder.secureRandomField == null) {
@@ -148,13 +148,28 @@ private static void setSecureRandom(ThreadContext context, java.security.SecureR
                 try {
                     secureRandomField.set(context, secureRandom);
                 }
-                catch (Exception ex) { /* IllegalAccessException should not happen */ }
+                catch (IllegalAccessException ex) { Utils.throwException(ex); /* should not happen */ }
             }
         }
 
         private static final String PREFERRED_PRNG;
         static {
-            PREFERRED_PRNG = SafePropertyAccessor.getProperty("jruby.preferred.prng", "NativePRNGNonBlocking");
+            String prng = SafePropertyAccessor.getProperty("jruby.preferred.prng", null);
+
+            if (prng == null) { // make sure the default experience is non-blocking for users
+                prng = "NativePRNGNonBlocking";
+                if (SafePropertyAccessor.getProperty("os.name") != null) {
+                    if (jnr.posix.util.Platform.IS_WINDOWS) { // System.getProperty("os.name") won't fail
+                        prng = "Windows-PRNG";
+                    }
+                }
+            }
+            // setting it to "" (empty) or "default" should just use new SecureRandom() :
+            if (prng.isEmpty() || prng.equalsIgnoreCase("default")) {
+                prng = null; tryPreferredPRNG = false; trySHA1PRNG = false;
+            }
+
+            PREFERRED_PRNG = prng;
 
             Field secureRandom = null;
             try {
@@ -169,6 +184,7 @@ private static void setSecureRandom(ThreadContext context, java.security.SecureR
 
         private static boolean tryPreferredPRNG = true;
         private static boolean trySHA1PRNG = true;
+        private static boolean tryStrongPRNG = false; // NOT-YET-IMPLEMENTED
 
         // copied from JRuby (not available in all 1.7.x) :
         public java.security.SecureRandom getSecureRandomImpl() {
@@ -178,15 +194,21 @@ public java.security.SecureRandom getSecureRandomImpl() {
                 try {
                     secureRandom = java.security.SecureRandom.getInstance(PREFERRED_PRNG);
                 }
-                catch (Exception e) { tryPreferredPRNG = false; }
+                catch (Exception e) {
+                    tryPreferredPRNG = false;
+                    OpenSSL.debug("SecureRandom '"+ PREFERRED_PRNG +"' failed:", e);
+                }
             }
 
             // Try SHA1PRNG
             if (secureRandom == null && trySHA1PRNG) {
                 try {
                     secureRandom = java.security.SecureRandom.getInstance("SHA1PRNG");
                 }
-                catch (Exception e) { trySHA1PRNG = false; }
+                catch (Exception e) {
+                    trySHA1PRNG = false;
+                    OpenSSL.debug("SecureRandom SHA1PRNG failed:", e);
+                }
             }
 
             // Just let JDK do whatever it does