1
0
mirror of https://github.com/element-hq/element-x-android.git synced 2026-10-23 18:49:00 +03:00
Files
element-x-android/docs/debug_proxying.md
hayaksi1 23a60cf20a Point the proxy debugging doc at the method that builds the clients
The doc told the reader to add disableSslVerification() to
RustMatrixClientFactory.create(), which has not built the client for a long
time; getBaseClientBuilder() is where the chain lives, and it covers both the
login client and the restored session client.

It also only described the emulator's own proxy setting, while the app already
follows the device's global proxy through DefaultProxyProvider, which is the
only way to do this on a physical device.
2026-08-25 15:54:45 +03:00

2.3 KiB

Setup a debug mitm proxy to inspect all the app's network traffic

  1. Install mitmproxy: brew install mitmproxy.
    1. Launch mitmweb from a terminal. It will pop up mitmproxy's web interface in a web browser.
  2. Configure Android Emulator.
    1. Launch your android emulator.
    2. Open its settings page and go to Settings -> Proxy (nb this tab isn't visible when running the emu inside the Android Studio window, you need to set it so it runs in its own window).
    3. Disable "Use Android Studio HTTP proxy settings" and pick "Manual proxy configuration".
    4. Set 127.0.0.1 as "Host name" and 8080 as "Port number".
    5. Click "Apply" and verify that "Proxy status" is "Success" and close the settings window. Screenshot 2023-10-04 at 14 48 47
    6. Alternatively, set the proxy on the device itself, which the app honours through DefaultProxyProvider, and which also works on a physical device:
      adb shell settings put global http_proxy 10.0.2.2:8080
      
      Use adb shell settings delete global http_proxy to remove it afterwards. On a physical device, replace 10.0.2.2 with the address of the machine running mitmproxy.
  3. Install the mitmproxy CA cert (this is needed to see traffic from java/kotlin code, it's not needed for traffic coming from native code e.g. the matrix-rust-sdk).
    1. Open the emulator Chrome browser app
    2. Go to the url mitm.it
    3. Follow the instructions to install the CA cert on Android devices. Screenshot 2023-10-04 at 14 51 27
  4. Slightly modify the Element X app source code.
    1. Go to the RustMatrixClientFactory.getBaseClientBuilder() method, which builds every client the app creates, whether it is logging in or restoring a session.
    2. Add .disableSslVerification() in the ClientBuilder method chain.
  5. Build and run the Element X app.
  6. Enjoy, you will see all the traffic in mitmproxy's web interface. Screenshot 2023-10-04 at 14 50 03