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

misc/plist_sniffer.py

@@ -7,8 +7,8 @@ import click
 from scapy.packet import Packet, Raw
 from scapy.sendrecv import sniff
 
-BPLIST_MAGIC = b'bplist'
-PLIST_MAGIC = b'<plist'
+BPLIST_MAGIC = b"bplist"
+PLIST_MAGIC = b"<plist"
 
 
 class PcapSniffer:
@@ -20,13 +20,13 @@ class PcapSniffer:
 
         if BPLIST_MAGIC in packet:
             try:
-                plist = plistlib.loads(packet[packet.find(BPLIST_MAGIC):])
+                plist = plistlib.loads(packet[packet.find(BPLIST_MAGIC) :])
                 self.report(plist)
             except plistlib.InvalidFileException:
                 pass
         if PLIST_MAGIC in packet:
             try:
-                plist = plistlib.loads(packet[packet.find(PLIST_MAGIC):])
+                plist = plistlib.loads(packet[packet.find(PLIST_MAGIC) :])
                 self.report(plist)
             except xml.parsers.expat.ExpatError:
                 pass
@@ -35,37 +35,37 @@ class PcapSniffer:
         try:
             print(plist)
             if self.file is not None:
-                self.file.write('---\n')
+                self.file.write("---\n")
                 self.file.write(pprint.pformat(plist))
-                self.file.write('\n---\n')
+                self.file.write("\n---\n")
         except ValueError:
-            print('failed to print plist')
+            print("failed to print plist")
 
 
 @click.group()
 def cli():
-    """ Parse RemoteXPC traffic """
+    """Parse RemoteXPC traffic"""
     pass
 
 
 @cli.command()
-@click.argument('pcap', type=click.Path(exists=True, file_okay=True, dir_okay=False))
-@click.option('-o', '--out', type=click.File('wt'))
+@click.argument("pcap", type=click.Path(exists=True, file_okay=True, dir_okay=False))
+@click.option("-o", "--out", type=click.File("wt"))
 def offline(pcap: str, out: IO):
-    """ Parse plists traffic from a .pcap file """
+    """Parse plists traffic from a .pcap file"""
     sniffer = PcapSniffer(out)
     for p in sniff(offline=pcap):
         sniffer.process_packet(p)
 
 
 @cli.command()
-@click.argument('iface')
-@click.option('-o', '--out', type=click.File('wt'))
+@click.argument("iface")
+@click.option("-o", "--out", type=click.File("wt"))
 def live(iface: str, out: IO):
-    """ Parse plists live from a given network interface """
+    """Parse plists live from a given network interface"""
     sniffer = PcapSniffer(out)
     sniff(iface=iface, prn=sniffer.process_packet)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     cli()

misc/remotexpc_sniffer.py

@@ -22,7 +22,7 @@ FRAME_HEADER_SIZE = 9
 
 
 def create_stream_key(src: str, sport: int, dst: str, dport: int) -> str:
-    return f'{src}/{sport}//{dst}/{dport}'
+    return f"{src}/{sport}//{dst}/{dport}"
 
 
 class TCPStream:
@@ -37,7 +37,7 @@ class TCPStream:
         self.segments = {}  # data segments to add later
 
     def __repr__(self) -> str:
-        return f'Stream<{self.key}>'
+        return f"Stream<{self.key}>"
 
     def __len__(self) -> int:
         return len(self.data)
@@ -58,12 +58,12 @@ class TCPStream:
             return False
         else:
             # if this data is in order (has a place to be inserted)
-            self.data[seq_offset:seq_offset + data_len] = data
+            self.data[seq_offset : seq_offset + data_len] = data
             # check if there are any waiting data segments to add
             for seq_offset in sorted(self.segments.keys()):
                 if seq_offset <= len(self.data):  # if we can add this segment to the stream
                     segment_payload = self.segments[seq_offset]
-                    self.data[seq_offset:seq_offset + len(segment_payload)] = segment_payload
+                    self.data[seq_offset : seq_offset + len(segment_payload)] = segment_payload
                     self.segments.pop(seq_offset)
                 else:
                     break  # short circuit because list is sorted
@@ -72,12 +72,12 @@ class TCPStream:
 
 class H2Stream(TCPStream):
     def pop_frames(self) -> list[Frame]:
-        """ Pop all available H2Frames """
+        """Pop all available H2Frames"""
 
         # If self.data starts with the http/2 magic bytes, pop them off
         if self.data.startswith(HTTP2_MAGIC):
-            logger.debug('HTTP/2 magic bytes')
-            self.data = self.data[len(HTTP2_MAGIC):]
+            logger.debug("HTTP/2 magic bytes")
+            self.data = self.data[len(HTTP2_MAGIC) :]
             self.seq += len(HTTP2_MAGIC)
 
         frames = []
@@ -120,13 +120,14 @@ class RemoteXPCSniffer:
         tcp_pkt = pkt[TCP]
         stream_key = create_stream_key(net_pkt.src, tcp_pkt.sport, net_pkt.dst, tcp_pkt.dport)
         stream = self._h2_streams.setdefault(
-            stream_key, H2Stream(net_pkt.src, tcp_pkt.sport, net_pkt.dst, tcp_pkt.dport))
+            stream_key, H2Stream(net_pkt.src, tcp_pkt.sport, net_pkt.dst, tcp_pkt.dport)
+        )
         stream_finished_assembling = stream.add(tcp_pkt)
         if stream_finished_assembling:  # if we just added something in order
             self._process_stream(stream)
 
     def _handle_data_frame(self, stream: H2Stream, frame: DataFrame) -> None:
-        previous_frame_data = self._previous_frame_data.get(stream.key, b'')
+        previous_frame_data = self._previous_frame_data.get(stream.key, b"")
         try:
             payload = XpcWrapper.parse(previous_frame_data + frame.data).message.payload
             if payload is None:
@@ -134,10 +135,11 @@ class RemoteXPCSniffer:
             xpc_message = decode_xpc_object(payload.obj)
         except ConstError:  # if we don't know what this payload is
             logger.debug(
-                f'New Data frame {stream.src}->{stream.dst} on HTTP/2 stream {frame.stream_id} TCP port {stream.dport}')
+                f"New Data frame {stream.src}->{stream.dst} on HTTP/2 stream {frame.stream_id} TCP port {stream.dport}"
+            )
             hexdump(frame.data[:64])
             if len(frame.data) > 64:
-                logger.debug(f'... {len(frame.data)} bytes')
+                logger.debug(f"... {len(frame.data)} bytes")
             return
         except StreamError:
             self._previous_frame_data[stream.key] = previous_frame_data + frame.data
@@ -149,27 +151,26 @@ class RemoteXPCSniffer:
         if xpc_message is None:
             return
 
-        logger.info(f'As Python Object (#{frame.stream_id}): {pformat(xpc_message)}')
+        logger.info(f"As Python Object (#{frame.stream_id}): {pformat(xpc_message)}")
 
         # print `pairingData` if exists, since it contains an inner struct
-        if 'value' not in xpc_message:
+        if "value" not in xpc_message:
             return
-        message = xpc_message['value']['message']
-        if 'plain' not in message:
+        message = xpc_message["value"]["message"]
+        if "plain" not in message:
             return
-        plain = message['plain']['_0']
-        if 'event' not in plain:
+        plain = message["plain"]["_0"]
+        if "event" not in plain:
             return
-        pairing_data = plain['event']['_0']['pairingData']['_0']['data']
+        pairing_data = plain["event"]["_0"]["pairingData"]["_0"]["data"]
         logger.info(PairingDataComponentTLVBuf.parse(pairing_data))
 
     def _handle_single_frame(self, stream: H2Stream, frame: Frame) -> None:
-        logger.debug(f'New HTTP/2 frame: {stream.key} ({frame})')
+        logger.debug(f"New HTTP/2 frame: {stream.key} ({frame})")
         if isinstance(frame, HeadersFrame):
-            logger.debug(
-                f'{stream.src} opening stream {frame.stream_id} for communication on port {stream.dport}')
+            logger.debug(f"{stream.src} opening stream {frame.stream_id} for communication on port {stream.dport}")
         elif isinstance(frame, GoAwayFrame):
-            logger.debug(f'{stream.src} closing stream {frame.stream_id} on port {stream.sport}')
+            logger.debug(f"{stream.src} closing stream {frame.stream_id} on port {stream.sport}")
         elif isinstance(frame, DataFrame):
             self._handle_data_frame(stream, frame)
 
@@ -180,27 +181,27 @@ class RemoteXPCSniffer:
 
 @click.group()
 def cli():
-    """ Parse RemoteXPC traffic """
+    """Parse RemoteXPC traffic"""
     pass
 
 
 @cli.command()
-@click.argument('file', type=click.Path(exists=True, file_okay=True, dir_okay=False))
+@click.argument("file", type=click.Path(exists=True, file_okay=True, dir_okay=False))
 def offline(file: str):
-    """ Parse RemoteXPC traffic from a .pcap file """
+    """Parse RemoteXPC traffic from a .pcap file"""
     sniffer = RemoteXPCSniffer()
     for p in sniff(offline=file):
         sniffer.process_packet(p)
 
 
 @cli.command()
-@click.argument('iface')
+@click.argument("iface")
 def live(iface: str):
-    """ Parse RemoteXPC live from a given network interface """
+    """Parse RemoteXPC live from a given network interface"""
     sniffer = RemoteXPCSniffer()
     sniff(iface=iface, prn=sniffer.process_packet)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     coloredlogs.install(level=logging.DEBUG)
     cli()

misc/understanding_idevice_protocol_layers.md

@@ -121,10 +121,10 @@ this feature over USB:
 
 ```shell
 # Turn it on
-pymobiledevice3 lockdown wifi-connection on
+pymobiledevice3 lockdown wifi-connections on
 
 # Or off
-pymobiledevice3 lockdown wifi-connection off
+pymobiledevice3 lockdown wifi-connections off
 ```
 
 Now the device will use the [bonjour](https://en.wikipedia.org/wiki/Bonjour_(software)) protocol in order to announce
@@ -197,7 +197,7 @@ from pymobiledevice3.lockdown import create_using_usbmux
 lockdown = create_using_usbmux()
 
 # Get a handle to the service
-service = lockdown.start_lockdown_service(SERIVCE_NAME)
+service = lockdown.start_lockdown_service(SERVICE_NAME)
 
 # Attempt to send and receive messages from it
 service.sendall(b'hello')
@@ -287,14 +287,14 @@ pymobiledevice3 developer dvt launch com.apple.mobilesafari
 
 ## DVT
 
-One of the more interesting developer services, is the one exposed by `DTServiceHub`. It is using DTX protocol messages,
+One of the more interesting developer services is the one exposed by `DTServiceHub`. It is using DTX protocol messages,
 but since it mainly wraps and allows access to stuff in `DVTFoundation.framework` we called it DVT in our
 implementation (probably standing for DeveloperTools).
 
 We don't delve too much into this protocol, but we'll say in general it allows us to invoke a whitelist of ObjC methods
 in different ObjC objects. The terminology used by DVT to each such ObjC object is called "channels".
 
-In order to access this different object use the following APIs:
+To access this different object use the following APIs:
 
 ```python
 from pymobiledevice3.lockdown import create_using_usbmux
@@ -313,17 +313,22 @@ dvt_channel = Screenshot(dvt)
 open('/tmp/screen.png', 'wb').write(dvt_channel.get_screenshot())
 ```
 
-Looking for an unimplemented feature/channel? Feel free to play with it (and submit a PR afterwards 🙏) using the
+Looking for an unimplemented feature/channel? Feel free to play with it (and submit a PR afterward 🙏) using the
 following shell:
 
 ```shell
 pymobiledevice3 developer dvt shell
 ```
 
+> **NOTE:** The full list of the methods that can be invoked on a DVT channel can be found by looking at all ObjC
+> classes in `DVTInstrumentsFoundation.framework` implementing the `DTXAllowedRPC` protocol.
+> There is an existing [Anubis rule](https://github.com/netanelc305/anubis/blob/9da337178ebd7e9f168e9df2d82b192eba4f1b30/example_rules.yaml#L14-L17)
+> I use to diff new methods against the existing ones.
+
 ## RemoteXPC
 
 Starting at iOS 17.0, Apple made a large refactor in the manner we all interact with the developer services. There can
-be multiple reasons for that decision, but in general this refactor main key points are:
+be multiple reasons for that decision, but in general these refactor main key points are:
 
 - Create a single standard for interacting with the new lockdown services (XPC Messages, Apple's proprietary IPC)
 - Optimize the protocol for large file transfers (such as the dyld_shared_cache)
@@ -347,10 +352,10 @@ Since all this communication is IP-based, but without any additional exported TC
 help us here. Instead, starting at iOS 16.0, when connecting an iDevice, it exports another non-standard USB-Ethernet
 adapter (with IPv6 link-local address), placing us in a subnet with the device's `remoted`.
 
-As we've said this communication is non-standard, and requires either:
+As we've said, this communication is non-standard and requires either:
 
 - macOS Monterey or higher
-- Special driver on your linux/windows machine
+- Special driver on your linux/Windows machine
 
 > **Spoiler Alert:** Apple may have regretted this, since starting at iOS 17.4, they added the `CodeDeviceProxy` - a new
 > lockdown service, allowing us skip all the steps this special driver is required for.
@@ -475,7 +480,7 @@ pymobiledevice3 developer dvt launch com.apple.mobilesafari --tunnel '11223344'
 This is of course also available via a python API:
 
 ```python
-from pymobiledevice3.tunneld import async_get_tunneld_devices
+from pymobiledevice3.tunneld.api import async_get_tunneld_devices
 from pymobiledevice3.services.os_trace import OsTraceService
 
 rsds = await async_get_tunneld_devices()