apply formatting

Author: jpramosi

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

README.md

@@ -57,18 +57,18 @@ gpg: Good signature from "Jimmy Pramosi (git) <[email protected]>" [u
 
 ```python
 import json
-from geckordp.rdp_client import RDPClient
+
 from geckordp.actors.root import RootActor
-from geckordp.profile import ProfileManager
 from geckordp.firefox import Firefox
-
+from geckordp.profile import ProfileManager
+from geckordp.rdp_client import RDPClient
 
 """ Uncomment to enable debug output
 """
-#from geckordp.settings import GECKORDP
-#GECKORDP.DEBUG = 1
-#GECKORDP.DEBUG_REQUEST = 1
-#GECKORDP.DEBUG_RESPONSE = 1
+# from geckordp.settings import GECKORDP
+# GECKORDP.DEBUG = 1
+# GECKORDP.DEBUG_REQUEST = 1
+# GECKORDP.DEBUG_RESPONSE = 1
 
 
 def main():
@@ -81,10 +81,7 @@ def main():
     profile.set_required_configs()
 
     # start firefox with specified profile
-    Firefox.start("https://example.com/",
-                  port,
-                  profile_name,
-                  ["-headless"])
+    Firefox.start("https://example.com/", port, profile_name, ["-headless"])
 
     # create client and connect to firefox
     client = RDPClient()
@@ -99,6 +96,7 @@ def main():
 
     input()
 
+
 if __name__ == "__main__":
     main()
 ```

dev/converter.py

@@ -1,12 +1,14 @@
 """ This is a helper script to create a formatted output log from pcap-dumps.
 """
+
 import argparse
 import json
 from pathlib import Path
-from scapy.all import PcapReader, re, Raw, TCP, IP
+
+from scapy.all import IP, TCP, PcapReader, Raw, re
 
 
-class JSONNode():
+class JSONNode:
 
     def __init__(self, idx: int, packet_idx: int):
         self.idx = idx
@@ -23,14 +25,20 @@ def __repr__(self):
 def main():
     # parse arguments
     parser = argparse.ArgumentParser(description="")
-    parser.add_argument("-i", "--input", type=str, default="",
-                        help="Input file to convert to.")
-    parser.add_argument("-p", "--port", type=int, default=6000,
-                        help="The port of the remote debug server.")
+    parser.add_argument(
+        "-i", "--input", type=str, default="", help="Input file to convert to."
+    )
+    parser.add_argument(
+        "-p",
+        "--port",
+        type=int,
+        default=6000,
+        help="The port of the remote debug server.",
+    )
     args, _ = parser.parse_known_args()
 
     input_file = Path(args.input).absolute()
-    if (not input_file.exists() or input_file.is_dir()):
+    if not input_file.exists() or input_file.is_dir():
         print(f"invalid input file '{input_file}'")
 
     buffer = ""
@@ -47,38 +55,37 @@ def main():
 
             # check whether it uses TCP protocol
             if p.haslayer(TCP) and p.haslayer(Raw):
-                if (len(payload) < 4):
+                if len(payload) < 4:
                     continue
                 root_nodes = []
 
                 # helper function to stack or pop nodes
                 def parse(brackets):
                     for idx, c in enumerate(payload):
-                        if (c == "{"):
+                        if c == "{":
                             brackets.append(JSONNode(idx, packet_idx))
                             continue
-                        if (c == "}"):
-                            if (len(brackets) <= 0):
+                        if c == "}":
+                            if len(brackets) <= 0:
                                 break
                             node = brackets.pop()
                             # check if root element
-                            if (len(brackets) == 0):
-                                root_nodes.append(
-                                    (node, JSONNode(idx, packet_idx)))
+                            if len(brackets) == 0:
+                                root_nodes.append((node, JSONNode(idx, packet_idx)))
                             continue
                     return brackets
 
                 # parse and check whether it is a request
                 # or response by checking the destination port
-                if (args.port == p[TCP].dport):
+                if args.port == p[TCP].dport:
                     req_brackets = parse(req_brackets)
-                    if (len(req_brackets) > 0):
+                    if len(req_brackets) > 0:
                         req_brackets[0].packets_list.append(packet_idx)
                         continue
                     buffer += "->REQUEST\n"
                 else:
                     res_brackets = parse(res_brackets)
-                    if (len(res_brackets) > 0):
+                    if len(res_brackets) > 0:
                         res_brackets[0].packets_list.append(packet_idx)
                         continue
                     buffer += "<-RESPONSE\n"
@@ -89,9 +96,9 @@ def parse(brackets):
 
                     new_payload = ""
                     # if it's only a single packet, no need to merge payloads
-                    if (len(node[0].packets_list) <= 0):
+                    if len(node[0].packets_list) <= 0:
                         # set new payload which contains only the json data
-                        new_payload = payload[node[0].idx:node[1].idx+1]
+                        new_payload = payload[node[0].idx : node[1].idx + 1]
                     else:
                         adjust_offset = 1
                         # merge payloads and its related sizes
@@ -103,7 +110,7 @@ def parse(brackets):
                         # shift index by new offset
                         node[1].idx += adjust_offset
                         # set new payload which contains only the json data
-                        new_payload = new_payload[node[0].idx:node[1].idx]
+                        new_payload = new_payload[node[0].idx : node[1].idx]
 
                     # format payload
                     new_payload = new_payload.replace("'", "\\'")
@@ -113,10 +120,10 @@ def parse(brackets):
                     except Exception as ex:
                         print(f"{ex}\n\n", new_payload)
                         return 1
-                    new_payload = "\t".expandtabs(
-                        8) + new_payload.replace("\n", "\n\t".expandtabs(8))
+                    new_payload = "\t".expandtabs(8) + new_payload.replace(
+                        "\n", "\n\t".expandtabs(8)
+                    )
                     buffer += f"{new_payload}\n"
-    
 
     # write buffer to the same path
     output_file = f"{input_file.parent.joinpath(input_file.stem)}.log"
@@ -125,6 +132,5 @@ def parse(brackets):
     print(f"converted pcap-dump in '{output_file}'")
 
 
-
 if __name__ == "__main__":
     main()

dev/profile.py

@@ -1,10 +1,12 @@
 """ This is a Firefox cli profile manager.
     Create, clone or remove a profile.
 """
-import os
+
 import argparse
+import os
 from argparse import RawTextHelpFormatter
 from pprint import pprint
+
 from geckordp.profile import ProfileManager
 from geckordp.settings import GECKORDP
 
@@ -16,72 +18,80 @@ def main():
     ]
     epilog = """available environment variables:\n\t"""
 
-
     parser = argparse.ArgumentParser(
         description="",
         formatter_class=RawTextHelpFormatter,
-        epilog=epilog+"\n\t".join(env_names)
+        epilog=epilog + "\n\t".join(env_names),
+    )
+    parser.add_argument(
+        "-n",
+        "--new",
+        type=str,
+        default="",
+        metavar="<profile-name>",
+        help="Creates a new firefox profile",
+    )
+    parser.add_argument(
+        "-c",
+        "--clone",
+        action="append",
+        nargs=2,
+        metavar=("<source-profile-name>", "<clone-profile-name>"),
+        help="Clones an existing profile with a different name",
+    )
+    parser.add_argument(
+        "-rm",
+        "--remove",
+        type=str,
+        default="",
+        metavar="<profile-name>",
+        help="Removes a profile",
     )
-    parser.add_argument("-n", "--new", type=str, default="", metavar="<profile-name>",
-                        help="Creates a new firefox profile")
-    parser.add_argument("-c", "--clone", action="append", nargs=2,
-                        metavar=("<source-profile-name>",
-                                 "<clone-profile-name>"),
-                        help="Clones an existing profile with a different name")
-    parser.add_argument("-rm", "--remove", type=str, default="", metavar="<profile-name>",
-                        help="Removes a profile")
-    parser.add_argument("-ls", "--list", action="store_true",
-                        help="List all profiles")
+    parser.add_argument("-ls", "--list", action="store_true", help="List all profiles")
     args, _ = parser.parse_known_args()
 
-
     env_vars = {}
     for env_name in env_names:
         env_vars[env_name] = os.environ.get(env_name, "")
 
-
     GECKORDP.DEBUG = 1
     pm = ProfileManager(env_vars["FIREFOX_PATH"], env_vars["PROFILE_PATH"])
 
-
-    if (args.new != ""):
+    if args.new != "":
         profile = pm.create(args.new)
-        if (profile == None):
+        if profile == None:
             return 1
         profile.set_required_configs()
         return 0
 
-
-    if (args.clone != None):
-        if (not isinstance(args.clone, list)):
+    if args.clone != None:
+        if not isinstance(args.clone, list):
             print("'--clone' expected 2 strings")
             return 1
 
-        if (len(args.clone) != 1):
+        if len(args.clone) != 1:
             print("'--clone' encountered an unknown error")
             return 1
 
         for n in args.clone[0]:
-            if (str(n).isdecimal()):
+            if str(n).isdecimal():
                 print(f"'--clone' expected a string value not '{n}'")
                 return 1
 
         profile = pm.clone(args.clone[0][0], args.clone[0][1])
-        if (profile == None):
+        if profile == None:
             print(f"cloning profile failed")
             return 1
-        
+
         profile.set_required_configs()
         return 0
 
-
-    if (args.remove != ""):
-        if (pm.remove(args.remove)):
+    if args.remove != "":
+        if pm.remove(args.remove):
             return 0
         return 1
 
-
-    if (args.list is True):
+    if args.list is True:
         pprint(pm.list_profiles())
         return 0