Merge pull request #58 from kruton/hashcat7

Support Hashcat 7.0.0 with less-rigid status parsing

Author: s3inlc

htpclient/hashcat_status.py

@@ -1,6 +1,13 @@
 class HashcatStatus:
     def __init__(self, line):
-        # parse
+        """
+        Initializes the HashcatStatus object by parsing a machine-readable
+        status line from Hashcat.
+
+        Args:
+            line (str): A single line of Hashcat machine-readable status
+                        output.
+        """
         self.status = -1
         self.speed = []
         self.exec_runtime = []
@@ -11,44 +18,72 @@ def __init__(self, line):
         self.rejected = 0
         self.util = []
         self.temp = []
+        self.power = []
+        self.unknown_fields = False
+
+        try:
+            fields = line.strip().split('\t')
+            if not fields or fields[0] != 'STATUS':
+                # Not a valid status line
+                return
+
+            self.status = int(fields[1])
+
+            i = 2
+            while i < len(fields):
+                key = fields[i]
+                i += 1
 
-        line = line.split("\t")
-        if line[0] != "STATUS":
-            # invalid line
-            return
-        elif len(line) < 19:
-            # invalid line
-            return
-        self.status = int(line[1])
-        index = 3
-        while line[index] != "EXEC_RUNTIME":
-            self.speed.append([int(line[index]), int(line[index + 1])])
-            index += 2
-        while line[index] != "CURKU":
-            index += 1
-        self.curku = int(line[index + 1])
-        self.progress[0] = int(line[index + 3])
-        self.progress[1] = int(line[index + 4])
-        self.rec_hash[0] = int(line[index + 6])
-        self.rec_hash[1] = int(line[index + 7])
-        self.rec_salt[0] = int(line[index + 9])
-        self.rec_salt[1] = int(line[index + 10])
-        if line[index + 11] == "TEMP":
-            # we have temp values
-            index += 12
-            while line[index] != "REJECTED":
-                self.temp.append(int(line[index]))
-                index += 1
-        else:
-            index += 11
-        self.rejected = int(line[index + 1])
-        if len(line) > index + 2:
-            index += 2
-            if line[index] == "UTIL":
-                index += 1
-                while len(line) - 1 > index:  # -1 because the \r\n is also included in the split
-                    self.util.append(int(line[index]))
-                    index += 1
+                if key == 'SPEED':
+                    # Speed has two values per device: hashes over period and period in ms
+                    while i + 1 < len(fields) and fields[i].isdigit() and fields[i+1].isdigit():
+                        self.speed.append([int(fields[i]), int(fields[i+1])])
+                        i += 2
+                elif key == 'EXEC_RUNTIME':
+                    # Execution runtime per device
+                    while i < len(fields) and fields[i].replace('.', '', 1).isdigit():
+                        self.exec_runtime.append(float(fields[i]))
+                        i += 1
+                elif key == 'CURKU':
+                    self.curku = int(fields[i])
+                    i += 1
+                elif key == 'PROGRESS':
+                    # Progress has two values: current and total
+                    self.progress = [int(fields[i]), int(fields[i+1])]
+                    i += 2
+                elif key == 'RECHASH':
+                    # Recovered hashes has two values: done and total
+                    self.rec_hash = [int(fields[i]), int(fields[i+1])]
+                    i += 2
+                elif key == 'RECSALT':
+                     # Recovered salts has two values: done and total
+                    self.rec_salt = [int(fields[i]), int(fields[i+1])]
+                    i += 2
+                elif key == 'TEMP':
+                    # Temperature per device
+                    while i < len(fields) and fields[i].lstrip('-').isdigit():
+                        self.temp.append(int(fields[i]))
+                        i += 1
+                elif key == 'REJECTED':
+                    self.rejected = int(fields[i])
+                    i += 1
+                elif key == 'UTIL':
+                    # Utilization per device
+                    while i < len(fields) and fields[i].lstrip('-').isdigit():
+                        self.util.append(int(fields[i]))
+                        i += 1
+                elif key == 'POWER':
+                    # Power usage per device (newer versions)
+                    while i < len(fields) and fields[i].lstrip('-').isdigit():
+                        self.power.append(int(fields[i]))
+                        i += 1
+                else:
+                    print(f"Unknown field in Hashcat status line: {key}")
+                    self.unknown_fields = True
+                    pass
+        except (ValueError, IndexError) as e:
+            print(f"Error parsing Hashcat status line: {e}")
+            self.__init__("") # Fallback to default initialization
 
     def is_valid(self):
         return self.status >= 0
@@ -87,3 +122,14 @@ def get_speed(self):
 
     def get_rejected(self):
         return self.rejected
+
+    def get_all_power(self):
+        return self.power
+
+    def get_power(self):
+        if not self.power:
+            return -1
+        power_sum = 0
+        for p in self.power:
+            power_sum += p
+        return int(power_sum / len(self.power))

tests/test_hashcat_status.py

@@ -0,0 +1,84 @@
+import unittest
+from htpclient.hashcat_status import HashcatStatus
+
+class TestHashcatStatus(unittest.TestCase):
+    def test_hashcat_6_single_device(self):
+        line = "STATUS\t3\tSPEED\t11887844\t1000\tEXEC_RUNTIME\t15.870873\tCURKU\t170970511093\tPROGRESS\t2735618289488\t2736891330000\tRECHASH\t0\t1\tRECSALT\t0\t1\tTEMP\t-1\tREJECTED\t0\tUTIL\t100\t"
+        status = HashcatStatus(line)
+        self.assertTrue(status.is_valid())
+        self.assertEqual(status.status, 3)
+        self.assertEqual(status.speed, [[11887844, 1000]])
+        self.assertEqual(status.exec_runtime, [15.870873])
+        self.assertEqual(status.curku, 170970511093)
+        self.assertEqual(status.progress, [2735618289488, 2736891330000])
+        self.assertEqual(status.rec_hash, [0, 1])
+        self.assertEqual(status.rec_salt, [0, 1])
+        self.assertEqual(status.temp, [-1])
+        self.assertEqual(status.rejected, 0)
+        self.assertEqual(status.util, [100])
+        self.assertEqual(status.power, [])
+        self.assertEqual(status.unknown_fields, False)
+
+    def test_hashcat_7_single_device(self):
+        line = "STATUS\t3\tSPEED\t11887844\t1000\tEXEC_RUNTIME\t15.870873\tCURKU\t170970511093\tPROGRESS\t2735618289488\t2736891330000\tRECHASH\t0\t1\tRECSALT\t0\t1\tTEMP\t-1\tREJECTED\t0\tUTIL\t100\tPOWER\t56\t"
+        status = HashcatStatus(line)
+        self.assertTrue(status.is_valid())
+        self.assertEqual(status.status, 3)
+        self.assertEqual(status.speed, [[11887844, 1000]])
+        self.assertEqual(status.exec_runtime, [15.870873])
+        self.assertEqual(status.curku, 170970511093)
+        self.assertEqual(status.progress, [2735618289488, 2736891330000])
+        self.assertEqual(status.rec_hash, [0, 1])
+        self.assertEqual(status.rec_salt, [0, 1])
+        self.assertEqual(status.temp, [-1])
+        self.assertEqual(status.rejected, 0)
+        self.assertEqual(status.util, [100])
+        self.assertEqual(status.power, [56])
+        self.assertEqual(status.unknown_fields, False)
+
+    def test_valid_status_line(self):
+        line = "STATUS\t1\tSPEED\t2534\t1000\tEXEC_RUNTIME\t123\tCURKU\t45\tPROGRESS\t67\t100\tRECHASH\t89\t120\tRECSALT\t56\t110\tTEMP\t25\tREJECTED\t7\tUTIL\t85\t90\tPOWER\t100\t150"
+        status = HashcatStatus(line)
+        self.assertEqual(status.status, 1)
+        self.assertEqual(status.speed, [[2534, 1000]])
+        self.assertEqual(status.exec_runtime, [123])
+        self.assertEqual(status.curku, 45)
+        self.assertEqual(status.progress, [67, 100])
+        self.assertEqual(status.rec_hash, [89, 120])
+        self.assertEqual(status.rec_salt, [56, 110])
+        self.assertEqual(status.temp, [25])
+        self.assertEqual(status.rejected, 7)
+        self.assertEqual(status.util, [85, 90])
+        self.assertEqual(status.power, [100, 150])
+
+    def test_invalid_status_line(self):
+        line = "NOT_STATUS_LINE"
+        status = HashcatStatus(line)
+        self.assertEqual(status.status, -1)
+
+    def test_missing_fields(self):
+        line = "STATUS\t1\tSPEED\t200\t1000"
+        status = HashcatStatus(line)
+        self.assertEqual(status.status, 1)
+        self.assertEqual(status.speed, [[200, 1000]])
+        self.assertEqual(status.exec_runtime, [])
+        self.assertEqual(status.curku, 0)
+        self.assertEqual(status.progress, [0, 0])
+
+    def test_get_progress(self):
+        line = "STATUS\t1\tPROGRESS\t42\t100"
+        status = HashcatStatus(line)
+        self.assertEqual(status.get_progress(), 42)
+
+    def test_get_speed(self):
+        line = "STATUS\t1\tSPEED\t12400\t1000\t2000\t1000"
+        status = HashcatStatus(line)
+        self.assertEqual(status.get_speed(), 12400 + 2000)
+
+    def test_get_util(self):
+        line = "STATUS\t1\tUTIL\t85\t90"
+        status = HashcatStatus(line)
+        self.assertEqual(status.get_util(), (85 + 90) // 2)
+
+if __name__ == '__main__':
+    unittest.main()