[feat] stack-trace debugging with unexpected catches

kares · kares · commit 20275816eaa6 · 2022-06-29T18:16:09.000+02:00
diff --git a/src/main/java/org/jruby/ext/openssl/OpenSSL.java b/src/main/java/org/jruby/ext/openssl/OpenSSL.java
@@ -243,6 +243,15 @@ public static void debug(final Ruby runtime, final CharSequence msg, final Throw
         if ( isDebug(runtime) ) runtime.getOut().println(msg.toString() + ' ' + e);
     }
 
+    public static void debugStackTrace(final Ruby runtime, final CharSequence msg, final Throwable e) {
+        if ( isDebug(runtime) ) {
+            synchronized (runtime.getOut()) {
+                runtime.getOut().print(msg.toString() + ' ');
+                e.printStackTrace(runtime.getOut());
+            }
+        }
+    }
+
     static void warn(final ThreadContext context, final CharSequence msg) {
         if ( warn ) warn(context, RubyString.newString(context.runtime, msg));
     }
diff --git a/src/main/java/org/jruby/ext/openssl/PKeyDSA.java b/src/main/java/org/jruby/ext/openssl/PKeyDSA.java
@@ -241,7 +241,7 @@ public IRubyObject initialize(final ThreadContext context, final IRubyObject[] a
             }
             catch (NoClassDefFoundError e) { noClassDef = true; debugStackTrace(runtime, e); }
             catch (InvalidKeySpecException e) { debug(runtime, "PKeyDSA could not read private key", e); }
-            catch (IOException e) { debug(runtime, "PKeyDSA could not read private key", e); }
+            catch (IOException e) { debugStackTrace(runtime, "PKeyDSA could not read private key", e); }
             catch (RuntimeException e) {
                 if ( isKeyGenerationFailure(e) ) debug(runtime, "PKeyDSA could not read private key", e);
                 else debugStackTrace(runtime, e);
@@ -253,7 +253,7 @@ public IRubyObject initialize(final ThreadContext context, final IRubyObject[] a
             }
             catch (NoClassDefFoundError e) { noClassDef = true; debugStackTrace(runtime, e); }
             catch (InvalidKeySpecException e) { debug(runtime, "PKeyDSA could not read public key", e); }
-            catch (IOException e) { debug(runtime, "PKeyDSA could not read public key", e); }
+            catch (IOException e) { debugStackTrace(runtime, "PKeyDSA could not read public key", e); }
             catch (RuntimeException e) {
                 if ( isKeyGenerationFailure(e) ) debug(runtime, "PKeyDSA could not read public key", e);
                 else debugStackTrace(runtime, e);
diff --git a/src/main/java/org/jruby/ext/openssl/PKeyEC.java b/src/main/java/org/jruby/ext/openssl/PKeyEC.java
@@ -297,7 +297,7 @@ public IRubyObject initialize(final ThreadContext context, final IRubyObject[] a
             }
             catch (NoClassDefFoundError e) { noClassDef = true; debugStackTrace(runtime, e); }
             catch (InvalidKeySpecException e) { debug(runtime, "PKeyEC could not read private key", e); }
-            catch (IOException e) { debug(runtime, "PKeyEC could not read private key", e); }
+            catch (IOException e) { debugStackTrace(runtime, "PKeyEC could not read private key", e); }
             catch (RuntimeException e) {
                 if ( isKeyGenerationFailure(e) ) debug(runtime, "PKeyEC could not read private key", e);
                 else debugStackTrace(runtime, e);
diff --git a/src/main/java/org/jruby/ext/openssl/PKeyRSA.java b/src/main/java/org/jruby/ext/openssl/PKeyRSA.java
@@ -287,7 +287,7 @@ public IRubyObject initialize(final ThreadContext context, final IRubyObject[] a
             try { key = readRSAPrivateKey(rsaFactory, str.getBytes()); }
             catch (NoClassDefFoundError e) { noClassDef = true; debugStackTrace(runtime, e); }
             catch (InvalidKeySpecException e) { debug(runtime, "PKeyRSA could not read private key", e); }
-            catch (IOException e) { debug(runtime, "PKeyRSA could not read private key", e); }
+            catch (IOException e) { debugStackTrace(runtime, "PKeyRSA could not read private key", e); }
             catch (RuntimeException e) {
                 if ( isKeyGenerationFailure(e) ) debug(runtime, "PKeyRSA could not read private key", e);
                 else debugStackTrace(runtime, e);
@@ -297,7 +297,7 @@ public IRubyObject initialize(final ThreadContext context, final IRubyObject[] a
             try { key = readRSAPublicKey(rsaFactory, str.getBytes()); }
             catch (NoClassDefFoundError e) { noClassDef = true; debugStackTrace(runtime, e); }
             catch (InvalidKeySpecException e) { debug(runtime, "PKeyRSA could not read public key", e); }
-            catch (IOException e) { debug(runtime, "PKeyRSA could not read public key", e); }
+            catch (IOException e) { debugStackTrace(runtime, "PKeyRSA could not read public key", e); }
             catch (RuntimeException e) {
                 if ( isKeyGenerationFailure(e) ) debug(runtime, "PKeyRSA could not read public key", e);
                 else debugStackTrace(runtime, e);
diff --git a/src/main/java/org/jruby/ext/openssl/SSLSocket.java b/src/main/java/org/jruby/ext/openssl/SSLSocket.java
@@ -766,7 +766,7 @@ private void doShutdown() throws IOException {
             return;
         }
         catch (RuntimeException e) {
-            debugStackTrace(getRuntime(), e);
+            debugStackTrace(getRuntime(), "SSLSocket.doShutdown", e);
             return;
         }
         netData.flip();
@@ -830,7 +830,7 @@ private IRubyObject sysreadImpl(final ThreadContext context,
             return buffStr;
         }
         catch (IOException ex) {
-            debug(runtime, "SSLSocket.sysreadImpl failed", ex);
+            debugStackTrace(runtime, "SSLSocket.sysreadImpl", ex);
             throw Utils.newError(runtime, runtime.getIOError(), ex);
         }
     }
@@ -914,7 +914,7 @@ private IRubyObject syswriteImpl(final ThreadContext context,
             return runtime.newFixnum(written);
         }
         catch (IOException ex) {
-            debug(runtime, "SSLSocket.syswriteImpl failed", ex);
+            debugStackTrace(runtime, "SSLSocket.syswriteImpl", ex);
             throw Utils.newError(runtime, runtime.getIOError(), ex);
         }
     }
diff --git a/src/main/java/org/jruby/ext/openssl/X509Cert.java b/src/main/java/org/jruby/ext/openssl/X509Cert.java
@@ -667,7 +667,7 @@ public RubyBoolean verify(final IRubyObject key) {
             return runtime.getTrue();
         }
         catch (CertificateException e) {
-            debug(runtime, "Certificate#verify failed: ", e);
+            debugStackTrace(runtime, "Certificate#verify failed", e);
             throw newCertificateError(runtime, e);
         }
         catch (NoSuchAlgorithmException e) {
@@ -679,11 +679,11 @@ public RubyBoolean verify(final IRubyObject key) {
             throw newCertificateError(runtime, e);
         }
         catch (SignatureException e) {
-            debug(runtime, "Certificate#verify failed: ", e);
+            debug(runtime, "Certificate#verify failed", e);
             return runtime.getFalse();
         }
         catch (InvalidKeyException e) {
-            debug(runtime, "Certificate#verify failed: ", e);
+            debug(runtime, "Certificate#verify failed", e);
             return runtime.getFalse();
         }
     }
diff --git a/src/main/java/org/jruby/ext/openssl/X509Request.java b/src/main/java/org/jruby/ext/openssl/X509Request.java
@@ -351,7 +351,7 @@ public IRubyObject verify(final ThreadContext context, IRubyObject key) {
             return runtime.newBoolean( getRequest().verify(publicKey) );
         }
         catch (InvalidKeyException e) {
-            debug(runtime, "X509::Request.verify invalid key", e);
+            debug(runtime, "X509::Request#verify invalid key", e);
             throw newRequestError(runtime, "invalid key supplied", e);
         }
         //catch (IOException e) {
diff --git a/src/main/java/org/jruby/ext/openssl/x509store/Lookup.java b/src/main/java/org/jruby/ext/openssl/x509store/Lookup.java
@@ -336,7 +336,7 @@ public int loadDefaultJavaCACertsFile(String certsFile) throws IOException, Gene
         try {
             // hardcode the keystore type, as we expect cacerts to be a java keystore
             // especially needed since Java 9 (getDefaultType on 11/13 is "pkcs12")
-            KeyStore keystore = SecurityHelper.getKeyStore("jks");
+            KeyStore keystore = SecurityHelper.getKeyStore("JKS");
 	        // null password - as the cacerts file isn't password protected
             keystore.load(fin, null);
             PKIXParameters params = new PKIXParameters(keystore);
@@ -470,7 +470,7 @@ public int call(final Lookup ctx, final Integer cmd, final String argp, final Nu
                         file = ctx.envEntry(X509_CERT_FILE_EVP); // ENV['SSL_CERT_FILE']
                     }
                     catch (RuntimeException e) {
-                        OpenSSL.debug(ctx.runtime, "failed to read env " + X509_CERT_FILE_EVP, e);
+                        OpenSSL.debugStackTrace(ctx.runtime, "failed to read env " + X509_CERT_FILE_EVP, e);
                     }
                     if (file == null) {
                         file = X509_CERT_FILE.replace('/', File.separatorChar);
diff --git a/src/main/java/org/jruby/ext/openssl/x509store/Store.java b/src/main/java/org/jruby/ext/openssl/x509store/Store.java
@@ -331,7 +331,7 @@ public int setDefaultPaths(Ruby runtime) throws Exception {
             if (!e.getClass().getSimpleName().equals("NotFound")) {
                 throw e;
             }
-            OpenSSL.debug(runtime, "add X509_CERT_FILER_CTX (to default paths)", e);
+            OpenSSL.debugStackTrace(runtime, "add X509_CERT_FILER_CTX (to default paths)", e);
         }
 
         lookup = addLookup(runtime, Lookup.hashDirLookup());
@@ -346,7 +346,7 @@ public int setDefaultPaths(Ruby runtime) throws Exception {
             if (!e.getClass().getSimpleName().equals("NotFound")) {
                 throw e;
             }
-            OpenSSL.debug(runtime, "add X509_HASH_DIR_CTX (to default paths)", e);
+            OpenSSL.debugStackTrace(runtime, "add X509_HASH_DIR_CTX (to default paths)", e);
         }
 
         X509Error.clearErrors();

Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,7 @@ public IRubyObject initialize(final ThreadContext context, final IRubyObject[] a`
`297`	`297`	`}`
`298`	`298`	`catch (NoClassDefFoundError e) { noClassDef = true; debugStackTrace(runtime, e); }`
`299`	`299`	`catch (InvalidKeySpecException e) { debug(runtime, "PKeyEC could not read private key", e); }`
`300`		`- catch (IOException e) { debug(runtime, "PKeyEC could not read private key", e); }`
	`300`	`+ catch (IOException e) { debugStackTrace(runtime, "PKeyEC could not read private key", e); }`
`301`	`301`	`catch (RuntimeException e) {`
`302`	`302`	`if ( isKeyGenerationFailure(e) ) debug(runtime, "PKeyEC could not read private key", e);`
`303`	`303`	`else debugStackTrace(runtime, e);`
Original file line number	Diff line number	Diff line change
`@@ -766,7 +766,7 @@ private void doShutdown() throws IOException {`
`766`	`766`	`return;`
`767`	`767`	`}`
`768`	`768`	`catch (RuntimeException e) {`
`769`		`- debugStackTrace(getRuntime(), e);`
	`769`	`+ debugStackTrace(getRuntime(), "SSLSocket.doShutdown", e);`
`770`	`770`	`return;`
`771`	`771`	`}`
`772`	`772`	`netData.flip();`
`@@ -830,7 +830,7 @@ private IRubyObject sysreadImpl(final ThreadContext context,`
`830`	`830`	`return buffStr;`
`831`	`831`	`}`
`832`	`832`	`catch (IOException ex) {`
`833`		`- debug(runtime, "SSLSocket.sysreadImpl failed", ex);`
	`833`	`+ debugStackTrace(runtime, "SSLSocket.sysreadImpl", ex);`
`834`	`834`	`throw Utils.newError(runtime, runtime.getIOError(), ex);`
`835`	`835`	`}`
`836`	`836`	`}`
`@@ -914,7 +914,7 @@ private IRubyObject syswriteImpl(final ThreadContext context,`
`914`	`914`	`return runtime.newFixnum(written);`
`915`	`915`	`}`
`916`	`916`	`catch (IOException ex) {`
`917`		`- debug(runtime, "SSLSocket.syswriteImpl failed", ex);`
	`917`	`+ debugStackTrace(runtime, "SSLSocket.syswriteImpl", ex);`
`918`	`918`	`throw Utils.newError(runtime, runtime.getIOError(), ex);`
`919`	`919`	`}`
`920`	`920`	`}`
Original file line number	Diff line number	Diff line change
`@@ -667,7 +667,7 @@ public RubyBoolean verify(final IRubyObject key) {`
`667`	`667`	`return runtime.getTrue();`
`668`	`668`	`}`
`669`	`669`	`catch (CertificateException e) {`
`670`		`- debug(runtime, "Certificate#verify failed: ", e);`
	`670`	`+ debugStackTrace(runtime, "Certificate#verify failed", e);`
`671`	`671`	`throw newCertificateError(runtime, e);`
`672`	`672`	`}`
`673`	`673`	`catch (NoSuchAlgorithmException e) {`
`@@ -679,11 +679,11 @@ public RubyBoolean verify(final IRubyObject key) {`
`679`	`679`	`throw newCertificateError(runtime, e);`
`680`	`680`	`}`
`681`	`681`	`catch (SignatureException e) {`
`682`		`- debug(runtime, "Certificate#verify failed: ", e);`
	`682`	`+ debug(runtime, "Certificate#verify failed", e);`
`683`	`683`	`return runtime.getFalse();`
`684`	`684`	`}`
`685`	`685`	`catch (InvalidKeyException e) {`
`686`		`- debug(runtime, "Certificate#verify failed: ", e);`
	`686`	`+ debug(runtime, "Certificate#verify failed", e);`
`687`	`687`	`return runtime.getFalse();`
`688`	`688`	`}`
`689`	`689`	`}`
Original file line number	Diff line number	Diff line change
`@@ -351,7 +351,7 @@ public IRubyObject verify(final ThreadContext context, IRubyObject key) {`
`351`	`351`	`return runtime.newBoolean( getRequest().verify(publicKey) );`
`352`	`352`	`}`
`353`	`353`	`catch (InvalidKeyException e) {`
`354`		`- debug(runtime, "X509::Request.verify invalid key", e);`
	`354`	`+ debug(runtime, "X509::Request#verify invalid key", e);`
`355`	`355`	`throw newRequestError(runtime, "invalid key supplied", e);`
`356`	`356`	`}`
`357`	`357`	`//catch (IOException e) {`
Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,7 @@ public int setDefaultPaths(Ruby runtime) throws Exception {`
`331`	`331`	`if (!e.getClass().getSimpleName().equals("NotFound")) {`
`332`	`332`	`throw e;`
`333`	`333`	`}`
`334`		`- OpenSSL.debug(runtime, "add X509_CERT_FILER_CTX (to default paths)", e);`
	`334`	`+ OpenSSL.debugStackTrace(runtime, "add X509_CERT_FILER_CTX (to default paths)", e);`
`335`	`335`	`}`
`336`	`336`
`337`	`337`	`lookup = addLookup(runtime, Lookup.hashDirLookup());`
`@@ -346,7 +346,7 @@ public int setDefaultPaths(Ruby runtime) throws Exception {`
`346`	`346`	`if (!e.getClass().getSimpleName().equals("NotFound")) {`
`347`	`347`	`throw e;`
`348`	`348`	`}`
`349`		`- OpenSSL.debug(runtime, "add X509_HASH_DIR_CTX (to default paths)", e);`
	`349`	`+ OpenSSL.debugStackTrace(runtime, "add X509_HASH_DIR_CTX (to default paths)", e);`
`350`	`350`	`}`
`351`	`351`
`352`	`352`	`X509Error.clearErrors();`