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
|
"""Ergonomic RE driver over the idatui RPC socket — terse text, auto socket.
A thin, opinionated layer over ``idatui.rpcclient`` for reverse-engineering
sessions. It removes the friction of raw driving: it resolves the socket
automatically (the single live pane), prints compact text instead of JSON
blobs, and bundles the common composite gestures (goto+rename, batch rename,
function comment, filtered pseudocode). Use it for low-overhead tool-calls.
python3 -m idatui.drive where # where am I
python3 -m idatui.drive pc main strrchr # pseudocode of main, lines matching 'strrchr'
python3 -m idatui.drive callees main # what main calls
python3 -m idatui.drive rename sub_5BE0 stdout_isatty
python3 -m idatui.drive mv sub_A=foo sub_B=bar # batch rename
python3 -m idatui.drive note main "entry point"# function comment
Socket: --sock, else IDATUI_RPC_SOCK, else the one live pane (from `pane list`).
'.' or omitted as a target means the current function. `raw <method> k=v` is a
passthrough to rpcclient (pretty JSON).
"""
from __future__ import annotations
import json
import os
import sys
from .pane import _load_registry, _pane_alive
from .rpcclient import RpcClient, RpcError
def _resolve_sock(explicit: str | None) -> str:
if explicit:
return explicit
env = os.environ.get("IDATUI_RPC_SOCK")
if env:
return env
live = [r for r in _load_registry()
if _pane_alive(r.get("pane", "")) and r.get("sock")
and os.path.exists(r["sock"])]
if len(live) == 1:
return live[0]["sock"]
if not live:
raise SystemExit("no live idatui pane — pass --sock, set IDATUI_RPC_SOCK, "
"or `python -m idatui.pane spawn ...`")
raise SystemExit("multiple live panes — pass --sock <one of>:\n"
+ "\n".join(" " + r["sock"] for r in live))
def _tgt(a: str | None) -> str | None:
return None if a in (None, ".", "") else a
def _coerce(v: str):
low = v.lower()
return {"true": True, "false": False, "null": None}.get(low, v)
# --------------------------------------------------------------------------- #
# commands (each: (client, args) -> text)
# --------------------------------------------------------------------------- #
def _fmt_where(st: dict) -> str:
fn = st.get("function") or {}
cur = st.get("cursor") or {}
name = fn.get("name")
ea = fn.get("ea")
loc = f"{name} @ {ea:#x}" if isinstance(ea, int) else "(none)"
extra = ""
if cur.get("kind") in ("decomp", "disasm"):
extra = f" L{cur.get('line')} C{cur.get('col')} word={cur.get('word')!r}"
elif cur.get("kind") == "hex":
extra = f" va={cur.get('va'):#x}" if isinstance(cur.get("va"), int) else ""
modal = st.get("modal")
m = f" [modal:{modal['kind']}]" if modal else ""
return f"{loc} [{st.get('active')}]{extra}{m}"
def cmd_where(c, args):
return _fmt_where(c.call("state"))
def cmd_go(c, args):
if not args:
raise SystemExit("usage: go <fn>")
c.call("goto", target=args[0], delay_ms=0)
return _fmt_where(c.call("state"))
def cmd_pc(c, args):
target = _tgt(args[0]) if args else None
needle = args[1].lower() if len(args) > 1 else None
d = c.call("pseudocode", target=target)
if not d.get("code"):
return f"(no pseudocode: {d.get('error')})"
lines = d["code"].splitlines()
if needle:
lines = [f"{i:4} {l}" for i, l in enumerate(lines) if needle in l.lower()]
return "\n".join(lines) or f"(no line matches {needle!r})"
return d["code"]
def cmd_dis(c, args):
target = _tgt(args[0]) if args else None
n = int(args[1]) if len(args) > 1 else 60
d = c.call("disassembly", target=target, max=n)
return "\n".join(f"{ln['ea']:#010x} {ln['text']}" for ln in d.get("lines", []))
def cmd_callees(c, args):
xs = c.call("xrefs_from", target=_tgt(args[0]) if args else None)
funcs = [x for x in xs if x.get("is_func")]
data = [x for x in xs if not x.get("is_func")]
out = [f" {x['to']:#x} {x.get('name')}" for x in funcs]
for x in data:
s = f" {x['string']!r}" if x.get("string") else ""
out.append(f" {x['to']:#x} {x.get('name')}{s}")
return "\n".join(out) or "(no outgoing refs)"
def cmd_callers(c, args):
if not args:
raise SystemExit("usage: callers <fn>")
xs = c.call("xrefs_to", target=args[0])
return "\n".join(f" {x['frm']:#x} in {x.get('fn_name')}" for x in xs) \
or "(no callers)"
def cmd_names(c, args):
if not args:
raise SystemExit("usage: names <substr> [limit]")
lim = int(args[1]) if len(args) > 1 else 40
fs = c.call("functions", filter=args[0], limit=lim)
return "\n".join(f" {f['ea']:#x} {f['name']} ({f['size']})" for f in fs) \
or "(no match)"
def _rename_one(c, old, new):
c.call("goto", target=old, delay_ms=0)
st = c.call("rename", name=new, word=old, delay_ms=0)
got = (st.get("function") or {}).get("name")
return f" {old} -> {got}"
def cmd_rename(c, args):
if len(args) != 2:
raise SystemExit("usage: rename <old> <new>")
return _rename_one(c, args[0], args[1])
def cmd_mv(c, args):
out = []
for pair in args:
if "=" not in pair:
raise SystemExit(f"usage: mv old=new ... (bad: {pair!r})")
old, new = pair.split("=", 1)
try:
out.append(_rename_one(c, old, new))
except RpcError as e:
out.append(f" {old} -> FAILED: {e}")
return "\n".join(out)
def cmd_note(c, args):
if len(args) < 2:
raise SystemExit("usage: note <fn> <text...>")
c.call("goto", target=args[0], delay_ms=0)
c.call("cursor", line=0, col=0)
c.call("comment", text=" ".join(args[1:]), delay_ms=0)
return f" noted {args[0]}"
def cmd_retype(c, args):
if len(args) < 2:
raise SystemExit("usage: retype <fn> <prototype...>")
c.call("goto", target=args[0], delay_ms=0)
st = c.call("retype", proto=" ".join(args[1:]), word=args[0], delay_ms=0)
return _fmt_where(st)
def cmd_save(c, args):
c.call("save")
return " saved"
def cmd_screen(c, args):
return c.call("screen").get("text", "")
def cmd_raw(c, args):
if not args:
raise SystemExit("usage: raw <method> [k=v ...]")
params = {}
for tok in args[1:]:
k, _, v = tok.partition("=")
params[k] = _coerce(v)
return json.dumps(c.call(args[0], **params), indent=2)
COMMANDS = {
"where": cmd_where, "go": cmd_go, "pc": cmd_pc, "dis": cmd_dis,
"callees": cmd_callees, "callers": cmd_callers, "names": cmd_names,
"rename": cmd_rename, "mv": cmd_mv, "note": cmd_note, "retype": cmd_retype,
"save": cmd_save, "screen": cmd_screen, "raw": cmd_raw,
}
def main(argv: list[str]) -> int:
args = list(argv)
sock = None
if args and args[0] == "--sock":
sock, args = args[1], args[2:]
if not args or args[0] in ("-h", "--help", "help"):
print("commands: " + " ".join(COMMANDS), file=sys.stderr)
print(__doc__, file=sys.stderr)
return 0 if args[:1] in (["help"], ["-h"], ["--help"]) else 2
cmd, rest = args[0], args[1:]
fn = COMMANDS.get(cmd)
if fn is None:
print(f"unknown command: {cmd!r} (try: {' '.join(COMMANDS)})", file=sys.stderr)
return 2
try:
with RpcClient(_resolve_sock(sock)) as c:
out = fn(c, rest)
except (OSError, RpcError, ConnectionError) as e:
print(f"error: {e}", file=sys.stderr)
return 1
if out:
print(out)
return 0
if __name__ == "__main__":
raise SystemExit(main(sys.argv[1:]))
|
