il2cpp_dumper 0.4.0

A blazing fast and reliable il2cpp dumper cross platfrom.
Documentation
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
use std::collections::{BTreeSet, HashMap};
use crate::io::BinaryStream;
use crate::error::{Result, Error};
use crate::search::SearchSection;
use crate::disassembler::Architecture;
use super::structures::*;

#[derive(Debug, Clone)]
pub struct VaSegment {
    pub vaddr: u64,
    pub memsz: u64,
    pub offset: u64,
}

pub struct Il2Cpp {
    pub stream: BinaryStream,
    pub version: f64,
    pub is_32bit: bool,

    pub types: Vec<Il2CppType>,
    pub method_pointers: Vec<u64>,
    pub generic_method_pointers: Vec<u64>,
    pub invoker_pointers: Vec<u64>,
    pub field_offsets: Vec<Vec<i32>>,
    pub metadata_usages: Vec<u64>,
    pub custom_attribute_generators: Vec<u64>,

    pub generic_insts: Vec<Il2CppGenericInst>,
    pub generic_inst_pointers: Vec<u64>,
    pub method_specs: Vec<Il2CppMethodSpec>,
    pub generic_method_table: Vec<Il2CppGenericMethodFunctionsDefinitions>,

    pub code_gen_modules: HashMap<String, Il2CppCodeGenModule>,
    pub code_gen_module_method_pointers: HashMap<String, Vec<u64>>,

    pub method_definition_method_specs: HashMap<usize, Vec<usize>>,
    pub method_spec_generic_method_pointers: HashMap<usize, u64>,

    pub code_registration: u64,
    pub metadata_registration: u64,
    pub is_dumped: bool,
    pub image_base: u64,

    field_offset_pointers: Vec<u64>,
    field_offsets_are_pointers: bool,
    type_dic: HashMap<u64, usize>,
    pub va_segments: Vec<VaSegment>,
    pub data_sections: Vec<SearchSection>,
    pub rgctxs_dictionary: HashMap<String, HashMap<u32, Vec<Il2CppRGCTXDefinition>>>,
    pub is_pe: bool,
    pub reverse_pinvoke_wrappers: Vec<u64>,
    pub unresolved_virtual_call_pointers: Vec<u64>,
    pub arch: Option<Architecture>,
    pub e_machine: u16,
    pub exported_symbols: Vec<String>,
    pub api_export_rvas: HashMap<String, u64>,
}

impl Il2Cpp {
    pub fn new(stream: BinaryStream, version: f64, is_32bit: bool) -> Self {
        Self {
            stream,
            version,
            is_32bit,
            types: Vec::new(),
            method_pointers: Vec::new(),
            generic_method_pointers: Vec::new(),
            invoker_pointers: Vec::new(),
            field_offsets: Vec::new(),
            metadata_usages: Vec::new(),
            custom_attribute_generators: Vec::new(),
            generic_insts: Vec::new(),
            generic_inst_pointers: Vec::new(),
            method_specs: Vec::new(),
            generic_method_table: Vec::new(),
            code_gen_modules: HashMap::new(),
            code_gen_module_method_pointers: HashMap::new(),
            method_definition_method_specs: HashMap::new(),
            method_spec_generic_method_pointers: HashMap::new(),
            code_registration: 0,
            metadata_registration: 0,
            is_dumped: false,
            image_base: 0,
            field_offset_pointers: Vec::new(),
            field_offsets_are_pointers: false,
            type_dic: HashMap::new(),
            va_segments: Vec::new(),
            data_sections: Vec::new(),
            rgctxs_dictionary: HashMap::new(),
            is_pe: false,
            reverse_pinvoke_wrappers: Vec::new(),
            unresolved_virtual_call_pointers: Vec::new(),
            arch: None,
            e_machine: 0,
            exported_symbols: Vec::new(),
            api_export_rvas: HashMap::new(),
        }
    }

    pub fn from_elf(elf: &crate::formats::elf::Elf) -> Self {
        let method_definition_method_specs: HashMap<usize, Vec<usize>> = elf
            .method_definition_method_specs
            .iter()
            .map(|(k, v)| (*k as usize, v.clone()))
            .collect();
        Self {
            stream: elf.stream.clone(),
            version: elf.stream.version,
            is_32bit: elf.is_32bit,
            types: elf.types.clone(),
            method_pointers: elf.method_pointers.clone(),
            generic_method_pointers: elf.generic_method_pointers.clone(),
            invoker_pointers: elf.invoker_pointers.clone(),
            field_offsets: Vec::new(),
            metadata_usages: elf.metadata_usages.clone(),
            custom_attribute_generators: elf.custom_attribute_generators.clone(),
            generic_insts: elf.generic_insts.clone(),
            generic_inst_pointers: elf.generic_inst_pointers.clone(),
            method_specs: elf.method_specs.clone(),
            generic_method_table: elf.generic_method_table.clone(),
            code_gen_modules: elf.code_gen_modules.clone(),
            code_gen_module_method_pointers: elf.code_gen_module_method_pointers.clone(),
            method_definition_method_specs,
            method_spec_generic_method_pointers: elf.method_spec_generic_method_pointers.clone(),
            code_registration: 0,
            metadata_registration: 0,
            is_dumped: elf.is_dumped,
            image_base: elf.stream.image_base,
            field_offset_pointers: elf.field_offsets.clone(),
            field_offsets_are_pointers: elf.field_offsets_are_pointers,
            type_dic: elf.type_dic.clone(),
            va_segments: elf.segments.iter().map(|s| VaSegment {
                vaddr: s.p_vaddr,
                memsz: s.p_memsz,
                offset: s.p_offset,
            }).collect(),
            data_sections: elf.segments.iter().filter(|s| {
                s.p_memsz != 0 && matches!(s.p_flags, 2 | 4 | 6)
            }).map(|s| SearchSection::new(
                s.p_offset,
                s.p_offset + s.p_filesz,
                s.p_vaddr,
                s.p_vaddr + s.p_memsz,
            )).collect(),
            rgctxs_dictionary: elf.rgctxs_dictionary.clone(),
            is_pe: false,
            reverse_pinvoke_wrappers: Vec::new(),
            unresolved_virtual_call_pointers: Vec::new(),
            arch: Architecture::from_elf_machine(elf.header.e_machine),
            e_machine: elf.header.e_machine,
            exported_symbols: Vec::new(),
            api_export_rvas: HashMap::new(),
        }
    }

    pub fn init(
        &mut self,
        code_registration: u64,
        metadata_registration: u64,
        map_vatr: &dyn Fn(u64) -> Result<u64>,
    ) -> Result<()> {
        self.code_registration = code_registration;
        self.metadata_registration = metadata_registration;
        self.stream.is_32bit = self.is_32bit;


        let mr_offset = map_vatr(metadata_registration)?;
        let mr = {
            self.stream.set_position(mr_offset);
            Il2CppMetadataRegistration::read(&mut self.stream, self.version)?
        };



        let types_offset = map_vatr(mr.types)?;
        self.stream.set_position(types_offset);
        let type_ptrs = self.stream.read_ptr_array_inline(mr.types_count as usize)?;


        self.types.clear();
        self.type_dic.clear();
        for (idx, ptr) in type_ptrs.iter().enumerate() {
            let t_offset = map_vatr(*ptr).map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, format!("type[{}] ptr=0x{:x}: {}", idx, ptr, e)))?;
            self.stream.set_position(t_offset);
            let mut t = Il2CppType::read(&mut self.stream)?;
            t.init(self.version);
            self.types.push(t);
            self.type_dic.insert(*ptr, idx);
        }


        if mr.generic_insts_count > 0 {

            let gi_offset = map_vatr(mr.generic_insts)?;
            self.generic_inst_pointers = self.stream.read_ptr_array(gi_offset, mr.generic_insts_count as usize)?;

            self.generic_insts.clear();
            for ptr in &self.generic_inst_pointers.clone() {
                let offset = map_vatr(*ptr)?;
                self.stream.set_position(offset);
                self.generic_insts.push(Il2CppGenericInst::read(&mut self.stream)?);
            }

        }

        if mr.method_specs_count > 0 && mr.method_specs > 0 {

            let ms_offset = map_vatr(mr.method_specs)?;
            self.stream.set_position(ms_offset);
            self.method_specs.clear();
            for _ in 0..mr.method_specs_count {
                self.method_specs.push(Il2CppMethodSpec::read(&mut self.stream)?);
            }

        }

        if mr.generic_method_table > 0 && mr.generic_method_table_count > 0 {

            let gmt_offset = map_vatr(mr.generic_method_table)?;
            self.stream.set_position(gmt_offset);
            self.generic_method_table.clear();
            for _ in 0..mr.generic_method_table_count {
                self.generic_method_table.push(
                    Il2CppGenericMethodFunctionsDefinitions::read(&mut self.stream, self.version)?
                );
            }

        }


        let cr_offset = map_vatr(code_registration)?;
        self.stream.set_position(cr_offset);
        let cr = Il2CppCodeRegistration::read(&mut self.stream, self.version)?;


        if cr.method_pointers > 0 && cr.method_pointers_count > 0 {

            let mp_offset = map_vatr(cr.method_pointers)?;
            self.method_pointers = self.stream.read_ptr_array(mp_offset, cr.method_pointers_count as usize)?;
        }

        if cr.generic_method_pointers > 0 && cr.generic_method_pointers_count > 0 {

            let gmp_offset = map_vatr(cr.generic_method_pointers)?;
            self.generic_method_pointers = self.stream.read_ptr_array(gmp_offset, cr.generic_method_pointers_count as usize)?;
        }

        if cr.invoker_pointers > 0 && cr.invoker_pointers_count > 0 {

            let ip_offset = map_vatr(cr.invoker_pointers)?;
            self.invoker_pointers = self.stream.read_ptr_array(ip_offset, cr.invoker_pointers_count as usize)?;
        }

        if self.version < 27.0 && cr.custom_attribute_generators > 0 && cr.custom_attribute_count > 0 {
            let ca_offset = map_vatr(cr.custom_attribute_generators)?;
            self.custom_attribute_generators = self.stream.read_ptr_array(ca_offset, cr.custom_attribute_count as usize)?;
        }

        if mr.metadata_usages > 0 && mr.metadata_usages_count > 0 && self.version < 27.0 {
            let mu_offset = map_vatr(mr.metadata_usages)?;
            self.metadata_usages = self.stream.read_ptr_array(mu_offset, mr.metadata_usages_count as usize)?;
        }

        self.field_offsets_are_pointers = self.version > 21.0;
        if mr.field_offsets > 0 && mr.field_offsets_count > 0 {

            let fo_offset = map_vatr(mr.field_offsets)?;
            if self.field_offsets_are_pointers {
                self.field_offset_pointers = self.stream.read_ptr_array(fo_offset, mr.field_offsets_count as usize)?;
            } else {
                self.stream.set_position(fo_offset);
                let mut raw = Vec::with_capacity(mr.field_offsets_count as usize);
                for _ in 0..mr.field_offsets_count {
                    raw.push(self.stream.read_i32()?);
                }
                self.field_offsets = vec![raw];
            }
        }

        self.build_method_spec_lookup();

        if self.version >= 24.2 {

            self.load_code_gen_modules(&cr, map_vatr)?;

        }


        Ok(())
    }

    fn build_method_spec_lookup(&mut self) {
        self.method_definition_method_specs.clear();
        self.method_spec_generic_method_pointers.clear();

        for (table_idx, table) in self.generic_method_table.iter().enumerate() {
            if (table.generic_method_index as usize) < self.method_specs.len() {
                let ms = &self.method_specs[table.generic_method_index as usize];
                let method_def_idx = ms.method_definition_index as usize;

                self.method_definition_method_specs
                    .entry(method_def_idx)
                    .or_default()
                    .push(table.generic_method_index as usize);

                let method_idx = table.indices.method_index as usize;
                if method_idx < self.generic_method_pointers.len() {
                    self.method_spec_generic_method_pointers
                        .insert(table.generic_method_index as usize, self.generic_method_pointers[method_idx]);
                }
            }
            let _ = table_idx;
        }
    }

    fn load_code_gen_modules(
        &mut self,
        cr: &Il2CppCodeRegistration,
        map_vatr: &dyn Fn(u64) -> Result<u64>,
    ) -> Result<()> {
        if cr.code_gen_modules == 0 || cr.code_gen_modules_count == 0 {
            return Ok(());
        }

        let modules_offset = map_vatr(cr.code_gen_modules)?;
        let module_ptrs = self.stream.read_ptr_array(modules_offset, cr.code_gen_modules_count as usize)?;

        for ptr in module_ptrs {
            let mod_offset = map_vatr(ptr)?;
            self.stream.set_position(mod_offset);
            let module = Il2CppCodeGenModule::read(&mut self.stream, self.version)?;

            let name_offset = map_vatr(module.module_name)?;
            let module_name = self.stream.read_string_to_null_at(name_offset)?;

            let method_ptrs = if module.method_pointers > 0 && module.method_pointer_count > 0 {
                let mp_offset = map_vatr(module.method_pointers)?;
                self.stream.read_ptr_array(mp_offset, module.method_pointer_count as usize)
                    .unwrap_or_else(|_| vec![0; module.method_pointer_count as usize])
            } else {
                Vec::new()
            };

            self.code_gen_module_method_pointers.insert(module_name.clone(), method_ptrs);
            self.code_gen_modules.insert(module_name, module);
        }

        Ok(())
    }

    pub fn get_method_pointer(&self, image_name: &str, method_def: &Il2CppMethodDefinition) -> u64 {
        if self.version >= 24.2 {
            if let Some(ptrs) = self.code_gen_module_method_pointers.get(image_name) {
                let method_pointer_index = (method_def.token & 0x00FFFFFF) as usize;
                if method_pointer_index > 0 && method_pointer_index <= ptrs.len() {
                    return ptrs[method_pointer_index - 1];
                }
            }
            0
        } else {
            let idx = method_def.method_index as usize;
            if idx < self.method_pointers.len() {
                self.method_pointers[idx]
            } else {
                0
            }
        }
    }

    pub fn get_field_offset_from_index(
        &mut self,
        type_def_index: usize,
        field_index_in_type: usize,
        field_index: usize,
        is_value_type: bool,
        is_static: bool,
    ) -> i32 {
        let offset = if self.field_offsets_are_pointers {
            if type_def_index >= self.field_offset_pointers.len() {
                return -1;
            }
            let ptr = self.field_offset_pointers[type_def_index];
            if ptr == 0 {
                return -1;
            }
            let target_va = ptr + (field_index_in_type as u64 * 4);
            let read_pos = match self.map_vatr(target_va) {
                Ok(p) => p,
                Err(_) => return -1,
            };
            self.stream.set_position(read_pos);
            match self.stream.read_i32() {
                Ok(v) => v,
                Err(_) => return -1,
            }
        } else if !self.field_offsets.is_empty() {
            let flat = &self.field_offsets[0];
            if field_index < flat.len() {
                flat[field_index]
            } else {
                return -1;
            }
        } else {
            return -1;
        };

        if offset > 0 && is_value_type && !is_static {
            let header = if self.is_32bit { 8 } else { 16 };
            return offset - header;
        }

        offset
    }

    pub fn get_rva(&self, pointer: u64) -> u64 {
        if self.image_base > 0 {
            pointer.wrapping_sub(self.image_base)
        } else {
            pointer
        }
    }

    pub fn get_il2cpp_type(&self, pointer: u64) -> Option<&Il2CppType> {
        self.type_dic.get(&pointer).and_then(|idx| self.types.get(*idx))
    }

    pub fn map_vatr(&self, addr: u64) -> Result<u64> {
        for seg in &self.va_segments {
            if addr >= seg.vaddr && addr <= seg.vaddr + seg.memsz {
                return Ok(addr - seg.vaddr + seg.offset);
            }
        }
        Err(Error::AddressNotMapped(addr))
    }

    pub fn map_rtva(&self, offset: u64) -> u64 {
        for seg in &self.va_segments {
            if offset >= seg.offset && offset <= seg.offset + seg.memsz {
                return offset - seg.offset + seg.vaddr;
            }
        }
        0
    }

    pub fn read_generic_class(&mut self, addr: u64) -> Result<Il2CppGenericClass> {
        let offset = self.map_vatr(addr)?;
        self.stream.set_position(offset);
        Il2CppGenericClass::read(&mut self.stream, self.version)
    }

    pub fn read_generic_inst(&mut self, addr: u64) -> Result<Il2CppGenericInst> {
        let offset = self.map_vatr(addr)?;
        self.stream.set_position(offset);
        Il2CppGenericInst::read(&mut self.stream)
    }

    pub fn read_ptr_array(&mut self, addr: u64, count: u64) -> Result<Vec<u64>> {
        let offset = self.map_vatr(addr)?;
        self.stream.set_position(offset);
        let mut result = Vec::with_capacity(count as usize);
        for _ in 0..count {
            result.push(self.stream.read_ptr()?);
        }
        Ok(result)
    }

    pub fn detect_architecture(&self) -> Architecture {
        if let Some(arch) = self.arch {
            return arch;
        }
        Architecture::from_bitness(self.is_32bit, self.is_pe)
    }

    pub fn build_sorted_method_addresses(&self) -> Vec<u64> {
        let mut addrs = BTreeSet::new();

        for &ptr in &self.method_pointers {
            if ptr > 0 {
                addrs.insert(self.get_rva(ptr));
            }
        }

        for &ptr in &self.generic_method_pointers {
            if ptr > 0 {
                addrs.insert(self.get_rva(ptr));
            }
        }

        for ptrs in self.code_gen_module_method_pointers.values() {
            for &ptr in ptrs {
                if ptr > 0 {
                    addrs.insert(self.get_rva(ptr));
                }
            }
        }

        for (&_spec_idx, &ptr) in &self.method_spec_generic_method_pointers {
            if ptr > 0 {
                addrs.insert(self.get_rva(ptr));
            }
        }

        addrs.into_iter().collect()
    }

    pub fn get_method_body_size(&self, rva: u64, sorted_addrs: &[u64]) -> usize {
        const MAX_BODY: usize = 0x4000;
        const MIN_BODY: usize = 4;

        match sorted_addrs.binary_search(&rva) {
            Ok(idx) => {
                if idx + 1 < sorted_addrs.len() {
                    let next = sorted_addrs[idx + 1];
                    let diff = (next - rva) as usize;
                    diff.min(MAX_BODY).max(MIN_BODY)
                } else {
                    MAX_BODY
                }
            }
            Err(_) => MAX_BODY,
        }
    }

    pub fn read_bytes_at_rva(&self, rva: u64, size: usize) -> Option<Vec<u8>> {
        let va = if self.image_base > 0 {
            rva.wrapping_add(self.image_base)
        } else {
            rva
        };

        let file_offset = match self.map_vatr(va) {
            Ok(o) => o,
            Err(_) => {
                if rva < self.stream.len() {
                    rva
                } else {
                    return None;
                }
            }
        };

        let data = self.stream.data();
        let start = file_offset as usize;
        let end = (start + size).min(data.len());

        if start >= data.len() {
            return None;
        }

        Some(data[start..end].to_vec())
    }
}