-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathlldbinit.py
4023 lines (3368 loc) · 125 KB
/
lldbinit.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
'''
.____ .____ ________ __________.__ _______ ._____________
| | | | \______ \\______ \__|\ \ |__\__ ___/
| | | | | | \| | _/ |/ | \| | | |
| |___| |___ | ` \ | \ / | \ | | |
|_______ \_______ \/_______ /______ /__\____|__ /__| |____|
\/ \/ \/ \/ \/ LLDBINIT v2.0
A gdbinit clone for LLDB aka how to make LLDB a bit more useful and less crappy
(c) Deroko 2014, 2015, 2016
(c) fG! 2017-2019 - [email protected] - https://reverse.put.as
(c) Peternguyen 2020
Available at https://github.com/gdbinit/lldbinit
No original license by Deroko so I guess this is do whatever you want with this
as long you keep original credits and sources references.
Original lldbinit code by Deroko @ https://github.com/deroko/lldbinit
gdbinit available @ https://github.com/gdbinit/Gdbinit
Huge thanks to Deroko for his original effort!
To list all implemented commands use 'lldbinitcmds' command.
How to install it:
------------------
$ cp lldbinit.py ~
$ echo "command script import ~/lldbinit.py" >>$HOME/.lldbinit
or
$ cp lldbinit.py /Library/Python/2.7/site-packages
$ echo "command script import lldbinit" >> $HOME/.lldbinit
or
just copy it somewhere and use "command script import path_to_script" when you want to load it.
BUGS:
-----
LLDB design:
------------
lldb -> debugger -> target -> process -> thread -> frame(s)
-> thread -> frame(s)
'''
from __future__ import print_function
if __name__ == "__main__":
print("Run only as script from LLDB... Not as standalone program!")
import sys
import re
import os
import time
import argparse
import subprocess
import tempfile
sys.path.insert(0, os.path.abspath(os.path.dirname(__file__)))
from utils import *
from xnu import *
try:
from keystone import *
CONFIG_KEYSTONE_AVAILABLE = 1
except ImportError:
CONFIG_KEYSTONE_AVAILABLE = 0
VERSION = "2.5"
#
# User configurable options
#
CONFIG_ENABLE_COLOR = 1
CONFIG_DISPLAY_DISASSEMBLY_BYTES = 1
CONFIG_DISASSEMBLY_LINE_COUNT = 8
CONFIG_USE_CUSTOM_DISASSEMBLY_FORMAT = 1
CONFIG_DISPLAY_STACK_WINDOW = 0
CONFIG_DISPLAY_FLOW_WINDOW = 0
CONFIG_ENABLE_REGISTER_SHORTCUTS = 1
CONFIG_DISPLAY_DATA_WINDOW = 0
# setup the logging level, which is a bitmask of any of the following possible values (don't use spaces, doesn't seem to work)
#
# LOG_VERBOSE LOG_PROCESS LOG_THREAD LOG_EXCEPTIONS LOG_SHLIB LOG_MEMORY LOG_MEMORY_DATA_SHORT LOG_MEMORY_DATA_LONG LOG_MEMORY_PROTECTIONS LOG_BREAKPOINTS LOG_EVENTS LOG_WATCHPOINTS
# LOG_STEP LOG_TASK LOG_ALL LOG_DEFAULT LOG_NONE LOG_RNB_MINIMAL LOG_RNB_MEDIUM LOG_RNB_MAX LOG_RNB_COMM LOG_RNB_REMOTE LOG_RNB_EVENTS LOG_RNB_PROC LOG_RNB_PACKETS LOG_RNB_ALL LOG_RNB_DEFAULT
# LOG_DARWIN_LOG LOG_RNB_NONE
#
# to see log (at least in macOS)
# $ log stream --process debugserver --style compact
# (or whatever style you like)
CONFIG_LOG_LEVEL = "LOG_NONE"
# removes the offsets and modifies the module name position
# reference: https://lldb.llvm.org/formats.html
CUSTOM_DISASSEMBLY_FORMAT = "\"{${function.initial-function}{${function.name-without-args}} @ {${module.file.basename}}:\n}{${function.changed}\n{${function.name-without-args}} @ {${module.file.basename}}:\n}{${current-pc-arrow} }${addr-file-or-load}: \""
DATA_WINDOW_ADDRESS = 0
POINTER_SIZE = 8 # assume architecture is 64 bits
old_register: Dict[str, int] = {}
arm_type = "thumbv7-apple-ios"
GlobalListOutput = []
Int3Dictionary: Dict[int, int] = {}
flag_regs = ('rflags', 'eflags', 'cpsr')
segment_regs = ("cs", "ds", "es", "gs", "fs", "ss", "cs", "gs", "fs")
x86_registers = [
"eax", "ebx", "ebp", "esp", "eflags", "edi", "esi", "edx", "ecx", "eip"
"cs", "ds", "es", "gs", "fs", "ss"
]
x86_64_registers = [
"rax", "rbx", "rbp", "rsp", "rflags", "rdi", "rsi", "rdx", "rcx", "rip",
"r8", "r9", "r10", "r11", "r12", "r13", "r14", "r15", "cs", "gs", "fs"
]
arm_32_registers = [
"r0", "r1", "r2", "r3", "cpsr", "r4", "r5", "r6", "r7", "r8",
"r9", "r10", "r11", "r12", "sp", "lr", "pc"
]
aarch64_registers = [
'x0', 'x1', 'x2', 'x3', 'cpsr',
'x4', 'x5', 'x6', 'x7',
'x8', 'x9', 'x10', 'x11',
'x12', 'x13', 'x14', 'x15',
'x16', 'x17', 'x18', 'x19',
'x20', 'x21', 'x22', 'x23',
'x24', 'x25', 'x26', 'x27',
'x28', 'x29', 'x30', 'sp', 'pc', 'fpcr', 'fpsr'
]
MACOS_VMMAP = MacOSVMMapCache()
XNU_ZONES = XNUZones()
SelectedVM = ''
def is_in_Xcode() -> bool:
path_env = os.getenv('PATH')
if not path_env:
# PATH didn't exists.
return False
return True if path_env.startswith('/Applications/Xcode') else False
def __lldb_init_module(debugger: SBDebugger, internal_dict: Dict):
''' we can execute commands using debugger.HandleCommand which makes all output to default
lldb console. With GetCommandinterpreter().HandleCommand() we can consume all output
with SBCommandReturnObject and parse data before we send it to output (eg. modify it);
'''
# don't load if we are in Xcode since it is not compatible and will block Xcode
if is_in_Xcode():
return
'''
If I'm running from $HOME where .lldbinit is located, seems like lldb will load
.lldbinit 2 times, thus this dirty hack is here to prevent doulbe loading...
if somebody knows better way, would be great to know :)
'''
var: lldb.SBStringList = debugger.GetInternalVariableValue(\
"stop-disassembly-count", debugger.GetInstanceName())
if var.IsValid():
var = var.GetStringAtIndex(0)
if var == "0":
return
res = lldb.SBCommandReturnObject()
ci: SBCommandInterpreter = debugger.GetCommandInterpreter()
# settings
ci.HandleCommand("settings set target.x86-disassembly-flavor intel", res)
ci.HandleCommand("settings set prompt \"(lldbinit) \"", res)
ci.HandleCommand("settings set stop-disassembly-count 0", res)
# set the log level - must be done on startup?
ci.HandleCommand("settings set target.process.extra-startup-command QSetLogging:bitmask=" + CONFIG_LOG_LEVEL + ";", res)
if CONFIG_USE_CUSTOM_DISASSEMBLY_FORMAT == 1:
ci.HandleCommand("settings set disassembly-format " + CUSTOM_DISASSEMBLY_FORMAT, res)
# the hook that makes everything possible :-)
ci.HandleCommand("command script add -f lldbinit.HandleHookStopOnTarget HandleHookStopOnTarget", res)
ci.HandleCommand("command script add -f lldbinit.HandleHookStopOnTarget ctx", res)
ci.HandleCommand("command script add -f lldbinit.HandleHookStopOnTarget context", res)
# commands
ci.HandleCommand("command script add -f lldbinit.cmd_lldbinitcmds lldbinitcmds", res)
ci.HandleCommand("command script add -f lldbinit.cmd_IphoneConnect iphone", res)
#
# dump memory commands
#
ci.HandleCommand("command script add -f lldbinit.cmd_db db", res)
ci.HandleCommand("command script add -f lldbinit.cmd_dw dw", res)
ci.HandleCommand("command script add -f lldbinit.cmd_dd dd", res)
ci.HandleCommand("command script add -f lldbinit.cmd_dq dq", res)
ci.HandleCommand("command script add -f lldbinit.cmd_DumpInstructions u", res)
ci.HandleCommand("command script add -f lldbinit.cmd_findmem findmem", res)
#
# ObjectiveC commands
#
ci.HandleCommand("command script add -f lldbinit.cmd_objc objc", res)
#
# Image commands
#
ci.HandleCommand("command script add -f lldbinit.cmd_xinfo xinfo", res)
ci.HandleCommand("command script add -f lldbinit.cmd_telescope tele", res)
ci.HandleCommand("command script add -f lldbinit.cmd_vmmap vmmap", res)
#
# Exploitation Helper commands
#
ci.HandleCommand("command script add -f lldbinit.cmd_pattern_create pattern_create", res)
ci.HandleCommand("command script add -f lldbinit.cmd_pattern_offset pattern_offset", res)
#
# Settings related commands
#
ci.HandleCommand("command script add -f lldbinit.cmd_enable enable", res)
ci.HandleCommand("command script add -f lldbinit.cmd_disable disable", res)
ci.HandleCommand("command script add -f lldbinit.cmd_contextcodesize contextcodesize", res)
# a few settings aliases
ci.HandleCommand("command alias enablesolib enable solib", res)
ci.HandleCommand("command alias disablesolib disable solib", res)
ci.HandleCommand("command alias enableaslr enable aslr", res)
ci.HandleCommand("command alias disableaslr disable aslr", res)
#
# Breakpoint related commands
#
ci.HandleCommand("command script add -f lldbinit.cmd_m_bp mbp", res)
ci.HandleCommand("command script add -f lldbinit.cmd_to_ida_addr toida", res)
ci.HandleCommand("command script add -f lldbinit.cmd_bhb bhb", res)
ci.HandleCommand("command script add -f lldbinit.cmd_bht bht", res)
ci.HandleCommand("command script add -f lldbinit.cmd_bpt bpt", res)
ci.HandleCommand("command script add -f lldbinit.cmd_bpn bpn", res)
# disable a breakpoint or all
ci.HandleCommand("command script add -f lldbinit.cmd_bpd bpd", res)
ci.HandleCommand("command script add -f lldbinit.cmd_bpda bpda", res)
# clear a breakpoint or all
ci.HandleCommand("command script add -f lldbinit.cmd_bpc bpc", res)
ci.HandleCommand("command alias bpca breakpoint delete", res)
# enable a breakpoint or all
ci.HandleCommand("command script add -f lldbinit.cmd_bpe bpe", res)
ci.HandleCommand("command script add -f lldbinit.cmd_bpea bpea", res)
# commands to set temporary int3 patches and restore original bytes
ci.HandleCommand("command script add -f lldbinit.cmd_int3 int3", res)
ci.HandleCommand("command script add -f lldbinit.cmd_rint3 rint3", res)
ci.HandleCommand("command script add -f lldbinit.cmd_listint3 listint3", res)
ci.HandleCommand("command script add -f lldbinit.cmd_nop nop", res)
ci.HandleCommand("command script add -f lldbinit.cmd_null null", res)
# change eflags commands
ci.HandleCommand("command script add -f lldbinit.cmd_cfa cfa", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cfc cfc", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cfd cfd", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cfi cfi", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cfo cfo", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cfp cfp", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cfs cfs", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cft cft", res)
ci.HandleCommand("command script add -f lldbinit.cmd_cfz cfz", res)
# skip/step current instruction commands
ci.HandleCommand("command script add -f lldbinit.cmd_skip skip", res)
ci.HandleCommand("command script add -f lldbinit.cmd_stepo stepo", res)
ci.HandleCommand("command script add -f lldbinit.cmd_si si", res)
# load breakpoints from file
ci.HandleCommand("command script add -f lldbinit.cmd_LoadBreakPoints lb", res)
ci.HandleCommand("command script add -f lldbinit.cmd_LoadBreakPointsRva lbrva", res)
# alias for existing breakpoint commands
# list all breakpoints
ci.HandleCommand("command alias bpl breakpoint list", res)
# alias "bp" command that exists in gdbinit - lldb also has alias for "b"
ci.HandleCommand("command alias bp _regexp-break", res)
# to set breakpoint commands - I hate typing too much
ci.HandleCommand("command alias bcmd breakpoint command add", res)
# launch process and stop at entrypoint (not exactly as gdb command that just inserts breakpoint)
# usually it will be inside dyld and not the target main()
ci.HandleCommand("command alias break_entrypoint process launch --stop-at-entry", res)
ci.HandleCommand("command script add -f lldbinit.cmd_show_loadcmds show_loadcmds", res)
ci.HandleCommand("command script add -f lldbinit.cmd_show_header show_header", res)
ci.HandleCommand("command script add -f lldbinit.cmd_datawin datawin", res)
if CONFIG_KEYSTONE_AVAILABLE == 1:
ci.HandleCommand("command script add -f lldbinit.cmd_asm32 asm32", res)
ci.HandleCommand("command script add -f lldbinit.cmd_asm64 asm64", res)
ci.HandleCommand("command script add -f lldbinit.cmd_arm32 arm32", res)
ci.HandleCommand("command script add -f lldbinit.cmd_arm64 arm64", res)
ci.HandleCommand("command script add -f lldbinit.cmd_armthumb armthumb", res)
# xnu kernel debug commands
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_showallkexts showallkexts", res)
# ci.HandleCommand("command script add -f lldbinit.cmd_xnu_breakpoint kbp", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_to_offset ktooff", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_list_all_process showallproc", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_find_process_by_name showproc", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_read_usr_addr readuseraddr", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_set_kdp_pmap setkdp", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_reset_kdp_pmap resetkdp", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_kdp_reboot kdp-reboot", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_show_bootargs showbootargs", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_panic_log panic_log", res)
# xnu zone commands
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_list_zone zone_list", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_zshow_logged_zone zone_show_logged_zone", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_zone_triage zone_triage", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_inspect_zone zone_inspect", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_show_chunk_at zone_show_chunk_at", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_show_chunk_with_regex zone_find_chunk_with_regex", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_find_chunk zone_find_chunk", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_zone_backtrace_at zone_backtrace_at", res)
ci.HandleCommand("command script add -f lldbinit.cmd_xnu_zone_reload zone_reload", res)
# # xnu port commands
# ci.HandleCommand("command script add -f lldbinit.cmd_xnu_show_ipc_task_port showtaskipc", res)
# ci.HandleCommand("command script add -f lldbinit.cmd_xnu_show_ports showports", res)
# xnu iokit commands
ci.HandleCommand("command script add -f lldbinit.cmd_iokit_print iokit_print", res)
ci.HandleCommand("command script add -f lldbinit.cmd_iokit_type iokit_type", res)
# xnu load kext
ci.HandleCommand("command script add -f lldbinit.cmd_addkext addkext", res)
# VMware/Virtualbox support
ci.HandleCommand("command script add -f lldbinit.cmd_vm_take_snapshot vmsnapshot", res)
ci.HandleCommand("command script add -f lldbinit.cmd_vm_reverse_snapshot vmrevert", res)
ci.HandleCommand("command script add -f lldbinit.cmd_vm_delete_snapshot vmdelsnap", res)
ci.HandleCommand("command script add -f lldbinit.cmd_vm_list_snapshot vmshowsnap", res)
ci.HandleCommand("command script add -f lldbinit.cmd_vm_show_vm vmlist", res)
ci.HandleCommand("command script add -f lldbinit.cmd_vm_select_vm vmselect", res)
# add the hook - we don't need to wait for a target to be loaded
ci.HandleCommand("target stop-hook add -o \"HandleHookStopOnTarget\"", res)
ci.HandleCommand("command script add --function lldbinit.cmd_banner banner", res)
debugger.HandleCommand("banner")
return
def cmd_banner(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
print(COLORS["RED"] + "[+] Loaded lldbinit version: " + VERSION + COLORS["RESET"])
def cmd_lldbinitcmds(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Display all available lldbinit commands.'''
help_table = [
[ "lldbinitcmds", "this command" ],
[ "enable", "configure lldb and lldbinit options" ],
[ "disable", "configure lldb and lldbinit options" ],
[ "contextcodesize", "set number of instruction lines in code window" ],
[ "b", "breakpoint address" ],
[ "bpt", "set a temporary software breakpoint" ],
[ "bhb", "set an hardware breakpoint" ],
[ "bpc", "clear breakpoint" ],
[ "bpca", "clear all breakpoints" ],
[ "bpd", "disable breakpoint" ],
[ "bpda", "disable all breakpoints" ],
[ "bpe", "enable a breakpoint" ],
[ "bpea", "enable all breakpoints" ],
[ "bcmd", "alias to breakpoint command add"],
[ "bpl", "list all breakpoints"],
[ "bpn", "temporarly breakpoint next instruction" ],
[ "break_entrypoint", "launch target and stop at entrypoint" ],
[ "skip", "skip current instruction" ],
[ "int3", "patch memory address with INT3" ],
[ "rint3", "restore original byte at address patched with INT3" ],
[ "listint3", "list all INT3 patched addresses" ],
[ "nop", "patch memory address with NOP" ],
[ "null", "patch memory address with NULL" ],
[ "stepo", "step over calls and loop instructions" ],
[ "lb", "load breakpoints from file and apply them (currently only func names are applied)" ],
[ "lbrva", "load breakpoints from file and apply to main executable, only RVA in this case" ],
[ "db/dw/dd/dq", "memory hex dump in different formats" ],
[ "findmem", "search memory" ],
[ "cfa/cfc/cfd/cfi/cfo/cfp/cfs/cft/cfz", "change CPU flags" ],
[ "u", "dump instructions" ],
[ "iphone", "connect to debugserver running on iPhone" ],
[ "ctx/context", "show current instruction pointer CPU context" ],
[ "show_loadcmds", "show otool output of Mach-O load commands" ],
[ "show_header", "show otool output of Mach-O header" ],
[ "enablesolib/disablesolib", "enable/disable the stop on library load events" ],
[ "enableaslr/disableaslr", "enable/disable process ASLR" ],
[ "datawin", "set start address to display on data window" ],
[ "asm32/asm64", "x86/x64 assembler using keystone" ],
[ "arm32/arm64/armthumb", "ARM assembler using keystone" ],
[ 'tele', 'view memory page'],
[ 'xinfo', 'find address belong to image'],
[ 'pattern_create', 'create cyclic string'],
[ 'pattern_offset', 'find offset in cyclic string'],
[ 'addkext', 'add an existed kext into kernel debug session'],
[ 'showallkexts', 'show all loaded kexts (only for xnu kernel debug)'],
[ 'kbp', 'set breakpoint at offset for specific kext (only for xnu kernel debug)'],
[ 'ktooff', 'convert current address to offset from basse address of kext (only for xnu kernel debug)'],
[ 'showallproc', 'show all running process (only for xnu kernel debug)'],
[ 'showproc', 'show specific process information of target process (only for xnu kernel debug)'],
[ 'readuseraddr', 'read userspace address (only for xnu kernel debug with kdp-remote)'],
[ 'setkdp', 'set kdp_pmap (only for xnu kernel debug with kdp-remote)'],
[ 'resetkdp', 'reset kdp_pmap (only for xnu kernel debug with kdp-remote)'],
[ 'showbootargs', 'show boot-args of macOS'],
[ 'kdp-reboot', 'reboot the remote machine'],
[ 'panic_log', 'show panic log'],
[ 'zone_list', 'list xnu zones name'],
[ 'zone_find_zones_index', 'list index of matching zone'],
[ 'zone_show_logged_zone', 'show all logged zones enable by "-zlog=<zone_name>'],
[ 'zone_triage', 'detect and print trace log for use after free/double free'],
[ 'zone_inspect', 'list all chunk in specific zone with their status'],
[ 'zone_show_chunk_at', 'find chunk address is freed or not'],
[ 'zone_find_chunk', 'find location of chunk address'],
[ 'zone_show_chunk_with_regex', 'find location of chunk address by using regex'],
[ 'zone_backtrace_at', 'list callstack of chunk if btlog is enabled'],
[ 'zone_reload', 'reload zone if network connection is failed'],
[ 'showports', 'Show all ports of given process name'],
[ 'iokit_print', 'Display readable iokit object of given address'],
[ 'iokit_type', 'Get type of iokit object of given address'],
['vmsnapshot', 'take snapshot for running virtual machine'],
['vmrevert', 'reverse snapshot for running virtual machine'],
['vmdelsnap', 'delete snapshot of running virtual machine'],
['vmshowsnap', 'show all snapshot of running virtual machine'],
['vmlist', 'list running virtual machine'],
['vmselect', 'select running virtual machine']
]
print("lldbinit available commands:")
for row in help_table:
print(" {: <20} - {: <30}".format(*row))
print("\nUse \'cmdname help\' for extended command help.")
# -------------------------
# Settings related commands
# -------------------------
def cmd_enable(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Enable certain lldb and lldbinit options. Use \'enable help\' for more information.'''
help = """
Enable certain lldb and lldbinit configuration options.
Syntax: enable <setting>
Available settings:
color: enable color mode.
solib: enable stop on library events trick.
aslr: enable process aslr.
stackwin: enable stack window in context display.
datawin: enable data window in context display, configure address with datawin.
flow: call targets and objective-c class/methods.
"""
global CONFIG_ENABLE_COLOR
global CONFIG_DISPLAY_STACK_WINDOW
global CONFIG_DISPLAY_FLOW_WINDOW
global CONFIG_DISPLAY_DATA_WINDOW
cmd = command.split()
if len(cmd) == 0:
print("[-] error: command requires arguments.")
print("")
print(help)
return
if cmd[0] == "color":
CONFIG_ENABLE_COLOR = 1
print("[+] Enabled color mode.")
elif cmd[0] == "solib":
debugger.HandleCommand("settings set target.process.stop-on-sharedlibrary-events true")
print("[+] Enabled stop on library events trick.")
elif cmd[0] == "aslr":
debugger.HandleCommand("settings set target.disable-aslr false")
print("[+] Enabled ASLR.")
elif cmd[0] == "stackwin":
CONFIG_DISPLAY_STACK_WINDOW = 1
print("[+] Enabled stack window in context display.")
elif cmd[0] == "flow":
CONFIG_DISPLAY_FLOW_WINDOW = 1
print("[+] Enabled indirect control flow window in context display.")
elif cmd[0] == "datawin":
CONFIG_DISPLAY_DATA_WINDOW = 1
print("[+] Enabled data window in context display. Configure address with \'datawin\' cmd.")
elif cmd[0] == "help":
print(help)
else:
print("[-] error: unrecognized command.")
print(help)
return
def cmd_disable(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Disable certain lldb and lldbinit options. Use \'disable help\' for more information.'''
help = """
Disable certain lldb and lldbinit configuration options.
Syntax: disable <setting>
Available settings:
color: disable color mode.
solib: disable stop on library events trick.
aslr: disable process aslr.
stackwin: disable stack window in context display.
datawin: enable data window in context display.
flow: call targets and objective-c class/methods.
"""
global CONFIG_ENABLE_COLOR
global CONFIG_DISPLAY_STACK_WINDOW
global CONFIG_DISPLAY_FLOW_WINDOW
global CONFIG_DISPLAY_DATA_WINDOW
cmd = command.split()
if len(cmd) == 0:
print("[-] error: command requires arguments.")
print("")
print(help)
return
if cmd[0] == "color":
CONFIG_ENABLE_COLOR = 0
print("[+] Disabled color mode.")
elif cmd[0] == "solib":
debugger.HandleCommand("settings set target.process.stop-on-sharedlibrary-events false")
print("[+] Disabled stop on library events trick.")
elif cmd[0] == "aslr":
debugger.HandleCommand("settings set target.disable-aslr true")
print("[+] Disabled ASLR.")
elif cmd[0] == "stackwin":
CONFIG_DISPLAY_STACK_WINDOW = 0
print("[+] Disabled stack window in context display.")
elif cmd[0] == "flow":
CONFIG_DISPLAY_FLOW_WINDOW = 0
print("[+] Disabled indirect control flow window in context display.")
elif cmd[0] == "datawin":
CONFIG_DISPLAY_DATA_WINDOW = 0
print("[+] Disabled data window in context display.")
elif cmd[0] == "help":
print(help)
else:
print("[-] error: unrecognized command.")
print(help)
return
def cmd_contextcodesize(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Set the number of disassembly lines in code window.
Use \'contextcodesize help\' for more information.'''
help = """
Configures the number of disassembly lines displayed in code window.
Syntax: contextcodesize <line_count>
Note: expressions supported, do not use spaces between operators.
"""
global CONFIG_DISASSEMBLY_LINE_COUNT
cmd = command.split()
if len(cmd) != 1:
print("[-] error: please insert the number of disassembly lines to display.")
print("")
print(help)
return
if cmd[0] == "help":
print(help)
print("\nCurrent configuration value is: {:d}".format(CONFIG_DISASSEMBLY_LINE_COUNT))
return
value = evaluate(cmd[0])
if value == None:
print("[-] error: invalid input value.")
print("")
print(help)
return
CONFIG_DISASSEMBLY_LINE_COUNT = value
return
# ---------------------------------
# Color and output related commands
# ---------------------------------
def color(x: str):
out_col = ""
if CONFIG_ENABLE_COLOR == 0:
output(out_col)
return
output(COLORS[x])
# append data to the output that we display at the end of the hook-stop
def output(x: str):
global GlobalListOutput
GlobalListOutput.append(x)
# ---------------------------
# Breakpoint related commands
# ---------------------------
# create breakpoint base on module name and offset
def cmd_m_bp(debugger: SBDebugger, command: str, result: SBCommandReturnObject, _dict: Dict):
args = command.split(' ')
if len(args) < 2:
print('mbp <module_name> <ida default mapped address>')
return
module_name = args[0]
ida_mapped_addr = evaluate(args[1])
cur_target: SBTarget = debugger.GetSelectedTarget()
target_module = find_module_by_name(cur_target, module_name)
if not target_module:
result.PutCString('Module {0} is not found'.format(module_name))
return
text_section = get_text_section(target_module)
file_base_addr = text_section.file_addr # get default address of module in file
offset = ida_mapped_addr - file_base_addr
base_addr = text_section.GetLoadAddress(cur_target) # get ASLR address when module is loaded
target_addr = base_addr + offset
cur_target.BreakpointCreateByAddress(target_addr)
result.PutCString('Done')
def cmd_to_ida_addr(debugger: SBDebugger, command: str, result: SBCommandReturnObject, _dict: Dict):
args = command.split(' ')
if len(args) < 2:
print('toida <module_name> <ida default mapped address>')
print('Convert lldb ASLR address of specific module to ida mapped address')
return
module_name = args[0]
aslr_mapped_addr = evaluate(args[1])
cur_target = debugger.GetSelectedTarget()
target_module = find_module_by_name(cur_target, module_name)
if not target_module:
result.PutCString('Module {0} is not found'.format(module_name))
return
text_section = get_text_section(target_module)
aslr_base_addr = text_section.GetLoadAddress(cur_target) # get ASLR address when module is loaded
offset = aslr_mapped_addr - aslr_base_addr
ida_base_addr = text_section.file_addr # get default address of module in file
ida_mapped_addr = ida_base_addr + offset
result.PutCString('[+] Ida mapped address of {0} : {1}'.format(module_name, hex(ida_mapped_addr)))
# temporary software breakpoint
def cmd_bpt(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Set a temporary software breakpoint. Use \'bpt help\' for more information.'''
help = """
Set a temporary software breakpoint.
Syntax: bpt <address>
Note: expressions supported, do not use spaces between operators.
"""
cmd = command.split()
if len(cmd) != 1:
print("[-] error: please insert a breakpoint address.")
print("")
print(help)
return
if cmd[0] == "help":
print(help)
return
value = evaluate(cmd[0])
if not value:
print("[-] error: invalid input value.")
print("")
print(help)
return
target = get_target()
breakpoint: lldb.SBBreakpoint = target.BreakpointCreateByAddress(value)
breakpoint.SetOneShot(True)
breakpoint.SetThreadID(get_frame().GetThread().GetThreadID())
print("[+] Set temporary breakpoint at 0x{:x}".format(value))
# hardware breakpoint
def cmd_bhb(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Set an hardware breakpoint'''
help = """
Set an hardware breakpoint.
Syntax: bhb <address>
Note: expressions supported, do not use spaces between operators.
"""
cmd = command.split()
if len(cmd) != 1:
print("[-] error: please insert a breakpoint address.")
print("")
print(help)
return
if cmd[0] == "help":
print(help)
return
value = evaluate(cmd[0])
if not value:
print("[-] error: invalid input value.")
print("")
print(help)
return
# the python API doesn't seem to support hardware breakpoints
# so we set it via command line interpreter
res = lldb.SBCommandReturnObject()
ci: SBCommandInterpreter = debugger.GetCommandInterpreter()
ci.HandleCommand("breakpoint set -H -a " + hex(value), res)
print("[+] Set hardware breakpoint at 0x{:x}".format(value))
return
# temporary hardware breakpoint
def cmd_bht(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Set a temporary hardware breakpoint'''
print("[-] error: lldb has no x86/x64 temporary hardware breakpoints implementation.")
return
# clear breakpoint number
def cmd_bpc(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Clear a breakpoint. Use \'bpc help\' for more information.'''
res = lldb.SBCommandReturnObject()
ci: SBCommandInterpreter = debugger.GetCommandInterpreter()
ci.HandleCommand(f"breakpoint delete {command}", res)
print(res.GetOutput())
# disable breakpoint number
def cmd_bpd(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
res = lldb.SBCommandReturnObject()
ci: SBCommandInterpreter = debugger.GetCommandInterpreter()
ci.HandleCommand("breakpoint disable " + command, res)
print(res.GetOutput())
# disable all breakpoints
def cmd_bpda(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Disable all breakpoints. Use \'bpda help\' for more information.'''
help = """
Disable all breakpoints.
Syntax: bpda
"""
cmd = command.split()
if len(cmd) != 0:
if cmd[0] == "help":
print(help)
return
print("[-] error: command doesn't take any arguments.")
print("")
print(help)
return
target = get_target()
if target.DisableAllBreakpoints() == False:
print("[-] error: failed to disable all breakpoints.")
print("[+] Disabled all breakpoints.")
# enable breakpoint number
def cmd_bpe(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
res = lldb.SBCommandReturnObject()
ci: SBCommandInterpreter = debugger.GetCommandInterpreter()
ci.HandleCommand("breakpoint enable " + command, res)
print(res.GetOutput())
# enable all breakpoints
def cmd_bpea(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Enable all breakpoints. Use \'bpea help\' for more information.'''
help = """
Enable all breakpoints.
Syntax: bpea
"""
cmd = command.split()
if len(cmd) != 0:
if cmd[0] == "help":
print(help)
return
print("[-] error: command doesn't take any arguments.")
print("")
print(help)
return
target = get_target()
if target.EnableAllBreakpoints() == False:
print("[-] error: failed to enable all breakpoints.")
print("[+] Enabled all breakpoints.")
# Temporarily breakpoint next instruction - this is useful to skip loops (don't want to use stepo for this purpose)
def cmd_bpn(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Temporarily breakpoint instruction at next address. Use \'bpn help\' for more information.'''
help = """
Temporarily breakpoint instruction at next address
Syntax: bpn
Note: control flow is not respected, it breakpoints next instruction in memory.
"""
cmd = command.split()
if len(cmd) != 0:
if cmd[0] == "help":
print(help)
return
print("[-] error: command doesn't take any arguments.")
print("")
print(help)
return
target = get_target()
start_addr = get_current_pc()
next_addr = start_addr + get_inst_size(start_addr)
breakpoint: SBBreakpoint = target.BreakpointCreateByAddress(next_addr)
breakpoint.SetOneShot(True)
breakpoint.SetThreadID(get_frame().GetThread().GetThreadID())
print("[+] Set temporary breakpoint at 0x{:x}".format(next_addr))
# skip current instruction - just advances PC to next instruction but doesn't execute it
def cmd_skip(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Advance PC to instruction at next address. Use \'skip help\' for more information.'''
help = """
Advance current instruction pointer to next instruction.
Syntax: skip
Note: control flow is not respected, it advances to next instruction in memory.
"""
cmd = command.split()
if len(cmd) != 0:
if cmd[0] == "help":
print(help)
return
print("[-] error: command doesn't take any arguments.")
print("")
print(help)
return
start_addr = get_current_pc()
next_addr = start_addr + get_inst_size(start_addr)
if is_x64():
get_frame().reg["rip"].value = format(next_addr, '#x')
elif is_i386():
get_frame().reg["eip"].value = format(next_addr, '#x')
# show the updated context
debugger.HandleCommand("context")
# XXX: ARM breakpoint
def cmd_int3(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Patch byte at address to an INT3 (0xCC) instruction. Use \'int3 help\' for more information.'''
help = """
Patch process memory with an INT3 byte at given address.
Syntax: int3 [<address>]
Note: useful in cases where the debugger breakpoints aren't respected but an INT3 will always trigger the debugger.
Note: ARM not yet supported.
Note: expressions supported, do not use spaces between operators.
"""
global Int3Dictionary
cmd = command.split()
# if empty insert a int3 at current PC
if len(cmd) == 0:
int3_addr = get_current_pc()
if int3_addr == 0:
print("[-] error: invalid current address.")
return
elif len(cmd) == 1:
if cmd[0] == "help":
print(help)
return
int3_addr = evaluate(cmd[0])
if not int3_addr:
print("[-] error: invalid input address value.")
print("")
print(help)
return
else:
print("[-] error: please insert a breakpoint address.")
print("")
print(help)
return
bytes_string = read_mem(int3_addr, 1)
if not len(bytes_string):
print("[-] error: Failed to read memory at 0x{:x}.".format(int3_addr))
return
bytes_read = bytearray(bytes_string)
patch_byte = b'\xCC'
if write_mem(int3_addr, patch_byte) == 0:
print("[-] error: Failed to write memory at 0x{:x}.".format(int3_addr))
return
# save original bytes for later restore
Int3Dictionary[int3_addr] = bytes_read[0]
print("[+] Patched INT3 at 0x{:x}".format(int3_addr))
def cmd_rint3(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''Restore byte at address from a previously patched INT3 (0xCC) instruction. Use \'rint3 help\' for more information.'''
help = """
Restore the original byte at a previously patched address using \'int3\' command.
Syntax: rint3 [<address>]
Note: expressions supported, do not use spaces between operators.
"""
global Int3Dictionary
cmd = command.split()
# if empty insert a int3 at current PC
if len(cmd) == 0:
int3_addr = get_current_pc()
if int3_addr == 0:
print("[-] error: invalid current address.")
return
elif len(cmd) == 1:
if cmd[0] == "help":
print(help)
return
int3_addr = evaluate(cmd[0])
if not int3_addr:
print("[-] error: invalid input address value.")
print("")
print(help)
return
else:
print("[-] error: please insert a INT3 patched address.")
print("")
print(help)
return
if len(Int3Dictionary) == 0:
print("[-] error: No INT3 patched addresses to restore available.")
return
bytes_string = read_mem(int3_addr, 1)
if not len(bytes_string):
print("[-] error: Failed to read memory at 0x{:x}.".format(int3_addr))
return
bytes_read = bytearray(bytes_string)
if bytes_read[0] == 0xCC:
#print("Found byte patched byte at 0x{:x}".format(int3_addr))
try:
original_byte = Int3Dictionary[int3_addr]
except:
print("[-] error: Original byte for address 0x{:x} not found.".format(int3_addr))
return
if write_mem(int3_addr, bytearray([original_byte])) == 0:
print("[-] error: Failed to write memory at 0x{:x}.".format(int3_addr))
return
# remove element from original bytes list
del Int3Dictionary[int3_addr]
else:
print("[-] error: No INT3 patch found at 0x{:x}.".format(int3_addr))
def cmd_listint3(debugger: SBDebugger, command: str, result: SBCommandReturnObject, dict: Dict):
'''List all patched INT3 (0xCC) instructions. Use \'listint3 help\' for more information.'''
help = """
List all addresses patched with \'int3\' command.
Syntax: listint3
"""
cmd = command.split()
if len(cmd) != 0:
if cmd[0] == "help":
print(help)
return