From 74b3b842fefec6a05d17bbdf365cd92c82fd3503 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Fri, 4 Sep 2015 16:17:55 +0200 Subject: rewrite basic docs for readthedocs --- docs/scripting/libmproxy.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/scripting/libmproxy.rst (limited to 'docs/scripting/libmproxy.rst') 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 -- cgit v1.2.3 From b4013659a81a48908eb3e060f04143ba1f9689bb Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 6 Sep 2015 03:20:58 +0200 Subject: docs :tada: --- docs/scripting/libmproxy.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/scripting/libmproxy.rst') diff --git a/docs/scripting/libmproxy.rst b/docs/scripting/libmproxy.rst index e263b89b..92fa5277 100644 --- a/docs/scripting/libmproxy.rst +++ b/docs/scripting/libmproxy.rst @@ -5,7 +5,7 @@ libmproxy .. note:: - We strongly encourage you to use :ref:`inline-scripts` rather than libmproxy. + We strongly encourage you to use :ref:`inlinescripts` 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. -- cgit v1.2.3