Skip to content
Navigation Menu
{{ message }}
forked from mitmproxy/mitmproxy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommand.py
More file actions
357 lines (305 loc) · 12.1 KB
/
Copy pathcommand.py
File metadata and controls
357 lines (305 loc) · 12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
"""
This module manages and invokes typed commands.
"""
import asyncio
import inspect
import types
import typing
import textwrap
import functools
import sys
import mitmproxy.types
from mitmproxy import exceptions
from mitmproxy.language import lexer, parser, traversal
def verify_arg_signature(f: typing.Callable, args: list, kwargs: dict) -> None:
sig = inspect.signature(f)
try:
sig.bind(*args, **kwargs)
except TypeError as v:
raise exceptions.CommandError("command argument mismatch: %s" % v.args[0])
def typename(t: type) -> str:
"""
Translates a type to an explanatory string.
"""
if t == inspect._empty: # type: ignore
raise exceptions.CommandError("missing type annotation")
to = mitmproxy.types.CommandTypes.get(t, None)
if not to:
raise exceptions.CommandError("unsupported type: %s" % getattr(t, "__name__", t))
return to.display
RunningCommand = typing.NamedTuple(
"RunningCommand",
[
("cmdstr", str),
("task", asyncio.Future)
],
)
class AsyncExecutionManager:
def __init__(self) -> None:
self.counter: int = 0
self.running_cmds: typing.Dict[int, RunningCommand] = {}
def add_command(self, cmd: RunningCommand) -> None:
self.counter += 1
cmd.task.add_done_callback(functools.partial(self._delete_callback,
cid=self.counter))
self.running_cmds[self.counter] = cmd
def stop_command(self, cid: int) -> None:
try:
cmd = self.running_cmds[cid]
except KeyError:
raise ValueError(f"There is not the command with id={cid}")
else:
cmd.task.cancel()
del self.running_cmds[cid]
def get_running(self) -> typing.List[typing.Tuple[int, str]]:
running = []
for cid in sorted(self.running_cmds):
running.append((cid, self.running_cmds[cid].cmdstr))
return running
def _delete_callback(self, task: asyncio.Task, cid: int) -> None:
del self.running_cmds[cid]
class Command:
def __init__(self, manager, path, func) -> None:
self.path = path
self.manager = manager
self.func = func
self.asyncf = True if asyncio.iscoroutinefunction(func) else False
sig = inspect.signature(self.func)
self.help = None
if func.__doc__:
txt = func.__doc__.strip()
self.help = "\n".join(textwrap.wrap(txt))
self.has_positional = False
for i in sig.parameters.values():
# This is the kind for *args parameters
if i.kind == i.VAR_POSITIONAL:
self.has_positional = True
self.paramtypes = [v.annotation for v in sig.parameters.values()]
if sig.return_annotation == inspect._empty: # type: ignore
self.returntype = None
else:
self.returntype = sig.return_annotation
# This fails with a CommandException if types are invalid
self.signature_help()
def paramnames(self) -> typing.Sequence[str]:
v = [typename(i) for i in self.paramtypes]
if self.has_positional:
v[-1] = "*" + v[-1]
return v
def retname(self) -> str:
return typename(self.returntype) if self.returntype else ""
def signature_help(self) -> str:
params = " ".join(self.paramnames())
ret = self.retname()
if ret:
ret = " -> " + ret
return "%s %s%s" % (self.path, params, ret)
def prepare_args(self, args: typing.Sequence[typing.Any]) -> typing.List[typing.Any]:
verify_arg_signature(self.func, list(args), {})
remainder: typing.Sequence[str] = []
if self.has_positional:
remainder = args[len(self.paramtypes) - 1:]
args = args[:len(self.paramtypes) - 1]
pargs = []
for arg, paramtype in zip(args, self.paramtypes):
if not isinstance(arg, str):
t = mitmproxy.types.CommandTypes.get(paramtype, None)
if t.is_valid(self.manager, t, arg):
pargs.append(arg)
else:
raise exceptions.CommandError(
f"{arg} is unexpected data for {t.display} type"
)
else:
pargs.append(parsearg(self.manager, arg, paramtype))
pargs.extend(remainder)
return pargs
def call(self, args: typing.Sequence[typing.Any]) -> typing.Any:
"""
Call the command with a list of arguments.
"""
ret = self.func(*self.prepare_args(args))
if ret is None and self.returntype is None:
return
typ = mitmproxy.types.CommandTypes.get(self.returntype)
if not typ.is_valid(self.manager, typ, ret):
raise exceptions.CommandError(
f"{self.path} returned unexpected data - expected {typ.display}"
)
return ret
async def async_call(self, args: typing.Sequence[typing.Any]) -> typing.Any:
"""
Call the command with a list of arguments asynchronously.
"""
ret = await self.func(*self.prepare_args(args))
if ret is None and self.returntype is None:
return
typ = mitmproxy.types.CommandTypes.get(self.returntype)
if not typ.is_valid(self.manager, typ, ret):
raise exceptions.CommandError(
f"{self.path} returned unexpected data - expected {typ.display}"
)
return ret
ParseResult = typing.NamedTuple(
"ParseResult",
[
("value", str),
("type", typing.Type),
("valid", bool),
],
)
class CommandManager(mitmproxy.types._CommandBase):
def __init__(self, master):
self.master = master
self.async_manager = AsyncExecutionManager()
self.command_parser = parser.create_parser(self)
self.commands: typing.Dict[str, Command] = {}
self.oneword_commands: typing.List[str] = []
def collect_commands(self, addon):
for i in dir(addon):
if not i.startswith("__"):
o = getattr(addon, i)
try:
is_command = hasattr(o, "command_path")
except Exception:
pass # hasattr may raise if o implements __getattr__.
else:
if is_command:
try:
self.add(o.command_path, o)
except exceptions.CommandError as e:
self.master.log.warn(
"Could not load command %s: %s" % (o.command_path, e)
)
def add(self, path: str, func: typing.Callable):
self.commands[path] = Command(self, path, func)
# Collecting one-word command names for lexer
if len(path.split(".")) == 1:
self.oneword_commands.append(path)
def parse_partial(
self,
cmdstr: str
) -> typing.Tuple[typing.Sequence[ParseResult], typing.Sequence[str]]:
"""
Parse a possibly partial command. Return a sequence of ParseResults and a sequence of remainder type help items.
"""
parts: typing.List[str] = lexer.get_tokens(cmdstr)
if not parts:
parts = [""]
elif parts[-1].isspace():
parts.append("")
parse: typing.List[ParseResult] = []
params: typing.List[type] = []
typ: typing.Type = None
for i, part in enumerate(parts):
typ = mitmproxy.types.Unknown
if not part.isspace():
if i == 0 or (i == 1 and parts[i - 1].isspace()):
typ = mitmproxy.types.Cmd
if part in self.commands:
params.extend(self.commands[part].paramtypes)
elif params:
typ = params.pop(0)
if typ == mitmproxy.types.Cmd and params and params[0] == mitmproxy.types.Arg:
if part in self.commands:
params[:] = self.commands[part].paramtypes
to = mitmproxy.types.CommandTypes.get(typ, None)
valid = False
if to:
try:
to.parse(self, typ, part)
except exceptions.TypeError:
valid = False
else:
valid = True
parse.append(
ParseResult(
value=part,
type=typ,
valid=valid,
)
)
remhelp: typing.List[str] = []
for x in params:
remt = mitmproxy.types.CommandTypes.get(x, None)
remhelp.append(remt.display)
return parse, remhelp
def get_command_by_path(self, path: str) -> Command:
"""
Returns command by its path. May raise CommandError.
"""
if path not in self.commands:
raise exceptions.CommandError(f"Unknown command: {path}")
return self.commands[path]
def call(self, path: str, *args: typing.Sequence[typing.Any]) -> typing.Any:
"""
Call a command with native arguments. May raise CommandError.
"""
return self.get_command_by_path(path).func(*args)
def call_strings(self, path: str, args: typing.Sequence[str]) -> typing.Any:
"""
Call a command using a list of string arguments. May raise CommandError.
"""
return self.get_command_by_path(path).call(args)
def async_execute(self, cmdstr: str) -> asyncio.Future:
"""
Schedule a command to be executed. May raise CommandError.
"""
lex = lexer.create_lexer(cmdstr, self.oneword_commands)
parsed_cmd = self.command_parser.parse(lexer=lex, async_exec=True)
execution_coro = traversal.execute_parsed_line(parsed_cmd)
command_task = asyncio.ensure_future(execution_coro)
self.async_manager.add_command(RunningCommand(cmdstr, command_task))
return command_task
def execute(self, cmdstr: str) -> typing.Any:
"""
Execute a command string. May raise CommandError.
"""
lex = lexer.create_lexer(cmdstr, self.oneword_commands)
parsed_cmd = self.command_parser.parse(lexer=lex)
return parsed_cmd
def dump(self, out=sys.stdout) -> None:
cmds = list(self.commands.values())
cmds.sort(key=lambda x: x.signature_help())
for c in cmds:
for hl in (c.help or "").splitlines():
print("# " + hl, file=out)
print(c.signature_help(), file=out)
print(file=out)
def parsearg(manager: CommandManager, spec: str, argtype: type) -> typing.Any:
"""
Convert a string to a argument to the appropriate type.
"""
t = mitmproxy.types.CommandTypes.get(argtype, None)
if not t:
raise exceptions.CommandError(f"Unsupported argument type: {argtype}")
try:
return t.parse(manager, argtype, spec) # type: ignore
except exceptions.TypeError as e:
raise exceptions.CommandError from e
def command(path):
def decorator(function):
if asyncio.iscoroutinefunction(function):
@functools.wraps(function)
async def wrapper(*args, **kwargs):
verify_arg_signature(function, args, kwargs)
return await function(*args, **kwargs)
else:
@functools.wraps(function)
def wrapper(*args, **kwargs):
verify_arg_signature(function, args, kwargs)
return function(*args, **kwargs)
wrapper.__dict__["command_path"] = path
return wrapper
return decorator
def argument(name, type):
"""
Set the type of a command argument at runtime. This is useful for more
specific types such as mitmproxy.types.Choice, which we cannot annotate
directly as mypy does not like that.
"""
def decorator(f: types.FunctionType) -> types.FunctionType:
assert name in f.__annotations__
f.__annotations__[name] = type
return f
return decorator
You can’t perform that action at this time.