pymobiledevice3 4.14.6__py3-none-any.whl → 7.0.6__py3-none-any.whl

pymobiledevice3/restore/restore_options.py

@@ -1,119 +1,130 @@
 # extracted from ac2
 import logging
 import uuid
+from typing import Optional
 
 from ipsw_parser.build_identity import BuildIdentity
 
 logger = logging.getLogger(__name__)
 
 SUPPORTED_DATA_TYPES = {
-    'BasebandBootData': False,
-    'BasebandData': False,
-    'BasebandStackData': False,
-    'BasebandUpdaterOutputData': False,
-    'BootabilityBundle': False,
-    'BuildIdentityDict': False,
-    'BuildIdentityDictV2': False,
-    'DataType': False,
-    'DiagData': False,
-    'EANData': False,
-    'FDRMemoryCommit': False,
-    'FDRTrustData': False,
-    'FUDData': False,
-    'FileData': False,
-    'FileDataDone': False,
-    'FirmwareUpdaterData': False,
-    'GrapeFWData': False,
-    'HPMFWData': False,
-    'HostSystemTime': True,
-    'KernelCache': False,
-    'NORData': False,
-    'NitrogenFWData': True,
-    'OpalFWData': False,
-    'OverlayRootDataCount': False,
-    'OverlayRootDataForKey': True,
-    'PeppyFWData': True,
-    'PersonalizedBootObjectV3': False,
-    'PersonalizedData': True,
-    'ProvisioningData': False,
-    'RamdiskFWData': True,
-    'RecoveryOSASRImage': True,
-    'RecoveryOSAppleLogo': True,
-    'RecoveryOSDeviceTree': True,
-    'RecoveryOSFileAssetImage': True,
-    'RecoveryOSIBEC': True,
-    'RecoveryOSIBootFWFilesImages': True,
-    'RecoveryOSImage': True,
-    'RecoveryOSKernelCache': True,
-    'RecoveryOSLocalPolicy': True,
-    'RecoveryOSOverlayRootDataCount': False,
-    'RecoveryOSRootTicketData': True,
-    'RecoveryOSStaticTrustCache': True,
-    'RecoveryOSVersionData': True,
-    'RootData': False,
-    'RootTicket': False,
-    'S3EOverride': False,
-    'SourceBootObjectV3': False,
-    'SourceBootObjectV4': False,
-    'SsoServiceTicket': False,
-    'StockholmPostflight': False,
-    'SystemImageCanonicalMetadata': False,
-    'SystemImageData': False,
-    'SystemImageRootHash': False,
-    'USBCFWData': False,
-    'USBCOverride': False,
-    'FirmwareUpdaterPreflight': True,
-    'ReceiptManifest': True,
-    'FirmwareUpdaterDataV2': False,
-    'RestoreLocalPolicy': True,
-    'AuthInstallCACert': True,
-    'OverlayRootDataForKeyIndex': True,
-
+    "BasebandBootData": False,
+    "BasebandData": False,
+    "BasebandStackData": False,
+    "BasebandUpdaterOutputData": False,
+    "BootabilityBundle": False,
+    "BuildIdentityDict": False,
+    "BuildIdentityDictV2": False,
+    "DataType": False,
+    "DiagData": False,
+    "EANData": False,
+    "FDRMemoryCommit": False,
+    "FDRTrustData": False,
+    "FUDData": False,
+    "FileData": False,
+    "FileDataDone": False,
+    "FirmwareUpdaterData": False,
+    "GrapeFWData": False,
+    "HPMFWData": False,
+    "HostSystemTime": True,
+    "KernelCache": False,
+    "NORData": False,
+    "NitrogenFWData": True,
+    "OpalFWData": False,
+    "OverlayRootDataCount": False,
+    "OverlayRootDataForKey": True,
+    "PeppyFWData": True,
+    "PersonalizedBootObjectV3": False,
+    "PersonalizedData": True,
+    "ProvisioningData": False,
+    "RamdiskFWData": True,
+    "RecoveryOSASRImage": True,
+    "RecoveryOSAppleLogo": True,
+    "RecoveryOSDeviceTree": True,
+    "RecoveryOSFileAssetImage": True,
+    "RecoveryOSIBEC": True,
+    "RecoveryOSIBootFWFilesImages": True,
+    "RecoveryOSImage": True,
+    "RecoveryOSKernelCache": True,
+    "RecoveryOSLocalPolicy": True,
+    "RecoveryOSOverlayRootDataCount": False,
+    "RecoveryOSRootTicketData": True,
+    "RecoveryOSStaticTrustCache": True,
+    "RecoveryOSVersionData": True,
+    "RootData": False,
+    "RootTicket": False,
+    "S3EOverride": False,
+    "SourceBootObjectV3": False,
+    "SourceBootObjectV4": False,
+    "SsoServiceTicket": False,
+    "StockholmPostflight": False,
+    "SystemImageCanonicalMetadata": False,
+    "SystemImageData": False,
+    "SystemImageRootHash": False,
+    "USBCFWData": False,
+    "USBCOverride": False,
+    "FirmwareUpdaterPreflight": True,
+    "ReceiptManifest": True,
+    "FirmwareUpdaterDataV2": False,
+    "RestoreLocalPolicy": True,
+    "AuthInstallCACert": True,
+    "OverlayRootDataForKeyIndex": True,
     # Added in iOS 18.0 beta1
-    'FirmwareUpdaterDataV3': True,
-    'MessageUseStreamedImageFile': True,
-    'UpdateVolumeOverlayRootDataCount': True,
-    'URLAsset': True,
+    "FirmwareUpdaterDataV3": True,
+    "MessageUseStreamedImageFile": True,
+    "UpdateVolumeOverlayRootDataCount": True,
+    "URLAsset": True,
 }
 
 # extracted from ac2
 SUPPORTED_MESSAGE_TYPES = {
-    'BBUpdateStatusMsg': False,
-    'CheckpointMsg': True,
-    'DataRequestMsg': False,
-    'FDRSubmit': True,
-    'MsgType': False,
-    'PreviousRestoreLogMsg': False,
-    'ProgressMsg': False,
-    'ProvisioningAck': False,
-    'ProvisioningInfo': False,
-    'ProvisioningStatusMsg': False,
-    'ReceivedFinalStatusMsg': False,
-    'RestoredCrash': True,
-    'StatusMsg': False,
-
+    "BBUpdateStatusMsg": False,
+    "CheckpointMsg": True,
+    "CrashLog": True,
+    "DataRequestMsg": False,
+    "FDRSubmit": True,
+    "MsgType": False,
+    "PreviousRestoreLogMsg": False,
+    "ProgressMsg": False,
+    "ProvisioningAck": False,
+    "ProvisioningInfo": False,
+    "ProvisioningStatusMsg": False,
+    "ReceivedFinalStatusMsg": False,
+    "RestoredCrash": True,
+    "StatusMsg": False,
     # Added in iOS 18.0 beta1
-    'AsyncDataRequestMsg': True,
-    'AsyncWait': True,
-    'RestoreAttestation': True,
+    "AsyncDataRequestMsg": True,
+    "AsyncWait": True,
+    "RestoreAttestation": True,
 }
 
 
 class RestoreOptions:
-
-    def __init__(self, preflight_info=None, sep=None, macos_variant=None, build_identity: BuildIdentity = None,
-                 restore_boot_args=None, spp=None, restore_behavior: str = None, msp=None):
+    def __init__(
+        self,
+        firmware_preflight_info=None,
+        sep=None,
+        macos_variant=None,
+        build_identity: BuildIdentity = None,
+        restore_boot_args=None,
+        spp=None,
+        restore_behavior: Optional[str] = None,
+        msp=None,
+    ):
         self.AutoBootDelay = 0
 
-        if preflight_info is not None:
-            bbus = dict(preflight_info)
-            bbus.pop('FusingStatus')
-            bbus.pop('PkHash')
-            self.BBUpdaterState = bbus
+        try:
+            if firmware_preflight_info is not None:
+                bbus = dict(firmware_preflight_info)
+                bbus.pop("FusingStatus")
+                bbus.pop("PkHash")
+                self.BBUpdaterState = bbus
 
-            nonce = preflight_info.get('Nonce')
-            if nonce is not None:
-                self.BasebandNonce = nonce
+                nonce = firmware_preflight_info.get("Nonce")
+                if nonce is not None:
+                    self.BasebandNonce = nonce
+        except KeyError as e:
+            logger.warning(f"Skipping addition of firmware_preflight_info due to: {e}")
 
         self.SupportedDataTypes = SUPPORTED_DATA_TYPES
         self.SupportedMessageTypes = SUPPORTED_MESSAGE_TYPES
@@ -155,33 +166,33 @@ class RestoreOptions:
             if msp:
                 self.SystemPartitionSize = msp
         else:
-            self.BootImageType = 'UserOrInternal'
-            self.DFUFileType = 'RELEASE'
+            self.BootImageType = "UserOrInternal"
+            self.DFUFileType = "RELEASE"
             self.DataImage = False
-            self.FirmwareDirectory = '.'
+            self.FirmwareDirectory = "."
             self.FlashNOR = True
-            self.KernelCacheType = 'Release'
-            self.NORImageType = 'production'
-            self.RestoreBundlePath = '/tmp/Per2.tmp'
-            self.SystemImageType = 'User'
+            self.KernelCacheType = "Release"
+            self.NORImageType = "production"
+            self.RestoreBundlePath = "/tmp/Per2.tmp"
+            self.SystemImageType = "User"
             self.UpdateBaseband = False
 
             # Added for iOS 18.0 beta1
             self.HostHasFixFor99053849 = True
-            self.SystemImageFormat = 'AEAWrappedDiskImage'
+            self.SystemImageFormat = "AEAWrappedDiskImage"
             self.WaitForDeviceConnectionToFinishStateMachine = False
             self.SupportedAsyncDataTypes = {
-                'BasebandData': False,
-                'RecoveryOSASRImage': False,
-                'StreamedImageDecryptionKey': False,
-                'SystemImageData': False,
-                'URLAsset': True
+                "BasebandData": False,
+                "RecoveryOSASRImage": False,
+                "StreamedImageDecryptionKey": False,
+                "SystemImageData": False,
+                "URLAsset": True,
             }
 
             if sep is not None:
-                required_capacity = sep.get('RequiredCapacity')
+                required_capacity = sep.get("RequiredCapacity")
                 if required_capacity:
-                    logger.debug(f'TZ0RequiredCapacity: {required_capacity}')
+                    logger.debug(f"TZ0RequiredCapacity: {required_capacity}")
                     self.TZ0RequiredCapacity = required_capacity
 
             self.PersonalizedDuringPreflight = True
@@ -197,7 +208,17 @@ class RestoreOptions:
         if spp:
             spp = dict(spp)
         else:
-            spp = {'128': 1280, '16': 160, '32': 320, '64': 640, '8': 80}
+            spp = {
+                "1024": 1280,
+                "128": 1280,
+                "16": 160,
+                "256": 1280,
+                "32": 320,
+                "512": 1280,
+                "64": 640,
+                "768": 1280,
+                "8": 80,
+            }
         self.SystemPartitionPadding = spp
 
     def to_dict(self):

pymobiledevice3/restore/restored_client.py

@@ -1,34 +1,62 @@
 import logging
-from functools import cached_property
 from typing import Any, Optional
 
 from pymobiledevice3 import usbmux
 from pymobiledevice3.exceptions import ConnectionFailedError, NoDeviceConnectedError
+from pymobiledevice3.lockdown import DEFAULT_LABEL
 from pymobiledevice3.restore.restore_options import RestoreOptions
 from pymobiledevice3.service_connection import ServiceConnection
+from pymobiledevice3.usbmux import select_devices_by_connection_type
+
+logger = logging.getLogger(__name__)
 
 
 class RestoredClient:
-    DEFAULT_CLIENT_NAME = 'pyMobileDevice'
+    DEFAULT_CLIENT_NAME = "pymobiledevice3"
     SERVICE_PORT = 62078
 
-    def __init__(self, udid: Optional[str] = None) -> None:
-        self.logger = logging.getLogger(__name__)
+    @classmethod
+    async def create(cls, ecid: str) -> "RestoredClient":
+        for mux_device in select_devices_by_connection_type("USB"):
+            logger.debug(f"Iterating: {mux_device}")
+            service = ServiceConnection.create_using_usbmux(
+                mux_device.serial, cls.SERVICE_PORT, connection_type=mux_device.connection_type
+            )
+            await service.aio_start()
+
+            query_type = await service.aio_send_recv_plist({"Request": "QueryType"})
+            version = query_type.get("RestoreProtocolVersion")
+            logger.debug(f"RestoreProtocolVersion: {version}")
+
+            if query_type.get("Type") != "com.apple.mobile.restored":
+                logger.debug(f"Skipping: {mux_device.serial} as its not a restored device")
+                await service.aio_close()
+                continue
+
+            restored_client = cls(mux_device.serial, version, service)
+            await restored_client._connect()
+
+            if restored_client.ecid != ecid:
+                logger.debug(
+                    f"Skipping: {restored_client.ecid} as its not the right ECID ({restored_client.ecid} "
+                    f"instead of {ecid})"
+                )
+                await service.aio_close()
+                continue
+
+            return restored_client
+        raise NoDeviceConnectedError()
+
+    def __init__(self, udid: str, version: str, service: ServiceConnection) -> None:
         self.udid = udid
-        self.version: Optional[str] = None
-        self.query_type: Optional[str] = None
-        self.label: Optional[str] = None
-        self.service: Optional[ServiceConnection] = None
-
-    async def connect(self, client_name: str = DEFAULT_CLIENT_NAME) -> None:
-        self.service = ServiceConnection.create_using_usbmux(self.udid, self.SERVICE_PORT,
-                                                             connection_type='USB')
-        await self.service.aio_start()
-        self.label = client_name
-        self.query_type = await self.service.aio_send_recv_plist({'Request': 'QueryType'})
-        self.version = self.query_type.get('RestoreProtocolVersion')
+        self.version = version
+        self.service = service
+        self.label = DEFAULT_LABEL
 
-        assert self.query_type.get('Type') == 'com.apple.mobile.restored', f'wrong query type: {self.query_type}'
+    async def _connect(self) -> None:
+        self.hardware_info = (await self.query_value("HardwareInfo"))["HardwareInfo"]
+        self.ecid = self.hardware_info["UniqueChipID"]
+        self.saved_debug_info = (await self.query_value("SavedDebugInfo"))["SavedDebugInfo"]
 
     @staticmethod
     def _get_or_verify_udid(udid: Optional[str] = None) -> str:
@@ -41,36 +69,28 @@ class RestoredClient:
         return device.serial
 
     async def query_value(self, key: Optional[str] = None) -> Any:
-        req = {'Request': 'QueryValue', 'Label': self.label}
+        req = {"Request": "QueryValue", "Label": self.label}
 
         if key:
-            req['QueryKey'] = key
+            req["QueryKey"] = key
 
         return await self.service.aio_send_recv_plist(req)
 
     async def start_restore(self, opts: Optional[RestoreOptions] = None) -> None:
-        req = {'Request': 'StartRestore', 'Label': self.label, 'RestoreProtocolVersion': self.version}
+        req = {"Request": "StartRestore", "Label": self.label, "RestoreProtocolVersion": self.version}
 
         if opts is not None:
-            req['RestoreOptions'] = opts.to_dict()
+            req["RestoreOptions"] = opts.to_dict()
 
-        self.logger.debug(f'start_restore request: {req}')
+        logger.debug(f"start_restore request: {req}")
 
         return await self.service.aio_send_plist(req)
 
     async def reboot(self) -> dict:
-        return await self.service.aio_send_recv_plist({'Request': 'Reboot', 'Label': self.label})
+        return await self.service.aio_send_recv_plist({"Request": "Reboot", "Label": self.label})
 
     async def send(self, message: dict) -> None:
         await self.service.aio_send_plist(message)
 
     async def recv(self) -> dict:
         return await self.service.aio_recv_plist()
-
-    @cached_property
-    async def hardware_info(self) -> dict[str, Any]:
-        return (await self.query_value('HardwareInfo'))['HardwareInfo']
-
-    @property
-    async def saved_debug_info(self) -> dict[str, Any]:
-        return (await self.query_value('SavedDebugInfo'))['SavedDebugInfo']