NMS-15498: Treat only ASCII characters between 32 and 127 as displayable

OpenNMS · Apr 18, 2023 · ac63cc6 · ac63cc6
1 parent 8570ccf
commit ac63cc6
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 2 deletions.
diff --git a/core/snmp/api/pom.xml b/core/snmp/api/pom.xml
@@ -29,6 +29,10 @@
     </plugins>
   </build>
   <dependencies>
+    <dependency>
+      <groupId>commons-lang</groupId>
+      <artifactId>commons-lang</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>

diff --git a/core/snmp/api/src/main/java/org/opennms/netmgt/snmp/AbstractSnmpValue.java b/core/snmp/api/src/main/java/org/opennms/netmgt/snmp/AbstractSnmpValue.java
@@ -28,8 +28,16 @@
 
 package org.opennms.netmgt.snmp;
 
+import java.nio.charset.Charset;
+
+import org.apache.commons.lang.StringUtils;
+
 public abstract class AbstractSnmpValue implements SnmpValue {
 
+    public static boolean allBytesPlainAscii(final byte[] bytes) {
+        return StringUtils.isAsciiPrintable(new String(bytes, Charset.defaultCharset()));
+    }
+
     public static boolean allBytesDisplayable(final byte[] bytes) {
         if (allBytesUTF_8(bytes)) {
             return true;

diff --git a/core/snmp/api/src/test/java/org/opennms/netmgt/snmp/AbstractSnmpValueTest.java b/core/snmp/api/src/test/java/org/opennms/netmgt/snmp/AbstractSnmpValueTest.java
@@ -28,6 +28,7 @@
 
 package org.opennms.netmgt.snmp;
 
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
@@ -110,6 +111,14 @@ public void testHighIso8859CharDisplayable() throws UnsupportedEncodingException
 		assertTrue(new String(hexStringToBytes(highIso8859Char), "ISO-8859-1"), AbstractSnmpValue.allBytesDisplayable(hexStringToBytes(highIso8859Char)));
 	}
 
+	@Test
+	public void testPlainAscii() {
+		for(char i = 0; i < 256; i++) {
+			final String string = "foo" + i + "bar";
+			assertEquals(i > 31 && i  < 127, AbstractSnmpValue.allBytesPlainAscii(string.getBytes()));
+		}
+	}
+
 	private static byte[] hexStringToBytes(String hexString) {
 		assertTrue(hexString.length() % 2 == 0);
 		byte[] retval = new byte[hexString.length() / 2];

diff --git a/core/snmp/impl-joesnmp/src/main/java/org/opennms/netmgt/snmp/joesnmp/JoeSnmpValue.java b/core/snmp/impl-joesnmp/src/main/java/org/opennms/netmgt/snmp/joesnmp/JoeSnmpValue.java
@@ -293,7 +293,7 @@ public boolean isDisplayable() {
             return true;
 
         if (getType() == SnmpValue.SNMP_OCTET_STRING) {
-            return allBytesDisplayable(getBytes());
+            return allBytesPlainAscii(getBytes());
         }
 
         return false;

diff --git a/core/snmp/impl-snmp4j/src/main/java/org/opennms/netmgt/snmp/snmp4j/Snmp4JValue.java b/core/snmp/impl-snmp4j/src/main/java/org/opennms/netmgt/snmp/snmp4j/Snmp4JValue.java
@@ -306,7 +306,7 @@ public boolean isDisplayable() {
         }
 
         if (getType() == SnmpValue.SNMP_OCTET_STRING) {
-            return allBytesDisplayable(getBytes());
+            return allBytesPlainAscii(getBytes());
         }
 
         return false;