fix tube's debug output of same byte compression (Gallopsled#2011)

* fix tube's debug output of same byte compression

* Update CHANGELOG.md

* move code to `log.maybe_hexdump`

* update doc string

Author: tkmikan

CHANGELOG.md

@@ -64,15 +64,9 @@ The table below shows which release corresponds to each branch, and what date th
 
 ## 4.9.0 (`dev`)
 
-- [#1922][1922] Fix logic in `wait_for_debugger`
-- [#1828][1828] libcdb: Load debug info and unstrip libc binary
-- [#1939][1939] Fix error in validating log levels
-- [#1981][1981] Fix `cyclic_find()` to make it work with large int values
+- [#2011][2011] Fix tube's debug output of same byte compression
 
-[1922]: https://github.com/Gallopsled/pwntools/pull/1922
-[1828]: https://github.com/Gallopsled/pwntools/pull/1828
-[1939]: https://github.com/Gallopsled/pwntools/pull/1939
-[1981]: https://github.com/Gallopsled/pwntools/pull/1981
+[2011]: https://github.com/Gallopsled/pwntools/pull/2011
 
 ## 4.8.0 (`beta`)
 

pwnlib/log.py

@@ -99,6 +99,7 @@
 import random
 import re
 import six
+import string
 import sys
 import threading
 import time
@@ -401,6 +402,20 @@ def hexdump(self, message, *args, **kwargs):
 
         self.info(pwnlib.util.fiddling.hexdump(message, *args, **kwargs))
 
+    def maybe_hexdump(self, message, *args, **kwargs):
+        """maybe_hexdump(self, message, *args, **kwargs)
+
+        Logs a message using indented. Repeated single byte is compressed, and
+        unprintable message is hexdumped.
+        """
+        if len(set(message)) == 1 and len(message) > 1:
+            self.indented('%r * %#x' % (message[:1], len(message)), *args, **kwargs)
+        elif len(message) == 1 or all(c in string.printable.encode() for c in message):
+            for line in message.splitlines(True):
+                self.indented(repr(line), *args, **kwargs)
+        else:
+            import pwnlib.util.fiddling
+            self.indented(pwnlib.util.fiddling.hexdump(message), *args, **kwargs)
 
     def warning(self, message, *args, **kwargs):
         """warning(message, *args, **kwargs)

pwnlib/tubes/tube.py

@@ -19,7 +19,6 @@
 from pwnlib.log import Logger
 from pwnlib.timeout import Timeout
 from pwnlib.tubes.buffer import Buffer
-from pwnlib.util import fiddling
 from pwnlib.util import misc
 from pwnlib.util import packing
 
@@ -155,15 +154,7 @@ def _fillbuffer(self, timeout = default):
 
         if data and self.isEnabledFor(logging.DEBUG):
             self.debug('Received %#x bytes:' % len(data))
-
-            if len(set(data)) == 1 and len(data) > 1:
-                self.indented('%r * %#x' % (data[0], len(data)), level = logging.DEBUG)
-            elif all(c in string.printable.encode() for c in data):
-                for line in data.splitlines(True):
-                    self.indented(repr(line), level = logging.DEBUG)
-            else:
-                self.indented(fiddling.hexdump(data), level = logging.DEBUG)
-
+            self.maybe_hexdump(data, level=logging.DEBUG)
         if data:
             self.buffer.add(data)
 
@@ -767,13 +758,8 @@ def send(self, data):
 
         if self.isEnabledFor(logging.DEBUG):
             self.debug('Sent %#x bytes:' % len(data))
-            if len(set(data)) == 1:
-                self.indented('%r * %#x' % (data[0], len(data)))
-            elif all(c in string.printable.encode() for c in data):
-                for line in data.splitlines(True):
-                    self.indented(repr(line), level = logging.DEBUG)
-            else:
-                self.indented(fiddling.hexdump(data), level = logging.DEBUG)
+            self.maybe_hexdump(data, level=logging.DEBUG)
+
         self.send_raw(data)
 
     def sendline(self, line=b''):