hirnd 0.1.0

hirn standalone daemon — gRPC, HTTP, and MCP server for cognitive memory
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
use axum::Json;
use axum::http::{HeaderMap, StatusCode};
use metrics::counter;
use serde::Serialize;
use serde_json::Value;

use crate::http::{CachedJsonResponse, ErrorResponse, HttpState};
use crate::raft::NodeId;

type HttpError = (StatusCode, Json<ErrorResponse>);

#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct RealmWriteOwner {
    pub(crate) node_id: NodeId,
    pub(crate) addr: String,
}

pub(crate) struct ForwardedWriteResponse {
    pub(crate) owner: RealmWriteOwner,
    pub(crate) response: CachedJsonResponse,
}

const FORWARDED_WRITE_HEADERS: &[&str] = &[
    "x-agent-id",
    "x-trace-id",
    "x-idempotency-key",
    "authorization",
];

pub(crate) struct CoordinationRuntime;

impl CoordinationRuntime {
    pub(crate) fn local_node_id(state: &HttpState) -> Option<NodeId> {
        state.raft.as_ref().map(|raft| raft.metrics().borrow().id)
    }

    pub(crate) async fn current_realm_owner(state: &HttpState, realm: &str) -> Option<NodeId> {
        let sm = state.raft_state_machine.as_ref()?;
        sm.realm_owner(realm).await
    }

    /// Returns the remote owner when this request should be forwarded.
    pub(crate) async fn realm_write_owner(
        state: &HttpState,
        realm: &str,
    ) -> Result<Option<RealmWriteOwner>, HttpError> {
        let (Some(my_id), Some(sm)) = (Self::local_node_id(state), &state.raft_state_machine)
        else {
            return Ok(None);
        };

        let Some(owner_node_id) = sm.realm_owner(realm).await else {
            return Ok(None);
        };
        if owner_node_id == my_id {
            return Ok(None);
        }

        let Some(owner_addr) = sm.node_addr(owner_node_id).await else {
            return Err((
                StatusCode::BAD_GATEWAY,
                Json(ErrorResponse::with_retryable(
                    format!(
                        "realm '{realm}' is assigned to owner node {owner_node_id} but no owner address is registered"
                    ),
                    true,
                )),
            ));
        };

        Ok(Some(RealmWriteOwner {
            node_id: owner_node_id,
            addr: owner_addr,
        }))
    }

    /// Forward a realm-owned write to the current owner node.
    ///
    /// When the realm has no assigned owner, or the daemon is running without
    /// cluster metadata, this returns `Ok(None)` and the caller must execute the
    /// request locally. Transport failures are surfaced as retryable gateway
    /// errors. Forwarded owner responses preserve their status codes and, for
    /// error bodies, gain a `retryable` flag when the owner did not provide one.
    pub(crate) async fn try_forward_write(
        state: &HttpState,
        headers: &HeaderMap,
        path: &str,
        body: &[u8],
    ) -> Result<Option<ForwardedWriteResponse>, HttpError> {
        let realm = headers
            .get("x-realm-id")
            .and_then(|value| value.to_str().ok())
            .ok_or_else(|| {
                (
                    StatusCode::BAD_REQUEST,
                    Json(ErrorResponse::new("missing X-Realm-ID header")),
                )
            })?;

        let Some(owner) = Self::realm_write_owner(state, realm).await? else {
            // Unassigned realms and standalone mode fall back to local execution.
            return Ok(None);
        };

        let parsed = Self::build_forward_url(&owner.addr, path)?;

        let mut request = state
            .forward_client
            .post(parsed)
            .header("x-realm-id", realm);
        for key in FORWARDED_WRITE_HEADERS {
            if let Some(value) = headers.get(*key) {
                request = request.header(*key, value.as_bytes());
            }
        }

        let response = request
            .header("content-type", "application/json")
            .body(body.to_vec())
            .send()
            .await
            .map_err(|error| {
                (
                    StatusCode::BAD_GATEWAY,
                    Json(ErrorResponse::with_retryable(
                        format!("failed to forward to owner node: {error}"),
                        true,
                    )),
                )
            })?;

        let status =
            StatusCode::from_u16(response.status().as_u16()).unwrap_or(StatusCode::BAD_GATEWAY);
        let response_body = response.bytes().await.map_err(|error| {
            (
                StatusCode::BAD_GATEWAY,
                Json(ErrorResponse::with_retryable(
                    format!("failed to read forwarded response: {error}"),
                    true,
                )),
            )
        })?;

        let response_body = if status.is_client_error() || status.is_server_error() {
            Self::annotate_forwarded_error(status, response_body.as_ref())
        } else {
            response_body.to_vec()
        };

        counter!(
            "hirnd_forwarded_requests_total",
            "path" => path.to_owned(),
            "realm" => realm.to_owned()
        )
        .increment(1);

        Ok(Some(ForwardedWriteResponse {
            owner,
            response: CachedJsonResponse::from_parts(status, response_body),
        }))
    }

    pub(crate) async fn forward_json_write<T: Serialize + Sync>(
        state: &HttpState,
        headers: &HeaderMap,
        path: &str,
        body: &T,
    ) -> Result<Option<ForwardedWriteResponse>, HttpError> {
        let body = serde_json::to_vec(body).map_err(|error| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse::with_retryable(
                    format!("failed to serialize forwarded request: {error}"),
                    false,
                )),
            )
        })?;

        Self::try_forward_write(state, headers, path, &body).await
    }

    fn build_forward_url(owner_addr: &str, path: &str) -> Result<reqwest::Url, HttpError> {
        let base = reqwest::Url::parse(owner_addr).map_err(|_| {
            (
                StatusCode::BAD_GATEWAY,
                Json(ErrorResponse::with_retryable(
                    "invalid owner node address; expected an explicit http:// or https:// URL",
                    false,
                )),
            )
        })?;

        match base.scheme() {
            "https" => {
                // N-H04: SSRF guard — reject cloud metadata IP ranges even over HTTPS.
                Self::reject_ssrf_target(&base)?;
            }
            "http" if Self::is_loopback_http_endpoint(&base) => {
                tracing::warn!(
                    owner_addr,
                    "using plaintext loopback owner forwarding endpoint"
                );
            }
            "http" => {
                return Err((
                    StatusCode::BAD_GATEWAY,
                    Json(ErrorResponse::with_retryable(
                        "owner node forwarding requires HTTPS; only loopback HTTP is allowed for local development",
                        false,
                    )),
                ));
            }
            _ => {
                return Err((
                    StatusCode::BAD_GATEWAY,
                    Json(ErrorResponse::with_retryable(
                        "invalid owner node address scheme",
                        false,
                    )),
                ));
            }
        }

        base.join(path).map_err(|_| {
            (
                StatusCode::BAD_GATEWAY,
                Json(ErrorResponse::with_retryable(
                    "invalid forwarded request path",
                    false,
                )),
            )
        })
    }

    /// Reject SSRF targets: cloud metadata endpoints, RFC1918, link-local,
    /// loopback, CGNAT (100.64/10), and known cloud metadata hostnames.
    ///
    /// Only checks hostnames that are IP literals or well-known metadata names;
    /// DNS-resolved IPs are validated at the reqwest client level via the
    /// `no_proxy` / custom DNS resolver if configured.
    fn reject_ssrf_target(url: &reqwest::Url) -> Result<(), HttpError> {
        let host = url.host_str().unwrap_or("");

        // Block known cloud metadata hostnames regardless of scheme.
        if matches!(
            host,
            "169.254.169.254"
                | "metadata.google.internal"
                | "metadata.goog"
                | "fd69::1"
                | "100.100.100.200" // Alibaba Cloud ECS metadata
        ) {
            return Err((
                StatusCode::BAD_GATEWAY,
                Json(ErrorResponse::with_retryable(
                    "forwarding to cloud metadata endpoints is not allowed",
                    false,
                )),
            ));
        }

        // Block IP literals in forbidden ranges.
        if let Ok(ip) = host.parse::<std::net::IpAddr>() {
            if Self::is_forbidden_ip(ip) {
                return Err((
                    StatusCode::BAD_GATEWAY,
                    Json(ErrorResponse::with_retryable(
                        "forwarding to reserved/private IP ranges is not allowed",
                        false,
                    )),
                ));
            }
        }

        Ok(())
    }

    /// Returns `true` for IP addresses that must not be forwarded to:
    /// loopback, link-local (169.254/16, fe80::/10), RFC1918 private
    /// (10/8, 172.16/12, 192.168/16), CGNAT (100.64/10), unique-local
    /// IPv6 (fc00::/7), and multicast.
    fn is_forbidden_ip(ip: std::net::IpAddr) -> bool {
        use std::net::{IpAddr, Ipv4Addr};
        match ip {
            IpAddr::V4(v4) => {
                v4.is_loopback()
                    || v4.is_link_local()
                    || v4.is_private()
                    || v4.is_broadcast()
                    // CGNAT: 100.64.0.0/10
                    || (u32::from(v4) >> 22 == u32::from(Ipv4Addr::new(100, 64, 0, 0)) >> 22)
                    // Documentation ranges: 192.0.2/24, 198.51.100/24, 203.0.113/24
                    || matches!(
                        v4.octets(),
                        [192, 0, 2, _] | [198, 51, 100, _] | [203, 0, 113, _]
                    )
            }
            IpAddr::V6(v6) => {
                let octets = v6.octets();
                v6.is_loopback()
                    || v6.is_multicast()
                    // Link-local: fe80::/10
                    || (octets[0] == 0xfe && (octets[1] & 0xc0) == 0x80)
                    // Unique-local: fc00::/7
                    || (octets[0] & 0xfe == 0xfc)
                    // Documentation range: 2001:db8::/32 (RFC 3849)
                    || (octets[0] == 0x20 && octets[1] == 0x01
                        && octets[2] == 0x0d && octets[3] == 0xb8)
                    // Check IPv4-mapped IPv6 addresses
                    || matches!(v6.to_ipv4_mapped(), Some(v4) if Self::is_forbidden_ip(IpAddr::V4(v4)))
            }
        }
    }

    fn is_loopback_http_endpoint(url: &reqwest::Url) -> bool {
        matches!(url.host_str(), Some("localhost" | "127.0.0.1" | "::1"))
    }

    fn annotate_forwarded_error(status: StatusCode, response_body: &[u8]) -> Vec<u8> {
        let retryable = Self::is_retryable_status(status);
        let annotated = match serde_json::from_slice::<Value>(response_body) {
            Ok(Value::Object(mut object)) => {
                object
                    .entry("retryable".to_owned())
                    .or_insert(Value::Bool(retryable));
                Value::Object(object)
            }
            Ok(other) => serde_json::json!({
                "error": other,
                "retryable": retryable,
            }),
            Err(_) => serde_json::json!({
                "error": String::from_utf8_lossy(response_body),
                "retryable": retryable,
            }),
        };

        serde_json::to_vec(&annotated).unwrap_or_else(|_| {
            format!(
                r#"{{"error":"failed to encode forwarded error response","retryable":{retryable}}}"#
            )
            .into_bytes()
        })
    }

    fn is_retryable_status(status: StatusCode) -> bool {
        status == StatusCode::REQUEST_TIMEOUT
            || status == StatusCode::TOO_MANY_REQUESTS
            || status.is_server_error()
    }
}

#[cfg(test)]
mod tests {
    use super::CoordinationRuntime;
    use axum::http::StatusCode;

    #[test]
    fn build_forward_url_accepts_loopback_http() {
        let parsed =
            CoordinationRuntime::build_forward_url("http://127.0.0.1:8080", "/v1/remember")
                .expect("loopback http should be accepted for local development");
        assert_eq!(parsed.as_str(), "http://127.0.0.1:8080/v1/remember");
    }

    #[test]
    fn build_forward_url_rejects_plain_hosts() {
        let err = CoordinationRuntime::build_forward_url("127.0.0.1:8080", "/v1/remember")
            .expect_err("owner addresses must include an explicit scheme");
        assert_eq!(err.0, StatusCode::BAD_GATEWAY);
    }

    #[test]
    fn build_forward_url_rejects_remote_http() {
        let err = CoordinationRuntime::build_forward_url("http://example.com", "/v1/remember")
            .expect_err("remote plaintext forwarding must be rejected");
        assert_eq!(err.0, StatusCode::BAD_GATEWAY);
    }

    #[test]
    fn build_forward_url_rejects_non_http_schemes() {
        let err = CoordinationRuntime::build_forward_url("ftp://127.0.0.1:8080", "/v1/remember")
            .expect_err("non-http schemes must be rejected");
        assert_eq!(err.0, StatusCode::BAD_GATEWAY);
    }

    // N-H04: SSRF tests — cloud metadata endpoints must be blocked even over HTTPS.

    #[test]
    fn build_forward_url_rejects_aws_imds() {
        let err = CoordinationRuntime::build_forward_url(
            "https://169.254.169.254/latest/meta-data/",
            "/v1/remember",
        )
        .expect_err("AWS IMDS must be rejected");
        assert_eq!(err.0, StatusCode::BAD_GATEWAY);
    }

    #[test]
    fn build_forward_url_rejects_gcp_metadata() {
        let err = CoordinationRuntime::build_forward_url(
            "https://metadata.google.internal/computeMetadata/v1/",
            "/v1/remember",
        )
        .expect_err("GCP metadata endpoint must be rejected");
        assert_eq!(err.0, StatusCode::BAD_GATEWAY);
    }

    #[test]
    fn build_forward_url_rejects_private_ip() {
        let err = CoordinationRuntime::build_forward_url("https://10.0.0.1:443", "/v1/remember")
            .expect_err("RFC1918 private IPs must be rejected");
        assert_eq!(err.0, StatusCode::BAD_GATEWAY);
    }

    #[test]
    fn build_forward_url_rejects_cgnat_ip() {
        let err = CoordinationRuntime::build_forward_url("https://100.64.0.1:443", "/v1/remember")
            .expect_err("CGNAT range must be rejected");
        assert_eq!(err.0, StatusCode::BAD_GATEWAY);
    }

    #[test]
    fn build_forward_url_accepts_public_https() {
        // Public IP should be accepted for HTTPS forwarding.
        let _ = CoordinationRuntime::build_forward_url("https://192.0.2.1:443", "/v1/remember")
            .expect_err("documentation range 192.0.2/24 should be rejected");
        // A genuinely public IP (not in any reserved range) must be accepted.
        let parsed = CoordinationRuntime::build_forward_url("https://1.2.3.4:443", "/v1/remember")
            .expect("public IP over HTTPS should be accepted");
        assert!(parsed.as_str().starts_with("https://1.2.3.4"));
    }
}