-
Notifications
You must be signed in to change notification settings - Fork 1
/
idarest.py
1656 lines (1427 loc) · 59.5 KB
/
idarest.py
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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import sys
import os
import cgi
import errno
import itertools
import json, pickle
import re
import requests
import socket
import threading
import time
import traceback
import atexit
import inspect
import itertools
import urllib.request, urllib.error, urllib.parse as urlparse
from code import InteractiveInterpreter
from http.server import BaseHTTPRequestHandler, HTTPServer
from queue import Queue, Empty, Full
from socketserver import ThreadingMixIn
# pip install superglobal split_paren
from superglobals import setglobal, getglobal, superglobals
from split_paren import paren_multisplit
try:
from .idarest_mixins import IdaRestConfiguration, BorrowStdOut, IdaRestLog
except:
from idarest_mixins import IdaRestConfiguration, BorrowStdOut, IdaRestLog
# for testing outside ida
try:
import idc
import ida_idaapi
import ida_kernwin
import ida_loader
import idaapi
import idautils
import ida_pro
from PyQt5 import QtWidgets, QtCore
delayed_exec_timer = QtCore.QTimer()
except:
class idc:
@staticmethod
def msg(s):
print(s)
def get_idb_path():
return '.'
class ida_idaapi:
plugin_t = object
PLUGIN_UNL = PLUGIN_KEEP = 0
_API_IDB = idc.get_idb_path()
_API_FILE = __file__
def ir_static_vars(**kwargs):
def decorate(func):
for k in kwargs:
setattr(func, k, kwargs[k])
return func
return decorate
def _classname(instance):
return getattr(getattr(instance, '__class__', object), '__name__', '')
def _asBytes(s):
if isinstance(s, str):
return s.encode('utf-8')
return s
def _asStringRaw(o):
return o.decode('raw_unicode_escape') if isinstance(o, (bytes, bytearray)) else o
def _execute_sync(cmd, *args):
if ida_pro.is_main_thread():
return cmd()
request = ida_kernwin.execute_sync(cmd, ida_kernwin.MFF_WRITE)
# request = ida_kernwin.execute_sync(cmd, ida_kernwin.MFF_NOWAIT)
# print("[_execute_sync] request: {}".format(request))
# HTTPRequestHandler.delayed_call(lambda: ida_kernwin.cancel_exec_request(request))
"""
IDA Pro Plugin Interface
Define an IDA Python plugin required class and function.
"""
# If used as a plugin everything just becomes harder, though it does clean-up used ports
# properly.
MENU_PATH = 'Edit/Other'
class idarest_plugin_t(IdaRestConfiguration, IdaRestLog, ida_idaapi.plugin_t):
count = 0
flags = ida_idaapi.PLUGIN_UNL
comment = "Interface to IDA Rest API"
help = "IDA Rest API for basic RE tool interoperability"
wanted_name = "IDA Rest API (Terminate)"
wanted_hotkey = ""
@staticmethod
def test_bind_port(port):
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
try:
# s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind((idarest_plugin_t.config['api_bind_ip'], port))
except socket.error as e:
if e.errno != errno.EADDRINUSE:
if idarest_plugin_t.config['api_debug']: idc.msg(e)
else:
if idarest_plugin_t.config['api_debug']: idc.msg("[idarest port-in-use]: {} ".format(port))
return False
return True
def init(self):
if idarest_plugin_t.count:
return ida_idaapi.PLUGIN_KEEP
idarest_plugin_t.count += 1
if idarest_plugin_t.config['api_verbose']: idc.msg("[idarest_plugin_t::init]\n")
super(idarest_plugin_t, self).__init__()
# self.load_configuration()
# 10 queues for standard operation, 1 queue for iter/generator usage
self.state = None
# I replaced the previous menu contexts with hotkey contexts, but then
# decided they were pretty useless
# new_ctx1 = ida_kernwin.add_hotkey("Alt-7", lambda *a: self.start())
# new_ctx2 = ida_kernwin.add_hotkey("Alt-8", lambda *a: self.stop())
# new_ctx2 = ida_kernwin.add_hotkey("Alt-9", lambda *a: self.term())
# self.ctxs = [new_ctx1, new_ctx2]
self.worker = None
self.timer = None
for port in range(idarest_plugin_t.config['api_port'], 65535):
if idarest_plugin_t.test_bind_port(port):
self.port = port
break
self.host = idarest_plugin_t.config['api_bind_ip']
# IDA 7 used totally new menu contexts, and I cba translating them.
# ret = self._add_menus()
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::init] done\n")
return self.start()
def is_alive(self):
return self.worker and self.worker.is_alive()
def start(self, *args):
# load_and_run_plugin
if idarest_plugin_t.config['api_verbose']: idc.msg("[idarest_plugin_t::start]\n")
if self.worker and self.worker.is_alive():
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::start] already running\n")
return ida_idaapi.PLUGIN_SKIP
worker = Worker(self.host, self.port)
self.worker = worker
self.worker.start()
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::start] worker started: port {}\n".format(self.port))
timer = Timer(self.host, self.port)
self.timer = timer
self.timer.start()
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::start] timer started\n")
def cleanup():
self.register(self.host, self.port, unregister=True)
self.log("**atexit** cleanup")
if worker and worker.is_alive():
self.log("[idarest_plugin_t::start::cleanup] stopping..\n")
worker.stop()
self.log("[idarest_plugin_t::start::cleanup] joining..\n")
worker.join()
self.log("[idarest_plugin_t::start::cleanup] stopped\n")
if timer and timer.is_alive() and not timer.stopped():
self.log("[idarest_plugin_t::start::cleanup] stopping..\n")
timer.stop()
self.log("[idarest_plugin_t::start::cleanup] joining..\n")
timer.join()
self.log("[idarest_plugin_t::start::cleanup] stopped\n")
print('[idarest_plugin_t::start] registered atexit cleanup')
atexit.register(cleanup)
# idarest_plugin_t.register(self.host, self.port)
return ida_idaapi.PLUGIN_KEEP
def run(self, *args):
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::run] {}\n".format(args))
pass
def stop(self):
if not self.timer or not self.timer.is_alive():
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::stop] timer was not running\n")
else:
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::stop] stopping master timer..\n")
self.timer.stop()
# idc.msg("[idarest_plugin_t::stop] joining..\n")
# self.timer.join()
if not self.worker or not self.worker.is_alive():
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::stop] worker was not running\n")
else:
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::stop] stopping RESTful service..\n")
self.worker.stop()
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::stop] joining..\n")
self.worker.join()
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::stop] stopped\n")
idarest_plugin_t.register(self.host, self.port, unregister=True)
idarest_main.instance = None
if 'ir' in globals():
globals().pop('ir')
if idarest_plugin_t.count > 0:
idarest_plugin_t.count -= 1
def term(self):
try:
self.stop()
except Exception as e:
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::term] {}: {}\n".format(e.__class__.__name__, str(e)))
# for ctx in self.ctxs:
# ida_kernwin.del_hotkey(ctx)
#
#
@staticmethod
def register(host, port, unregister=False):
if unregister:
url = 'http://{}:{}{}/unregister'.format(idarest_plugin_t.config['master_host'], idarest_plugin_t.config['master_port'], idarest_plugin_t.config['api_prefix'])
else:
url = 'http://{}:{}{}/register'.format(idarest_plugin_t.config['master_host'], idarest_plugin_t.config['master_port'], idarest_plugin_t.config['api_prefix'])
if idarest_plugin_t.config['api_verbose']: idc.msg("[idarest_plugin_t::register] trying to connect to master at {}\n".format(url))
master_plugin = _API_FILE.replace('idarest.py', 'idarest_master.py')
connect_timeout = 1
read_timeout = 1
try:
p = _API_IDB
idb = os.path.split(os.path.split(p)[0])[1] + '/' + os.path.splitext(os.path.split(os.path.split(p)[1])[1])[0]
r = requests.get(
url,
params={
'host': host,
'port': port,
'idb': idb,
},
timeout=(connect_timeout, read_timeout))
if r.status_code == 200:
if r.content:
if idarest_plugin_t.config['api_verbose']: idc.msg("[idarest_plugin_t::register] master responded correctly: {}, {}\n".format(url, r.content))
else:
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::register] master failed to return data: {}, {}\n".format(url, r.content))
return
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::register] master returned status_code: {}\n".format(r.status_code))
except Exception as e:
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::register] failed to connect to master at {}: {}\n".format(url, e.__class__.__name__))
if not unregister:
if e.__class__.__name__ in ('ConnectTimeout', 'ConnectionError'):
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::register] launching new master\n")
_execute_sync(lambda: ida_loader.load_plugin(master_plugin), ida_kernwin.MFF_WRITE)
else:
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::register] exception not of a type to trigger loading new master\n")
except requests.exceptions.ConnectionError as e:
if idarest_plugin_t.config['api_info']:
idc.msg("[idarest_plugin_t::register] failed to connect to master: {}: {}\n".format(e.__class__.__name__, str(e)))
if not unregister:
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::register] launching new master\n")
_execute_sync(lambda: ida_loader.load_plugin(master_plugin), ida_kernwin.MFF_WRITE)
# ConnectionAbortedError
if idarest_plugin_t.config['api_info']: idc.msg("[idarest_plugin_t::register] failed to connect to master: {}: {}\n".format(e.__class__.__name__, str(e)))
@property
def handler(self):
return self.worker.httpd.RequestHandlerClass
def add_route(self, route_pattern, f):
self.handler.add_route(route_pattern, f)
def remove_route(self, route_pattern):
self.handler.remove_route(self.handler, route_pattern)
idarest_plugin_t.load_configuration()
class HTTPRequestError(BaseException):
def __init__(self, msg, code):
self.msg = msg
self.code = code
class UnknownApiError(HTTPRequestError):
pass
class HTTPRequestHandler(BaseHTTPRequestHandler):
routes = {}
docs = {}
prefns = {}
postfns = {}
idarest_queue = [Queue() for x in range(11)]
uid_iterator = itertools.count()
@property
def uid(self):
# is probably guaranteed to be atomic https://stackoverflow.com/a/27062830/912236
value = next(HTTPRequestHandler.uid_iterator)
return value % 10
def log_message(self, format, *args):
return
@staticmethod
def _get_params(f):
if idarest_plugin_t.config['api_debug']: idc.msg(inspect.getsource(ir.handler.routes['call'][1]))
@staticmethod
def set_result(uid, value):
if idarest_plugin_t.config['api_verbose']: idc.msg("[set_result] {}: {}\n".format(uid, value))
HTTPRequestHandler.idarest_queue[uid].put(value)
return uid
@staticmethod
def synced_next(value):
try:
v = next(value)
if idarest_plugin_t.config['api_debug']: idc.msg("next value: {}".format(v))
HTTPRequestHandler.set_result(10, v)
except StopIteration as e:
HTTPRequestHandler.set_result(10, e)
@staticmethod
def wrapped_iter(value):
while True:
_execute_sync(lambda: HTTPRequestHandler.synced_next(value), ida_kernwin.MFF_WRITE)
yield HTTPRequestHandler.get_result(10)
yield None
@staticmethod
def get_result(uid):
try:
value = HTTPRequestHandler.idarest_queue[uid].get(timeout=2)
if str(type(value)) == "<class 'generator'>":
if idarest_plugin_t.config['api_debug']: idc.msg("[get_result] return wrapped_iter")
return HTTPRequestHandler.wrapped_iter(value)
except Empty:
value = {'code': 400, 'msg': 'No response: timeout',
"traceback": traceback.format_exc()}
except Exception as e:
value = {'code': 400, 'msg': 'Unhandled Exception: ({}) {}'.format(type(e), str(e)),
"traceback": traceback.format_exc()}
except:
value = "timeout"
if idarest_plugin_t.config['api_verbose']: idc.msg("[get_result] {}: {}\n".format(uid, value))
return value
@staticmethod
def build_route_pattern(route):
return re.compile("^{0}$".format(route))
@staticmethod
def route(route_str):
def decorator(f):
# if idarest_plugin_t.config['api_debug']: print("[route] {}: {}".format(route_str, f.__doc__))
route_path = idarest_plugin_t.config['api_prefix'] + '/' + route_str + '/?'
route_pattern = HTTPRequestHandler.build_route_pattern(route_path)
HTTPRequestHandler.routes[route_str] = (route_pattern, f)
HTTPRequestHandler.docs[route_str] = f.__doc__
# HTTPRequestHandler.params[route_str] = HTTPRequestHandler._get_params(f)
return f
return decorator
@classmethod
def add_route(cls, route_str, f):
# print("[HTTPRequestHandler::add_route] cls: {}".format(cls))
route_path = idarest_plugin_t.config['api_prefix'] + '/' + route_str + '/?'
route_pattern = cls.build_route_pattern(route_path)
cls.routes[route_str] = (route_pattern, f)
cls.docs[route_str] = f.__doc__
return f
def remove_route(self, route_str):
if route_str in self.routes:
self.routes.pop(route_str)
return True
return False
@staticmethod
def prefn(route_str):
def decorator(f):
HTTPRequestHandler.prefns.setdefault(route_str, []).append(f)
return f
return decorator
@staticmethod
def postfn(route_str):
def decorator(f):
HTTPRequestHandler.postfns.setdefault(route_str, []).append(f)
return f
return decorator
def _get_route_match(self, path):
for (key, (route_pattern, view_function)) in self.routes.items():
if False: print("[debug] route_pattern:{}, path:{}".format(route_pattern, path))
m = route_pattern.match(path)
if m:
return key, view_function
return None
def _get_route_prefn(self, key):
try:
return self.prefns[key]
except:
return []
def _get_route_postfn(self, key):
try:
return self.postfns[key]
except:
return []
def _write(self, s):
self.wfile.write(_asBytes(s))
def _write_chunk(self, r):
l = len(r)
self._write('{:X}\r\n{}\r\n'.format(l, r))
def _serve_route(self, args, opts):
# Python>urlparse.urlparse('http://localhost.local:1234/ida/api/v1.0/get_type.json?idiot=phil&a=b')
# ('http', 'localhost.local:1234', '/ida/api/v1.0/get_type.json', '', 'idiot=phil&a=b', '')
# Python>pp(read_everything(u))
# [ ('fragment', '', "<class 'str'>"),
# ('hostname', 'localhost.local', "<class 'str'>"),
# ('netloc', 'localhost.local:1234', "<class 'str'>"),
# ('params', '', "<class 'str'>"),
# ('password', None, "<class 'NoneType'>"),
# ('path', '/ida/api/v1.0/get_type.json', "<class 'str'>"),
# ('port', '0x4d2', "<class 'int'>"),
# ('query', 'idiot=phil&a=b', "<class 'str'>"),
# ('scheme', 'http', "<class 'str'>"),
# ('username', None, "<class 'NoneType'>")]
path = urlparse.urlparse(self.path).path
# Python>os.path.splitext(u.path)
# ('/ida/api/v1.0/get_type', '.json')
path, response_encoding = os.path.splitext(path)
if response_encoding:
response_encoding = response_encoding.lstrip('.')
else:
response_encoding = 'json'
opts['response_encoding'] = response_encoding
route_match = self._get_route_match(path)
if route_match:
key, view_function = route_match
# these won't run in the main thread, so could cause issues if they try to interact with the idb
for prefn in self._get_route_prefn(key):
args = prefn(self, args)
uid = self.uid
# while not HTTPRequestHandler.idarest_queue[uid].empty():
# print("[_serve_route] flushing queue...")
# HTTPRequestHandler.idarest_queue[uid].get()
#
def _exec():
try:
HTTPRequestHandler.set_result(uid, view_function(self, args))
except Exception as e:
HTTPRequestHandler.set_result(uid, e)
# ida_kernwin.execute_sync(lambda: HTTPRequestHandler.set_result(uid, view_function(self, args)), ida_kernwin.MFF_WRITE)
_execute_sync(_exec, ida_kernwin.MFF_WRITE)
results = HTTPRequestHandler.get_result(uid)
# these won't run in the main thread, so could cause issues if they try to interact with the idb
for postfn in self._get_route_postfn(key):
results = postfn(self, results)
return results
else:
raise UnknownApiError('Route "{0}" has not been registered'.format(path), 404)
def _serve_queue(self, q):
response = {
'code': 200,
'msg': 'CONTROL',
'control': {'queue': 'stop'},
'data': False,
}
jsonp_callback = self._extract_callback()
if jsonp_callback:
content_type = 'application/javascript'
response_fmt = jsonp_callback + '({0});'
else:
content_type = 'application/json'
response_fmt = '{0}'
self.send_response(200)
self.send_header('Content-Type', content_type)
self.send_origin_headers()
self.send_header('Transfer-Encoding', 'chunked')
self.end_headers()
try:
for i in itertools.count(start=0):
self._write_chunk(response_fmt.format(json.dumps(response)))
if idarest_plugin_t.config['api_debug']: idc.msg("[HTTPRequestHandler::_serve_queue] wrote: {}\n".format(response))
data = q.get(timeout=idarest_plugin_t.config['api_queue_result_qget_timeout'])
if data is None:
if idarest_plugin_t.config['api_debug']: idc.msg("[HTTPRequestHandler::_serve_queue] Queue returned None\n")
break
response = {
'code': 200,
'msg': 'OK',
'oob': {'count': i},
'data': data,
}
if isinstance(response['data'], dict):
if 'error' in response['data']:
response['msg'] = 'FAIL'
except Empty:
pass
response = {
'code': 200,
'msg': 'CONTROL',
'control': {'queue': 'stop'},
'data': False,
}
self._write_chunk(response_fmt.format(json.dumps(response)))
self._write_chunk('')
# self._write('0\r\n\r\n')
def _serve_generator(self, it):
iterable = True
exception = True
queue = True
response = {
'code' : 200,
'msg' : 'CONTROL',
'data' : False,
'control': {'iterable': 'start'},
}
jsonp_callback = self._extract_callback()
if jsonp_callback:
content_type = 'application/javascript'
response_fmt = jsonp_callback + '({0});'
else:
content_type = 'application/json'
response_fmt = '{0}'
self.send_response(200)
self.send_header('Content-Type', content_type)
self.send_origin_headers()
self.send_header('Transfer-Encoding', 'chunked')
self.end_headers()
try:
for i in itertools.count(start=0):
self._write_chunk(response_fmt.format(json.dumps(response)))
if idarest_plugin_t.config['api_debug']: idc.msg("[HTTPRequestHandler::_serve_generator] wrote: {}".format(r))
data = next(it)
if data is None:
break
if isinstance(data, StopIteration):
break
response = {
'code' : 200,
'msg' : 'OK',
'oob': {'count': i},
'data' : data,
}
if isinstance(response['data'], dict):
if 'error' in response['data']:
response['msg'] = 'FAIL'
except StopIteration:
pass
response = {
'code' : 200,
'msg' : 'CONTROL',
'control': {'iterable': 'stop'},
'data' : False,
}
self._write_chunk(response_fmt.format(json.dumps(response)))
self._write_chunk('')
# self._write('0\r\n\r\n')
def send_origin_headers(self):
if self.headers.get('Origin', '') == 'null':
self.send_header('Access-Control-Allow-Origin', self.headers.get('Origin'))
self.send_header('Vary', 'Origin')
def _serve(self, args):
error = False
try:
opts = {}
it = self._serve_route(args, opts)
# it = sleeping_generator_test({}, {})
if issubclass(it.__class__, Exception):
response = {'code': 400, 'msg': 'returned exception {}: {}'.format(it.__class__, str(it))}
error = True
print('returned exception {}: {}'.format(it.__class__, str(it)))
elif str(type(it)) == "<class 'generator'>":
# if idarest_plugin_t.config['api_debug']: print("[_serve] Generator!")
return self._serve_generator(it)
elif it.__class__.__name__ == "Queue":
# if idarest_plugin_t.config['api_debug']: print("[_serve] Queue!")
return self._serve_queue(it)
else:
if isinstance(it, dict) and it.get('code', None):
response = it
else:
response = {
'code' : 200,
'msg' : 'OK',
'data' : it,
}
if isinstance(response['data'], dict):
if 'error' in response['data']:
response['code'] = 400
response['msg'] = response['data']['error']
if 'error_trace' in response['data']:
response['traceback'] = response['data']['error_trace']
response.pop('data')
except UnknownApiError as e:
self.send_error(e.code, e.msg)
return
except HTTPRequestError as e:
response = {'code': e.code, 'msg' : e.msg}
except ValueError as e:
response = {'code': 400, 'msg': 'ValueError: ' + str(e)}
except KeyError as e:
response = {'code': 400, 'msg': 'KeyError: ' + str(e)}
except StopIteration as e:
response = {'code': 400, 'msg': 'StopIteration: ' + str(e)}
except Exception as e:
response = {
'code': 400,
'msg': '{}: {}'.format(_classname(e), str(e)),
"traceback": traceback.format_exc()
}
encoder = json.dumps
response_encoding = self._extract_response_encoding()
if response_encoding == 'pickle':
encoder = pickle.dumps
jsonp_callback = self._extract_callback()
if jsonp_callback:
content_type = 'application/javascript'
response_fmt = jsonp_callback + '({0});'
else:
content_type = 'application/json'
response_fmt = '{0}'
self.send_response(200)
self.send_header('Content-Type', content_type)
self.send_origin_headers()
self.end_headers()
self._write(response_fmt.format(encoder(response)))
return
def _extract_post_map(self):
content_type, _t = cgi.parse_header(self.headers.get('content-type'))
# if content_type != 'application/json':
# raise HTTPRequestError(
# 'Bad content-type, use application/json',
# 400)
length = int(self.headers.get('content-length'))
try:
return json.loads(self.rfile.read(length))
except ValueError as e:
raise HTTPRequestError(
'Bad or malformed json content',
400)
def _extract_query_map(self):
query = urlparse.urlparse(self.path).query
qd = urlparse.parse_qs(query)
args = {}
for k, v in qd.items():
if len(v) != 1:
raise HTTPRequestError(
"Query param specified multiple times : " + k,
400)
args[k.lower()] = v[0]
return args
def _extract_callback(self):
try:
args = self._extract_query_map()
return args['callback']
except:
return ''
def _extract_response_encoding(self):
try:
path = urlparse.urlparse(self.path).path
# Python>os.path.splitext(u.path)
# ('/ida/api/v1.0/get_type', '.json')
path, response_encoding = os.path.splitext(path)
if response_encoding:
response_encoding = response_encoding.lstrip('.')
else:
response_encoding = 'json'
return response_encoding
except:
return ''
def process_headers(self):
self.header_dict = dict()
for a, c in self.headers.items():
if a and c:
self.header_dict[a.strip()] = c.strip()
def do_POST(self):
self.process_headers()
try:
args = self._extract_post_map()
except TypeError as e:
# thrown on no content, just continue on
args = '{}'
except HTTPRequestError as e:
self.send_error(e.code, e.msg)
return
self._serve(args)
def do_GET(self):
self.process_headers()
try:
HTTPRequestHandler._request = self
args = self._extract_query_map()
except HTTPRequestError as e:
self.send_error(e.code, e.msg)
return
try:
self._serve(args)
except ConnectionAbortedError as e:
if idarest_plugin_t.config['api_debug']: idc.msg("[HTTPRequestHandler::do_GET] {}: {}\n".format(e.__class__.__name__, str(e)))
@staticmethod
def delayed_call(f):
"""
call function (delayed)
allows us to start a function that will fill a Queue, while still being
able to return that Queue before the function blocks
"""
with ida_kernwin.disabled_script_timeout_t():
def delayed_exec():
f()
# delayed_exec_timer = QtCore.QTimer()
delayed_exec_timer.singleShot(0, delayed_exec)
@staticmethod
def fake_cli(text):
"""
fake text input into cli
TODO: copy ida stdout perhaps? see ipyida's Zmq console tee.
"""
with ida_kernwin.disabled_script_timeout_t():
# We'll now have to schedule a call to the standard
# 'execute' action. We can't call it right away, because
# the "Output window" doesn't have focus, and thus
# the action will fail to execute since it requires
# the "Output window" as context.
def delayed_exec(*args):
output_window_title = "Output window"
tw = ida_kernwin.find_widget(output_window_title)
if not tw:
raise Exception("Couldn't find widget '%s'" % output_window_title)
# convert from a SWiG 'TWidget*' facade,
# into an object that PyQt will understand
w = ida_kernwin.PluginForm.TWidgetToPyQtWidget(tw)
line_edit = w.findChild(QtWidgets.QLineEdit)
if not line_edit:
raise Exception("Couldn't find input")
line_edit.setFocus() # ensure it has focus
QtWidgets.QApplication.instance().processEvents() # and that it received the focus event
# inject text into widget
line_edit.setText(text)
# and execute the standard 'execute' action
ida_kernwin.process_ui_action("cli:Execute")
# delayed_exec_timer = QtCore.QTimer()
delayed_exec_timer.singleShot(0, delayed_exec)
"""
API handlers for IDA
"""
def check_ea(f):
def wrapper(self, args):
if 'ea' in args:
try:
ea = int(args['ea'], 16)
except ValueError:
raise IDARequestError(
'ea parameter malformed - must be 0xABCD', 400)
if ea > idc.MaxEA():
raise IDARequestError(
'ea out of range - MaxEA is 0x%x' % idc.MaxEA(), 400)
args['ea'] = ea
return f(self, args)
return wrapper
def check_color(f):
def wrapper(self, args):
if 'color' in args:
color = args['color']
try:
color = color.lower().lstrip('#').rstrip('h')
if color.startswith('0x'):
color = color[2:]
# IDA Color is BBGGRR, we need to convert from RRGGBB
color = color[-2:] + color[2:4] + color[:2]
color = int(color, 16)
except:
raise IDARequestError(
'color parameter malformed - must be RRGGBB form', 400)
args['color'] = color
return f(self, args)
return wrapper
# this doesn't presently work, as it ends up being executed in IDA's main
# working thread. but let's leave it in so we can still use the decorator
# and maybe it will be fixed.
def require_params(*params):
def decorator(f):
def require_params_wrapper(self, args):
for x in params:
if ':' not in x and ' ' not in x and x not in args:
raise IDARequestError('missing parameter {0}'.format(x), 400)
return f(self, args)
require_params_wrapper.__doc__ = f.__doc__
require_params_wrapper._params = getattr(f, '_params', [])
require_params_wrapper._params.append(params)
return require_params_wrapper
return decorator
class IDARequestError(HTTPRequestError):
pass
class EvalInterpreter(InteractiveInterpreter):
def __init__(self, locals=None):
super(EvalInterpreter, self).__init__(locals)
self.buffer = []
self.stdout_list = []
self.stderr_list = []
def write(self, data):
self.buffer.append(data)
def eval(self, cmd):
is_help = cmd.startswith('help(')
result = None
r = None
with BorrowStdOut(self.stdout_list, self.stderr_list, is_help):
r = self.runsource(cmd)
if isinstance(self.stderr_list, list):
if self.stderr_list:
start = False
result = []
for line in self.stderr_list:
if 'File "<input>"' in line:
start = True
if start:
result.append(line)
if result:
self.stderr_list = [self.stderr_list[0]] + result
return {
'code': 400,
'msg': ''.join(self.stderr_list),
}
result = ''.join(self.stdout_list + self.buffer)
if r != False:
raise SyntaxError(cmd)
if isinstance(self.stdout_list, list):
return result
class EvalInterpreterQueue(EvalInterpreter):
def __init__(self, locals, queue):
super(EvalInterpreterQueue, self).__init__(locals)
self.buffer = queue
self.stdout_list = self.buffer
self.stderr_list = self.buffer
self.buffer.append = self.buffer.put
class IDARequestHandler(HTTPRequestHandler):
@staticmethod
def _hex(v):
return hex(v).rstrip('L')
@staticmethod
def _from_hex(v):
if re.match(r'0x[0-9a-fA-F]+$', v):
return int(v, 16)
if re.match(r'\d+$', v):
return int(v, 10)
if re.match(r'".*"$', v):
return v[1:-1]
if re.match(r"'.*'$", v):
return v[1:-1]
return v
def paren_split(s, delim):
""" split string, respecting quotes """
result = paren_multisplit(s, delim, '\'"', '\'"')
if idarest_plugin_t.config['api_debug']: print("[paren_split] in: {}".format(s))
if idarest_plugin_t.config['api_debug']: print("[paren_split] out: {}".format(result))
return result
@staticmethod
def _dotted(key):
pieces = key.split('.')
return pieces
@staticmethod
def _ensure_path(_dict, path):
if not path:
if idarest_plugin_t.config['api_debug']: idc.msg("[_ensure_path] empty path\n")
return None
for piece in path:
try:
if piece in _dict:
_dict = _dict[piece]
except TypeError:
if hasattr(_dict, piece):
_dict = getattr(_dict, piece)
else:
return None
return _dict
@staticmethod
def _getplus(key):
return getglobal(key)
# _globals = superglobals()
#
# if isinstance(key, list):
# path = key
# else:
# path = IDARequestHandler._dotted(key)
#
# base = IDARequestHandler._ensure_path(_globals, path)
# return base
@staticmethod
def error(e):
if issubclass(e.__class__, Exception):
_class = _classname(e)
_message = str(e)
result = {
"error": "{}: {}".format(_class, _message),
"error_trace": traceback.format_exc(),
}
else:
result = {
"error": e,
}
return result
@HTTPRequestHandler.route('info')
def info(self, args):
# No args, Return everything we can meta-wise about the ida session
# file crcs
result = {