Merge pull request #619 from Ciphey/bee-fix-ausearch

Added new checker and general cleanup

Author: SkeletalDemise

ciphey/basemods/Checkers/__init__.py

@@ -1 +1 @@
-from . import any, brandon, ezcheck, format, human, quorum, regex
+from . import any, brandon, ezcheck, format, human, quorum, regex, what

ciphey/basemods/Checkers/brandon.py

@@ -104,18 +104,6 @@ def clean_text(self, text: str) -> set:
         text = set(text)
         return text
 
-        x = []
-        for word in text:
-            # poor mans lemmatisation
-            # removes 's from the dict'
-            if word.endswith("'s"):
-                x.append(word[0:-2])
-        text = self.mh.strip_punctuation(x)
-        # turns it all into lowercase and as a set
-        complete = set([word.lower() for word in x])
-
-        return complete
-
     def checker(self, text: str, threshold: float, text_length: int, var: set) -> bool:
         """Given text determine if it passes checker
 

ciphey/basemods/Checkers/ezcheck.py

@@ -6,6 +6,7 @@
 from .format import JsonChecker
 from .human import HumanChecker
 from .regex import RegexList
+from .what import What
 
 
 @registry.register
@@ -41,11 +42,8 @@ def __init__(self, config: Config):
 
         # We need to modify the config for each of the objects
 
-        # First the flag regexes, as they are the fastest
-        flags_config = config
-        flags_config.update_param("regexlist", "resource", "cipheydists::list::flags")
-        # We do not cache, as this uses a different, on-time config
-        self.checkers.append(RegexList(flags_config))
+        # First PyWhat, as it's the fastest
+        self.checkers.append(config(What))
 
         # Next, the json checker
         self.checkers.append(config(JsonChecker))

ciphey/basemods/Checkers/what.py

@@ -0,0 +1,32 @@
+from typing import Dict, Optional
+
+from ciphey.iface import Checker, Config, ParamSpec, T, registry
+from loguru import logger
+from pywhat import identifier
+
+
+@registry.register
+class What(Checker[str]):
+
+    """
+    Uses PyWhat to determine plaintext with regexes
+    """
+
+    def check(self, ctext: T) -> Optional[str]:
+        logger.trace("Trying PyWhat checker")
+        returned_regexes = self.id.identify(ctext, api=True)
+        if len(returned_regexes["Regexes"]) > 0:
+            return returned_regexes["Regexes"][0]["Regex Pattern"]["Name"]
+        return None
+
+    def getExpectedRuntime(self, text: T) -> float:
+        # TODO: actually bench this
+        return 2e-7 * len(text)
+
+    @staticmethod
+    def getParams() -> Optional[Dict[str, ParamSpec]]:
+        return None
+
+    def __init__(self, config: Config):
+        super().__init__(config)
+        self.id = identifier.Identifier()

ciphey/basemods/Searchers/ausearch.py

@@ -337,4 +337,4 @@ def getParams() -> Optional[Dict[str, ParamSpec]]:
                 desc="Sets the maximum depth before we give up ordering items.",
                 default="2",
             ),
-        }
+        }

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ciphey"
-version = "5.11.2"
+version = "5.11.3"
 description = "Automated Decryption Tool"
 authors = ["Brandon <brandon@skerritt.blog>"]
 license = "MIT"
@@ -25,6 +25,7 @@ click = ">=7.1.2,<9.0.0"
 click-spinner = "^0.1.10"
 pyyaml = "^5.3.1"
 yaspin = ">=0.17,<1.6"
+pywhat = "^0.2.5"
 
 [tool.poetry.dev-dependencies]
 pytest-cov = "^2.10.1"

tests/test_main.py

@@ -123,8 +123,8 @@ def test_binary_base64_caesar():
 
 def test_braille():
     res = decrypt(
-        Config.library_default().complete_config(), 
-        "⠓⠑⠇⠇⠕⠀⠍⠽⠀⠝⠁⠍⠑⠀⠊⠎⠀⠃⠑⠑⠀⠁⠝⠙⠀⠊⠀⠇⠊⠅⠑⠀⠙⠕⠛⠀⠁⠝⠙⠀⠁⠏⠏⠇⠑⠀⠁⠝⠙⠀⠞⠗⠑⠑"
+        Config.library_default().complete_config(),
+        "⠓⠑⠇⠇⠕⠀⠍⠽⠀⠝⠁⠍⠑⠀⠊⠎⠀⠃⠑⠑⠀⠁⠝⠙⠀⠊⠀⠇⠊⠅⠑⠀⠙⠕⠛⠀⠁⠝⠙⠀⠁⠏⠏⠇⠑⠀⠁⠝⠙⠀⠞⠗⠑⠑",
     )
     assert res.lower() == answer_str.lower()
 

tests/test_regex.py

@@ -0,0 +1,26 @@
+import pytest
+
+from ciphey import decrypt
+from ciphey.iface import Config
+
+
+def test_regex_ip():
+    res = decrypt(
+        Config().library_default().complete_config(),
+        "MTkyLjE2MC4wLjE=",
+    )
+    assert res == "192.160.0.1"
+
+def test_regex_domain():
+    res = decrypt(
+        Config().library_default().complete_config(),
+        "aHR0cHM6Ly9nb29nbGUuY29t",
+    )
+    assert res == "https://google.com"
+
+def test_regex_bitcoin():
+    res = decrypt(
+        Config().library_default().complete_config(),
+        "M0ZaYmdpMjljcGpxMkdqZHdWOGV5SHVKSm5rTHRrdFpjNQ==",
+    )
+    assert res == "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"