mitmproxy/mitmproxy/eventsequence.py

import typing

from mitmproxy import controller
from mitmproxy import flow
from mitmproxy import http
from mitmproxy import tcp
from mitmproxy import websocket

Events = frozenset([
    "clientconnect",
    "clientdisconnect",
    "serverconnect",
    "serverdisconnect",
    # TCP
    "tcp_start",
    "tcp_message",
    "tcp_error",
    "tcp_end",
    # HTTP
    "http_connect",
    "request",
    "requestheaders",
    "response",
    "responseheaders",
    "error",
    # WebSocket
    "websocket_handshake",
    "websocket_start",
    "websocket_message",
    "websocket_error",
    "websocket_end",
    # misc
    "next_layer",
    "configure",
    "done",
    "log",
    "load",
    "running",
    "tick",
    "update",
])

TEventGenerator = typing.Iterator[typing.Tuple[str, typing.Any]]


def _iterate_http(f: http.HTTPFlow) -> TEventGenerator:
    if f.request:
        yield "requestheaders", f
        yield "request", f
    if f.response:
        yield "responseheaders", f
        yield "response", f
    if f.error:
        yield "error", f


def _iterate_websocket(f: websocket.WebSocketFlow) -> TEventGenerator:
    messages = f.messages
    f.messages = []
    f.reply = controller.DummyReply()
    yield "websocket_start", f
    while messages:
        f.messages.append(messages.pop(0))
        yield "websocket_message", f
    if f.error:
        yield "websocket_error", f
    yield "websocket_end", f


def _iterate_tcp(f: tcp.TCPFlow) -> TEventGenerator:
    messages = f.messages
    f.messages = []
    f.reply = controller.DummyReply()
    yield "tcp_start", f
    while messages:
        f.messages.append(messages.pop(0))
        yield "tcp_message", f
    if f.error:
        yield "tcp_error", f
    yield "tcp_end", f


_iterate_map = {
    http.HTTPFlow: _iterate_http,
    websocket.WebSocketFlow: _iterate_websocket,
    tcp.TCPFlow: _iterate_tcp,
}  # type: typing.Dict[typing.Type[flow.Flow], typing.Callable[[typing.Any], TEventGenerator]]


def iterate(f: flow.Flow) -> TEventGenerator:
    try:
        e = _iterate_map[type(f)]
    except KeyError as err:
        raise TypeError("Unknown flow type: {}".format(f)) from err
    else:
        yield from e(f)
make eventsequence.iterate extendable 2017-07-15 10:22:46 +00:00			`import typing`

shorten option help We can have longer versions in the docs, but this makes the options pages quite hard to parse. 2017-07-17 18:47:44 +00:00			`from mitmproxy import controller`
			`from mitmproxy import flow`
update mypy 2017-07-20 14:27:13 +00:00			`from mitmproxy import http`
Move all tools into mitmproxy.tools, move models/* to top level The primary motivation here (and for all the other moving around) is to present a clean "front of house" to library users, and to migrate primary objects to the top of the module hierarchy. 2016-10-19 02:25:39 +00:00			`from mitmproxy import tcp`
add WebSocket flows and messages 2016-11-13 16:50:51 +00:00			`from mitmproxy import websocket`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00
			`Events = frozenset([`
			`"clientconnect",`
			`"clientdisconnect",`
			`"serverconnect",`
			`"serverdisconnect",`
shorten option help We can have longer versions in the docs, but this makes the options pages quite hard to parse. 2017-07-17 18:47:44 +00:00			`# TCP`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`"tcp_start",`
			`"tcp_message",`
			`"tcp_error",`
			`"tcp_end",`
shorten option help We can have longer versions in the docs, but this makes the options pages quite hard to parse. 2017-07-17 18:47:44 +00:00			`# HTTP`
Add the http_connect event for HTTP CONNECT requests 2016-11-11 23:44:43 +00:00			`"http_connect",`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`"request",`
			`"requestheaders",`
			`"response",`
			`"responseheaders",`
			`"error",`
shorten option help We can have longer versions in the docs, but this makes the options pages quite hard to parse. 2017-07-17 18:47:44 +00:00			`# WebSocket`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`"websocket_handshake",`
add WebSocket flows and messages 2016-11-13 16:50:51 +00:00			`"websocket_start",`
			`"websocket_message",`
			`"websocket_error",`
			`"websocket_end",`
shorten option help We can have longer versions in the docs, but this makes the options pages quite hard to parse. 2017-07-17 18:47:44 +00:00			`# misc`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`"next_layer",`
			`"configure",`
			`"done",`
			`"log",`
addons: start -> load throughout 2017-03-23 21:15:41 +00:00			`"load",`
Enable custom options for addons - Add an options parameter to the start() event. This is to be used by addons on startup to add custom options. - Add a running() event that is called once the proxy is up and running. - With the new paradigm we can't log during master __init__, so add a tiny termstatus addon to print proxy status to terminal once we're running. 2017-03-09 00:52:58 +00:00			`"running",`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`"tick",`
Commands, core update event This patch: - Introduces a core update() event that should be invoked whenever flows are changed outside of the normal lifecycle. - Extend view.resolve to know about @all, which matches all flows in the view. - Add a core flow.resume comand, which resumes flows and broadcasts an update event. - Define flow list bindings for: A -> flow.resume @all a -> flow.resume @focus d -> view.remove @focus z -> view.remove @all 2017-04-28 05:01:48 +00:00			`"update",`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`])`

update mypy 2017-07-20 14:27:13 +00:00			`TEventGenerator = typing.Iterator[typing.Tuple[str, typing.Any]]`

Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00
update mypy 2017-07-20 14:27:13 +00:00			`def _iterate_http(f: http.HTTPFlow) -> TEventGenerator:`
make eventsequence.iterate extendable 2017-07-15 10:22:46 +00:00			`if f.request:`
			`yield "requestheaders", f`
			`yield "request", f`
			`if f.response:`
			`yield "responseheaders", f`
			`yield "response", f`
			`if f.error:`
			`yield "error", f`


update mypy 2017-07-20 14:27:13 +00:00			`def _iterate_websocket(f: websocket.WebSocketFlow) -> TEventGenerator:`
make eventsequence.iterate extendable 2017-07-15 10:22:46 +00:00			`messages = f.messages`
			`f.messages = []`
			`f.reply = controller.DummyReply()`
			`yield "websocket_start", f`
			`while messages:`
			`f.messages.append(messages.pop(0))`
			`yield "websocket_message", f`
			`if f.error:`
			`yield "websocket_error", f`
			`yield "websocket_end", f`


update mypy 2017-07-20 14:27:13 +00:00			`def _iterate_tcp(f: tcp.TCPFlow) -> TEventGenerator:`
make eventsequence.iterate extendable 2017-07-15 10:22:46 +00:00			`messages = f.messages`
			`f.messages = []`
			`f.reply = controller.DummyReply()`
			`yield "tcp_start", f`
			`while messages:`
			`f.messages.append(messages.pop(0))`
			`yield "tcp_message", f`
			`if f.error:`
			`yield "tcp_error", f`
			`yield "tcp_end", f`


shorten option help We can have longer versions in the docs, but this makes the options pages quite hard to parse. 2017-07-17 18:47:44 +00:00			`_iterate_map = {`
make eventsequence.iterate extendable 2017-07-15 10:22:46 +00:00			`http.HTTPFlow: _iterate_http,`
			`websocket.WebSocketFlow: _iterate_websocket,`
update mypy 2017-07-20 14:27:13 +00:00			`tcp.TCPFlow: _iterate_tcp,`
			`} # type: typing.Dict[typing.Type[flow.Flow], typing.Callable[[typing.Any], TEventGenerator]]`
make eventsequence.iterate extendable 2017-07-15 10:22:46 +00:00

			`def iterate(f: flow.Flow) -> TEventGenerator:`
			`try:`
			`e = _iterate_map[type(f)]`
update mypy 2017-07-20 14:27:13 +00:00			`except KeyError as err:`
			`raise TypeError("Unknown flow type: {}".format(f)) from err`
Kill flow.master - create master.Master Also extract events into .events 2016-10-19 00:22:50 +00:00			`else:`
make eventsequence.iterate extendable 2017-07-15 10:22:46 +00:00			`yield from e(f)`