iris-chat 0.1.47

Iris Chat command line client and shared encrypted chat core
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
434
435
436
437
438
439
use async_trait::async_trait;
use hashtree_core::{sha256, to_hex, Hash, Store, StoreError};
use reqwest::StatusCode;
use std::collections::{HashMap, VecDeque};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc, OnceLock};
use std::time::Duration;
use tokio::sync::RwLock;

/// Read-only Blossom store whose owned response buffer cannot exceed its
/// per-blob cap. Every received body chunk also shares one traversal budget,
/// including chunks from failed servers and snapshot fallback attempts.
pub(super) struct BoundedBlossomStore {
    client: reqwest::Client,
    servers: Vec<String>,
    max_blob_bytes: usize,
    budget: ReadBudget,
    cache: Arc<RwLock<BlobCache>>,
}

const MAX_CACHED_BYTES: usize = 32 * 1024 * 1024;
static SHARED_CACHE: OnceLock<Arc<RwLock<BlobCache>>> = OnceLock::new();

#[derive(Default)]
struct BlobCache {
    entries: HashMap<Hash, Vec<u8>>,
    order: VecDeque<Hash>,
    bytes: usize,
}

impl BlobCache {
    fn insert(&mut self, hash: Hash, data: Vec<u8>) {
        if self.entries.contains_key(&hash) || data.len() > MAX_CACHED_BYTES {
            return;
        }
        while self.bytes + data.len() > MAX_CACHED_BYTES {
            let Some(oldest) = self.order.pop_front() else {
                break;
            };
            if let Some(removed) = self.entries.remove(&oldest) {
                self.bytes -= removed.len();
            }
        }
        self.bytes += data.len();
        self.order.push_back(hash);
        self.entries.insert(hash, data);
    }
}

struct ReadBudget {
    reads_left: AtomicUsize,
    bytes_left: AtomicUsize,
}

impl ReadBudget {
    fn new(reads: usize, bytes: usize) -> Self {
        Self {
            reads_left: AtomicUsize::new(reads),
            bytes_left: AtomicUsize::new(bytes),
        }
    }

    fn consume(counter: &AtomicUsize, amount: usize) -> bool {
        #[allow(
            deprecated,
            reason = "The Linux release toolchain uses Rust 1.93, before Atomic::try_update stabilized."
        )]
        let previous = counter
            .fetch_update(Ordering::Relaxed, Ordering::Relaxed, |left| {
                Some(left.saturating_sub(amount))
            })
            .unwrap_or_else(|left| left);
        previous >= amount
    }

    fn consume_read(&self) -> bool {
        Self::consume(&self.reads_left, 1)
    }

    fn consume_bytes(&self, bytes: usize) -> bool {
        Self::consume(&self.bytes_left, bytes)
    }
}

#[derive(Debug, PartialEq, Eq)]
enum BlobFetchError {
    Request(String),
    Status(u16),
    TooLarge { buffered_bytes: usize, limit: usize },
    HashMismatch,
    BudgetExceeded,
}

impl std::fmt::Display for BlobFetchError {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Request(error) => formatter.write_str(error),
            Self::Status(status) => write!(formatter, "HTTP {status}"),
            Self::TooLarge {
                buffered_bytes,
                limit,
            } => write!(
                formatter,
                "blob exceeds {limit}-byte limit after buffering {buffered_bytes} bytes"
            ),
            Self::HashMismatch => formatter.write_str("downloaded blob hash does not match CID"),
            Self::BudgetExceeded => formatter.write_str("profile search byte budget exceeded"),
        }
    }
}

impl BoundedBlossomStore {
    pub(super) fn new(
        servers: Vec<String>,
        timeout: Duration,
        max_blob_bytes: usize,
        max_reads: usize,
        max_total_bytes: usize,
    ) -> Result<Self, String> {
        let client = reqwest::Client::builder()
            .timeout(timeout)
            .build()
            .map_err(|error| format!("could not start profile blob client: {error}"))?;
        Ok(Self {
            client,
            servers,
            max_blob_bytes,
            budget: ReadBudget::new(max_reads, max_total_bytes),
            cache: Arc::new(RwLock::new(BlobCache::default())),
        })
    }

    pub(super) fn with_shared_cache(mut self) -> Self {
        self.cache = SHARED_CACHE
            .get_or_init(|| Arc::new(RwLock::new(BlobCache::default())))
            .clone();
        self
    }

    async fn fetch_from_server(
        &self,
        server: &str,
        hash: &Hash,
    ) -> Result<Option<Vec<u8>>, BlobFetchError> {
        let url = format!("{}/{}.bin", server.trim_end_matches('/'), to_hex(hash));
        let mut response = self
            .client
            .get(url)
            .send()
            .await
            .map_err(|error| BlobFetchError::Request(error.to_string()))?;
        if response.status() == StatusCode::NOT_FOUND {
            return Ok(None);
        }
        if !response.status().is_success() {
            return Err(BlobFetchError::Status(response.status().as_u16()));
        }
        if response
            .content_length()
            .is_some_and(|length| length > self.max_blob_bytes as u64)
        {
            return Err(BlobFetchError::TooLarge {
                buffered_bytes: 0,
                limit: self.max_blob_bytes,
            });
        }

        let mut data = Vec::new();
        while let Some(chunk) = response
            .chunk()
            .await
            .map_err(|error| BlobFetchError::Request(error.to_string()))?
        {
            if !self.budget.consume_bytes(chunk.len()) {
                return Err(BlobFetchError::BudgetExceeded);
            }
            if chunk.len() > self.max_blob_bytes.saturating_sub(data.len()) {
                return Err(BlobFetchError::TooLarge {
                    buffered_bytes: data.len(),
                    limit: self.max_blob_bytes,
                });
            }
            data.extend_from_slice(&chunk);
        }
        if sha256(&data) != *hash {
            return Err(BlobFetchError::HashMismatch);
        }
        Ok(Some(data))
    }
}

#[async_trait]
impl Store for BoundedBlossomStore {
    async fn put(&self, _hash: Hash, _data: Vec<u8>) -> Result<bool, StoreError> {
        Err(StoreError::Other(
            "profile search store is read-only".to_string(),
        ))
    }

    async fn get(&self, hash: &Hash) -> Result<Option<Vec<u8>>, StoreError> {
        if !self.budget.consume_read() {
            return Err(StoreError::Other(
                "profile search read budget exceeded".to_string(),
            ));
        }
        {
            let cache = self.cache.read().await;
            if let Some(data) = cache.entries.get(hash) {
                if data.len() > self.max_blob_bytes {
                    return Err(StoreError::Other(
                        "cached profile blob exceeds byte limit".to_string(),
                    ));
                }
                if !self.budget.consume_bytes(data.len()) {
                    return Err(StoreError::Other(
                        "profile search byte budget exceeded".to_string(),
                    ));
                }
                return Ok(Some(data.clone()));
            }
        }

        let mut last_error = None;
        for server in &self.servers {
            match self.fetch_from_server(server, hash).await {
                Ok(Some(data)) => {
                    self.cache.write().await.insert(*hash, data.clone());
                    return Ok(Some(data));
                }
                Ok(None) => {}
                Err(BlobFetchError::BudgetExceeded) => {
                    return Err(StoreError::Other(
                        "profile search byte budget exceeded".to_string(),
                    ));
                }
                Err(error) => last_error = Some(format!("{server}: {error}")),
            }
        }
        match last_error {
            Some(error) => Err(StoreError::Other(format!(
                "profile search blob download failed: {error}"
            ))),
            None => Ok(None),
        }
    }

    async fn has(&self, hash: &Hash) -> Result<bool, StoreError> {
        if !self.budget.consume_read() {
            return Err(StoreError::Other(
                "profile search read budget exceeded".to_string(),
            ));
        }
        if self.cache.read().await.entries.contains_key(hash) {
            return Ok(true);
        }
        let hash = to_hex(hash);
        for server in &self.servers {
            let url = format!("{}/{}.bin", server.trim_end_matches('/'), hash);
            if self
                .client
                .head(url)
                .send()
                .await
                .is_ok_and(|response| response.status().is_success())
            {
                return Ok(true);
            }
        }
        Ok(false)
    }

    async fn delete(&self, _hash: &Hash) -> Result<bool, StoreError> {
        Err(StoreError::Other(
            "profile search store is read-only".to_string(),
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::{Read, Write};
    use std::net::TcpListener;
    use std::thread;

    fn serve_chunked_blob(chunks: Vec<Vec<u8>>) -> (String, thread::JoinHandle<String>) {
        let listener = TcpListener::bind("127.0.0.1:0").unwrap();
        let address = listener.local_addr().unwrap();
        let server = thread::spawn(move || {
            let (mut stream, _) = listener.accept().unwrap();
            let mut request = Vec::new();
            let mut buffer = [0; 1024];
            while !request.windows(4).any(|window| window == b"\r\n\r\n") {
                let count = stream.read(&mut buffer).unwrap();
                if count == 0 {
                    break;
                }
                request.extend_from_slice(&buffer[..count]);
            }
            stream
                .write_all(b"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n")
                .unwrap();
            for chunk in chunks {
                if write!(stream, "{:x}\r\n", chunk.len()).is_err()
                    || stream.write_all(&chunk).is_err()
                    || stream.write_all(b"\r\n").is_err()
                    || stream.flush().is_err()
                {
                    break;
                }
                thread::sleep(Duration::from_millis(5));
            }
            let _ = stream.write_all(b"0\r\n\r\n");
            String::from_utf8_lossy(&request).into_owned()
        });
        (format!("http://{address}"), server)
    }

    fn test_store(
        servers: Vec<String>,
        blob: usize,
        reads: usize,
        total: usize,
    ) -> BoundedBlossomStore {
        BoundedBlossomStore::new(servers, Duration::from_secs(1), blob, reads, total).unwrap()
    }

    fn assert_requested(server: thread::JoinHandle<String>, hash: &Hash) {
        assert!(server
            .join()
            .unwrap()
            .contains(&format!("/{}.bin", to_hex(hash))));
    }

    #[tokio::test]
    async fn chunked_response_never_grows_owned_buffer_past_blob_limit() {
        let body = vec![7; 48];
        let hash = sha256(&body);
        let (url, server) = serve_chunked_blob(vec![body[..16].to_vec(); 3]);
        let store = test_store(vec![url.clone()], 24, 1, 100);

        let error = store.fetch_from_server(&url, &hash).await.unwrap_err();
        assert!(matches!(
            error,
            BlobFetchError::TooLarge {
                buffered_bytes: 0..=24,
                limit: 24
            }
        ));
        assert_requested(server, &hash);
    }

    #[tokio::test]
    async fn oversized_server_falls_back_to_valid_hash_matching_blob() {
        let valid = b"bounded profile blob";
        let hash = sha256(valid);
        let (large_url, large_server) = serve_chunked_blob(vec![vec![9; 16], vec![9; 16]]);
        let (valid_url, valid_server) = serve_chunked_blob(vec![valid.to_vec()]);
        let store = test_store(vec![large_url, valid_url], valid.len(), 1, 100);

        assert_eq!(
            store.get(&hash).await.unwrap().as_deref(),
            Some(valid.as_slice())
        );
        assert_requested(large_server, &hash);
        assert_requested(valid_server, &hash);
    }

    #[tokio::test]
    async fn hash_mismatch_falls_back_to_valid_server() {
        let valid = b"bounded profile index blob";
        let hash = sha256(valid);
        let (bad_url, bad_server) = serve_chunked_blob(vec![b"wrong body".to_vec()]);
        let (valid_url, valid_server) = serve_chunked_blob(vec![valid.to_vec()]);
        let store = test_store(vec![bad_url, valid_url], valid.len(), 1, 100);

        assert_eq!(
            store.get(&hash).await.unwrap().as_deref(),
            Some(valid.as_slice())
        );
        assert_requested(bad_server, &hash);
        assert_requested(valid_server, &hash);
    }

    #[tokio::test]
    async fn failed_servers_share_and_exhaust_aggregate_byte_budget() {
        let hash = sha256(b"expected body");
        let (first_url, first_server) = serve_chunked_blob(vec![vec![1; 16]]);
        let (second_url, second_server) = serve_chunked_blob(vec![vec![2; 16]]);
        let store = test_store(vec![first_url, second_url], 32, 1, 24);

        let error = store.get(&hash).await.unwrap_err();
        assert!(error.to_string().contains("byte budget exceeded"));
        assert_requested(first_server, &hash);
        assert_requested(second_server, &hash);
        assert_eq!(store.budget.bytes_left.load(Ordering::Relaxed), 0);
    }

    #[tokio::test]
    async fn cache_hits_consume_read_and_byte_budgets() {
        let body = b"cached profile blob";
        let hash = sha256(body);
        let (url, server) = serve_chunked_blob(vec![body.to_vec()]);
        let store = test_store(vec![url], body.len(), 3, body.len() * 2);

        assert!(store.get(&hash).await.unwrap().is_some());
        assert!(store.get(&hash).await.unwrap().is_some());
        assert_eq!(store.budget.reads_left.load(Ordering::Relaxed), 1);
        assert_eq!(store.budget.bytes_left.load(Ordering::Relaxed), 0);
        assert!(store
            .get(&hash)
            .await
            .unwrap_err()
            .to_string()
            .contains("byte budget exceeded"));
        assert_requested(server, &hash);
    }

    #[tokio::test]
    async fn separate_searches_reuse_verified_blobs_with_independent_budgets() {
        let body = b"shared cross-query profile blob";
        let hash = sha256(body);
        let (url, server) = serve_chunked_blob(vec![body.to_vec()]);
        let first = test_store(vec![url], body.len(), 1, body.len()).with_shared_cache();
        assert_eq!(
            first.get(&hash).await.unwrap().as_deref(),
            Some(body.as_slice())
        );
        assert_requested(server, &hash);
        let second = test_store(Vec::new(), body.len(), 1, body.len()).with_shared_cache();
        assert_eq!(
            second.get(&hash).await.unwrap().as_deref(),
            Some(body.as_slice())
        );
        assert!(second.get(&hash).await.is_err());
        let limited = test_store(Vec::new(), body.len() - 1, 1, body.len()).with_shared_cache();
        assert!(limited.get(&hash).await.is_err());
    }
}