Charles

Web Debugging Proxy Application for Windows, Mac OS and Linux

Download

Getting Started

The best way to learn how to use Charles and to learn how it can help you is just to install it and see how it works. If you haven’t already please read the installation guide.

Start Using Charles

Start Charles by running the application from your Start menu, or from your Applications folder, or from wherever you’ve installed it.

If you have Firefox installed you will be asked a question about the Firefox Add-On. This lets you tell Charles whether you’ve installed the Firefox Add-On or not.

On Mac OS X you’ll be asked a question about your Mac OS X Proxy Settings. In order to autoconfigure your proxy settings on Mac OS X you need to grant permission to Charles by entering your password.

You can answer “Not Yet” to these two questions and you’ll have the opportunity later.

First Impressions

The first thing you’ll see is an Untitled Session. If your proxy settings have been autoconfigured you should now be able to use your web browser and observe the events being recorded in Charles.

You’ll see nodes appearing in the tree on the left for each website/host that you visit. Explore the tree. Click on one of the recorded events and you’ll see the details a look at the bodies (probably only on the response tab unless you’re doing POSTs) and you’ll see the data being transmitted.

This is the simplest and most common thing you can do with Charles. It is incredibly powerful as you are now able to see everything that is being transmitted and received – it lets you look underneath the hood at what is actually happening.

Charles is developed by XK72. All content is copyright 2023. Site design by Matthew Buchanan.

Charles: незаменимый тул в арсенале QA-инженера

Для тестирования мобильных приложений, работающих с удаленными серверами, QA-инженеру приходится держать под рукой множество разных тестовых аккаунтов, логов, запросов и ответов. Реальность такова, что не всегда удается договориться о предоставлении нужных тестовых данных в срок. Чаще всего серверные разработчики будут незнакомыми вам людьми по ту сторону Скайпа. В таких ситуациях приходится своими руками подменять ответ сервера перед его передачей в приложение.

Чтобы редактировать выдачу сервера и воспроизводить сложные тестовые сценарии в QA Redmadrobot, мы используем Charles.

Как это работает?

Charles — инструмент для мониторинга HTTP/HTTPS трафика. Программа работает как прокси-сервер между мобильным приложением (в нашем случае) и сервером этого приложения. Charles записывает и сохраняет все запросы, которые проходят через подключенный к нему телефон и позволяет их редактировать.

Инструкция по установке Charles на Mac OS X и подключение телефона.

1. Качаем и устанавливаем.
2. При первом запуске Charles заботливо предложит автоматически настроить параметры сети — соглашаемся.
3. Переходим в Proxy > Proxy Settings и выставляем порт 8888, если он уже не прописан.
4. На телефоне заходим в настройки Wi-Fi и прописываем в прокси сервер IP-адрес вашего Mac и порт 8888.
Телефон должен быть подключен к той же Wi-Fi сети, что и ваш Mac.

Готово. При следующем соединении клиент Charles попросить разрешение подключить ваш телефон. После этого в Charles начинают отображаться все HTTP-запросы и ответы, которые проходят через ваш телефон.

Для мониторинга HTTPS-трафика нужно пройти дополнительные шаги:
5. Переходим в браузер телефона и заходим на www.charlesproxy.com/getssl для установки сертификата SSL, который будет использоваться при подключении. Устанавливаем.
6. В списке хостов выбираем желаемый хост с HTTPS и ставим галочку Enable SSL Proxying.

Готово. Теперь в клиенте Charles отображается HTTPS-трафик по выбранному хосту.

Важно
Если ваше приложение использует SSL pinning, то Charles не сможет перехватывать запросы и ответы.

Мониторинг трафика

Для наглядной демонстрации работы с API используем приложение Хабрахабр для Android. На iPhone стоит защита от программ типа Charles, но на Android её нет.

Charles выстраивает все запросы в порядке их отправки на сервер. Запросы и ответы можно просматривать как в отформатированном, так и в «сыром» виде. В QA Redmadrobot во время тестирования телефон всегда подключен к Charles. Таким образом остается возможность посмотреть историю запросов и отследить хитрые баги.

Подмена данных

Как видите, у меня не так много кармы. Charles поможет сделать вид, что её чуть больше, чем есть на самом деле.

Выдача по аккаунту выглядит так (только JSON-строка, без header’ов):

< "data": < "id": 946584, "login": "yaryabu", "time_registered": "2015-02-27T15:22:52+03:00", "score": 6, "fullname": null, "sex": 0, "rating": 0, "rating_position": 0, "geo": < "country": null, "region": null, "city": null >, "counters": < "posts": 1, "comments": 3, "followed": 0, "followers": 0 >, "badges": [< "alias": "habred", "title": "Захабренный", "plural": "Захабренные", "description": "Пользователь с кармой \u003E0." >], "avatar": "http:\/\/habrahabr.ru\/i\/avatars\/stub-user-middle.gif", "is_readonly": false >, "server_time": "2015-10-16T20:38:02+03:00" > 

В логе есть поле score:

"score": 6 

По всей видимости, как раз то, что мне нужно.

Rewrite settings

Для подмены серверных данных открываем Tools > Rewrite.
В списке слева отображаются сеты из запросов, которые можно составлять на свой вкус. После создания сета идет выставление location. Здесь мы прописываем URL запроса с query параметрами (по желанию).

Следующий шаг — создать правило подмены. К сожалению, Charles не умеет подменять информацию по ключу. Нужно вручную прописывать ключ и значение, а затем писать то, что мы ходим увидеть.

Окно создания правила будет выглядеть следующим образом:

Сам экран подмены будет выглядеть приблизительно так:

Следующий ответ по запросу информации о себе будет иметь отредактированные данные, score = 5000:

< "data": < "id": 946584, "login": "yaryabu", "time_registered": "2015-02-27T15:22:52+03:00", "score": 5000, "fullname": null, "sex": 0, "rating": 0, "rating_position": 0, "geo": < "country": null, "region": null, "city": null >, "counters": < "posts": 1, "comments": 3, "followed": 0, "followers": 0 >, "badges": [< "alias": "habred", "title": "Захабренный", "plural": "Захабренные", "description": "Пользователь с кармой \u003E0." >], "avatar": "http:\/\/habrahabr.ru\/i\/avatars\/stub-user-middle.gif", "is_readonly": false >, "server_time": "2015-10-16T20:58:05+03:00" > 

При следующем переходе на экран профиля в приложении Хабра мы увидим плод своих трудов.

Хочу еще раз напомнить, что информация на сервере остается прежней. Данные изменяются во время путешествия к МП и эти изменения никак не затрагивают реальные данные профиля.

Таким же образом можно подменять не только ответы, но и запросы. Для этого на экране Rewrite rule нужно поставить галочку в поле Request, а не Response.

Breakpoints

При подмене запросов с помощью Rewrite settings в Charles невозможно редактировать кириллицу. При изменении любой информации на кириллицу ваши логи будут состоять из множества вопросительных знаков.

К счастью, этот недостаток можно обойти с помощью другой функции Charles — breakpoints. Идея похожая, но только ответы останавливаются прямо перед передачей в МП, и их можно редактировать своими руками в реальном времени.

Открываем Breakpoints settings и прописываем URL запроса.

При следующем ответе по этому запросу Charles перехватит всю выдачу и позволит нам с ней работать. Следует держать в голове, что МП может выкинуть ошибку по тайм-ауту, и текущий запрос уйдет в никуда.

Заменим мой логин на что-нибудь, написанное на кириллице.

Вот и все. Приложение отображает нужную нам информацию и проблем с кириллицей не возникает.

Самое главное

Лицензионная версия Charles обойдется в $50 на человека. Charles разрешает пользоваться собой бесплатно, но с ограничениями. Функционал инструмента не блокируется, но во время использования триальной версии иногда будут появляться окна с просьбой подождать 5-10 секунд перед возобновлением работы и еще раз подумать о том, как клево было бы купить лицензию. Также каждые 30 минут программа будет автоматически завершаться и вся история запросов будет утрачена.

Итоги

Charles является незаменимым инструментом в арсенале QA-инженеров Redmadrobot. С его помощью можно создавать любые необходимые тестовые данные, как реальные, так и невозможные (если верить API-спецификациям). Такие возможности расширяют границы тестирования черного ящика и позволяют наблюдать все основные взаимодействия вашего МП и его серверов. Тестирование на таком уровне позволяет находить более сложные дефекты и значительно повышает общее качество приложения.

• тестирование мобильных приложений
• redmadrobot
• мобильная разработка
• mobile development
• qa
• quality assurance
• charles
• charlesproxy
• proxy
• web debugger

• Блог компании red_mad_robot
• Разработка мобильных приложений
• Тестирование веб-сервисов
• Тестирование мобильных приложений

Погружение в удивительный мир Charles для чайников

В сегодняшней статье я вам поведаю о том, как пользоваться программой Charles, мощным инструментом для тестирования веб-сервисов, в перечень возможностей которого входит перехватывание запросов, их подмена и перенаправление на локальные файлы.

Charles работает и на мобильных устройствах, но в этой статье мы будем рассматривать только версию для Windows. Давайте же начнем!

Установка Charles

Начать следует, конечно же, с установки. Скачиваем программу с официального сайта разработчика.

Программа платная, но есть тестовый период на 30 дней. Даже без покупки программой можно спокойно пользоваться, но время одной сессии будет ограничено 30 минутами, а также частенько на 5-10 секунд будет появляться оверлей.

Вы можете получить полную версию программы сами-знаете-какими методами, но мы их рассматривать не будем. Все же лучше поддержать разработчиков!

После скачивания следует запустить exe-файл и произвести инсталляцию. Здесь ничего сложного нет, просто оставьте стандартные настройки установки.

Комьюнити теперь в Телеграм
Подпишитесь и будьте в курсе последних IT-новостей

Настройка программы

После установки программу следует настроить. Многие пользователи Charles забывают об этом этапе, а затем кусают локти, пытаясь понять, почему у них ничего не работает. На самом деле настройка программы очень простая, сейчас все покажу!

Для начала нужно установить сертификат программы. Именно из-за него, увы, и возникает большинство проблем, связанных с неработоспособностью программы.

Инструкция по установке сертификата:

Открываем меню установки сертификата через Help -> SSL Proxying -> Install Root Charles Certificate.

Здесь выбираем «Локальный компьютер» и жмем «Далее».

ВАЖНО! На этом этапе выбираем «Поместить все сертификаты в следующее хранилище», жмем «Обзор», затем ОБЯЗАТЕЛЬНО выбираем «Доверенные корневые центры сертификации».

Жмем «Далее».

Затем жмем «Готово».

Установку сертификата мы выполнили, теперь нам необходимо включить SSL Proxying и настроить его фильтрацию, чтобы начать перехватывать запросы. Фильтрация определяет, какие именно запросы нужно ловить, но мы сделаем так, чтобы у нас перехватывались все запросы.

Открываем Proxy -> SSL Proxying Settings.

Ставим галочку на «Enable SSL Proxying», затем под полем «Include» жмем на кнопку «Add».

Для отключения фильтрации и сниффинга всего трафика мы просто добавляем звездочку в поле « Host » .

Программа настроена. Теперь рассмотрим ее возможности и функции.

Compose

Данная функция позволяет нам отправить копию выбранного запроса с измененными параметрами.

Нам достаточно выбрать один конкретный запрос и с помощью функции Compose поменять его параметры (заголовок запроса, тело запроса, куки, код и пр.)
Для начала мы можем отделить конкретные запросы от остальных с помощью функции Focus :

Теперь выбираем нужный нам запрос и выполняем ПКМ -> Compose

У нас создается копия запроса, в которой мы можем менять все, что нам нужно: тело, шапку, тип запроса, версию HTTP и т.д.

Например, можно подменять некоторые значения в коде, чтобы проверить валидацию на бэкенде. Допустим, поле принимает только числовое значение. Мы используем Compose, передавая в значение поле уже буквы. Если запрос пройдет без ошибок, то это значит, что валидация отсутствует.

После изменения нужных нам параметров жмем « Execute » и получаем копию запроса с ответом от сервера.

Breakpoint

Данная функция позволяет точнее работать с запросами, вешая на них так называемый «Breakpoint» (точку остановки).

Ниже показано, как через настройки добавить запрос в список Breakpoint. После повторного получения указанного вами запроса в программе откроется отдельная сессия, в которой вы сможете спокойно работать с ним.

Отмечу, что эта функция, по сути, делает автоматический Compose. Вы так же можете менять значения, но вам не придется каждый раз выбирать конкретный запрос.

Открываем Proxy -> Breakpoint Settings.

Ставим галочку на «Enable Breakpoints», затем жмем «Add».

Заполняем все поля в открывшемся окне (выше пример заполнения).

При повторном получении запроса с такими же данными у вас будет открываться новое окошко, в котором вы сможете работать с пойманным запросом. Удобно!

Rewrite

Если же ваша задача заключается в подмене параметров множества запросов, то вы можете прибегнуть к функции « Rewrite » .

Открываем Tools -> Rewrite.

Заполняем все поля (они идентичны тем, что заполняются при создании Breakpoint).

Затем жмем «Add» уже под правым нижним полем, указываем тип редактирования запроса, заменяемые значения, а также условия замены.

Давайте поймаем запрос и посмотрим на реакцию Charles!

Charles поймал нужный запрос, а затем заменил все Header одним значением.

Repeat Advanced

Данная функция будет полезна для нагрузочного тестирования. Хоть Charles и не блещет особым потенциалом в данной области, но базовую проверку корректности флуд-контроля вы сможете выполнить.

Ниже подробно показано, как это сделать.

ПКМ по запросу -> Repeat Advanced.

Здесь настраиваем все в соответствии с указаниями на приложенной выше картинке.

Должно открыться новое окно, где отправляются запросы.

Map Local

Последняя функция в сегодняшней статье. Позволяет работать с локальными файлами.

Демонстрация инструмента ниже.

ПКМ по запросу -> Map Local.

В открывшемся окне у нас идут знакомые поля. Жмем «Choose» и выбираем локальный файл, после чего жмем « OK » .

При повторном получении того же запроса Charles будет перенаправлять его на локальный файл.

Надеюсь, эта статья помогла вам разобраться в основах Charles. Это действительно мощный и довольно простой инструмент для тестирования. Спасибо за внимание!

При подготовке материала использовались источники:
https://www.charlesproxy.com/documentation/getting-started/
https://habr.com/ru/companies/redmadrobot/articles/269109/
https://timeweb.com/ru/community/articles/pogruzhenie-v-udivitelnyy-mir-charles