pyiosbackup 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

pyiosbackup/__main__.py

@@ -20,6 +20,7 @@ backup_path_argument = click.argument('backup_path', type=click.Path(exists=True
 password_argument = click.argument('password')
 password_option = click.option('-p', '--password', default='')
 target_option = click.option('--target', type=click.Path(), default='.')
+strict_option = click.option('--strict', is_flag=True)
 verbosity = click.option('-v', '--verbosity', count=True, callback=set_verbosity, expose_value=False)
 
 
@@ -34,11 +35,12 @@ def cli():
 @click.argument('relative_path')
 @password_option
 @target_option
+@strict_option
 @verbosity
-def extract_domain_path(backup_path, domain, relative_path, password, target):
+def extract_domain_path(backup_path, domain, relative_path, password, target, strict):
     """ Extract a file from backup, given its domain and relative path."""
     backup = Backup.from_path(backup_path, password)
-    backup.extract_domain_and_path(domain, relative_path, target)
+    backup.extract_domain_and_path(domain, relative_path, target, strict)
 
 
 @cli.command()
@@ -46,33 +48,36 @@ def extract_domain_path(backup_path, domain, relative_path, password, target):
 @click.argument('file_id')
 @password_option
 @target_option
+@strict_option
 @verbosity
-def extract_id(backup_path, file_id, password, target):
+def extract_id(backup_path, file_id, password, target, strict):
     """ Extract a file from backup, given its file ID."""
     backup = Backup.from_path(backup_path, password)
-    backup.extract_file_id(file_id, target)
+    backup.extract_file_id(file_id, target, strict)
 
 
 @cli.command()
 @backup_path_argument
 @password_argument
 @target_option
+@strict_option
 @verbosity
-def extract_all(backup_path, password, target):
+def extract_all(backup_path, password, target, strict):
     """ Decrypt all files in a backup."""
     backup = Backup.from_path(backup_path, password)
-    backup.extract_all(target)
+    backup.extract_all(target, strict)
 
 
 @cli.command()
 @backup_path_argument
 @password_argument
 @target_option
+@strict_option
 @verbosity
-def unback(backup_path, password, target):
+def unback(backup_path, password, target, strict):
     """ Decrypt all files in a backup to a filesystem layout."""
     backup = Backup.from_path(backup_path, password)
-    backup.unback(target)
+    backup.unback(target, strict)
 
 
 @cli.command()

pyiosbackup/backup.py

@@ -6,7 +6,7 @@ from pathlib import Path
 from packaging.version import Version
 
 from pyiosbackup.entry import Entry
-from pyiosbackup.exceptions import BackupPasswordIsRequired
+from pyiosbackup.exceptions import BackupPasswordIsRequired, CorruptedEntryError
 from pyiosbackup.keybag import Keybag
 from pyiosbackup.manifest_dbs.factory import from_path as manifest_db_from_path
 from pyiosbackup.manifest_dbs.manifest_db_interface import ManifestDb
@@ -98,10 +98,11 @@ class Backup:
     def is_encrypted(self) -> bool:
         return self._manifest_plist.is_encrypted
 
-    def unback(self, path='.'):
+    def unback(self, path='.', strict: bool = False):
         """
         Extract all decrypted files from a backup in a filesystem layout
         :param path: Path to destination directory.
+        :param strict: Raise exception on extracting errors.
         """
         logger.info(f'Extracting backup to {path}')
         dest_dir = Path(path)
@@ -110,12 +111,13 @@ class Backup:
             dest_file = dest_dir / file.domain / file.relative_path
             logger.debug(f'Extracting file {file.filename} to {dest_file}')
             dest_file.parent.mkdir(exist_ok=True, parents=True)
-            dest_file.write_bytes(file.read_bytes())
+            self._extract_and_write_entry_content(file, dest_file, strict)
 
-    def extract_all(self, path='.'):
+    def extract_all(self, path='.', strict: bool = False):
         """
         Extract all decrypted files from a backup.
         :param path: Path to destination directory.
+        :param strict: Raise exception on extracting errors.
         """
         logger.info(f'Extracting backup to {path}')
         dest_dir = Path(path)
@@ -130,34 +132,36 @@ class Backup:
             dest_file = dest_dir / file.hash_path
             logger.debug(f'Extracting file {file.filename} to {dest_file}')
             dest_file.parent.mkdir(exist_ok=True, parents=True)
-            dest_file.write_bytes(file.read_bytes())
+            self._extract_and_write_entry_content(file, dest_file, strict)
 
-    def extract_file_id(self, file_id: str, path='.'):
+    def extract_file_id(self, file_id: str, path='.', strict: bool = False):
         """
         Extract a file by its id.
         :param file_id: File ID.
         :param path: Path to destination directory.
+        :param strict: Raise exception on extracting errors.
         """
         entry = self.get_entry_by_id(file_id)
         dest = Path(path)
         if dest.is_dir():
             dest /= entry.name
         dest.parent.mkdir(exist_ok=True, parents=True)
-        dest.write_bytes(entry.read_bytes())
+        self._extract_and_write_entry_content(entry, dest, strict)
 
-    def extract_domain_and_path(self, domain: str, relative_path: str, path='.'):
+    def extract_domain_and_path(self, domain: str, relative_path: str, path='.', strict: bool = False):
         """
         Extract a file by its domain and path.
         :param domain: File's domain, e.g. 'RootDomain'.
         :param relative_path: File's relative path, e.g. 'Library/Preferences/com.apple.backupd.plist'.
         :param path: Path to destination directory.
+        :param strict: Raise exception on extracting errors.
         """
         entry = self.get_entry_by_domain_and_path(domain, relative_path)
         dest = Path(path)
         if dest.is_dir():
             dest /= entry.name
         dest.parent.mkdir(exist_ok=True, parents=True)
-        dest.write_bytes(entry.read_bytes())
+        self._extract_and_write_entry_content(entry, dest, strict)
 
     def get_entry_by_id(self, file_id: str) -> Entry:
         """
@@ -219,3 +223,11 @@ class Backup:
             'size': size,
             'is_encrypted': self._manifest_plist.is_encrypted,
         }
+
+    def _extract_and_write_entry_content(self, entry: Entry, dest: Path, strict: bool):
+        try:
+            dest.write_bytes(entry.read_bytes())
+        except ValueError:
+            logger.warning(f'Could not extract content for {entry.relative_path}')
+            if strict:
+                raise CorruptedEntryError()

pyiosbackup/entry.py

@@ -1,10 +1,10 @@
-from dataclasses import dataclass
-from datetime import datetime
 import pathlib
 import posixpath
+from dataclasses import dataclass
+from datetime import datetime
 
-from packaging.version import Version
 from cryptography.hazmat.primitives import padding
+from packaging.version import Version
 
 FILE_DATA_PAD_BITS = 128  # Files data is 128 bits (16 bytes) padded.
 MODE_TYPE_MASK = 0xE000

pyiosbackup/exceptions.py

@@ -10,3 +10,8 @@ class BackupPasswordIsRequired(PyIosBackupException):
 class MissingEntryError(PyIosBackupException):
     """ Raise when trying to access an entry that doesn't exist. """
     pass
+
+
+class CorruptedEntryError(PyIosBackupException):
+    """ Raise when trying to extract and decrypt an entry fails. """
+    pass

pyiosbackup/keybag.py

@@ -1,11 +1,11 @@
 import hashlib
 import logging
+import math
 
-from construct import Bytes, this, Int32ub, GreedyRange, IfThenElse
-from packaging.version import Version
-from construct import Struct, GreedyBytes, Int32ul
-from cryptography.hazmat.primitives.keywrap import aes_key_unwrap
+from construct import Bytes, GreedyBytes, GreedyRange, IfThenElse, Int32ub, Int32ul, Struct, this
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+from cryptography.hazmat.primitives.keywrap import aes_key_unwrap
+from packaging.version import Version
 
 from pyiosbackup.manifest_plist import ManifestPlist
 
@@ -58,7 +58,8 @@ class Keybag:
         """
         keybag = keybag_struct.parse(manifest.keybag)
         # The class count excludes the root class (first class in the keybag) and is one based.
-        class_count = [e.data for e in keybag if e.tag == b'CLAS'][0] - 1
+        first_class_index = [i for i in range(len(keybag)) if keybag[i].tag == b'CLAS'][0]
+        class_count = math.ceil((len(keybag) - first_class_index) / Keybag.CLASS_ELEMENTS_COUNT)
         logger.debug(f'Found {class_count} key classes')
         classes_index = len(keybag) - (Keybag.CLASS_ELEMENTS_COUNT * class_count)
         decryption_key = Keybag._decryption_key_from_password(password, keybag[:classes_index], manifest)

pyiosbackup/manifest_dbs/factory.py

@@ -3,8 +3,8 @@ from pathlib import Path
 from packaging.version import Version
 
 from pyiosbackup.manifest_dbs.manifest_db_interface import ManifestDb
-from pyiosbackup.manifest_dbs.sqlite3 import ManifestDbSqlite3
 from pyiosbackup.manifest_dbs.mbdb import ManifestDbMbdb
+from pyiosbackup.manifest_dbs.sqlite3 import ManifestDbSqlite3
 
 
 def from_path(backup_path: Path, manifest, keybag) -> ManifestDb:

pyiosbackup/manifest_dbs/mbdb.py

@@ -1,9 +1,9 @@
-from pathlib import Path
-from datetime import timezone, datetime
 import hashlib
+from datetime import datetime, timezone
+from pathlib import Path
 
-from construct import Struct, Const, Bytes, GreedyRange, Int16ub, IfThenElse, Computed, this, \
-    Int32ub, Int64ub, Byte, Array, PaddedString
+from construct import Array, Byte, Bytes, Computed, Const, GreedyRange, IfThenElse, Int16ub, Int32ub, Int64ub, \
+    PaddedString, Struct, this
 
 from pyiosbackup.exceptions import MissingEntryError
 from pyiosbackup.manifest_dbs.manifest_db_interface import ManifestDb

pyiosbackup/manifest_dbs/sqlite3.py

@@ -1,9 +1,9 @@
-from pathlib import Path
-from datetime import datetime, timezone
+import logging
 import sqlite3
 import tempfile
-import logging
 from dataclasses import dataclass
+from datetime import datetime, timezone
+from pathlib import Path
 
 from bpylist2 import archiver
 

pyiosbackup/manifest_plist.py

@@ -1,5 +1,5 @@
-from pathlib import Path
 import plistlib
+from pathlib import Path
 
 from packaging.version import Version
 

{pyiosbackup-0.2.2.dist-info → pyiosbackup-0.2.4.dist-info}/METADATA

@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pyiosbackup
-Version: 0.2.2
+Version: 0.2.4
 Summary: A python parser for iOS backups
 Author-email: Matan Perelman <matan1008@gmail.com>
 Maintainer-email: Matan Perelman <matan1008@gmail.com>
-License: GNU GENERAL PUBLIC LICENSE
+License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
         
          Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
@@ -690,17 +690,21 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: bpylist2 (>=4.0.1)
-Requires-Dist: cryptography (>=35.0.0)
+Requires-Dist: bpylist2>=4.0.1
+Requires-Dist: cryptography>=35.0.0
 Requires-Dist: packaging
 Requires-Dist: construct
 Requires-Dist: click
 Provides-Extra: test
-Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
 
 [![Python application](https://github.com/matan1008/pyiosbackup/workflows/Python%20application/badge.svg)](https://github.com/matan1008/pyiosbackup/actions/workflows/python-app.yml "Python application action")
 [![Pypi version](https://img.shields.io/pypi/v/pyiosbackup.svg)](https://pypi.org/project/pyiosbackup/ "PyPi package")

pyiosbackup-0.2.4.dist-info/RECORD

@@ -0,0 +1,18 @@
+pyiosbackup/__init__.py,sha256=1b_5ZMer7ZuuVI2WC9GCAYWP62DNvE3lh3RWHACoNos,38
+pyiosbackup/__main__.py,sha256=O7LaLls0E88ZxSlc2Gqn0335UnlSQsz8vdmtvE37WcI,2442
+pyiosbackup/backup.py,sha256=RKnWimS-IG8xpeuKA2GtxWCqXRQ2CAgBqHUtViMBXDc,8868
+pyiosbackup/entry.py,sha256=1CR_r24YSoGfYBomKkZZwA4t3tUu7WLNLTQE5q09aVY,4603
+pyiosbackup/exceptions.py,sha256=hXJLD1RToqvmGetHHtpQbKQidkJQx4TOlaSf2im7ers,464
+pyiosbackup/keybag.py,sha256=ER7z_CJGZX-rzzXF_CxcntUxOuBES_pShYqpx9n3djU,4731
+pyiosbackup/manifest_plist.py,sha256=WWozREPN3Vm5xdwY27gqX61Zr5Rg0Jq7QqPQpEUBn_w,942
+pyiosbackup/manifest_dbs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyiosbackup/manifest_dbs/factory.py,sha256=lJNQ_5EiUriObZZn-EXr83k62VHtqHQ4xH3ITs8UX8w,781
+pyiosbackup/manifest_dbs/manifest_db_interface.py,sha256=DNxuShVPSH1l_59IdqibiTv8f4Akz02jiuwMUCtxtro,522
+pyiosbackup/manifest_dbs/mbdb.py,sha256=hqGvuZiYU7sJGEvWpSg6E-K4q6N6H2djTZB4mCqP3hQ,3562
+pyiosbackup/manifest_dbs/sqlite3.py,sha256=YrPnVrld1naIZA2dF40mZsxiDYk08zPa4stmaR-KfTo,3490
+pyiosbackup-0.2.4.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pyiosbackup-0.2.4.dist-info/METADATA,sha256=I3luEmMCZ0bnyHHhD-UW8gEiG0aydyVZaZlDt0Xgsto,44271
+pyiosbackup-0.2.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+pyiosbackup-0.2.4.dist-info/entry_points.txt,sha256=frMMD9_8u6eoiBHBriurbVQtuytO1DX9HUeYA3UDOXU,58
+pyiosbackup-0.2.4.dist-info/top_level.txt,sha256=p19DE7G-wJEY49fcQHMZUFlxc2O4LmWhkDrhZcs3suo,12
+pyiosbackup-0.2.4.dist-info/RECORD,,

{pyiosbackup-0.2.2.dist-info → pyiosbackup-0.2.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyiosbackup-0.2.2.dist-info/RECORD

@@ -1,18 +0,0 @@
-pyiosbackup/__init__.py,sha256=1b_5ZMer7ZuuVI2WC9GCAYWP62DNvE3lh3RWHACoNos,38
-pyiosbackup/__main__.py,sha256=Z3NKaeGUwpsidL7VGtDBsQB-11CVbNHtvrAWDDcZ4kg,2263
-pyiosbackup/backup.py,sha256=CIPh3MnZEWot7Z3EJ7ufWjTKuLv4hqvuZB1BLoTVaoc,8099
-pyiosbackup/entry.py,sha256=aAC6v7s1AUr3ydStLg1ipuoLMD6P_guUJ6vMX32Iaoo,4603
-pyiosbackup/exceptions.py,sha256=nJUEACYezGiS74eIM84U5mb3MR88SmE_83kgGoZgciM,335
-pyiosbackup/keybag.py,sha256=_a1SlqTUlnu8xKMegN9ep0yIG0nt-dwfIaTLx-Q3m1o,4626
-pyiosbackup/manifest_plist.py,sha256=3tu4nGMBTxtfazwK6k6sNVf2mWMTh_-4FVfhbbaoYCQ,942
-pyiosbackup/manifest_dbs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pyiosbackup/manifest_dbs/factory.py,sha256=huaMbi0DQlro-39jGSgo2y25bd8vIPdUQJcU222xpYc,781
-pyiosbackup/manifest_dbs/manifest_db_interface.py,sha256=DNxuShVPSH1l_59IdqibiTv8f4Akz02jiuwMUCtxtro,522
-pyiosbackup/manifest_dbs/mbdb.py,sha256=g9tLb4TLHBgovnSceWki89vKZWFaWLTFNfPGy25f54I,3562
-pyiosbackup/manifest_dbs/sqlite3.py,sha256=l1eGzb7b---CxjrFu-hJB37AWVGqNZCdoCp_qHBCwtg,3490
-pyiosbackup-0.2.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-pyiosbackup-0.2.2.dist-info/METADATA,sha256=hmn-yZ8X5hqd78JxzjPLBtFBP1S6Snmv5UhMvpa_SBA,44083
-pyiosbackup-0.2.2.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-pyiosbackup-0.2.2.dist-info/entry_points.txt,sha256=frMMD9_8u6eoiBHBriurbVQtuytO1DX9HUeYA3UDOXU,58
-pyiosbackup-0.2.2.dist-info/top_level.txt,sha256=p19DE7G-wJEY49fcQHMZUFlxc2O4LmWhkDrhZcs3suo,12
-pyiosbackup-0.2.2.dist-info/RECORD,,