AndroidFridaManager 0.4__tar.gz → 0.8__tar.gz

{AndroidFridaManager-0.4 → AndroidFridaManager-0.8}/AndroidFridaManager/AndroidFridaManager.py

@@ -12,12 +12,26 @@ import lzma
 import re
 from shutil import copyfile
 import tempfile
+import argparse
 
 # some parts are taken from ttps://github.com/Mind0xP/Frida-Python-Binding/
 
 class FridaManager():
 
     def __init__(self, is_remote=False, socket="", verbose=False, frida_install_dst="/data/local/tmp/"):
+        """
+        Constructor of the current FridaManager instance
+
+        :param is_remote: The number to multiply.
+        :type number: bool
+        :param socket: The socket to connect to the remote device. The remote device needs to be set by <ip:port>. By default this string will be empty in order to indicate that FridaManger is working with the first connected USB device.
+        :type number: string
+        :param verbose: Set the output to verbose, so that the logging information gets printed. By default set to False.
+        :type number: bool
+        :param frida_install_dst: The path where the frida server should be installed. By default it will be installed to /data/local/tmp/.
+        :type number: bool
+
+        """
         self.is_remote = is_remote
         self.device_socket = socket
         self.verbose = verbose
@@ -31,6 +45,10 @@ class FridaManager():
 
 
     def _setup_logging(self):
+        """
+        Setup logging for the current instance of FridaManager 
+
+        """
         logger = logging.getLogger()
         logger.setLevel(logging.INFO)
         color_formatter = ColoredFormatter(
@@ -68,6 +86,13 @@ class FridaManager():
 
 
     def is_frida_server_running(self):
+        """
+        Checks if on the connected device a frida server is running. 
+        The test is done by the Android system command pidof and is looking for the string frida-server.
+
+        :return: True if a frida-server is running otherwise False.
+        :rtype: bool
+        """
         result = self.run_adb_command_as_root("/system/bin/pidof frida-server")
         if len(result.stdout) > 1:
             return True
@@ -89,15 +114,28 @@ class FridaManager():
         self._adb_remove_file_if_exist(cmd)
 
 
-    def install_frida_server(self,dst_dir="/data/local/tmp/"):
+    def install_frida_server(self, dst_dir="/data/local/tmp/", version="latest"):
+        """
+        Install the frida server binary on the Android device. 
+        This includes downloading the frida-server, decompress it and pushing it to the Android device.
+        By default it is pushed into the /data/local/tmp/ directory.
+        Further the binary will be set to executable in order to run it.
+
+        :param dst_dir: The destination folder where the frida-server binary should be installed (pushed). 
+        :type number: string
+        :param version: The version. By default the latest version will be used.
+        :type number: string
+
+        """
         if dst_dir is self.install_frida_server.__defaults__[0]:
             frida_dir = self.frida_install_dst
         else:
             frida_dir = dst_dir
 
         with tempfile.TemporaryDirectory() as dir:
-            self.logger.info(f"[*] downloading frida-server to {dir}")
-            file_path = self.download_frida_server(dir)
+            if self.verbose:
+                self.logger.info(f"[*] downloading frida-server to {dir}")
+            file_path = self.download_frida_server(dir,version)
             tmp_frida_server = self.extract_frida_server_comp(file_path)
             # ensure's that we always overwrite the current installation with our recent downloaded version
             self._adb_remove_file_if_exist(frida_dir + "frida-server")
@@ -107,18 +145,32 @@ class FridaManager():
 
     # by default the latest frida-server version will be downloaded
     def download_frida_server(self, path, version="latest"):
+        """
+        Downloads a frida server. By default the latest version is used.
+        If you want to download a specific version you have to provide it trough the version parameter.
+
+        :param path: The path where the compressed frida-server should be downloded.
+        :type number: string
+        :param version: The version. By default the latest version will be used.
+        :type number: string
+
+        :return: The location of the downloaded frida server in its compressed form.
+        :rtype: string
+        """
         url = self.get_frida_server_for_android_url(version)
         with open(path+"/frida-server","wb") as fsb:
             res = requests.get(url)
             fsb.write(res.content)
-            self.logger.info(f"[*] writing frida-server to {path}")
+            if self.verbose:
+                self.logger.info(f"[*] writing frida-server to {path}")
 
         return path+"/frida-server"
 
 
 
     def extract_frida_server_comp(self, file_path):
-        self.logger.info(f"[*] extracting {file_path} ...")
+        if self.verbose:
+            self.logger.info(f"[*] extracting {file_path} ...")
         # create a subdir for the specified filename
         frida_server_dir = file_path[:-3]
         os.makedirs(frida_server_dir)
@@ -153,19 +205,22 @@ class FridaManager():
 
     def _get_frida_server_donwload_url(self, arch, version):
         frida_download_prefix = "https://github.com/frida/frida/releases"
-        url = "https://api.github.com/repos/frida/frida/releases/"+version
-        try:
-            res = requests.get(url)
-        except requests.exceptions.TooManyRedirects:
-            # invalid version therfore set to latest 
-            url = "https://api.github.com/repos/frida/frida/releases/latest"
-            res = requests(url)
-        except requests.exceptions.RequestException as e:
-            print("[-] error in doing requests: "+e)
-            exit(2)
 
-        frida_server_path = re.findall(r'\/download\/\d+\.\d+\.\d+\/frida\-server\-\d+\.\d+\.\d+\-android\-'+arch+'\.xz',res.text)
-        final_url = frida_download_prefix + frida_server_path[0]
+        if version is "latest":
+            url = "https://api.github.com/repos/frida/frida/releases/"+version
+        
+            try:
+                res = requests.get(url)
+            except requests.exceptions.RequestException as e:
+                print("[-] error in doing requests: "+e)
+                exit(2)
+
+            frida_server_path = re.findall(r'\/download\/\d+\.\d+\.\d+\/frida\-server\-\d+\.\d+\.\d+\-android\-'+arch+'\.xz',res.text)
+            final_url = frida_download_prefix + frida_server_path[0]
+
+        else:
+            final_url = "https://github.com/frida/frida/releases/download/"+ version +"/frida-server-"+version+"-android-"+arch+".xz"
+
 
         if self.verbose:
             print(f"[*] frida-server download url: {final_url}")
@@ -242,10 +297,39 @@ class FridaManager():
         if self._adb_does_file_exist(path):
             output = self.run_adb_command_as_root("rm "+path)
 
-# only there in order to do some tests will be removed soon
-#if __name__ == "__main__":
-#    afm_obj = FridaManager()
-#    afm_obj.install_frida_server()
-#    result = afm_obj.is_frida_server_running()
-#    print(result)
+
+
+if __name__ == "__main__":
+    if len(sys.argv) > 1:
+        parser = argparse.ArgumentParser(description='FridaManager initialization parameters.')
+        
+        parser.add_argument('--is_remote', type=lambda x: (str(x).lower() == 'true'), default=False, help='Whether to use Frida in remote mode. Default is False.')
+        parser.add_argument('--socket', type=str, default="", help='Socket to use for the connection. Expected in the format <ip:port>.')
+        parser.add_argument('--verbose', action='store_true', default=False, help='Enable verbose output. Default is False.')
+        parser.add_argument('--frida_install_dst', type=str, default="/data/local/tmp/", help='Frida installation destination. Default is "/data/local/tmp/".')
+        parser.add_argument('-r','--is_running', type=bool, default=False, help='Checks only if frida-server is running on the Android device or not.')
+
+        args = parser.parse_args()
+
+        if args.is_running:
+            afm_obj = FridaManager()
+            if afm_obj.is_frida_server_running():
+                print("[*] frida-server is running on Android device")
+            else:
+                print("[*] frida-server is not running on Android device")
+
+            sys.exit()
+
+
+
+        afm_obj = FridaManager(args.is_remote, args.socket, args.verbose, args.frida_install_dst)
+    else:
+        afm_obj = FridaManager()
+
+    afm_obj.install_frida_server()
+    result = afm_obj.is_frida_server_running()
+    if result:
+        print("[*] succesfull installed and launched latest frida-server version on Android device")
+    else:
+        print("[-] unable to run frida-server on Android device")
 

{AndroidFridaManager-0.4 → AndroidFridaManager-0.8}/AndroidFridaManager.egg-info/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: AndroidFridaManager
-Version: 0.4
+Version: 0.8
 Summary: A python API in order to install and run the frida-server on an Android device.
 Home-page: https://github.com/fkie-cad/AndroidFridaManager
+Author: Daniel Baier
 Author-email: daniel.baier@fkie.fraunhofer.de
 License: GPL v3
 Keywords: mobile,instrumentation,frida,hook,android
@@ -28,20 +29,39 @@ Just install it via pip:
 pip install AndroidFridaManager
 ```
 
+This will install the `afrim`-command to your system.
+
 ## Usage
 
+In order to easily install the latest frida-server version to your Android device just run the following command:
+
+```bash
+$ afrim 
+```
+
+
+In order to check only if frida-server is running invoke it with the `-r`-parameter:
+
+```bash
+$ afrim -r
+```
+
+
+## API Usage
+
 ```python
 from AndroidFridaManager import FridaManager
-
+...
 afm_obj = FridaManager(is_remote=False, socket="ip:port", verbose=False, frida_install_dst="/data/local/tmp/")
 afm_obj.install_frida_server()
 afm_obj.run_frida_server()
 ```
 
+
 ## API
 
 ```python
-install_frida_server(version="latest")
+install_frida_server(dst_dir="/data/local/tmp/", version="latest")
 run_frida_server()
 is_frida_server_running()
 stop_frida_server()

{AndroidFridaManager-0.4 → AndroidFridaManager-0.8}/AndroidFridaManager.egg-info/SOURCES.txt

@@ -6,5 +6,6 @@ AndroidFridaManager/__init__.py
 AndroidFridaManager.egg-info/PKG-INFO
 AndroidFridaManager.egg-info/SOURCES.txt
 AndroidFridaManager.egg-info/dependency_links.txt
+AndroidFridaManager.egg-info/entry_points.txt
 AndroidFridaManager.egg-info/requires.txt
 AndroidFridaManager.egg-info/top_level.txt

AndroidFridaManager-0.8/AndroidFridaManager.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+afrim = AndroidFridaManager.FridaManger:main

{AndroidFridaManager-0.4 → AndroidFridaManager-0.8}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: AndroidFridaManager
-Version: 0.4
+Version: 0.8
 Summary: A python API in order to install and run the frida-server on an Android device.
 Home-page: https://github.com/fkie-cad/AndroidFridaManager
+Author: Daniel Baier
 Author-email: daniel.baier@fkie.fraunhofer.de
 License: GPL v3
 Keywords: mobile,instrumentation,frida,hook,android
@@ -28,20 +29,39 @@ Just install it via pip:
 pip install AndroidFridaManager
 ```
 
+This will install the `afrim`-command to your system.
+
 ## Usage
 
+In order to easily install the latest frida-server version to your Android device just run the following command:
+
+```bash
+$ afrim 
+```
+
+
+In order to check only if frida-server is running invoke it with the `-r`-parameter:
+
+```bash
+$ afrim -r
+```
+
+
+## API Usage
+
 ```python
 from AndroidFridaManager import FridaManager
-
+...
 afm_obj = FridaManager(is_remote=False, socket="ip:port", verbose=False, frida_install_dst="/data/local/tmp/")
 afm_obj.install_frida_server()
 afm_obj.run_frida_server()
 ```
 
+
 ## API
 
 ```python
-install_frida_server(version="latest")
+install_frida_server(dst_dir="/data/local/tmp/", version="latest")
 run_frida_server()
 is_frida_server_running()
 stop_frida_server()

{AndroidFridaManager-0.4 → AndroidFridaManager-0.8}/README.md

@@ -9,20 +9,39 @@ Just install it via pip:
 pip install AndroidFridaManager
 ```
 
+This will install the `afrim`-command to your system.
+
 ## Usage
 
+In order to easily install the latest frida-server version to your Android device just run the following command:
+
+```bash
+$ afrim 
+```
+
+
+In order to check only if frida-server is running invoke it with the `-r`-parameter:
+
+```bash
+$ afrim -r
+```
+
+
+## API Usage
+
 ```python
 from AndroidFridaManager import FridaManager
-
+...
 afm_obj = FridaManager(is_remote=False, socket="ip:port", verbose=False, frida_install_dst="/data/local/tmp/")
 afm_obj.install_frida_server()
 afm_obj.run_frida_server()
 ```
 
+
 ## API
 
 ```python
-install_frida_server(version="latest")
+install_frida_server(dst_dir="/data/local/tmp/", version="latest")
 run_frida_server()
 is_frida_server_running()
 stop_frida_server()

{AndroidFridaManager-0.4 → AndroidFridaManager-0.8}/setup.py

@@ -2,7 +2,7 @@ import os
 from setuptools import setup, find_packages
 from os.path import abspath, dirname, join
 
-__version__ = 0.4
+__version__ = "0.8"
 __author__ = "Daniel Baier"
 
 # Fetches the content from README.md
@@ -37,7 +37,7 @@ setup(
 
     url="https://github.com/fkie-cad/AndroidFridaManager",
 
-    author_name=__author__,
+    author=__author__,
     author_email="daniel.baier@fkie.fraunhofer.de",
     license='GPL v3',
 
@@ -69,9 +69,9 @@ setup(
     # This field is OPTIONAL
     keywords=["mobile", "instrumentation", "frida", "hook", "android"],
 
-    #entry_points={
-    #        'console_scripts': [
-    #        'ammm=ammm:main',
-    #    ],
-    #},
+    entry_points={
+            'console_scripts': [
+                'afrim=AndroidFridaManager.FridaManger:main',
+        ],
+    },
 )