-
Notifications
You must be signed in to change notification settings - Fork 281
Expand file tree
/
Copy pathmicrosoft.cpp
More file actions
848 lines (729 loc) · 35.6 KB
/
microsoft.cpp
File metadata and controls
848 lines (729 loc) · 35.6 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
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
#include "microsoft.h"
#include <chrono>
using namespace BinaryNinja;
using namespace BinaryNinja::RTTI;
using namespace BinaryNinja::RTTI::Microsoft;
constexpr int COL_SIG_REV0 = 0;
constexpr int COL_SIG_REV1 = 1;
constexpr int BCD_HASPCHD = 0x40;
constexpr const char *TYPE_SOURCE_MICROSOFT = "rtti_microsoft";
// This is used internally when processing a `CompleteObjectLocator`.
struct CompleteObjectLocatorInfo
{
uint64_t classOffset = 0;
std::optional<std::string> baseClassName;
std::optional<uint64_t> baseVft;
};
ClassHierarchyDescriptor::ClassHierarchyDescriptor(BinaryView *view, uint64_t address)
{
BinaryReader reader = BinaryReader(view);
reader.Seek(address);
signature = reader.Read32();
attributes = reader.Read32();
numBaseClasses = reader.Read32();
pBaseClassArray = static_cast<int32_t>(reader.Read32());
}
BaseClassDescriptor::BaseClassDescriptor(BinaryView *view, uint64_t address)
{
BinaryReader reader = BinaryReader(view);
reader.Seek(address);
pTypeDescriptor = static_cast<int32_t>(reader.Read32());
numContainedBases = reader.Read32();
where_mdisp = static_cast<int32_t>(reader.Read32());
where_pdisp = static_cast<int32_t>(reader.Read32());
where_vdisp = static_cast<int32_t>(reader.Read32());
attributes = reader.Read32();
pClassHierarchyDescriptor = static_cast<int32_t>(reader.Read32());
}
BaseClassArray::BaseClassArray(BinaryView *view, uint64_t address, uint32_t length) : length(length)
{
BinaryReader reader = BinaryReader(view);
reader.Seek(address);
descriptors = {};
for (size_t i = 0; i < length; i++)
descriptors.emplace_back(reader.Read32());
}
TypeDescriptor::TypeDescriptor(BinaryView *view, uint64_t address)
{
BinaryReader reader = BinaryReader(view);
reader.Seek(address);
pVFTable = reader.ReadPointer();
spare = reader.ReadPointer();
name = reader.ReadCString(512);
}
CompleteObjectLocator::CompleteObjectLocator(BinaryView *view, uint64_t address)
{
BinaryReader reader = BinaryReader(view);
reader.Seek(address);
signature = reader.Read32();
offset = reader.Read32();
cdOffset = reader.Read32();
pTypeDescriptor = static_cast<int32_t>(reader.Read32());
pClassHierarchyDescriptor = static_cast<int32_t>(reader.Read32());
if (signature == COL_SIG_REV1)
{
pSelf = static_cast<int32_t>(reader.Read32());
}
else
{
pSelf = 0;
}
}
std::optional<CompleteObjectLocator> ReadCompleteObjectorLocator(BinaryView *view, uint64_t address)
{
auto coLocator = CompleteObjectLocator(view, address);
uint64_t startAddr = view->GetOriginalImageBase();
auto outsideSection = [&](uint64_t addr) {
return view->GetSectionsAt(addr).empty();
};
if (coLocator.signature > 1)
return std::nullopt;
if (coLocator.signature == COL_SIG_REV1)
{
if (coLocator.pSelf + startAddr != address)
return std::nullopt;
// Relative addrs
if (outsideSection(coLocator.pTypeDescriptor + startAddr))
return std::nullopt;
if (outsideSection(coLocator.pClassHierarchyDescriptor + startAddr))
return std::nullopt;
}
else
{
// Absolute addrs
if (outsideSection(coLocator.pTypeDescriptor))
return std::nullopt;
if (outsideSection(coLocator.pClassHierarchyDescriptor))
return std::nullopt;
}
return coLocator;
}
Ref<Type> GetPMDType(BinaryView *view)
{
auto typeId = Type::GenerateAutoTypeId(TYPE_SOURCE_MICROSOFT, QualifiedName("PMD"));
Ref<Type> typeCache = view->GetTypeById(typeId);
if (typeCache == nullptr)
{
Ref<Type> intType = Type::IntegerType(4, true);
StructureBuilder pmdBuilder;
pmdBuilder.AddMember(intType, "mdisp");
pmdBuilder.AddMember(intType, "pdisp");
pmdBuilder.AddMember(intType, "vdisp");
view->DefineType(typeId, QualifiedName("_PMD"), TypeBuilder::StructureType(pmdBuilder.Finalize()).Finalize());
typeCache = view->GetTypeById(typeId);
}
return typeCache;
}
Ref<Type> ClassHierarchyDescriptorType(BinaryView *view, BNPointerBaseType ptrBaseTy);
Ref<Type> BaseClassDescriptorType(BinaryView *view, BNPointerBaseType ptrBaseTy)
{
auto typeId = Type::GenerateAutoTypeId(TYPE_SOURCE_MICROSOFT, QualifiedName("RTTIBaseClassDescriptor"));
Ref<Type> typeCache = view->GetTypeById(typeId);
if (typeCache == nullptr)
{
Ref<Architecture> arch = view->GetDefaultArchitecture();
Ref<Type> uintType = Type::IntegerType(4, false);
StructureBuilder baseClassDescriptorBuilder;
// Would require creating a new type for every type descriptor length. Instead just use void*
Ref<Type> pTypeDescType = TypeBuilder::PointerType(4, Type::VoidType())
.SetPointerBase(ptrBaseTy, 0)
.Finalize();
baseClassDescriptorBuilder.AddMember(pTypeDescType, "pTypeDescriptor");
baseClassDescriptorBuilder.AddMember(uintType, "numContainedBases");
baseClassDescriptorBuilder.AddMember(GetPMDType(view), "where");
Ref<Enumeration> attrEnum = EnumerationBuilder()
.AddMemberWithValue("BCD_NOT_VISIBLE", 0x01)
.AddMemberWithValue("BCD_AMBIGUOUS", 0x02)
.AddMemberWithValue("BCD_PRIVORPROTBASE", 0x04)
.AddMemberWithValue("BCD_PRIVORPROTINCOMPOBJ", 0x08)
.AddMemberWithValue("BCD_VBOFCONTOBJ", 0x10)
.AddMemberWithValue("BCD_NONPOLYMORPHIC", 0x20)
.AddMemberWithValue("BCD_HASPCHD", 0x40)
.Finalize();
Ref<Type> attrType = Type::EnumerationType(arch, attrEnum, 4);
baseClassDescriptorBuilder.AddMember(attrType, "attributes");
Ref<Type> pClassDescType = TypeBuilder::PointerType(4, ClassHierarchyDescriptorType(view, ptrBaseTy))
.SetPointerBase(ptrBaseTy, 0)
.Finalize();
baseClassDescriptorBuilder.AddMember(pClassDescType, "pClassDescriptor");
view->DefineType(typeId, QualifiedName("_RTTIBaseClassDescriptor"),
TypeBuilder::StructureType(baseClassDescriptorBuilder.Finalize()).Finalize());
typeCache = view->GetTypeById(typeId);
}
return typeCache;
}
Ref<Type> BaseClassArrayType(BinaryView *view, const uint64_t length, BNPointerBaseType ptrBaseTy)
{
StructureBuilder baseClassArrayBuilder;
Ref<Type> pBaseClassDescType = TypeBuilder::PointerType(4, BaseClassDescriptorType(view, ptrBaseTy))
.SetPointerBase(ptrBaseTy, 0)
.Finalize();
baseClassArrayBuilder.AddMember(
Type::ArrayType(pBaseClassDescType, length), "arrayOfBaseClassDescriptors");
return TypeBuilder::StructureType(baseClassArrayBuilder.Finalize()).Finalize();
}
Ref<Type> ClassHierarchyDescriptorType(BinaryView *view, BNPointerBaseType ptrBaseTy)
{
auto typeId = Type::GenerateAutoTypeId(TYPE_SOURCE_MICROSOFT, QualifiedName("RTTIClassHierarchyDescriptor"));
Ref<Type> typeCache = view->GetTypeById(typeId);
if (typeCache == nullptr)
{
Ref<Architecture> arch = view->GetDefaultArchitecture();
Ref<Type> uintType = Type::IntegerType(4, false);
StructureBuilder classHierarchyDescriptorBuilder;
classHierarchyDescriptorBuilder.AddMember(uintType, "signature");
Ref<Enumeration> attrEnum = EnumerationBuilder()
.AddMemberWithValue("CHD_MULTINH", 0x01)
.AddMemberWithValue("CHD_VIRTINH", 0x02)
.AddMemberWithValue("CHD_AMBIGUOUS", 0x04)
.Finalize();
Ref<Type> attrType = Type::EnumerationType(arch, attrEnum, 4);
classHierarchyDescriptorBuilder.AddMember(attrType, "attributes");
classHierarchyDescriptorBuilder.AddMember(uintType, "numBaseClasses");
Ref<Type> pBaseClassArrayType = TypeBuilder::PointerType(4, Type::VoidType())
.SetPointerBase(ptrBaseTy, 0)
.Finalize();
classHierarchyDescriptorBuilder.AddMember(pBaseClassArrayType, "pBaseClassArray");
view->DefineType(typeId, QualifiedName("_RTTIClassHierarchyDescriptor"),
TypeBuilder::StructureType(classHierarchyDescriptorBuilder.Finalize()).Finalize());
typeCache = view->GetTypeById(typeId);
}
return typeCache;
}
Ref<Type> CompleteObjectLocator64Type(BinaryView *view)
{
auto typeId = Type::GenerateAutoTypeId(TYPE_SOURCE_MICROSOFT, QualifiedName("RTTICompleteObjectLocator64"));
Ref<Type> typeCache = view->GetTypeById(typeId);
if (typeCache == nullptr)
{
Ref<Architecture> arch = view->GetDefaultArchitecture();
Ref<Type> uintType = Type::IntegerType(4, false);
StructureBuilder completeObjectLocatorBuilder;
Ref<Enumeration> sigEnum = EnumerationBuilder()
.AddMemberWithValue("COL_SIG_REV0", 0)
.AddMemberWithValue("COL_SIG_REV1", 1)
.Finalize();
Ref<Type> sigType = Type::EnumerationType(arch, sigEnum, 4);
completeObjectLocatorBuilder.AddMember(sigType, "signature");
completeObjectLocatorBuilder.AddMember(uintType, "offset");
completeObjectLocatorBuilder.AddMember(uintType, "cdOffset");
Ref<Type> pTypeDescType = TypeBuilder::PointerType(4, Type::VoidType())
.SetPointerBase(RelativeToBinaryStartPointerBaseType, 0)
.Finalize();
completeObjectLocatorBuilder.AddMember(pTypeDescType, "pTypeDescriptor");
Ref<Type> pClassHierarchyDescType = TypeBuilder::PointerType(
4, ClassHierarchyDescriptorType(view, RelativeToBinaryStartPointerBaseType))
.SetPointerBase(RelativeToBinaryStartPointerBaseType, 0)
.Finalize();
completeObjectLocatorBuilder.AddMember(pClassHierarchyDescType, "pClassHierarchyDescriptor");
Ref<Type> pSelfType = TypeBuilder::PointerType(4, Type::NamedType(view, typeId))
.SetPointerBase(RelativeToBinaryStartPointerBaseType, 0)
.Finalize();
completeObjectLocatorBuilder.AddMember(pSelfType, "pSelf");
view->DefineType(typeId, QualifiedName("_RTTICompleteObjectLocator"),
TypeBuilder::StructureType(completeObjectLocatorBuilder.Finalize()).Finalize());
typeCache = view->GetTypeById(typeId);
}
return typeCache;
}
Ref<Type> CompleteObjectLocator32Type(BinaryView *view)
{
auto typeId = Type::GenerateAutoTypeId(TYPE_SOURCE_MICROSOFT, QualifiedName("RTTICompleteObjectLocator32"));
Ref<Type> typeCache = view->GetTypeById(typeId);
if (typeCache == nullptr)
{
Ref<Architecture> arch = view->GetDefaultArchitecture();
Ref<Type> uintType = Type::IntegerType(4, false);
StructureBuilder completeObjectLocatorBuilder;
Ref<Enumeration> sigEnum = EnumerationBuilder()
.AddMemberWithValue("COL_SIG_REV0", 0)
.AddMemberWithValue("COL_SIG_REV1", 1)
.Finalize();
Ref<Type> sigType = Type::EnumerationType(arch, sigEnum, 4);
completeObjectLocatorBuilder.AddMember(sigType, "signature");
completeObjectLocatorBuilder.AddMember(uintType, "offset");
completeObjectLocatorBuilder.AddMember(uintType, "cdOffset");
Ref<Type> pTypeDescType = TypeBuilder::PointerType(4, Type::VoidType())
.Finalize();
completeObjectLocatorBuilder.AddMember(pTypeDescType, "pTypeDescriptor");
Ref<Type> pClassHierarchyDescType = TypeBuilder::PointerType(
4, ClassHierarchyDescriptorType(view, AbsolutePointerBaseType))
.Finalize();
completeObjectLocatorBuilder.AddMember(pClassHierarchyDescType, "pClassHierarchyDescriptor");
view->DefineType(typeId, QualifiedName("_RTTICompleteObjectLocator"),
TypeBuilder::StructureType(completeObjectLocatorBuilder.Finalize()).Finalize());
typeCache = view->GetTypeById(typeId);
}
return typeCache;
}
Ref<Type> TypeDescriptorType(BinaryView *view, uint64_t length)
{
size_t addrSize = view->GetAddressSize();
StructureBuilder typeDescriptorBuilder;
typeDescriptorBuilder.AddMember(Type::PointerType(addrSize, Type::VoidType(), true), "pVFTable");
typeDescriptorBuilder.AddMember(Type::PointerType(addrSize, Type::VoidType()), "spare");
// Char array needs to be individually resized.
typeDescriptorBuilder.AddMember(Type::ArrayType(Type::IntegerType(1, true, "char"), length), "name");
return TypeBuilder::StructureType(typeDescriptorBuilder.Finalize()).Finalize();
}
std::vector<BaseClassInfo> MicrosoftRTTIProcessor::ProcessClassHierarchyDescriptor(uint64_t address, CompleteObjectLocator &coLocator, const ClassInfo &classInfo)
{
auto startAddr = m_view->GetOriginalImageBase();
auto resolveAddr = [&](const uint64_t relAddr) {
return coLocator.signature == COL_SIG_REV1 ? startAddr + relAddr : relAddr;
};
auto ptrBaseTy = coLocator.signature ? RelativeToBinaryStartPointerBaseType : AbsolutePointerBaseType;
auto classHierarchyDesc = ClassHierarchyDescriptor(m_view, address);
auto classHierarchyDescName = fmt::format("{}::`RTTI Class Hierarchy Descriptor'", classInfo.className);
m_view->DefineAutoSymbol(new Symbol{DataSymbol, classHierarchyDescName, address});
m_view->DefineDataVariable(address,
Confidence(ClassHierarchyDescriptorType(m_view, ptrBaseTy), RTTI_CONFIDENCE));
auto baseClassArrayAddr = resolveAddr(classHierarchyDesc.pBaseClassArray);
auto baseClassArray = BaseClassArray(m_view, baseClassArrayAddr, classHierarchyDesc.numBaseClasses);
auto baseClassArrayName = fmt::format("{}::`RTTI Base Class Array'", classInfo.className);
m_view->DefineAutoSymbol(new Symbol{DataSymbol, baseClassArrayName, baseClassArrayAddr});
m_view->DefineDataVariable(baseClassArrayAddr,
Confidence(BaseClassArrayType(m_view, baseClassArray.length, ptrBaseTy),
RTTI_CONFIDENCE));
std::vector<BaseClassInfo> baseClasses = {};
for (auto pBaseClassDescAddr: baseClassArray.descriptors)
{
auto baseClassDescAddr = resolveAddr(pBaseClassDescAddr);
auto baseClassDesc = BaseClassDescriptor(m_view, baseClassDescAddr);
auto baseClassTypeDescAddr = resolveAddr(baseClassDesc.pTypeDescriptor);
if (baseClassTypeDescAddr == 0)
{
// Fixes issue https://github.com/Vector35/binaryninja-api/issues/6837
m_logger->LogWarnF("Skipping BaseClassDescriptor with null pTypeDescriptor {:#x}", baseClassDescAddr);
continue;
}
auto baseClassTypeDesc = TypeDescriptor(m_view, baseClassTypeDescAddr);
auto baseClassName = DemangleNameMS(m_view, allowMangledClassNames, baseClassTypeDesc.name);
if (!baseClassName.has_value())
{
m_logger->LogWarnF("Skipping BaseClassDescriptor with mangled name {:#x}", baseClassTypeDescAddr);
continue;
}
BaseClassInfo baseClassInfo = {baseClassName.value(), (uint64_t)baseClassDesc.where_mdisp};
auto baseClassDescName = fmt::format("{}::`RTTI Base Class Descriptor at ({},{},{},{})", baseClassInfo.className,
baseClassDesc.where_mdisp, baseClassDesc.where_pdisp,
baseClassDesc.where_vdisp, baseClassDesc.attributes);
m_view->DefineAutoSymbol(new Symbol{DataSymbol, baseClassDescName, baseClassDescAddr});
m_view->DefineDataVariable(baseClassDescAddr,
Confidence(BaseClassDescriptorType(m_view, ptrBaseTy), RTTI_CONFIDENCE));
auto baseClassTypeDescSymName = fmt::format("class {} `RTTI Type Descriptor'", baseClassInfo.className);
m_view->DefineAutoSymbol(new Symbol{DataSymbol, baseClassTypeDescSymName, baseClassTypeDescAddr});
m_view->DefineDataVariable(baseClassTypeDescAddr,
Confidence(TypeDescriptorType(m_view, baseClassTypeDesc.name.length()), RTTI_CONFIDENCE));
// If we are not dealing with are own class we should add it as a base class.
if (baseClassDesc.where_mdisp != 0 || baseClassInfo.className != classInfo.className)
{
if (baseClassDesc.attributes & BCD_HASPCHD) {
baseClasses.emplace_back(baseClassInfo);
}
}
}
return baseClasses;
}
std::optional<ClassInfo> MicrosoftRTTIProcessor::ProcessRTTI(uint64_t coLocatorAddr)
{
auto coLocator = ReadCompleteObjectorLocator(m_view, coLocatorAddr);
if (!coLocator.has_value())
return std::nullopt;
auto startAddr = m_view->GetOriginalImageBase();
auto resolveAddr = [&](const uint64_t relAddr) {
return coLocator->signature == COL_SIG_REV1 ? startAddr + relAddr : relAddr;
};
// Get type descriptor then check to see if the class name was demangled.
auto typeDescAddr = resolveAddr(coLocator->pTypeDescriptor);
auto typeDesc = TypeDescriptor(m_view, typeDescAddr);
auto className = DemangleNameMS(m_view, allowMangledClassNames, typeDesc.name);
if (!className.has_value())
return std::nullopt;
// If the className is empty we will change it to the address, this is to fix type clobbering.
if (className->empty())
{
if (!allowAnonymousClassNames)
{
m_logger->LogDebugF("Skipping CompleteObjectorLocator with anonymous name {:#x}", coLocatorAddr);
return std::nullopt;
}
className = fmt::format("anonymous_{:#x}", coLocatorAddr);
}
auto classInfo = ClassInfo{RTTIProcessorType::Microsoft, className.value()};
auto classHierarchyDescAddr = resolveAddr(coLocator->pClassHierarchyDescriptor);
// Verify the class hierarchy descriptor signature is zero.
auto reader = BinaryReader(m_view);
reader.Seek(classHierarchyDescAddr);
if (auto signature = reader.Read32(); signature != 0)
{
m_logger->LogWarnF("Skipping CompleteObjectorLocator with non-zero hierarchy descriptor signature {:#x}", coLocatorAddr);
return std::nullopt;
}
classInfo.baseClasses = ProcessClassHierarchyDescriptor(classHierarchyDescAddr, coLocator.value(), classInfo);
// Locate the current base class if we are in one.
std::optional<BaseClassInfo> currentBaseClass;
if (coLocator->offset > 0)
{
for (const auto &baseClassInfo: classInfo.baseClasses)
{
if (baseClassInfo.className != classInfo.className
&& baseClassInfo.offset == coLocator->offset)
{
currentBaseClass = baseClassInfo;
break;
}
}
}
auto typeDescSymName = fmt::format("class {} `RTTI Type Descriptor'", classInfo.className);
m_view->DefineAutoSymbol(new Symbol{DataSymbol, typeDescSymName, typeDescAddr});
m_view->DefineDataVariable(typeDescAddr,
Confidence(TypeDescriptorType(m_view, typeDesc.name.length()), RTTI_CONFIDENCE));
auto coLocatorName = fmt::format("{}::`RTTI Complete Object Locator'", className.value());
if (currentBaseClass.has_value())
coLocatorName += fmt::format("{{for `{}'}}", currentBaseClass->className);
m_view->DefineAutoSymbol(new Symbol{DataSymbol, coLocatorName, coLocatorAddr});
if (coLocator->signature == COL_SIG_REV1)
m_view->DefineDataVariable(coLocatorAddr, Confidence(CompleteObjectLocator64Type(m_view), RTTI_CONFIDENCE));
else
m_view->DefineDataVariable(coLocatorAddr, Confidence(CompleteObjectLocator32Type(m_view), RTTI_CONFIDENCE));
return classInfo;
}
std::optional<VirtualFunctionTableInfo> MicrosoftRTTIProcessor::ProcessVFT(uint64_t vftAddr, ClassInfo &classInfo, std::optional<BaseClassInfo> baseClassInfo)
{
VirtualFunctionTableInfo vftInfo = {vftAddr};
// Virtual functions and the analysis object of it, if it exists.
std::vector<std::pair<uint64_t, std::optional<Ref<Function>>>> virtualFunctions = {};
uint64_t currentVftEntry = vftAddr;
while (true)
{
uint64_t vFuncAddr = 0;
const FunctionDiscoverState state = DiscoverVirtualFunction(currentVftEntry, vFuncAddr);
if (state == FunctionDiscoverState::Failed)
break;
currentVftEntry += m_view->GetAddressSize();
Ref<Platform> vftPlatform = m_view->GetDefaultPlatform()->GetAssociatedPlatformByAddress(vFuncAddr);
Ref<Function> vFunc = m_view->GetAnalysisFunction(vftPlatform, vFuncAddr);
virtualFunctions.emplace_back(vFuncAddr, vFunc ? std::optional(vFunc) : std::nullopt);
}
if (virtualFunctions.empty())
{
m_logger->LogDebugF("Skipping empty virtual function table... {:#x}", vftAddr);
return std::nullopt;
}
for (auto &[vFuncAddr, _]: virtualFunctions)
vftInfo.virtualFunctions.emplace_back(VirtualFunctionInfo{vFuncAddr});
// Create virtual function table type
auto vftTypeName = fmt::format("{}::VTable", classInfo.className);
if (baseClassInfo.has_value())
{
// TODO: What is the correct form for the name?
vftTypeName = fmt::format("{}::{}", baseClassInfo->className, vftTypeName);
}
// TODO: Hack the debug type id is used here to allow the PDB type (debug info) to overwrite the RTTI vtable type.
auto typeId = Type::GenerateAutoDebugTypeId(vftTypeName);
Ref<Type> vftType = m_view->GetTypeById(typeId);
if (vftType == nullptr)
{
size_t addrSize = m_view->GetAddressSize();
StructureBuilder vftBuilder = {};
vftBuilder.SetPropagateDataVariableReferences(true);
size_t vFuncIdx = 0;
// Until https://github.com/Vector35/binaryninja-api/issues/5982 is fixed
auto vftSize = virtualFunctions.size() * addrSize;
vftBuilder.SetWidth(vftSize);
if (baseClassInfo.has_value() && baseClassInfo->vft.has_value())
{
if (baseClassInfo->vft->virtualFunctions.size() <= virtualFunctions.size())
{
// Adjust the current vFunc index to the end of the shared vFuncs.
vFuncIdx = baseClassInfo->vft->virtualFunctions.size();
virtualFunctions.erase(virtualFunctions.begin(), virtualFunctions.begin() + vFuncIdx);
// We should set the vtable as a base class so that xrefs are propagated (among other things).
// NOTE: this means that `this` params will be assumed pre-adjusted, this is normally fine assuming type propagation
// NOTE: never occurs on the vft types. Other-wise we need to change this.
auto baseVftTypeName = fmt::format("{}::VTable", baseClassInfo->className);
NamedTypeReferenceBuilder baseVftNTR;
baseVftNTR.SetName(baseVftTypeName);
// Width is unresolved here so that we can keep non-base vfuncs un-inherited.
auto baseVftSize = vFuncIdx * addrSize;
vftBuilder.SetBaseStructures({ BaseStructure(baseVftNTR.Finalize(), 0, baseVftSize) });
}
else
{
LogWarnF("Skipping adjustments for base VFT with more functions than sub VFT... {:#x}", vftAddr);
}
}
for (auto &&[_, vFunc]: virtualFunctions)
{
auto vFuncName = fmt::format("vFunc_{}", vFuncIdx);
if (vFunc.has_value())
{
// If we have a better name, use it.
auto vFuncObj = vFunc.value();
auto vFuncSymName = vFuncObj->GetSymbol()->GetShortName();
if (vFuncSymName.compare(0, 4, "sub_") != 0)
vFuncName = vFuncObj->GetSymbol()->GetShortName();
// MyClass::func -> func
std::size_t pos = vFuncName.rfind("::");
if (pos != std::string::npos)
vFuncName = vFuncName.substr(pos + 2);
}
// NOTE: The analyzed function type might not be available here.
auto vFuncOffset = vFuncIdx * addrSize;
// We have access to a backing function type, use it, otherwise void!
auto vFuncType = vFunc.has_value() ? vFunc.value()->GetType() : Type::VoidType();
vftBuilder.AddMemberAtOffset(
Type::PointerType(addrSize, vFuncType, true), vFuncName, vFuncOffset);
vFuncIdx++;
}
// TODO: Hack, we have a base class at 0 we are defining, meaning we never get the MyClass::VTable
// TODO: Only the MyBase::MyClass::VTable, and people who reference this type dont know that the appropriate type is the
// TODO: MyBase::MyClass::VTable, we should create a fake vtable for this type to redirect to the correct 0 offset base class type.
if (baseClassInfo.has_value() && baseClassInfo->offset == 0)
{
NamedTypeReferenceBuilder namedTypeRef;
namedTypeRef.SetName(vftTypeName);
namedTypeRef.SetTypeId(typeId);
auto rootRedirectType = Confidence(Type::NamedType(namedTypeRef.Finalize()), RTTI_CONFIDENCE);
auto rootRedirectName = fmt::format("{}::VTable", classInfo.className);
auto redirectTypeId = Type::GenerateAutoDebugTypeId(rootRedirectName);
// This will now create the redirect type MyClass::VTable for uninformed analysis to use.
// MyClass -> MyBase::MyClass::VTable (when MyBase offset is 0).
m_view->DefineType(redirectTypeId, rootRedirectName, rootRedirectType.GetValue());
}
m_view->DefineType(typeId, vftTypeName, TypeBuilder::StructureType(vftBuilder.Finalize()).Finalize());
}
auto vftName = fmt::format("{}::`vftable'", classInfo.className);
if (baseClassInfo.has_value())
vftName += fmt::format("{{for `{}'}}", baseClassInfo->className);
m_view->DefineAutoSymbol(new Symbol {DataSymbol, vftName, vftAddr});
m_view->DefineDataVariable(vftAddr, Confidence(Type::NamedType(m_view, vftTypeName), RTTI_CONFIDENCE));
return vftInfo;
}
MicrosoftRTTIProcessor::MicrosoftRTTIProcessor(const Ref<BinaryView> &view, bool useMangled, bool checkRData, bool vftSweep, bool allowAnonymous)
{
m_view = view;
m_logger = view->CreateLogger("Microsoft RTTI");
allowMangledClassNames = useMangled;
allowAnonymousClassNames = allowAnonymous;
checkWritableRData = checkRData;
m_classInfo = {};
virtualFunctionTableSweep = vftSweep;
auto metadata = view->QueryMetadata(VIEW_METADATA_RTTI);
if (metadata != nullptr)
{
// Load in metadata to the processor.
DeserializedMetadata(RTTIProcessorType::Microsoft, metadata);
}
}
void MicrosoftRTTIProcessor::ProcessRTTI()
{
Ref<BackgroundTask> bgTask = new BackgroundTask("Scanning for Microsoft RTTI...", true);
auto start_time = std::chrono::high_resolution_clock::now();
uint64_t startAddr = m_view->GetOriginalImageBase();
uint64_t endAddr = m_view->GetEnd();
BinaryReader optReader = BinaryReader(m_view);
auto addrSize = m_view->GetAddressSize();
auto scan = [&](const Ref<Segment> &segment) {
for (uint64_t coLocatorAddr = segment->GetStart(); coLocatorAddr < segment->GetEnd() - 0x18;
coLocatorAddr += addrSize)
{
if (bgTask->IsCancelled())
break;
optReader.Seek(coLocatorAddr);
uint32_t sigVal = optReader.Read32();
if (sigVal == COL_SIG_REV1)
{
// Check for self reference
optReader.SeekRelative(16);
if (optReader.Read32() == coLocatorAddr - startAddr)
{
if (auto classInfo = ProcessRTTI(coLocatorAddr))
m_classInfo[coLocatorAddr] = classInfo.value();
}
}
else if (sigVal == COL_SIG_REV0)
{
// Check ?AV
optReader.SeekRelative(8);
uint64_t typeDescNameAddr = optReader.Read32() + 8;
if (typeDescNameAddr > startAddr && typeDescNameAddr < endAddr)
{
// Make sure we do not read across segment boundary.
auto typeDescSegment = m_view->GetSegmentAt(typeDescNameAddr);
if (typeDescSegment != nullptr && typeDescSegment->GetEnd() - typeDescNameAddr > 4)
{
optReader.Seek(typeDescNameAddr);
auto typeDescNameStart = optReader.ReadString(4);
if (typeDescNameStart == ".?AV" || typeDescNameStart == ".?AU" || typeDescNameStart == ".?AW")
{
if (auto classInfo = ProcessRTTI(coLocatorAddr))
m_classInfo[coLocatorAddr] = classInfo.value();
}
}
}
}
}
};
// Scan data sections for colocators.
auto rdataSection = m_view->GetSectionByName(".rdata");
for (const Ref<Segment> &segment: m_view->GetSegments())
{
if (segment->GetFlags() == (SegmentReadable | SegmentContainsData))
{
// If a malformed binary makes the binary view set up unbacked segments we should not attempt to read in them.
if (m_view->ReadBuffer(segment->GetStart(), 4).GetLength() != 4)
{
m_logger->LogInfoF("Unbacked start for segment {:#x}... skipping", segment->GetStart());
continue;
}
m_logger->LogDebugF("Attempting to find RTTI in segment {:#x}", segment->GetStart());
try
{
scan(segment);
}
catch (std::exception &e)
{
m_logger->LogWarnF("Unhandled exception in segment scan {:#x} {}", segment->GetStart(), e.what());
}
}
else if (checkWritableRData && rdataSection && rdataSection->GetStart() == segment->GetStart())
{
m_logger->LogDebugF("Attempting to find RTTI in writable rdata segment {:#x}",
segment->GetStart());
try
{
scan(segment);
}
catch (std::exception &e)
{
m_logger->LogWarnF("Unhandled exception in writable segment scan {:#x} {}", segment->GetStart(), e.what());
}
}
}
bgTask->Finish();
auto end_time = std::chrono::high_resolution_clock::now();
std::chrono::duration<double> elapsed_time = end_time - start_time;
m_logger->LogDebugF("ProcessRTTI took {} seconds", elapsed_time.count());
}
void MicrosoftRTTIProcessor::ProcessVFT()
{
Ref<BackgroundTask> bgTask = new BackgroundTask("Scanning for Microsoft VFT...", true);
std::map<uint64_t, uint64_t> vftMap = {};
std::unordered_set<uint64_t> vftFinished = {};
auto start_time = std::chrono::high_resolution_clock::now();
for (auto &[coLocatorAddr, classInfo]: m_classInfo)
{
for (auto &ref: m_view->GetDataReferences(coLocatorAddr))
{
auto vftAddr = ref + m_view->GetAddressSize();
vftMap[coLocatorAddr] = vftAddr;
}
}
if (virtualFunctionTableSweep && !m_classInfo.empty())
{
BinaryReader optReader = BinaryReader(m_view);
auto addrSize = m_view->GetAddressSize();
auto scan = [&](const Ref<Segment> &segment) {
uint64_t startAddr = segment->GetStart();
uint64_t endAddr = segment->GetEnd();
for (uint64_t vtableAddr = startAddr; vtableAddr < endAddr - 0x18; vtableAddr += addrSize)
{
if (bgTask->IsCancelled())
break;
optReader.Seek(vtableAddr);
uint64_t coLocatorAddr = optReader.ReadPointer();
auto coLocator = m_classInfo.find(coLocatorAddr);
if (coLocator == m_classInfo.end())
continue;
// Found a vtable reference to colocator.
vftMap[coLocatorAddr] = vtableAddr + addrSize;
}
};
// Scan data sections for virtual function tables.
auto rdataSection = m_view->GetSectionByName(".rdata");
for (const Ref<Segment> &segment: m_view->GetSegments())
{
if (bgTask->IsCancelled())
break;
if (segment->GetFlags() == (SegmentReadable | SegmentContainsData))
{
m_logger->LogDebugF("Attempting to find VirtualFunctionTables in segment {:#x}", segment->GetStart());
try
{
scan(segment);
}
catch (std::exception &e)
{
m_logger->LogWarnF("Unhandled exception in vtable segment scan {:#x} {}", segment->GetStart(), e.what());
}
}
else if (checkWritableRData && rdataSection && rdataSection->GetStart() == segment->GetStart())
{
m_logger->LogDebugF("Attempting to find VirtualFunctionTables in writable rdata segment {:#x}",
segment->GetStart());
try
{
scan(segment);
}
catch (std::exception &e)
{
m_logger->LogWarnF("Unhandled exception in vtable writable segment scan {:#x} {}", segment->GetStart(), e.what());
}
}
}
}
std::function<void(uint64_t)> processClassAndBases = [&](uint64_t coLocatorAddr) -> void {
auto& classInfo = m_classInfo[coLocatorAddr];
uint64_t vftAddr = vftMap[coLocatorAddr];
if (vftFinished.find(vftAddr) != vftFinished.end() || classInfo.vft.has_value())
return;
// Process all relevant base classes first.
// Otherwise, when we process this class we won't have the base vft available if needed.
for (auto& baseInfo : classInfo.baseClasses)
{
for (auto& [baseCoLocAddr, baseClassInfo] : m_classInfo)
{
if (baseClassInfo.className != baseInfo.className)
continue;
processClassAndBases(baseCoLocAddr);
// TODO: We might want to return the vft from processClassAndBases instead of doing this.
baseInfo.vft = m_classInfo[baseCoLocAddr].vft;
}
}
// Process the vtable for the current class.
// By this point all base classes should already exist, along with their type.
// Get the appropriate base class if there is one by reading the colocator.
auto coLocator = ReadCompleteObjectorLocator(m_view, coLocatorAddr);
// TODO: This should always be valid!
if (!coLocator.has_value())
return;
std::optional<BaseClassInfo> baseClassInfo;
for (const auto& base: classInfo.baseClasses)
{
if (base.offset == coLocator->offset && base.className != classInfo.className)
{
// Take the first to match the offset with a different name from the class.
baseClassInfo = base;
break;
}
}
vftFinished.insert(vftAddr);
if (auto vftInfo = ProcessVFT(vftAddr, classInfo, baseClassInfo))
classInfo.vft = vftInfo.value();
};
size_t processedNum = 0;
for (const auto &[coLocatorAddr, _]: vftMap)
{
if (bgTask->IsCancelled())
break;
processClassAndBases(coLocatorAddr);
std::string progress = fmt::format("Processing Microsoft VFTs... {}/{}", processedNum++, vftMap.size());
bgTask->SetProgressText(progress);
}
bgTask->Finish();
auto end_time = std::chrono::high_resolution_clock::now();
std::chrono::duration<double> elapsed_time = end_time - start_time;
m_logger->LogDebugF("ProcessVFT took {} seconds", elapsed_time.count());
}