Initial commit

Author: gitclone-url

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Abhijeet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,21 @@
+# Boot Image Extractor
+
+Boot Image Extractor is a standalone python script designed to extract the boot image from Android devices with root access. It supports both single and dual-slotted devices.
+
+## Prerequisites
+
+- Python 3
+- `pyfiglet` library
+- Root access on the Android device
+
+## Contributing
+
+Contributions to the Boot Image Extractor are welcome. Please feel free to fork the repository, make your changes, and submit a pull request.
+
+## License
+
+This script is released under the [MIT License](LICENSE).
+
+## Support
+
+If you encounter any issues or have questions, please open an issue on the repository's issue tracker.

requirements.txt

@@ -0,0 +1 @@
+pyfiglet

scripts/__init__.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+
+"""A script to extract boot image from either single or dual slotted Android devices with root access."""
+
+import os
+import sys
+import pyfiglet
+import subprocess
+
+def print_banner(name):
+    max_width = os.get_terminal_size().columns
+    banner = pyfiglet.figlet_format(name, font='small', width=max_width)
+    print(banner.center(max_width))
+    
+def exit_with_error(error, reason):
+    print("\nError:", error)
+    print("\nReason:", reason)
+    sys.exit(1)
+      
+def extract_boot_image_dual_slot(boot_a_path, boot_b_path):
+    active_slot = subprocess.getoutput('getprop ro.boot.slot_suffix')
+    print("\nIt is recommended to extract the boot image according to the current active slot, which is ({}).\n".format(active_slot))
+
+    while True:
+        chosen_slot = input("Which boot slot image would you like to extract? (a/b): ").lower()
+        if chosen_slot == 'a':
+            boot_image_path = boot_a_path
+            break
+        elif chosen_slot == 'b':
+            boot_image_path = boot_b_path
+            break
+        else:
+            print("Invalid input. Please choose either 'a' or 'b'.\n")
+            continue
+
+    print("\nExtracting the boot image from {}...".format(boot_image_path))
+    try:
+        subprocess.check_call(['dd', 'if={}'.format(boot_image_path), 'of=./boot{}.img'.format(active_slot)])
+        print("Boot image successfully extracted and saved in your {} directory.".format(os.path.basename(os.getcwd())))
+    except subprocess.CalledProcessError:
+        exit_with_error("Failed to extract the boot image", "dd command failed")
+
+def extract_boot_image_single_slot(boot_path):
+    print("\nExtracting the boot image from {}...".format(boot_path))
+    try:
+        subprocess.check_call(['dd', 'if={}'.format(boot_path), 'of=./boot.img'])
+        print("Boot image successfully extracted and saved in your {} directory.".format(os.path.basename(os.getcwd())))
+    except subprocess.CalledProcessError:
+        exit_with_error("Failed to extract the boot image", "dd command failed")
+
+def main():
+    if os.geteuid() != 0:
+        exit_with_error("Insufficient privileges", "This script requires root access. Please run as root or use sudo.")
+
+    print_banner("Boot Image Extractor")
+
+    boot_names = ['boot', 'boot_a', 'boot_b']
+    for name in boot_names:
+        path = subprocess.getoutput('find /dev/block -type l -name {} -print | head -n 1'.format(name))
+        if path:
+            print("{} = {}".format(name, path))
+            if name == 'boot_a':
+                boot_a_path = path
+            elif name == 'boot_b':
+                boot_b_path = path
+            else:
+                boot_path = path
+
+    if 'boot_a_path' in locals() and 'boot_b_path' in locals():
+        print("\nDevice has dual boot slots.")
+        extract_boot_image_dual_slot(boot_a_path, boot_b_path)
+    elif 'boot_path' in locals():
+        print("\nDevice has a single boot slot.")
+        extract_boot_image_single_slot(boot_path)
+    else:
+        exit_with_error("No boot slots found", "unable to find the symlinked boot slot files")
+
+if __name__ == '__main__':
+    main()

scripts/boot_image_extractor.py

@@ -0,0 +1,17 @@
+# BootImageExtractor Setup File
+# -----------------------------
+# 
+# Install with: pip install .
+#
+# Usage: sudo boot_image_extractor.py or su -c 'boot_image_extractor.py'
+#
+
+from setuptools import setup
+
+setup(
+    name='Boot-Image-Extractor',
+    scripts=['scripts/boot_image_extractor.py'],
+    install_requires=[
+        'pyfiglet',
+    ],
+)

setup.py

@@ -0,0 +1,48 @@
+import unittest
+import os
+import sys
+from unittest.mock import patch, MagicMock
+
+sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+
+class TestBootImageExtractor(unittest.TestCase):
+    """
+    Provides unit tests for the Boot Image Extractor script to ensure its proper functionality
+    in various scenarios. Additional test cases can be added to improve test coverage.
+    """
+    
+    def test_print_banner(self):
+        from scripts.boot_image_extractor import print_banner
+        with patch('builtins.print') as mock_print:
+            print_banner("Test Banner")
+            mock_print.assert_called_once()
+            
+    @patch('builtins.print')
+    @patch('subprocess.getoutput')
+    @patch('os.geteuid', MagicMock(return_value=0))
+    def test_extract_boot_image_single_slot(self, mock_getoutput, mock_print):
+        mock_getoutput.return_value = '/dev/block/boot'
+        with patch('subprocess.check_call', MagicMock()) as mock_check_call:
+            with patch('os.path.basename', MagicMock(return_value='test')):
+                with patch('subprocess.getoutput', MagicMock(return_value='a')):
+                    from scripts.boot_image_extractor import extract_boot_image_single_slot
+                    extract_boot_image_single_slot('boot_path')
+                    mock_check_call.assert_called_with(['dd', 'if=boot_path', 'of=./boot.img'])
+                    
+    @patch('builtins.print')
+    @patch('subprocess.getoutput')
+    @patch('os.geteuid', MagicMock(return_value=0))
+    def test_extract_boot_image_dual_slot(self, mock_getoutput, mock_print):
+        mock_getoutput.side_effect = ['/dev/block/boot_a', '/dev/block/boot_b', 'a']
+        with patch('builtins.input', return_value='a'):
+            with patch('subprocess.check_call', MagicMock()) as mock_check_call:
+                with patch('os.path.basename', MagicMock(return_value='test')):
+                    with patch('subprocess.getoutput', MagicMock(return_value='a')):
+                        from scripts.boot_image_extractor import extract_boot_image_dual_slot
+                        extract_boot_image_dual_slot('boot_a_path', 'boot_b_path')
+                        mock_check_call.assert_called_with(['dd', 'if=boot_a_path', 'of=./boota.img'])
+                        
+
+if __name__ == '__main__':
+    unittest.main()