Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thyrlian/Charles-Proxy-Mobile-Guide

The mobile hackers' guide to Charles Proxy :thumbsup:
https://github.com/thyrlian/Charles-Proxy-Mobile-Guide

android charles charles-proxy config configuration debug guide ios mobile monitor proxy setup sniffer tutorial

Last synced: 3 months ago
JSON representation

The mobile hackers' guide to Charles Proxy :thumbsup:

Host: GitHub
URL: https://github.com/thyrlian/Charles-Proxy-Mobile-Guide
Owner: thyrlian
Created: 2017-05-15T19:16:41.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-07-07T12:43:00.000Z (over 6 years ago)
Last Synced: 2024-10-27T11:24:10.544Z (3 months ago)
Topics: android, charles, charles-proxy, config, configuration, debug, guide, ios, mobile, monitor, proxy, setup, sniffer, tutorial
Size: 1.13 MB
Stars: 142
Watchers: 5
Forks: 15
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Charles Proxy Mobile Guide
The mobile hackers' guide to Charles Proxy :thumbsup:

## Intro

[Charles](https://www.charlesproxy.com/) is an HTTP proxy / HTTP monitor / Reverse Proxy that enables a developer to view all of the HTTP and SSL / HTTPS traffic between their machine and the Internet. This includes requests, responses and the HTTP headers (which contain the cookies and caching information).

## SSL Proxying

### Computer (macOS)

* **Charles** -> **Proxy** -> **SSL Proxying Settings...** -> **SSL Proxying**
* Check "**Enable SSL Proxying**"
* Add location matcher "**Host: &ast;**", "**Port: &ast;**"

* **Charles** -> **Help** -> **SSL Proxying** -> **Install Charles Root Certificate**
* It would install the certificate to **Keychain**, and open it up automatically
* Double click the certificate in Keychain
* Expand **Trust**, select **Always Trust** for **When using this certificate**

* Get the **IP address** that Charles is listening to
* **Charles** -> **Help** -> **Local IP Address**
* Or get the WLAN IP address via command line (right into your clipboard)
```shell
ifconfig | tr "\n" "→" | tr "\r" "→" | grep -Eo "→en0.*?→en[[:digit:]]" | grep -Eo "inet[[:blank:]+]([0-9]{1,3}\.){3}[0-9]{1,3}" | cut -d' ' -f2 | tr -d "\n" | pbcopy && pbpaste
```
* Or get the LAN IP address via command line (right into your clipboard)
```shell
ifconfig | tr "\n" "→" | tr "\r" "→" | grep -Eo "→en[[:digit:]].*?active→" | grep -v "en0" | grep -Eo "inet[[:blank:]+]([0-9]{1,3}\.){3}[0-9]{1,3}" | cut -d' ' -f2 | tr -d "\n" | pbcopy && pbpaste
```

### Android

* Launch **Charles** and keep it running
* Get the **IP address**
* Make sure the Android device uses the same network as Charles
* On **Android** device
* Go to **Settings** -> **Wi-Fi** -> long click the **network** in use -> **Modify network** -> **Advanced options** -> **Proxy** -> **Manual**
* **Proxy hostname** = **IP address**
* **Proxy port** = **8888**

* Launch **Browser**, visit https://chls.pro/ssl, save the certificate

* The system would ask you to set a lock screen **PIN** or **password**, just set one and save it
* Now the certificate is installed
* Open an application and monitor the traffic on Charles
* A dialog pops up on computer asking "A connection attempt to Charles has been made from the host ...", just click **Allow** button

#### Android N (7.0, API level 24) and afterwards

* Open your Android project with Android Studio
* **Android Studio** -> **File** -> **New** -> **Android resource directory**
* **Directory name** = **xml**
* **Directory type** = **xml**
* **Source set** = **debug**
* **Android Studio** -> **File** -> **New** -> **XML resource file**
* **File name** = **network_security_config**
* **Root element** = **network-security-config**
* Above step would generate a XML file with the given root element. Now paste below content to replace the existing content in the generated XML file.
```xml

```
* Then go to **debug** source set, create a blank **AndroidManifest.xml** file if you don't have one for the debug build variant, and add content like below (eventually the manifest merger will merge it with the main manifest). When you already have one, simply add the `networkSecurityConfig` attribute under `application`.
```xml

```

Now the SSL proxying should work for your app's debug build variant, but not for release build variant.

### iOS

* Launch **Charles** and keep it running
* Get the **IP address**
* Make sure the iOS device uses the same network as Charles
* On **iOS** device
* Go to **Settings** -> **Wi-Fi** -> click the **network** in use -> set **HTTP PROXY** to **Manual**
* **Server** = **IP address**
* **Port** = **8888**

* Launch **Safari**, visit https://chls.pro/ssl (if it doesn't work, try http://www.charlesproxy.com/getssl), install the certificate

* Open an application and monitor the traffic on Charles
* A dialog pops up on computer asking "A connection attempt to Charles has been made from the host ...", just click **Allow** button

#### iOS 10.3 and afterwards

* After the certificate is installed
* Go to **Settings** -> **General** -> **About** -> **Certificate Trust Settings** -> **Enable Full Trust For Root Certificates** -> enable Charles' certificate

### Terminal

In case you need to debug via curl in a terminal:

* To set Charles as the proxy

```shell
export http_proxy=http://127.0.0.1:8888 && export https_proxy=$http_proxy
```

* To remove the proxy

```shell
unset http_proxy https_proxy
```

### SSL CA Certificate

* Charles Proxy running on the same computer provides the same SSL certificate.