chore(crashtracking): Redact other things

Author: bric3

dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/parsers/RedactUtils.java

@@ -37,11 +37,21 @@ public final class RedactUtils {
   // Type descriptors like Lcom/company/Type;
   private static final Pattern TYPE_DESCRIPTOR = Pattern.compile("L([A-Za-z$_][A-Za-z0-9$_/]*);");
 
-  // klass/interface references: - klass: 'com/company/Class'
-  private static final Pattern KLASS_REF = Pattern.compile("((?:klass|interface): ')([^']+)(')");
+  // klass references: - klass: 'com/company/Class'
+  private static final Pattern KLASS_REF = Pattern.compile("(klass: ')([^']+)'");
 
   // 'in 'class'' clause in {method} descriptor entries
-  private static final Pattern METHOD_IN_CLASS = Pattern.compile("( in ')([^']+)(')");
+  private static final Pattern METHOD_IN_CLASS = Pattern.compile("( in ')([^']+)'");
+
+  // Object-reference field values in oop dumps: a 'com/company/Class'{0x...}
+  private static final Pattern OBJ_FIELD_REF =
+      Pattern.compile("(a ')([A-Za-z$_][A-Za-z0-9$_/]*)'");
+
+  // Class name in nmethod compiled-method output (JDK 11+):
+  //   "Compiled method (c2) ... com.company.Foo::methodName (N bytes)"   (PRODUCT — dots)
+  //   "Compiled method (c2) ... com/company/Foo::methodName (N bytes)"   (debug  — slashes)
+  private static final Pattern NMETHOD_CLASS =
+      Pattern.compile("([A-Za-z][A-Za-z0-9$]*(?:[./][A-Za-z][A-Za-z0-9$]*)+)::");
 
   // Library path in two formats produced by os::print_location():
   //   <offset 0x...> in /path/to/lib.so at 0x...       (no dladdr symbol)
@@ -106,6 +116,8 @@ private static String redactLine(String line, boolean isClassOop) {
     line = redactTypeDescriptors(line);
     line = redactKlassReference(line);
     line = redactMethodClass(line);
+    line = redactObjFieldRef(line);
+    line = redactNmethodClass(line);
     line = redactLibraryPath(line);
     line = redactStringOopRef(line, isClassOop);
     line = redactOopClassName(line);
@@ -140,39 +152,65 @@ static String redactStringTypeValue(String line) {
 
   /**
    * Redacts the package of type descriptors in a line: <code>Lcom/company/Type;</code> to <code>
-   * Lredacted/redacted/Type;</code>
+   * Lredacted/Redacted;</code>
    */
   static String redactTypeDescriptors(String line) {
     return replaceAll(TYPE_DESCRIPTOR, line, m -> "L" + redactJvmClassName(m.group(1)) + ";");
   }
 
   /**
-   * Redacts klass/interface references in a line: <code>klass: 'com/company/Class'</code> to <code>
-   * klass: 'redacted/redacted/Class'</code>
+   * Redacts klass references in a line: <code>klass: 'com/company/Class'</code> to <code>
+   * klass: 'redacted/Redacted'</code>
    */
   static String redactKlassReference(String line) {
     return replaceAll(
-        KLASS_REF, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + m.group(3));
+        KLASS_REF, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + "'");
   }
 
   /**
    * Redacts the class in a method descriptor's {@code in 'class'} clause: <code>
-   * in 'com/company/Class'</code> to <code>in 'redacted/redacted/Class'</code>
+   * in 'com/company/Class'</code> to <code>in 'redacted/Redacted'</code>
    */
   static String redactMethodClass(String line) {
     return replaceAll(
-        METHOD_IN_CLASS, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + m.group(3));
+        METHOD_IN_CLASS, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + "'");
   }
 
   /**
    * Redacts all but the parent directory and filename from a library path. Handles both <code>
    * &lt;offset 0x...&gt; in /path/to/dir/lib.so</code> and <code>symbol+0 in
-   * /path/to/dir/lib.so</code> to <code>... in /redacted/redacted/dir/lib.so</code>
+   * /path/to/dir/lib.so</code> to <code>... in /redacted/dir/lib.so</code>
    */
   static String redactLibraryPath(String line) {
     return replaceAll(LIBRARY_PATH, line, m -> m.group(1) + redactPath(m.group(2)));
   }
 
+  /**
+   * Redacts the class name in oop dump object-reference field values: <code>a
+   * 'com/company/Class'</code> to <code>a 'redacted/Redacted'</code>.
+   */
+  static String redactObjFieldRef(String line) {
+    return replaceAll(
+        OBJ_FIELD_REF, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + "'");
+  }
+
+  /**
+   * Redacts the class name in nmethod {@code Compiled method} output (JDK 11+): <code>
+   * com.company.Foo::methodName</code> to <code>redacted.Redacted::methodName</code>. Handles both
+   * dot-separated (PRODUCT build) and slash-separated (debug build) class names.
+   */
+  static String redactNmethodClass(String line) {
+    return replaceAll(
+        NMETHOD_CLASS,
+        line,
+        m -> {
+          String cls = m.group(1);
+          String redacted =
+              cls.indexOf('/') >= 0 ? redactJvmClassName(cls) : redactDottedClassName(cls);
+          return redacted + "::";
+        });
+  }
+
   /**
    * Redacts any {@code "value"\{0x...\}} OOP reference to {@code "REDACTED"\{0x...\}}. This is the
    * safe default for lines that are not part of a {@code java.lang.Class} oop dump, where the
@@ -186,7 +224,7 @@ static String redactDottedClassOopRef(String line) {
 
   /**
    * Redacts the class name in {@code is an oop: ClassName}: <code>is an oop: com.company.Class
-   * </code> to <code>is an oop: redacted.redacted.Class</code>
+   * </code> to <code>is an oop: redacted.Redacted</code>
    */
   static String redactOopClassName(String line) {
     return replaceAll(IS_AN_OOP, line, m -> m.group(1) + redactDottedClassName(m.group(2)));

dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/parsers/RedactUtilsTest.java

@@ -300,4 +300,91 @@ void testRedactReadableMemoryHexDump_leavesUnrelatedLinesUnchanged() {
     assertThat(RedactUtils.redactReadableMemoryHexDump("0x00007f37a16e2590 is an unknown value"))
         .isEqualTo("0x00007f37a16e2590 is an unknown value");
   }
+
+  @Test
+  void testRedactObjFieldRef_redactsUnknownPackage() {
+    assertThat(
+            RedactUtils.redactObjFieldRef(
+                " - 'owner' 'Lcom/company/Owner;' @12  a 'com/company/Owner'{0x00007f3700001234} (0x12345678)"))
+        .isEqualTo(
+            " - 'owner' 'Lcom/company/Owner;' @12  a 'redacted/Redacted'{0x00007f3700001234} (0x12345678)");
+  }
+
+  @Test
+  void testRedactObjFieldRef_keepsKnownPackage() {
+    assertThat(
+            RedactUtils.redactObjFieldRef(
+                " - 'loader' 'Ljava/lang/ClassLoader;' @12  a 'java/lang/ClassLoader'{0x00007f3700001234} (0x12345678)"))
+        .isEqualTo(
+            " - 'loader' 'Ljava/lang/ClassLoader;' @12  a 'java/lang/ClassLoader'{0x00007f3700001234} (0x12345678)");
+  }
+
+  @Test
+  void testRedactObjFieldRef_leavesUnrelatedLinesUnchanged() {
+    assertThat(RedactUtils.redactObjFieldRef("0x00007f37a16e2590 is an unknown value"))
+        .isEqualTo("0x00007f37a16e2590 is an unknown value");
+  }
+
+  @Test
+  void testRedactNmethodClass_dottedUnknownPackage() {
+    assertThat(
+            RedactUtils.redactNmethodClass(
+                "Compiled method (c2) 3068 4       com.company.Foo::methodName (456 bytes)"))
+        .isEqualTo("Compiled method (c2) 3068 4       redacted.Redacted::methodName (456 bytes)");
+  }
+
+  @Test
+  void testRedactNmethodClass_dottedKnownPackage() {
+    assertThat(
+            RedactUtils.redactNmethodClass(
+                "Compiled method (c2) 3068 4       java.util.HashMap::resize (456 bytes)"))
+        .isEqualTo(
+            "Compiled method (c2) 3068 4       java.util.HashMap::resize (456 bytes)");
+  }
+
+  @Test
+  void testRedactNmethodClass_slashUnknownPackage() {
+    assertThat(RedactUtils.redactNmethodClass("com/company/Foo::methodName"))
+        .isEqualTo("redacted/Redacted::methodName");
+  }
+
+  @Test
+  void testRedactNmethodClass_slashKnownPackage() {
+    assertThat(RedactUtils.redactNmethodClass("java/util/HashMap::resize"))
+        .isEqualTo("java/util/HashMap::resize");
+  }
+
+  @Test
+  void testRedactNmethodClass_leavesUnrelatedLinesUnchanged() {
+    assertThat(RedactUtils.redactNmethodClass("0x00007f37a16e2590 is an unknown value"))
+        .isEqualTo("0x00007f37a16e2590 is an unknown value");
+  }
+
+  @Test
+  void testRedactRegisterToMemoryMapping_objFieldRef() {
+    // Non-java.lang.Class oop with object-reference field: a 'ClassName' is redacted
+    String value =
+        "0x00000007142f8848 is an oop: com.company.Holder \n"
+            + "{0x00000007142f8848} - klass: 'com/company/Holder'\n"
+            + " - ---- fields (total size 3 words):\n"
+            + " - 'ref' 'Ljava/lang/Object;' @12  a 'com/company/Inner'{0x00007f1200003456} (0xabcdef01)";
+    assertThat(RedactUtils.redactRegisterToMemoryMapping(value))
+        .isEqualTo(
+            "0x00000007142f8848 is an oop: redacted.Redacted \n"
+                + "{0x00000007142f8848} - klass: 'redacted/Redacted'\n"
+                + " - ---- fields (total size 3 words):\n"
+                + " - 'ref' 'Ljava/lang/Object;' @12  a 'redacted/Redacted'{0x00007f1200003456} (0xabcdef01)");
+  }
+
+  @Test
+  void testRedactRegisterToMemoryMapping_nmethodCompiledMethod() {
+    // nmethod entry (JDK 11+): "Compiled method" line class name is redacted
+    String value =
+        "0x00007f36cd2b1600 is at entry_point+13512 in (nmethod*) 0x00007f36cd2b1510\n"
+            + "Compiled method (c2) 3068 4       com.company.Foo::processRequest (456 bytes)";
+    assertThat(RedactUtils.redactRegisterToMemoryMapping(value))
+        .isEqualTo(
+            "0x00007f36cd2b1600 is at entry_point+13512 in (nmethod*) 0x00007f36cd2b1510\n"
+                + "Compiled method (c2) 3068 4       redacted.Redacted::processRequest (456 bytes)");
+  }
 }