blvm-node 0.1.90

Bitcoin Commons BLVM: Minimal Bitcoin node implementation using blvm-protocol and blvm-consensus
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

//! Phase 6 acceptance (a) and (b): a module fetches a local mock only when the
//! origin is allowed, and is refused for an unlisted origin, an off-list
//! redirect, and a private address.

#[path = "stub_node_api.rs"]
mod stub_node_api;

use std::collections::HashMap;
use std::io::{Read, Write};
use std::net::TcpListener;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
use std::time::Duration;

use blvm_node::config::NodeConfig;
use blvm_node::module::api::hub::ModuleApiHub;
use blvm_node::module::http::HttpPolicy;
use blvm_node::module::ipc::protocol::{
    MessageType, RequestMessage, RequestPayload, ResponsePayload,
};
use blvm_node::module::registry::manifest::ModuleManifest;
use blvm_node::module::security::permissions::{Permission, PermissionSet};
use stub_node_api::MockNodeAPI;

fn serve(response: &'static [u8]) -> (u16, thread::JoinHandle<()>) {
    let listener = TcpListener::bind("127.0.0.1:0").unwrap();
    let port = listener.local_addr().unwrap().port();
    let handle = thread::spawn(move || {
        let (mut sock, _) = listener.accept().unwrap();
        sock.set_read_timeout(Some(Duration::from_secs(2))).unwrap();
        let mut buf = [0u8; 2048];
        let _ = sock.read(&mut buf);
        let _ = sock.write_all(response);
    });
    (port, handle)
}

fn hub_for(module: &str, allow: Vec<String>) -> ModuleApiHub {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::HttpClient);
    hub.register_module_permissions(module.to_string(), permissions);
    let mut map = HashMap::new();
    map.insert(module.to_string(), allow);
    hub.set_http_policy(HttpPolicy {
        allow: map,
        proxy: None,
    });
    hub
}

fn http_request(url: &str) -> RequestMessage {
    RequestMessage {
        correlation_id: 1,
        request_type: MessageType::HttpRequest,
        payload: RequestPayload::HttpRequest {
            url: url.to_string(),
            accept: Some("application/json".to_string()),
            timeout_ms: 2_000,
        },
    }
}

#[tokio::test]
async fn allowed_local_origin_is_fetched() {
    let body = b"HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: 11\r\nConnection: close\r\n\r\n{\"ok\":true}";
    let (port, handle) = serve(body);
    let origin = format!("http://127.0.0.1:{port}");
    let mut hub = hub_for("fees-mod", vec![origin.clone()]);
    let response = hub
        .handle_request("fees-mod", http_request(&format!("{origin}/fees")))
        .await
        .unwrap();
    handle.join().unwrap();
    assert!(response.success);
    match response.payload {
        Some(ResponsePayload::HttpResponse {
            status,
            content_type,
            body,
        }) => {
            assert_eq!(status, 200);
            assert_eq!(content_type.as_deref(), Some("application/json"));
            assert_eq!(body, b"{\"ok\":true}");
        }
        other => panic!("unexpected payload: {other:?}"),
    }
    let audit = hub.get_audit_log(10);
    assert_eq!(audit[0].module_id, "fees-mod");
    assert_eq!(audit[0].origin.as_deref(), Some(origin.as_str()));
    assert_eq!(audit[0].status, Some(200));
    assert!(audit[0].success);
}

#[tokio::test]
async fn unlisted_origin_redirect_and_private_address_are_refused() {
    let hit = Arc::new(AtomicBool::new(false));
    let hit_flag = Arc::clone(&hit);
    let secret = TcpListener::bind("127.0.0.1:0").unwrap();
    secret.set_nonblocking(true).unwrap();
    let secret_port = secret.local_addr().unwrap().port();
    let secret_thread = thread::spawn(move || {
        for _ in 0..40 {
            if let Ok((mut sock, _)) = secret.accept() {
                hit_flag.store(true, Ordering::SeqCst);
                let _ = sock.write_all(b"HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 6\r\nConnection: close\r\n\r\nsecret");
                return;
            }
            thread::sleep(Duration::from_millis(50));
        }
    });

    let redirect = format!(
        "HTTP/1.1 302 Found\r\nLocation: http://127.0.0.1:{secret_port}/\r\nContent-Length: 0\r\nConnection: close\r\n\r\n"
    );
    let redirect_bytes = redirect.into_bytes();
    let listener = TcpListener::bind("127.0.0.1:0").unwrap();
    let port = listener.local_addr().unwrap().port();
    let redirect_thread = thread::spawn(move || {
        let (mut sock, _) = listener.accept().unwrap();
        sock.set_read_timeout(Some(Duration::from_secs(2))).unwrap();
        let mut buf = [0u8; 2048];
        let _ = sock.read(&mut buf);
        let _ = sock.write_all(&redirect_bytes);
    });

    let origin = format!("http://127.0.0.1:{port}");
    let mut hub = hub_for("fees-mod", vec![origin.clone()]);

    let unlisted = hub
        .handle_request("fees-mod", http_request("https://not-listed.example/fees"))
        .await
        .unwrap();
    assert!(!unlisted.success);
    assert!(unlisted.error.unwrap().contains("not allowed"));

    let private = hub
        .handle_request("fees-mod", http_request("http://10.1.2.3/fees"))
        .await
        .unwrap();
    assert!(!private.success);
    assert!(private.error.unwrap().contains("private address"));

    let redirected = hub
        .handle_request("fees-mod", http_request(&format!("{origin}/go")))
        .await
        .unwrap();
    assert!(!redirected.success);
    let reason = redirected.error.unwrap();
    assert!(
        reason.contains("not allowed") || reason.contains("private address"),
        "{reason}"
    );
    redirect_thread.join().unwrap();
    secret_thread.join().unwrap();
    assert!(!hit.load(Ordering::SeqCst));

    let audit = hub.get_audit_log(10);
    assert!(audit.iter().any(|entry| {
        entry.module_id == "fees-mod" && !entry.success && entry.origin.is_some()
    }));
}

#[test]
fn operator_allow_list_is_not_a_module_config_table() {
    let config: NodeConfig = toml::from_str(
        r#"
[module_network.blvm-fees]
http_allow = ["https://mempool.space"]

[network]
http_proxy = "socks5h://127.0.0.1:9050"
"#,
    )
    .unwrap();
    assert_eq!(
        config.module_network["blvm-fees"].http_allow,
        vec!["https://mempool.space".to_string()]
    );
    assert_eq!(
        config.network.unwrap().http_proxy.as_deref(),
        Some("socks5h://127.0.0.1:9050")
    );
    let modules = config.modules.unwrap();
    assert!(modules.module_configs.get("blvm-fees").is_none());
}

#[test]
fn manifest_http_wants_are_kept_and_not_the_allow_list() {
    let manifest: ModuleManifest = toml::from_str(
        r#"
name = "blvm-fees"
version = "0.1.0"
entry_point = "blvm-fees"

[network]
http_wants = ["https://mempool.space"]
"#,
    )
    .unwrap();
    assert_eq!(
        manifest.network.http_wants,
        vec!["https://mempool.space".to_string()]
    );
    let metadata = manifest.to_metadata();
    assert!(metadata.capabilities.is_empty());
}