Merge pull request #235 from cconlon/jniDebug

Add JNI Java level debugging with System Property: wolfssljni.debug=true
wolfSSL · Nov 22, 2024 · 6e69cb2 · 6e69cb2
2 parents fd51ab9 + 2fa0417
commit 6e69cb2
Show file tree

Hide file tree

Showing 35 changed files with 2,261 additions and 489 deletions.
diff --git a/README.md b/README.md
@@ -218,6 +218,7 @@ and what each enables.
 | System Property | Default | To Enable | Description |
 | --- | --- | --- | --- |
 | wolfssl.debug | "false" | "true" | Enables native wolfSSL debug logging |
+| wolfssljni.debug | "false" | "true" | Enables wolfJNI debug logging |
 | wolfjsse.debug | "false" | "true | Enables wolfJSSE debug logging |
 | wolfjsse.debugFormat | | "JSON" | Switches debug output format |
 | wolfsslengine.debug | "false" | "true" | Enables SSLEngine debug logging |
@@ -239,6 +240,15 @@ System.setProperty("wolfjsse.debug", "true");
 System.setProperty("wolfsslengine.debug", "true);
 ```
 
+If wolfSSL JNI/JSSE debug System properties are changed at runtime after
+the WolfSSLDebug class has already been initialized/used, applications need
+to refresh the debug property values inside the WolfSSLDebug class. To do so,
+after setting System properties, call:
+
+```
+WolfSSLDebug.refreshDebugFlags()
+```
+
 JDK debug logging can be enabled using the `-Djavax.net.debug=all` option.
 
 ### JSON Log Message Format

diff --git a/examples/Client.java b/examples/Client.java
@@ -230,7 +230,6 @@ public void run(String[] args) {
 
             /* init library */
             WolfSSL sslLib = new WolfSSL();
-            sslLib.debuggingON();
 
             /* set logging callback */
             if (logCallback == 1) {

diff --git a/examples/Server.java b/examples/Server.java
@@ -217,7 +217,6 @@ public void run(String[] args) {
 
             /* init library */
             WolfSSL sslLib = new WolfSSL();
-            sslLib.debuggingON();
 
             /* set logging callback */
             if (logCallback == 1) {

diff --git a/examples/provider/ClientJSSE.java b/examples/provider/ClientJSSE.java
@@ -50,7 +50,7 @@
 import javax.net.ssl.KeyManagerFactory;
 import javax.net.ssl.TrustManagerFactory;
 
-import com.wolfssl.provider.jsse.WolfSSLDebug;
+import com.wolfssl.WolfSSLDebug;
 import com.wolfssl.provider.jsse.WolfSSLProvider;
 import com.wolfssl.WolfSSL;
 import java.security.PrivateKey;

diff --git a/examples/provider/ServerJSSE.java b/examples/provider/ServerJSSE.java
@@ -35,7 +35,7 @@
 import javax.net.ssl.TrustManagerFactory;
 
 import com.wolfssl.WolfSSLException;
-import com.wolfssl.provider.jsse.WolfSSLDebug;
+import com.wolfssl.WolfSSLDebug;
 import com.wolfssl.provider.jsse.WolfSSLProvider;
 
 public class ServerJSSE {

diff --git a/src/java/com/wolfssl/WolfSSL.java b/src/java/com/wolfssl/WolfSSL.java
@@ -568,7 +568,12 @@ public enum TLS_VERSION {
      *                                      initialize correctly
      */
     public WolfSSL() throws WolfSSLException {
-        int ret = init();
+        int ret;
+
+        WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, "initializing wolfSSL library");
+
+        ret = init();
         if (ret != SSL_SUCCESS) {
             throw new WolfSSLException("Failed to initialize wolfSSL library: "
                     + ret);
@@ -663,6 +668,9 @@ public static void loadLibrary() throws UnsatisfiedLinkError {
 
         int fipsLoaded = 0;
 
+        WolfSSLDebug.log(WolfSSL.class, WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, "loading native library: wolfssl");
+
         String osName = System.getProperty("os.name");
         if (osName != null && osName.toLowerCase().contains("win")) {
             try {
@@ -680,6 +688,9 @@ public static void loadLibrary() throws UnsatisfiedLinkError {
             }
         }
 
+        WolfSSLDebug.log(WolfSSL.class, WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, "loading native library: wolfssljni");
+
         /* Load wolfssljni library */
         System.loadLibrary("wolfssljni");
     }
@@ -695,6 +706,10 @@ public static void loadLibrary() throws UnsatisfiedLinkError {
      * @throws UnsatisfiedLinkError if the library is not found.
      */
     public static void loadLibrary(String libName) throws UnsatisfiedLinkError {
+
+        WolfSSLDebug.log(WolfSSL.class, WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, "loading native library by name: " + libName);
+
         System.loadLibrary(libName);
     }
 
@@ -716,6 +731,10 @@ public static void loadLibrary(String libName) throws UnsatisfiedLinkError {
      */
     public static void loadLibraryAbsolute(String libPath)
         throws UnsatisfiedLinkError {
+
+        WolfSSLDebug.log(WolfSSL.class, WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, "loading native library by path: " + libPath);
+
         System.load(libPath);
     }
 
@@ -1489,6 +1508,9 @@ public static String[] getCiphersAvailableIana(TLS_VERSION version) {
      */
     public static int cryptoCbRegisterDevice(int devId) {
 
+        WolfSSLDebug.log(WolfSSL.class, WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, "registering crypto cb devId: " + devId);
+
         return wc_CryptoCb_RegisterDevice(devId);
     }
 
@@ -1500,6 +1522,9 @@ public static int cryptoCbRegisterDevice(int devId) {
      */
     public static int cryptoCbUnRegisterDevice(int devId) {
 
+        WolfSSLDebug.log(WolfSSL.class, WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, "unregistering crypto cb devId: " + devId);
+
         wc_CryptoCb_UnRegisterDevice(devId);
 
         return 0;

diff --git a/src/java/com/wolfssl/WolfSSLCertManager.java b/src/java/com/wolfssl/WolfSSLCertManager.java
@@ -27,6 +27,7 @@
 import java.security.cert.Certificate;
 import java.security.cert.X509Certificate;
 import java.security.cert.CertificateEncodingException;
+import com.wolfssl.WolfSSLDebug;
 import com.wolfssl.WolfSSLException;
 
 /**
@@ -61,11 +62,15 @@ static native int CertManagerVerifyBuffer(long cm, byte[] in, long sz,
      * @throws WolfSSLException if unable to create new manager
      */
     public WolfSSLCertManager() throws WolfSSLException {
+
         cmPtr = CertManagerNew();
         if (cmPtr == 0) {
             throw new WolfSSLException("Failed to create WolfSSLCertManager");
         }
         this.active = true;
+
+        WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, cmPtr, "creating new WolfSSLCertManager");
     }
 
     /**
@@ -99,6 +104,10 @@ public synchronized int CertManagerLoadCA(String f, String d)
         confirmObjectIsActive();
 
         synchronized (cmLock) {
+            WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+                WolfSSLDebug.INFO, this.cmPtr, "entered CertManagerLoadCA(" +
+                f + ", " + d + "");
+
             return CertManagerLoadCA(this.cmPtr, f, d);
         }
     }
@@ -121,6 +130,11 @@ public synchronized int CertManagerLoadCABuffer(
         confirmObjectIsActive();
 
         synchronized (cmLock) {
+            WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+                WolfSSLDebug.INFO, this.cmPtr,
+                "entered CertManagerLoadCABuffer(sz: " + sz +
+                ", format: " + format + "");
+
             return CertManagerLoadCABuffer(this.cmPtr, in, sz, format);
         }
     }
@@ -142,6 +156,10 @@ public synchronized int CertManagerLoadCAKeyStore(KeyStore ks)
 
         confirmObjectIsActive();
 
+        WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+            WolfSSLDebug.INFO, this.cmPtr,
+            "entered CertManagerLoadCAKeyStore(" + ks + ")");
+
         if (ks == null) {
             throw new WolfSSLException("Input KeyStore is null");
         }
@@ -194,6 +212,10 @@ public synchronized int CertManagerUnloadCAs()
         confirmObjectIsActive();
 
         synchronized (cmLock) {
+            WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+                WolfSSLDebug.INFO, this.cmPtr,
+                "entered CertManagerUnloadCAs()");
+
             return CertManagerUnloadCAs(this.cmPtr);
         }
     }
@@ -217,6 +239,11 @@ public synchronized int CertManagerVerifyBuffer(
         confirmObjectIsActive();
 
         synchronized (cmLock) {
+            WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+                WolfSSLDebug.INFO, this.cmPtr,
+                "entered CertManagerVerifyBuffer(sz: " + sz + ", format: " +
+                format + ")");
+
             return CertManagerVerifyBuffer(this.cmPtr, in, sz, format);
         }
     }
@@ -228,12 +255,16 @@ public synchronized int CertManagerVerifyBuffer(
     public synchronized void free() throws IllegalStateException {
 
         synchronized (stateLock) {
+
             if (this.active == false) {
                 /* already freed, just return */
                 return;
             }
 
             synchronized (cmLock) {
+                WolfSSLDebug.log(getClass(), WolfSSLDebug.Component.JNI,
+                    WolfSSLDebug.INFO, this.cmPtr, "entered free()");
+
                 /* free native resources */
                 CertManagerFree(this.cmPtr);