diff options
author | Maximilian Hils <git@maximilianhils.com> | 2015-09-04 16:17:55 +0200 |
---|---|---|
committer | Maximilian Hils <git@maximilianhils.com> | 2015-09-04 16:17:55 +0200 |
commit | 74b3b842fefec6a05d17bbdf365cd92c82fd3503 (patch) | |
tree | 38f082ca369ae8d237dc4fe41971a1dcd1edf820 /docs/scripting/libmproxy.rst | |
parent | e88c7e4c58a862d6a222d1f8d4638102228b929e (diff) | |
download | mitmproxy-74b3b842fefec6a05d17bbdf365cd92c82fd3503.tar.gz mitmproxy-74b3b842fefec6a05d17bbdf365cd92c82fd3503.tar.bz2 mitmproxy-74b3b842fefec6a05d17bbdf365cd92c82fd3503.zip |
rewrite basic docs for readthedocs
Diffstat (limited to 'docs/scripting/libmproxy.rst')
-rw-r--r-- | docs/scripting/libmproxy.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/scripting/libmproxy.rst b/docs/scripting/libmproxy.rst new file mode 100644 index 00000000..e263b89b --- /dev/null +++ b/docs/scripting/libmproxy.rst @@ -0,0 +1,27 @@ +.. _libmproxy: + +libmproxy +========= + +.. note:: + + We strongly encourage you to use :ref:`inline-scripts` rather than libmproxy. + - Inline Scripts are equally powerful and provide an easier syntax. + - Most examples are written as inline scripts. + - Multiple inline scripts can be used together. + - Inline Scripts can either be executed headless with mitmdump or within the mitmproxy UI. + + +All of mitmproxy's basic functionality is exposed through the **libmproxy** +library. The example below shows a simple implementation of the "sticky cookie" +functionality included in the interactive mitmproxy program. Traffic is +monitored for ``Cookie`` and ``Set-Cookie`` headers, and requests are rewritten +to include a previously seen cookie if they don't already have one. In effect, +this lets you log in to a site using your browser, and then make subsequent +requests using a tool like curl, which will then seem to be part of the +authenticated session. + + +.. literalinclude:: ../../examples/stickycookies + :caption: examples/stickycookies + :language: python |