devel doc update

CHANGELOG.adoc

@@ -34,7 +34,7 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * Minor CLI improvements
 * Improved type hints
 * Updated instructions to extract the RDP certificate and private key ({uri-issue}345[#345])
-* Documentation updates ({uri-issue}335[#335], {uri-issue}339[#339], {uri-issue}340[#340], {uri-issue}360[#360], {uri-issue}371[#371], {uri-issue}381[#381], {uri-issue}383[#383], {uri-issue}384[#384], {uri-issue}408[#408])
+* Documentation updates ({uri-issue}335[#335], {uri-issue}339[#339], {uri-issue}340[#340], {uri-issue}360[#360], {uri-issue}371[#371], {uri-issue}381[#381], {uri-issue}383[#383], {uri-issue}384[#384], {uri-issue}408[#408], {uri-issue}420[#420])
 * Replaced unmaintained dependency notify2 with py-notifier ({uri-issue}363[#363], {uri-issue}365[#365])
 * Some Python 3.10 compatibility work ({uri-issue}366[#366], {uri-issue}380[#380])
 * Enable play/pause replay on the Player by pressing the Space key ({uri-issue}403[#403]).

bin/pyrdp-mitm.py

@@ -2,23 +2,23 @@
 
 #
 # This file is part of the PyRDP project.
-# Copyright (C) 2018-2021 GoSecure Inc.
+# Copyright (C) 2018-2022 GoSecure Inc.
 # Licensed under the GPLv3 or later.
 #
+# Need to install this reactor before importing any other code
 import asyncio
+from twisted.internet import asyncioreactor
+asyncioreactor.install(asyncio.new_event_loop())
+
 import logging
 import os
+import socket
 
-# Need to install this reactor before importing other twisted code
-from twisted.internet import asyncioreactor
-
-asyncioreactor.install(asyncio.get_event_loop())
 from twisted.internet import reactor
 
 from pyrdp.core.mitm import MITMServerFactory
 from pyrdp.mitm.cli import showConfiguration, configure
 from pyrdp.logging import LOGGER_NAMES
-import socket
 
 
 def main():

docs/debugging-recipes.adoc

@@ -112,4 +112,10 @@ Moving `~/.wireshark/` was enough.
 
 Extracting a single VirtualChannel (id 1004 for DeviceRedirection) raw bytes:
 
-    -d tls.port==13389,tpkt -T fields -e rdp.virtualChannelData -2 "t124.channelId == 1004"
+    -d tls.port==13389,tpkt -T fields -e rdp.virtualChannelData -2 "t124.channelId == 1004"
+
+
+== AsyncIO Debugging
+
+asyncio code is harder to debug.
+When you think the bug is related to asyncio, like strange hangs, you can see some strategies here: https://docs.python.org/3/library/asyncio-dev.html

pyrdp/mitm/DeviceRedirectionMITM.py

@@ -44,10 +44,7 @@ def onDirectoryListingComplete(self, deviceID: int, requestID: int):
 class DeviceRedirectionMITM(Subject):
     """
     MITM component for the device redirection channel.
-    It saves files transferred over RDP to a local directory. The files aren't named after their remote name to avoid
-    conflicts. Rather, they are given a random name, and the mapping to their remote path is given by the mapping.json
-    file. Each unique file (identified by its hash) is saved only once. Duplicates are removed to avoid filling the drive
-    with identical files.
+    It saves files transferred over RDP to a local directory.
     """
 
     FORGED_COMPLETION_ID = 1000000