thalir-core 0.1.0

Core IR types and builders for ThalIR smart contract analysis
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

/*! Strip names and metadata for confidential auditing.
 *
 * Proprietary code needs auditing but can't be shared openly. Hash identifiers and remove metadata
 * while preserving security-relevant behavior, then map findings back to original names when reporting
 * vulnerabilities.
 */

pub mod deobfuscator;
pub mod mapping_store;
pub mod name_obfuscator;
pub mod pass;
pub mod string_sanitizer;

pub use deobfuscator::VulnerabilityMapper;
pub use mapping_store::{MappingMetadata, ObfuscationMapping};
pub use name_obfuscator::NameObfuscator;
pub use pass::ObfuscationPass;
pub use string_sanitizer::StringSanitizer;

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum ObfuscationLevel {
    None,
    Minimal,
    Standard,
}

impl Default for ObfuscationLevel {
    fn default() -> Self {
        Self::None
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ObfuscationConfig {
    pub level: ObfuscationLevel,
    pub retain_mapping: bool,
    pub hash_salt: Option<String>,
    pub strip_string_constants: bool,
    pub strip_error_messages: bool,
    pub strip_metadata: bool,
}

impl Default for ObfuscationConfig {
    fn default() -> Self {
        Self {
            level: ObfuscationLevel::None,
            retain_mapping: false,
            hash_salt: None,
            strip_string_constants: false,
            strip_error_messages: false,
            strip_metadata: false,
        }
    }
}

impl ObfuscationConfig {
    pub fn standard() -> Self {
        Self {
            level: ObfuscationLevel::Standard,
            retain_mapping: true,
            hash_salt: None,
            strip_string_constants: true,
            strip_error_messages: true,
            strip_metadata: true,
        }
    }

    pub fn minimal() -> Self {
        Self {
            level: ObfuscationLevel::Minimal,
            retain_mapping: true,
            hash_salt: None,
            strip_string_constants: false,
            strip_error_messages: false,
            strip_metadata: false,
        }
    }
}