mirror of
https://github.com/Grasscutters/mitmproxy.git
synced 2024-11-22 15:37:45 +00:00
480052f58b
* Partial gRPC contentview prototype, not linted, no tests, not as add-on * Linted (flake8) * Save dev state * Rewrote of protobuf parser, use decoding strategy, reduced rendered data. Parser uses generators * minor cleanup * fix: preferred encoding was provided as function instead of value * flake8: line length * Backlinked message tree objects, temporary debug out * Partial implementation of gRPC definitions. Save state to fix a cras (data invalidate in edit mode) * hack: deal with missing exception handling for generator based content views * gRPC/Protoparser descriptions (with test code) * replaced manual gzip decoding with mitmproxy.net.encoding.decode * Refactored typing imports * Reafctoring * distinguish request vs response definitions, separate view config from parser config * Code cleaning, moved customized protobuf definitions to example addon * final cleanup * changelog * Stubs for tests * Fixed render_riority of addon example * Started adding tests * Work on tests * mypy * Added pseudo encoder to tests, to cover special decodings * Example addon test added * finalized tests, no 100 percent coverage possible, see comments un uncovered code * minor adjustments * fixup tests * Typos Co-authored-by: Maximilian Hils <git@maximilianhils.com>
84 lines
4.1 KiB
Python
84 lines
4.1 KiB
Python
"""
|
|
Add a custom version of the gRPC/protobuf content view, which parses
|
|
protobuf messages based on a user defined rule set.
|
|
|
|
"""
|
|
from mitmproxy import contentviews
|
|
from mitmproxy.contentviews.grpc import ViewGrpcProtobuf, ViewConfig, ProtoParser
|
|
|
|
config: ViewConfig = ViewConfig()
|
|
config.parser_rules = [
|
|
# Note:
|
|
#
|
|
# The first two ParserRules use the same flow filter, although one should reply to request messages and the other to responses.
|
|
# Even with '~s' and '~q' filter expressions, the whole flow would be matched (for '~s') or not matched at all (for '~q'), if
|
|
# the contentview displays a http.Message belonging to a flow with existing request and response.
|
|
# The rules would have to be applied on per-message-basis, instead of per-flow-basis to distinguish request and response (the
|
|
# contentview deals with a single message, either request or response, the flow filter with a flow contiaing both).
|
|
#
|
|
# Thus different ParserRule classes are used to restrict rules to requests or responses were needed:
|
|
#
|
|
# - ParserRule: applied to requests and responses
|
|
# - ParserRuleRequest: applies to requests only
|
|
# - ParserRuleResponse: applies to responses only
|
|
#
|
|
# The actual 'filter' definition in the rule, would still match the whole flow. This means '~u' expressions could
|
|
# be used, to match the URL from the request of a flow, while the ParserRuleResponse is only applied to the response.
|
|
|
|
ProtoParser.ParserRuleRequest(
|
|
name = "Geo coordinate lookup request",
|
|
# note on flowfilter: for tflow the port gets appended to the URL's host part
|
|
filter = "example\\.com.*/ReverseGeocode",
|
|
field_definitions=[
|
|
ProtoParser.ParserFieldDefinition(tag="1", name="position"),
|
|
ProtoParser.ParserFieldDefinition(tag="1.1", name="latitude", intended_decoding=ProtoParser.DecodedTypes.double),
|
|
ProtoParser.ParserFieldDefinition(tag="1.2", name="longitude", intended_decoding=ProtoParser.DecodedTypes.double),
|
|
ProtoParser.ParserFieldDefinition(tag="3", name="country"),
|
|
ProtoParser.ParserFieldDefinition(tag="7", name="app"),
|
|
]
|
|
),
|
|
ProtoParser.ParserRuleResponse(
|
|
name = "Geo coordinate lookup response",
|
|
# note on flowfilter: for tflow the port gets appended to the URL's host part
|
|
filter = "example\\.com.*/ReverseGeocode",
|
|
field_definitions=[
|
|
ProtoParser.ParserFieldDefinition(tag="1.2", name="address"),
|
|
ProtoParser.ParserFieldDefinition(tag="1.3", name="address array element"),
|
|
ProtoParser.ParserFieldDefinition(tag="1.3.1", name="unknown bytes", intended_decoding=ProtoParser.DecodedTypes.bytes),
|
|
ProtoParser.ParserFieldDefinition(tag="1.3.2", name="element value long"),
|
|
ProtoParser.ParserFieldDefinition(tag="1.3.3", name="element value short"),
|
|
ProtoParser.ParserFieldDefinition(tag="", tag_prefixes=["1.5.1", "1.5.3", "1.5.4", "1.5.5", "1.5.6"], name="position"),
|
|
ProtoParser.ParserFieldDefinition(tag=".1", tag_prefixes=["1.5.1", "1.5.3", "1.5.4", "1.5.5", "1.5.6"], name="latitude", intended_decoding=ProtoParser.DecodedTypes.double), # noqa: E501
|
|
ProtoParser.ParserFieldDefinition(tag=".2", tag_prefixes=["1.5.1", "1.5.3", "1.5.4", "1.5.5", "1.5.6"], name="longitude", intended_decoding=ProtoParser.DecodedTypes.double), # noqa: E501
|
|
ProtoParser.ParserFieldDefinition(tag="7", name="app"),
|
|
]
|
|
),
|
|
]
|
|
|
|
|
|
class ViewGrpcWithRules(ViewGrpcProtobuf):
|
|
name = "customized gRPC/protobuf"
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__(config=config)
|
|
|
|
def __call__(self, *args, **kwargs) -> contentviews.TViewResult:
|
|
heading, lines = super().__call__(*args, **kwargs)
|
|
return heading + " (addon with custom rules)", lines
|
|
|
|
def render_priority(self, *args, **kwargs) -> float:
|
|
# increase priority above default gRPC view
|
|
s_prio = super().render_priority(*args, **kwargs)
|
|
return s_prio + 1 if s_prio > 0 else s_prio
|
|
|
|
|
|
view = ViewGrpcWithRules()
|
|
|
|
|
|
def load(l):
|
|
contentviews.add(view)
|
|
|
|
|
|
def done():
|
|
contentviews.remove(view)
|