dotscope 0.8.4

A high-performance, cross-platform framework for analyzing and reverse engineering .NET PE executables
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
use crate::{
    analysis::{
        ConstValue, FieldRef, MethodPurity, MethodRef, ReturnInfo, SsaBlock, SsaFunction,
        SsaInstruction, SsaOp, SsaType, SsaVarId,
    },
    compiler::EventLog,
    deobfuscation::{
        config::{EngineConfig, IterationConfig, PassConfig},
        engine::DeobfuscationEngine,
        result::DeobfuscationResult,
    },
    metadata::token::Token,
};

#[test]
fn test_engine_default() {
    let engine = DeobfuscationEngine::default();
    // Default config has all passes enabled
    assert!(engine.config.passes.constant_propagation);
    assert!(engine.config.passes.dead_code_elimination);
}

#[test]
fn test_engine_config() {
    let config = EngineConfig {
        iterations: IterationConfig {
            max_ssa_iterations: 10,
            ..Default::default()
        },
        passes: PassConfig {
            inline_threshold: 30,
            ..Default::default()
        },
        ..Default::default()
    };

    let engine = DeobfuscationEngine::new(config);
    assert_eq!(engine.config.iterations.max_ssa_iterations, 10);
    assert_eq!(engine.config.passes.inline_threshold, 30);
}

#[test]
fn test_pipeline_passes_default() {
    let engine = DeobfuscationEngine::default();
    let scheduler = engine.create_scheduler();

    // Deob passes (structure, value) are populated later by create_deob_passes().
    // create_scheduler only adds generic compiler passes.
    // Simplify (opaque predicates, VRP, CFG simplification, jump threading) + Inline
    assert!(scheduler.pass_count() > 0); // Opaque predicates + CFG + inlining
    assert!(scheduler.normalize_count() > 0); // DCE, constant prop, GVN, copy prop, strength reduction
}

#[test]
fn test_pipeline_passes_selective() {
    let config = EngineConfig {
        passes: PassConfig {
            constant_propagation: true,
            copy_propagation: false,
            opaque_predicate_removal: false,
            control_flow_simplification: false,
            dead_code_elimination: false,
            string_decryption: false,
            strength_reduction: false,
            memory_optimization: false,
            ..Default::default()
        },
        ..Default::default()
    };

    let engine = DeobfuscationEngine::new(config);
    let scheduler = engine.create_scheduler();

    // ProxyDevirtualization + Reassociation + constant propagation + GVN should be in normalize
    assert_eq!(scheduler.normalize_count(), 4); // ProxyDevirtualizationPass + ReassociationPass + ConstantPropagationPass + GVN
                                                // No opaque pred, CFG simplification, or inlining
    assert_eq!(scheduler.pass_count(), 0);
}

/// `memory_optimization` is the only toggle that differs between these two
/// configs, so it must account for exactly one normalize pass.
#[test]
fn test_pipeline_memory_optimization_toggle() {
    let base = PassConfig {
        constant_propagation: false,
        copy_propagation: false,
        opaque_predicate_removal: false,
        control_flow_simplification: false,
        dead_code_elimination: false,
        string_decryption: false,
        strength_reduction: false,
        memory_optimization: false,
        ..Default::default()
    };

    let without = DeobfuscationEngine::new(EngineConfig {
        passes: base.clone(),
        ..Default::default()
    })
    .create_scheduler();

    let with = DeobfuscationEngine::new(EngineConfig {
        passes: PassConfig {
            memory_optimization: true,
            ..base
        },
        ..Default::default()
    })
    .create_scheduler();

    assert_eq!(
        with.normalize_count(),
        without.normalize_count() + 1,
        "enabling memory_optimization should register exactly one normalize pass"
    );
    assert_eq!(with.pass_count(), without.pass_count());
}

#[test]
fn test_analyze_return_void() {
    // Create SSA with void return
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return { value: None }));
    ssa.add_block(block);

    let result = ssa.return_info();
    assert!(matches!(result, ReturnInfo::Void));
}

#[test]
fn test_analyze_return_constant() {
    // Create SSA that returns a constant
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    // Define a constant
    let var = SsaVarId::from_index(0);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Const {
        dest: var,
        value: ConstValue::I32(42),
    }));

    // Return the constant
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return {
        value: Some(var),
    }));
    ssa.add_block(block);

    let result = ssa.return_info();
    assert!(matches!(result, ReturnInfo::Constant(ConstValue::I32(42))));
}

#[test]
fn test_analyze_return_no_returns_is_void() {
    // Create SSA with no return statements (unusual but possible)
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let block = SsaBlock::new(0);
    ssa.add_block(block);

    let result = ssa.return_info();
    assert!(matches!(result, ReturnInfo::Void));
}

#[test]
fn test_analyze_purity_pure() {
    // Create SSA with only pure operations
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    // Pure arithmetic operation
    let dest = SsaVarId::from_index(0);
    let src1 = SsaVarId::from_index(1);
    let src2 = SsaVarId::from_index(2);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Add {
        dest,
        left: src1,
        right: src2,
        flags: None,
    }));
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return {
        value: Some(dest),
    }));
    ssa.add_block(block);

    let result = ssa.purity();
    assert!(matches!(result, MethodPurity::Pure));
}

#[test]
fn test_analyze_purity_impure_store_field() {
    // Create SSA with a field store
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let obj = SsaVarId::from_index(0);
    let val = SsaVarId::from_index(1);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::StoreField {
        object: obj,
        field: FieldRef::new(Token::new(0x04000001)),
        value: val,
    }));
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return { value: None }));
    ssa.add_block(block);

    let result = ssa.purity();
    assert!(matches!(result, MethodPurity::Impure));
}

#[test]
fn test_analyze_purity_impure_throw() {
    // Create SSA with a throw
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let exc = SsaVarId::from_index(0);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Throw { exception: exc }));
    ssa.add_block(block);

    let result = ssa.purity();
    assert!(matches!(result, MethodPurity::Impure));
}

#[test]
fn test_analyze_purity_readonly() {
    // Create SSA with only field reads
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let dest = SsaVarId::from_index(0);
    let obj = SsaVarId::from_index(1);
    block.add_instruction(
        SsaInstruction::synthetic(SsaOp::LoadField {
            dest,
            object: obj,
            field: FieldRef::new(Token::new(0x04000001)),
        })
        .with_result_type(SsaType::I32),
    );
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return {
        value: Some(dest),
    }));
    ssa.add_block(block);

    let result = ssa.purity();
    assert!(matches!(result, MethodPurity::ReadOnly));
}

#[test]
fn test_analyze_purity_unknown_calls() {
    // Create SSA with a call
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let dest = SsaVarId::from_index(0);
    block.add_instruction(
        SsaInstruction::synthetic(SsaOp::Call {
            dest: Some(dest),
            method: MethodRef::new(Token::new(0x06000001)),
            args: vec![],
        })
        .with_result_type(SsaType::I32),
    );
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return {
        value: Some(dest),
    }));
    ssa.add_block(block);

    let result = ssa.purity();
    assert!(matches!(result, MethodPurity::Unknown));
}

#[test]
fn test_detect_string_decryptor_xor() {
    // Create small SSA with XOR operations (typical of string decryption)
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let dest = SsaVarId::from_index(0);
    let left = SsaVarId::from_index(1);
    let right = SsaVarId::from_index(2);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Xor {
        dest,
        left,
        right,
        flags: None,
    }));
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return {
        value: Some(dest),
    }));
    ssa.add_block(block);

    let result = DeobfuscationEngine::detect_string_decryptor_pattern(&ssa);
    assert!(result);
}

#[test]
fn test_detect_string_decryptor_large_method() {
    // Create large SSA (over 200 instructions)
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    // Add 250 instructions
    for _ in 0..250_usize {
        let dest = SsaVarId::from_index(0);
        block.add_instruction(SsaInstruction::synthetic(SsaOp::Const {
            dest,
            value: ConstValue::I32(42),
        }));
    }
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return { value: None }));
    ssa.add_block(block);

    // Large methods should not be detected as string decryptors
    let result = DeobfuscationEngine::detect_string_decryptor_pattern(&ssa);
    assert!(!result);
}

#[test]
fn test_detect_dispatcher_with_switch() {
    // Create SSA with a switch having 5+ targets
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let value = SsaVarId::from_index(0);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Switch {
        value,
        targets: vec![1, 2, 3, 4, 5], // 5 targets
        default: 6,
    }));
    ssa.add_block(block);

    let result = DeobfuscationEngine::detect_dispatcher_pattern(&ssa);
    assert!(result);
}

#[test]
fn test_detect_dispatcher_small_switch() {
    // Create SSA with a small switch (< 5 targets)
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let value = SsaVarId::from_index(0);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Switch {
        value,
        targets: vec![1, 2],
        default: 3,
    }));
    ssa.add_block(block);

    let result = DeobfuscationEngine::detect_dispatcher_pattern(&ssa);
    assert!(!result);
}

#[test]
fn test_detect_dispatcher_no_switch() {
    // Create SSA without switch
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return { value: None }));
    ssa.add_block(block);

    let result = DeobfuscationEngine::detect_dispatcher_pattern(&ssa);
    assert!(!result);
}

#[test]
fn test_compute_method_summary() {
    let engine = DeobfuscationEngine::default();

    // Create a simple pure method with constant return
    let mut ssa: SsaFunction = SsaFunction::new(0, 0);
    let mut block = SsaBlock::new(0);

    let var = SsaVarId::from_index(0);
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Const {
        dest: var,
        value: ConstValue::I32(42),
    }));
    block.add_instruction(SsaInstruction::synthetic(SsaOp::Return {
        value: Some(var),
    }));
    ssa.add_block(block);

    let token = Token::new(0x06000001);
    let summary = engine.compute_method_summary(&ssa, token);

    assert_eq!(summary.token, token);
    assert!(matches!(summary.return_info, ReturnInfo::Constant(_)));
    assert!(matches!(summary.purity, MethodPurity::Pure));
    assert!(!summary.is_string_decryptor);
    assert!(!summary.is_dispatcher);
}

#[test]
fn test_deobfuscation_result_summary() {
    let result = DeobfuscationResult::new_with_techniques(EventLog::new(), Vec::new(), None);

    // summary() returns just the stats (no prefix)
    let summary = result.summary();
    assert!(!summary.is_empty() || summary == "No changes"); // Stats or "No changes"

    // detailed_summary() includes detection info
    let detailed = result.detailed_summary();
    assert!(detailed.contains("Deobfuscation complete"));
}