diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml index 54402fcf..4ab93c6b 100644 --- a/.github/workflows/mypy.yml +++ b/.github/workflows/mypy.yml @@ -15,7 +15,7 @@ jobs: - name: Setup Python uses: actions/setup-python@v7 with: - python-version: "3.10" + python-version: "3.11" - name: Install uv uses: astral-sh/setup-uv@v10.0.0 with: diff --git a/.github/workflows/ruff.yml b/.github/workflows/ruff.yml index 08fc2cdd..382818b8 100644 --- a/.github/workflows/ruff.yml +++ b/.github/workflows/ruff.yml @@ -16,7 +16,7 @@ jobs: - name: Setup Python uses: actions/setup-python@v7 with: - python-version: "3.10" + python-version: "3.11" - name: Install uv uses: astral-sh/setup-uv@v10.0.0 with: diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 52a9d9cf..07d6e280 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -16,10 +16,10 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.10', '3.11', '3.12', '3.13', '3.14', '3.15'] + python-version: ['3.11', '3.12', '3.13', '3.14', '3.15'] env: # Takes precedence over .python-version, which otherwise makes `uv run` - # rebuild the venv with 3.10 and test every matrix entry on 3.10. + # rebuild the venv with 3.11 and test every matrix entry on 3.11. UV_PYTHON: ${{ matrix.python-version }} steps: diff --git a/.python-version b/.python-version index c8cfe395..2c073331 100644 --- a/.python-version +++ b/.python-version @@ -1 +1 @@ -3.10 +3.11 diff --git a/docs/favicon.png b/docs/favicon.png new file mode 100644 index 00000000..da45cbe8 Binary files /dev/null and b/docs/favicon.png differ diff --git a/docs/install.md b/docs/install.md index 7c5ee6ee..47a59f68 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,6 +1,6 @@ # Installation -Before proceeding, please note that MVT requires Python 3.10 or newer to run. While it should be available on most operating systems, please make sure of that before proceeding. +Before proceeding, please note that MVT requires Python 3.11 or newer to run. While it should be available on most operating systems, please make sure of that before proceeding. ## Dependencies on Linux diff --git a/mkdocs.yml b/mkdocs.yml index 4cbdb47b..bf0419db 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,8 +18,28 @@ markdown_extensions: use_pygments: true theme: name: material + logo: mvt.png + favicon: favicon.png features: - tabs + palette: + - media: "(prefers-color-scheme)" + primary: black + toggle: + icon: material/link + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: black + toggle: + icon: material/toggle-switch + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: black + toggle: + icon: material/toggle-switch-off + name: Switch to system preference plugins: - search - mkdocstrings diff --git a/pyproject.toml b/pyproject.toml index 4154662b..9de64aed 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,7 +36,7 @@ dependencies = [ "python-dateutil==2.9.0.post0", "tzdata==2026.3", ] -requires-python = ">= 3.10" +requires-python = ">= 3.11" [project.urls] homepage = "https://docs.mvt.re/en/latest/" diff --git a/src/mvt/android/cli.py b/src/mvt/android/cli.py index 4c159857..f8b71083 100644 --- a/src/mvt/android/cli.py +++ b/src/mvt/android/cli.py @@ -160,7 +160,9 @@ def check_adb(ctx): "zone is read from persist.sys.timezone in the bugreport itself." ), ) -@click.option("--verbose", "-v", is_flag=True, help=HELP_MSG_VERBOSE_COMMAND) +@click.option( + "--verbose", "-v", is_flag=True, hidden=True, help=HELP_MSG_VERBOSE_COMMAND +) @click.argument("BUGREPORT_PATH", type=click.Path(exists=True)) @click.pass_context def check_bugreport( @@ -235,7 +237,9 @@ def check_bugreport( ) @click.option("--non-interactive", "-n", is_flag=True, help=HELP_MSG_NONINTERACTIVE) @click.option("--backup-password", "-p", help=HELP_MSG_ANDROID_BACKUP_PASSWORD) -@click.option("--verbose", "-v", is_flag=True, help=HELP_MSG_VERBOSE_COMMAND) +@click.option( + "--verbose", "-v", is_flag=True, hidden=True, help=HELP_MSG_VERBOSE_COMMAND +) @click.argument("BACKUP_PATH", type=click.Path(exists=True)) @click.pass_context def check_backup( @@ -310,7 +314,9 @@ def check_backup( ) @click.option("--non-interactive", "-n", is_flag=True, help=HELP_MSG_NONINTERACTIVE) @click.option("--backup-password", "-p", help=HELP_MSG_ANDROID_BACKUP_PASSWORD) -@click.option("--verbose", "-v", is_flag=True, help=HELP_MSG_VERBOSE_COMMAND) +@click.option( + "--verbose", "-v", is_flag=True, hidden=True, help=HELP_MSG_VERBOSE_COMMAND +) @click.argument("ANDROIDQF_PATH", type=click.Path(exists=True)) @click.pass_context def check_androidqf( @@ -397,7 +403,9 @@ def check_androidqf( "time instead of UTC." ), ) -@click.option("--verbose", "-v", is_flag=True, help=HELP_MSG_VERBOSE_COMMAND) +@click.option( + "--verbose", "-v", is_flag=True, hidden=True, help=HELP_MSG_VERBOSE_COMMAND +) @click.argument("LOGS_PATH", type=click.Path(exists=True)) @click.pass_context def check_intrusion_logs( diff --git a/src/mvt/android/cmd_check_backup.py b/src/mvt/android/cmd_check_backup.py index 066cd8aa..b4878b00 100644 --- a/src/mvt/android/cmd_check_backup.py +++ b/src/mvt/android/cmd_check_backup.py @@ -27,6 +27,8 @@ from .modules.backup import BACKUP_MODULES log = logging.getLogger(__name__) +MAX_BACKUP_PASSWORD_ATTEMPTS = 3 + class InvalidAndroidBackup(Exception): pass @@ -72,6 +74,15 @@ class CmdAndroidCheckBackup(Command): self.__tar: Optional[tarfile.TarFile] = None self.__files: List[str] = [] + def _get_backup_password(self) -> str: + password = prompt_or_load_android_backup_password(log, self.module_options) + if not password: + if self.sub_command: + raise InvalidAndroidBackup("No backup password provided") + log.critical("No backup password provided.") + sys.exit(1) + return password + def from_ab(self, ab_file_bytes: bytes) -> None: self.__type = "ab" header = parse_ab_header(ab_file_bytes) @@ -84,28 +95,40 @@ class CmdAndroidCheckBackup(Command): sys.exit(1) password = None + # A password typed at the prompt is asked for again if it is wrong. + # One given on the command line or in the environment is not. + max_attempts = 1 if header["encryption"] != "none": - password = prompt_or_load_android_backup_password(log, self.module_options) - if not password: + if not self.module_options.get("backup_password", None): + max_attempts = MAX_BACKUP_PASSWORD_ATTEMPTS + password = self._get_backup_password() + attempt = 1 + while True: + try: + tardata = parse_backup_file(ab_file_bytes, password=password) + break + except InvalidBackupPassword: + if attempt < max_attempts: + attempt += 1 + log.error( + "Invalid backup password, try again (attempt %d of %d)", + attempt, + max_attempts, + ) + password = self._get_backup_password() + continue if self.sub_command: - raise InvalidAndroidBackup("No backup password provided") - log.critical("No backup password provided.") + raise InvalidAndroidBackup("Invalid backup password") + log.critical("Invalid backup password") + sys.exit(1) + except AndroidBackupParsingError as exc: + if self.sub_command: + raise InvalidAndroidBackup( + f"Impossible to parse this backup file: {exc}" + ) from exc + log.critical("Impossible to parse this backup file: %s", exc) + log.critical("Please use Android Backup Extractor (ABE) instead") sys.exit(1) - try: - tardata = parse_backup_file(ab_file_bytes, password=password) - except InvalidBackupPassword: - if self.sub_command: - raise InvalidAndroidBackup("Invalid backup password") - log.critical("Invalid backup password") - sys.exit(1) - except AndroidBackupParsingError as exc: - if self.sub_command: - raise InvalidAndroidBackup( - f"Impossible to parse this backup file: {exc}" - ) from exc - log.critical("Impossible to parse this backup file: %s", exc) - log.critical("Please use Android Backup Extractor (ABE) instead") - sys.exit(1) dbytes = io.BytesIO(tardata) try: diff --git a/src/mvt/common/password.py b/src/mvt/common/password.py index b59ae490..128baee3 100644 --- a/src/mvt/common/password.py +++ b/src/mvt/common/password.py @@ -6,7 +6,7 @@ """Password prompts with masked keyboard feedback. This is based on the ``echo_char`` support added to :mod:`getpass` in Python -3.14. MVT supports Python 3.10 and later, so it cannot use that API directly. +3.14. MVT supports Python 3.11 and later, so it cannot use that API directly. """ import contextlib diff --git a/src/mvt/ios/cli.py b/src/mvt/ios/cli.py index f9f58885..b83c4a70 100644 --- a/src/mvt/ios/cli.py +++ b/src/mvt/ios/cli.py @@ -278,7 +278,9 @@ def extract_key(password, key_file, backup_path): help=HELP_MSG_LOAD_MODULE, ) @click.option("--hashes", "-H", is_flag=True, help=HELP_MSG_HASHES) -@click.option("--verbose", "-v", is_flag=True, help=HELP_MSG_VERBOSE_COMMAND) +@click.option( + "--verbose", "-v", is_flag=True, hidden=True, help=HELP_MSG_VERBOSE_COMMAND +) @click.argument("BACKUP_PATH", type=click.Path(exists=True)) @click.pass_context def check_backup( @@ -347,7 +349,9 @@ def check_backup( help=HELP_MSG_LOAD_MODULE, ) @click.option("--hashes", "-H", is_flag=True, help=HELP_MSG_HASHES) -@click.option("--verbose", "-v", is_flag=True, help=HELP_MSG_VERBOSE_COMMAND) +@click.option( + "--verbose", "-v", is_flag=True, hidden=True, help=HELP_MSG_VERBOSE_COMMAND +) @click.argument("DUMP_PATH", type=click.Path(exists=True)) @click.pass_context def check_fs( @@ -416,7 +420,9 @@ def check_fs( help=HELP_MSG_LOAD_MODULE, ) @click.option("--hashes", "-H", is_flag=True, help=HELP_MSG_HASHES) -@click.option("--verbose", "-v", is_flag=True, help=HELP_MSG_VERBOSE_COMMAND) +@click.option( + "--verbose", "-v", is_flag=True, hidden=True, help=HELP_MSG_VERBOSE_COMMAND +) @click.argument("SYSDIAGNOSE_PATH", type=click.Path(exists=True)) @click.pass_context def check_sysdiagnose( diff --git a/src/mvt/ios/data/ios_versions.json b/src/mvt/ios/data/ios_versions.json index 839aa200..23f9b4ba 100644 --- a/src/mvt/ios/data/ios_versions.json +++ b/src/mvt/ios/data/ios_versions.json @@ -1224,6 +1224,10 @@ "version": "18.7.10", "build": "22H374" }, + { + "version": "18.7.11", + "build": "22H384" + }, { "version": "26", "build": "23A341" @@ -1283,5 +1287,13 @@ { "version": "27.0.1", "build": "24A446" + }, + { + "version": "27.2", + "build": "24B91020" + }, + { + "version": "27.2", + "build": "24B119" } ] \ No newline at end of file diff --git a/tests/test_check_android_backup.py b/tests/test_check_android_backup.py index ac0680f0..61ba7a12 100644 --- a/tests/test_check_android_backup.py +++ b/tests/test_check_android_backup.py @@ -59,6 +59,66 @@ class TestCheckAndroidBackupCommand: assert result.exit_code == 1 assert "Invalid backup password" in caplog.text + def test_check_encrypted_backup_prompt_retry(self, mocker): + """A wrong password at the prompt is asked for again""" + prompt_mock = mocker.patch( + "mvt.android.modules.backup.helpers.prompt_password", + side_effect=["wrong_password", TEST_BACKUP_PASSWORD], + ) + runner = CliRunner() + path = os.path.join(get_artifact_folder(), "androidqf_encrypted/backup.ab") + result = runner.invoke(check_backup, [path]) + + assert prompt_mock.call_count == 2 + assert result.exit_code == 0 + + def test_check_encrypted_backup_prompt_gives_up(self, mocker, caplog): + """The prompt gives up after three wrong passwords""" + prompt_mock = mocker.patch( + "mvt.android.modules.backup.helpers.prompt_password", + return_value="wrong_password", + ) + runner = CliRunner() + path = os.path.join(get_artifact_folder(), "androidqf_encrypted/backup.ab") + + with caplog.at_level(logging.CRITICAL): + result = runner.invoke(check_backup, [path]) + + assert prompt_mock.call_count == 3 + assert result.exit_code == 1 + assert "Invalid backup password" in caplog.text + + def test_check_encrypted_backup_prompt_retry_empty(self, mocker, caplog): + """An empty answer on a retry ends the check""" + prompt_mock = mocker.patch( + "mvt.android.modules.backup.helpers.prompt_password", + side_effect=["wrong_password", ""], + ) + runner = CliRunner() + path = os.path.join(get_artifact_folder(), "androidqf_encrypted/backup.ab") + + with caplog.at_level(logging.CRITICAL): + result = runner.invoke(check_backup, [path]) + + assert prompt_mock.call_count == 2 + assert result.exit_code == 1 + assert "No backup password provided" in caplog.text + + def test_check_encrypted_backup_cli_invalid_no_prompt(self, mocker): + """A password given on the command line is not asked for again""" + prompt_mock = mocker.patch( + "mvt.android.modules.backup.helpers.prompt_password", + return_value=TEST_BACKUP_PASSWORD, + ) + runner = CliRunner() + path = os.path.join(get_artifact_folder(), "androidqf_encrypted/backup.ab") + result = runner.invoke( + check_backup, ["--backup-password", "invalid_password", path] + ) + + assert prompt_mock.call_count == 0 + assert result.exit_code == 1 + def test_check_encrypted_backup_env(self, mocker): """Provide password as environment variable""" prompt_mock = mocker.patch( diff --git a/tests/test_cli_verbose.py b/tests/test_cli_verbose.py index d8826ff6..9e4cdc98 100644 --- a/tests/test_cli_verbose.py +++ b/tests/test_cli_verbose.py @@ -100,8 +100,8 @@ class TestVerboseOnTheCheckCommands: assert result.exit_code == 0 assert _console_level() == logging.DEBUG - def test_the_command_option_says_it_is_kept_for_compatibility(self): + def test_the_command_option_is_hidden_from_the_help(self): result = CliRunner().invoke(ios_cli, [*OFFLINE, "check-backup", "--help"]) assert result.exit_code == 0 - assert "kept for compatibility" in result.output + assert "--verbose" not in result.output diff --git a/uv.lock b/uv.lock index 085b1a35..f30a52d5 100644 --- a/uv.lock +++ b/uv.lock @@ -1,6 +1,6 @@ version = 1 revision = 3 -requires-python = ">=3.10" +requires-python = ">=3.11" resolution-markers = [ "python_full_version >= '3.15'", "python_full_version < '3.15'",