Merge branch 'master' of https://github.com/ShellCode33/CredSLayer

Author: ShellCode33

.travis.yml

@@ -13,7 +13,10 @@ python:
 - '3.8'
 - 'pypy3'
 
-script: python -m unittest tests/tests.py
+script:
+  - python -m unittest tests/tests.py
+  - make -C docs html
+  - touch docs/_build/html/.nojekyll
 
 deploy:
   - provider: releases
@@ -27,6 +30,14 @@ deploy:
     skip_cleanup: true
     api_key:
       secure: IcX91IbJikIWp5p9AgJWKVpVIhpBZdpstQmz7hES9BnGdh1o/cLcIHcJGhpJXqSQ+kEspxw5DHMhKYFcKShWmj1TyG4TI1eCNycJ/F8f2d4TRBvucZxNfiPZF7GmxZrWEze6iFJ4p3KPBzwQ2zfggxYwbyEL5d73vfLcVc3nQDpoanRvF94EDobMuAeKk5P01OGRU2IK4pMi1ESOolUZr2XKiNaTgNqol5np/XI6Gte+Mlx8bo+AcVKCC+mSSVotrTsPsRErma9sVF9OYf8OH0jySwAt2tqvWRAC66R+inJMbH1qJdJ1EsO2hyF3N7pe9oIGJZkRqxd7Z20MTDg8zYCydbNQB/bsLZeA1fLmt5uQ3+AmIGnia27v7h5tGd5oeceMUbmXtYbX5midfvDXnpZcpqUE/8aUiN/Lq0Lr6qGGiSjvlynEYBWfMY5W4yLhpsKryTn/oaeBMAoMg2IY4BFkSZ+Evtu1RQe5EloYzwT/QjJ2LVO6Rb0ORZpmXUZcuFJOLoISFDqjaI5OpamDuxwKzvR6OGwq+sFYTR42rLN4YZ9NVbUb5AqkKdwqvo8qRiEtivkokbcNwRtMSgEnvD1TSLArYHQdY9gvLNP8CTyW6qO+0Wt1/DianqjYhsk3fBBHijfRbBBRqfyYNmipLm0cPZ1VW4OeBRF+A1OumRc=
+  - provider: pages
+    skip_cleanup: true
+    local_dir: docs/_build/html/
+    on:
+      repo: ShellCode33/CredSLayer
+      tags: true
+    github_token:
+      secure: IcX91IbJikIWp5p9AgJWKVpVIhpBZdpstQmz7hES9BnGdh1o/cLcIHcJGhpJXqSQ+kEspxw5DHMhKYFcKShWmj1TyG4TI1eCNycJ/F8f2d4TRBvucZxNfiPZF7GmxZrWEze6iFJ4p3KPBzwQ2zfggxYwbyEL5d73vfLcVc3nQDpoanRvF94EDobMuAeKk5P01OGRU2IK4pMi1ESOolUZr2XKiNaTgNqol5np/XI6Gte+Mlx8bo+AcVKCC+mSSVotrTsPsRErma9sVF9OYf8OH0jySwAt2tqvWRAC66R+inJMbH1qJdJ1EsO2hyF3N7pe9oIGJZkRqxd7Z20MTDg8zYCydbNQB/bsLZeA1fLmt5uQ3+AmIGnia27v7h5tGd5oeceMUbmXtYbX5midfvDXnpZcpqUE/8aUiN/Lq0Lr6qGGiSjvlynEYBWfMY5W4yLhpsKryTn/oaeBMAoMg2IY4BFkSZ+Evtu1RQe5EloYzwT/QjJ2LVO6Rb0ORZpmXUZcuFJOLoISFDqjaI5OpamDuxwKzvR6OGwq+sFYTR42rLN4YZ9NVbUb5AqkKdwqvo8qRiEtivkokbcNwRtMSgEnvD1TSLArYHQdY9gvLNP8CTyW6qO+0Wt1/DianqjYhsk3fBBHijfRbBBRqfyYNmipLm0cPZ1VW4OeBRF+A1OumRc=
   - provider: pypi
     distributions: sdist bdist_wheel
     skip_existing: true

README.md

@@ -14,6 +14,9 @@ This tool is really helpful if you're doing IT security or if you want to scan y
 
 # Features
 
+CredSLayer doesn't waste your time with invalid credentials, it makes sure credentials are valid.
+Yet if it's not able to tell whether they're valid or not, what has been found will be printed out anyway. 
+
 Right now, CredSLayer supports the following protocols:
 * FTP
 * SMTP / IMAP / POP3

credslayer/core/extract.py

@@ -6,15 +6,15 @@
 from credslayer.core.utils import CreditCard
 
 # This regex has been made in order to prevent false positives, theoretically it can miss a few addresses.
-email_regex = re.compile(r'(?:\t| |^|<|,|:)([^+\x00-\x20@<>/\\{}`^\'*:;=()%\[\],_\-"]'
-                         r'[^\x00-\x20@<>/\\{}`^\'*:;=()%\[\],"]{2,63}@(?:[a-z0-9]{2,63}\.)+[a-z]{2,6})')
+_email_regex = re.compile(r'(?:\t| |^|<|,|:)([^+\x00-\x20@<>/\\{}`^\'*:;=()%\[\],_\-"]'
+                          r'[^\x00-\x20@<>/\\{}`^\'*:;=()%\[\],"]{2,63}@(?:[a-z0-9]{2,63}\.)+[a-z]{2,6})')
 
 # Tries to match things that look like a credit card.
 # Things like 11111111-11111111 will also match, that's why there's a second step to validate that data.
-first_step_credit_card_regex = re.compile(r"(?:\s|^)(?:\d[ -]*?){13,16}(?:\s|$)")
+_first_step_credit_card_regex = re.compile(r"(?:\s|^)(?:\d[ -]*?){13,16}(?:\s|$)")
 
 # https://gist.github.com/michaelkeevildown/9096cd3aac9029c4e6e05588448a8841
-second_step_credit_card_regex = re.compile(
+_second_step_credit_card_regex = re.compile(
     r"^(?P<AmericanExpress>3[47][0-9]{13})"
     r"|(?P<BCGlobal>(?:6541|6556)[0-9]{12})"
     r"|(?P<CarteBlanche>389[0-9]{11})"
@@ -41,11 +41,22 @@
 credit_cards_already_found = set()
 
 
-def extract_emails(packet_strings: List[str]) -> Set:
+def extract_emails(packet_strings: List[str]) -> Set[str]:
+    """
+    Parameters
+    ----------
+    packet_strings
+        The list of strings to extract emails from.
+
+    Returns
+    -------
+    Set[str]
+        A set of emails found.
+    """
     emails = set()
 
     for string in packet_strings:
-        emails_found = email_regex.findall(string)
+        emails_found = _email_regex.findall(string)
 
         for email_found in emails_found:
             if email_found not in emails_already_found:
@@ -56,17 +67,28 @@ def extract_emails(packet_strings: List[str]) -> Set:
 
 
 def extract_credit_cards(packet_strings: List[str]) -> Set[CreditCard]:
+    """
+    Parameters
+    ----------
+    packet_strings
+        The list of strings to extract credit cards from.
+
+    Returns
+    -------
+    Set[CreditCard]
+        A set of `CreditCard` tuple.
+    """
     credit_cards = set()
 
     def clean_credit_card(card):
         return card.replace(" ", "").replace("-", "")
 
     for string in packet_strings:
-        credit_cards_found = first_step_credit_card_regex.findall(string)
+        credit_cards_found = _first_step_credit_card_regex.findall(string)
 
         for credit_card_found in credit_cards_found:
             credit_card_found = credit_card_found.strip()  # Remove potential whitespaces
-            credit_card_match = second_step_credit_card_regex.match(clean_credit_card(credit_card_found))
+            credit_card_match = _second_step_credit_card_regex.match(clean_credit_card(credit_card_found))
 
             if credit_card_match and credit_card_found not in credit_cards_already_found:
                 credit_cards.add(CreditCard(credit_card_match.lastgroup, credit_card_found))

credslayer/core/logger.py

@@ -24,6 +24,10 @@ def _log(content):
 
 
 def debug(*args):
+    """
+    This should be used to display information to the developers, not the users.
+    """
+
     if not DEBUG_MODE:
         return
 
@@ -37,6 +41,10 @@ def debug(*args):
 
 
 def info(*args):
+    """
+    This should be used to display - not necessarily - useful information to the users.
+    """
+
     if len(args) == 2:
         session = args[0]
         msg = args[1]
@@ -47,8 +55,14 @@ def info(*args):
 
 
 def error(msg: str):
+    """
+    This should be used when anything goes wrong (not necessarily fatal).
+    """
     _log("{}[ERROR]{} {}".format(Color.RED, Color.RESET, msg))
 
 
 def found(session: Session, msg: str):
+    """
+    This should be used when something valuable has been found.
+    """
     _log("{}[{} {}] {}{}{}[FOUND]{} {}".format(Color.BRIGHT_BLUE, session.protocol, str(session), Color.RESET, Color.WHITE, Color.BACKGROUND_RED, Color.RESET, msg))