Add comments explaining intention behind certain regexes

fkie-cad · Jun 29, 2022 · 4cdf575 · 4cdf575
1 parent e73941b
commit 4cdf575
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/attacks/attack.py b/src/attacks/attack.py
@@ -108,6 +108,7 @@ def interrupt_handler(self, _signum, _frame):
 
     @contextmanager
     def check_printed(self, indicator):
+        # Removes all ANSI escape sequences to prevent unintended string mismatches when checking for success
         ansi_escape = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
         lp = ListPrinter()
         old_printer = self.printer

diff --git a/src/attacks/ssh.py b/src/attacks/ssh.py
@@ -99,6 +99,7 @@ def print_output(self, msg_file, printer):
 
     @staticmethod
     def print_windows_output(msg_file, printer):
+        # Removes certain ANSI escape codes (J, m, H) to prevent the printed console output from being malformed
         ansi_escape = re.compile(r'\x1b\[(?:[0-?]*[JmH])')
         while not msg_file.channel.exit_status_ready() or msg_file.channel.recv_ready():
             printer.print(ansi_escape.sub("", msg_file.readline()))