soth-mitm 0.2.1

Rust intercepting proxy crate with deterministic handler/event contracts for SOTH.
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

use crate::engine::{
    DownstreamCertProfile as CoreDownstreamCertProfile,
    TlsFingerprintClass as CoreTlsFingerprintClass, TlsFingerprintMode as CoreTlsFingerprintMode,
    TlsProfile as CoreTlsProfile, UpstreamClientAuthMode as CoreUpstreamClientAuthMode,
    UpstreamSniMode as CoreUpstreamSniMode,
};
use crate::tls::{
    DownstreamCertProfile as TlsDownstreamCertProfile,
    UpstreamClientAuthMode as TlsUpstreamClientAuthMode,
    UpstreamTlsProfile as TlsUpstreamTlsProfile, UpstreamTlsSniMode as TlsUpstreamTlsSniMode,
};

pub(crate) fn map_upstream_tls_profile(profile: CoreTlsProfile) -> TlsUpstreamTlsProfile {
    match profile {
        CoreTlsProfile::Strict => TlsUpstreamTlsProfile::Strict,
        CoreTlsProfile::Default => TlsUpstreamTlsProfile::Default,
        CoreTlsProfile::Compat => TlsUpstreamTlsProfile::Compat,
    }
}

pub(crate) fn resolve_effective_upstream_tls_profile(
    profile: CoreTlsProfile,
    fingerprint_mode: CoreTlsFingerprintMode,
    fingerprint_class: CoreTlsFingerprintClass,
) -> TlsUpstreamTlsProfile {
    match (fingerprint_mode, fingerprint_class) {
        (CoreTlsFingerprintMode::Native, _) => map_upstream_tls_profile(profile),
        (CoreTlsFingerprintMode::CompatClass, CoreTlsFingerprintClass::ChromeLike) => match profile
        {
            CoreTlsProfile::Strict => TlsUpstreamTlsProfile::Strict,
            CoreTlsProfile::Default | CoreTlsProfile::Compat => TlsUpstreamTlsProfile::Default,
        },
        (CoreTlsFingerprintMode::CompatClass, CoreTlsFingerprintClass::FirefoxLike) => {
            match profile {
                CoreTlsProfile::Strict => TlsUpstreamTlsProfile::Strict,
                CoreTlsProfile::Default | CoreTlsProfile::Compat => TlsUpstreamTlsProfile::Compat,
            }
        }
        (CoreTlsFingerprintMode::CompatClass, CoreTlsFingerprintClass::Native) => {
            map_upstream_tls_profile(profile)
        }
    }
}

pub(crate) fn map_upstream_sni_mode(mode: CoreUpstreamSniMode) -> TlsUpstreamTlsSniMode {
    match mode {
        CoreUpstreamSniMode::Required => TlsUpstreamTlsSniMode::Required,
        CoreUpstreamSniMode::Auto => TlsUpstreamTlsSniMode::Auto,
        CoreUpstreamSniMode::Disabled => TlsUpstreamTlsSniMode::Disabled,
    }
}

pub(crate) fn map_upstream_client_auth_mode(
    mode: CoreUpstreamClientAuthMode,
) -> TlsUpstreamClientAuthMode {
    match mode {
        CoreUpstreamClientAuthMode::Never => TlsUpstreamClientAuthMode::Never,
        CoreUpstreamClientAuthMode::IfRequested => TlsUpstreamClientAuthMode::IfRequested,
        CoreUpstreamClientAuthMode::Required => TlsUpstreamClientAuthMode::Required,
    }
}

pub(crate) fn map_downstream_cert_profile(
    profile: CoreDownstreamCertProfile,
) -> TlsDownstreamCertProfile {
    match profile {
        CoreDownstreamCertProfile::Modern => TlsDownstreamCertProfile::Modern,
        CoreDownstreamCertProfile::Compat => TlsDownstreamCertProfile::Compat,
    }
}

pub(crate) fn insert_tls_fingerprint_provenance(
    attributes: &mut std::collections::BTreeMap<String, String>,
    fingerprint_mode: CoreTlsFingerprintMode,
    fingerprint_class: CoreTlsFingerprintClass,
) {
    attributes.insert(
        "tls_fingerprint_mode".to_string(),
        fingerprint_mode.as_str().to_string(),
    );
    attributes.insert(
        "tls_fingerprint_class".to_string(),
        fingerprint_class.as_str().to_string(),
    );
}

#[cfg(test)]
mod tls_fingerprint_profile_tests {
    use super::resolve_effective_upstream_tls_profile;
    use super::{
        CoreTlsFingerprintClass, CoreTlsFingerprintMode, CoreTlsProfile, TlsUpstreamTlsProfile,
    };

    #[test]
    fn compat_class_preserves_strict_profile() {
        assert_eq!(
            resolve_effective_upstream_tls_profile(
                CoreTlsProfile::Strict,
                CoreTlsFingerprintMode::CompatClass,
                CoreTlsFingerprintClass::ChromeLike,
            ),
            TlsUpstreamTlsProfile::Strict
        );
        assert_eq!(
            resolve_effective_upstream_tls_profile(
                CoreTlsProfile::Strict,
                CoreTlsFingerprintMode::CompatClass,
                CoreTlsFingerprintClass::FirefoxLike,
            ),
            TlsUpstreamTlsProfile::Strict
        );
    }

    #[test]
    fn chrome_like_prefers_default_profile_for_non_strict() {
        assert_eq!(
            resolve_effective_upstream_tls_profile(
                CoreTlsProfile::Default,
                CoreTlsFingerprintMode::CompatClass,
                CoreTlsFingerprintClass::ChromeLike,
            ),
            TlsUpstreamTlsProfile::Default
        );
        assert_eq!(
            resolve_effective_upstream_tls_profile(
                CoreTlsProfile::Compat,
                CoreTlsFingerprintMode::CompatClass,
                CoreTlsFingerprintClass::ChromeLike,
            ),
            TlsUpstreamTlsProfile::Default
        );
    }

    #[test]
    fn firefox_like_prefers_compat_profile_for_non_strict() {
        assert_eq!(
            resolve_effective_upstream_tls_profile(
                CoreTlsProfile::Default,
                CoreTlsFingerprintMode::CompatClass,
                CoreTlsFingerprintClass::FirefoxLike,
            ),
            TlsUpstreamTlsProfile::Compat
        );
        assert_eq!(
            resolve_effective_upstream_tls_profile(
                CoreTlsProfile::Compat,
                CoreTlsFingerprintMode::CompatClass,
                CoreTlsFingerprintClass::FirefoxLike,
            ),
            TlsUpstreamTlsProfile::Compat
        );
    }
}