iris-chat 0.1.66

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
use super::*;
use crate::core::protocol::public_discovery::{test_support, DiscoveryRelays, PublicDiscovery};
use nostr::Tag;
use std::sync::atomic::Ordering;

fn reported_account_failure(receiver: &flume::Receiver<CoreMsg>) -> bool {
    receiver.try_iter().any(|message| {
        let CoreMsg::Internal(event) = message else {
            return false;
        };
        matches!(event.as_ref(), InternalEvent::DebugLog { category, detail }
            if category == "protocol.read.error" && detail.starts_with("scope=account "))
    })
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn cold_reads_reuse_account_receiver_and_keep_peer_and_private_scopes_separate() {
    let owner = Keys::generate();
    let device = Keys::generate();
    let sibling = Keys::generate();
    let oversized = Keys::generate();
    let peer = Keys::generate();
    let session = Keys::generate();
    let (failures, failed_reads) = flume::unbounded();
    let scope = ReadScope {
        account_authors: [
            owner.public_key(),
            device.public_key(),
            sibling.public_key(),
            oversized.public_key(),
        ]
        .into_iter()
        .collect(),
        failure_sender: Some(failures),
    };
    let mut events = [&owner, &device, &sibling, &peer]
        .into_iter()
        .map(|key| {
            EventBuilder::new(Kind::Metadata, "verified fixture")
                .sign_with_keys(key)
                .unwrap()
        })
        .collect::<Vec<_>>();
    events.push(
        EventBuilder::new(Kind::from(MESSAGE_EVENT_KIND as u16), "ratchet fixture")
            .tags([Tag::public_key(device.public_key())])
            .sign_with_keys(&session)
            .unwrap(),
    );
    let expected = events.iter().map(|event| event.id).collect::<HashSet<_>>();
    events.push(
        EventBuilder::new(Kind::Metadata, "x".repeat(128 * 1024))
            .sign_with_keys(&oversized)
            .unwrap(),
    );
    let mut forged = EventBuilder::new(Kind::Metadata, "forged own metadata")
        .sign_with_keys(&owner)
        .unwrap();
    forged.sig = events.last().unwrap().sig;
    events.push(forged);
    let relay = test_support::plain_relay(events).await;
    let client = Client::new(device.clone());
    client.add_relay(relay.url.clone()).await.unwrap();
    client.connect().await;
    let receiver = client.relay(relay.url.clone()).await.unwrap();
    let retained = SubscriptionId::new("existing-account-receiver");
    receiver
        .subscribe_with_id(
            retained.clone(),
            vec![Filter::new()
                .kind(Kind::Metadata)
                .author(owner.public_key())],
            SubscribeOptions::default(),
        )
        .await
        .unwrap();
    test_support::until(|| {
        relay
            .ready_subjects()
            .contains(&owner.public_key().to_hex())
    })
    .await;
    assert_eq!(relay.connections.load(Ordering::SeqCst), 1);

    let pool = Arc::new(DiscoveryRelays::default());
    let (sender, _incoming) = flume::unbounded();
    let worker = PublicDiscovery::new(&tokio::runtime::Handle::current(), sender, pool.clone());
    worker
        .configure(
            std::slice::from_ref(&relay.url),
            vec![Filter::new().kind(Kind::Metadata).author(peer.public_key())],
        )
        .unwrap();
    test_support::until(|| relay.ready_subjects().contains(&peer.public_key().to_hex())).await;
    assert_eq!(relay.connections.load(Ordering::SeqCst), 2);
    let public = Filter::new().kind(Kind::Metadata).authors([
        owner.public_key(),
        device.public_key(),
        sibling.public_key(),
        oversized.public_key(),
        peer.public_key(),
    ]);
    let private = Filter::new()
        .kind(Kind::from(MESSAGE_EVENT_KIND as u16))
        .author(session.public_key())
        .pubkey(device.public_key());
    for _ in 0..2 {
        let fetched = fetch_events_for_filters(
            &client,
            &pool,
            &scope,
            vec![public.clone(), private.clone()],
            Duration::from_secs(3),
        )
        .await
        .unwrap();
        assert_eq!(
            fetched.iter().map(|event| event.id).collect::<HashSet<_>>(),
            expected
        );
    }
    // Only private reads get fresh anonymous connections. Public reads reuse
    // the original account receiver and the one anonymous peer connection.
    test_support::until(|| relay.active.load(Ordering::SeqCst) == 2).await;
    assert_eq!(relay.connections.load(Ordering::SeqCst), 4);

    let own_filter = Filter::new()
        .kind(Kind::Metadata)
        .author(owner.public_key());
    let before = relay.requests();
    relay.hold_eose.store(true, Ordering::SeqCst);
    let pending = tokio::spawn({
        let client = client.clone();
        let pool = pool.clone();
        let filter = own_filter.clone();
        let scope = ReadScope {
            account_authors: scope.account_authors.clone(),
            failure_sender: scope.failure_sender.clone(),
        };
        async move {
            fetch_events_for_filters(
                &client,
                &pool,
                &scope,
                vec![filter],
                Duration::from_secs(30),
            )
            .await
        }
    });
    test_support::until(|| relay.requests() > before).await;
    let pending_id = relay
        .wire
        .lock()
        .unwrap()
        .iter()
        .rev()
        .find(|(_, frame)| frame[0] == "REQ")
        .unwrap()
        .1[1]
        .clone();
    pending.abort();
    assert!(pending.await.unwrap_err().is_cancelled());
    test_support::until(|| {
        relay
            .wire
            .lock()
            .unwrap()
            .iter()
            .any(|(_, frame)| frame[0] == "CLOSE" && frame[1] == pending_id)
    })
    .await;
    assert!(receiver
        .subscription(&SubscriptionId::new(pending_id.as_str().unwrap()))
        .await
        .is_none());
    relay.hold_eose.store(false, Ordering::SeqCst);
    assert!(receiver.subscription(&retained).await.is_some());

    relay.reject_subscriptions.store(true, Ordering::SeqCst);
    assert!(fetch_events_for_filters(
        &client,
        &pool,
        &scope,
        vec![own_filter.clone()],
        Duration::from_secs(3)
    )
    .await
    .is_err());
    relay.reject_subscriptions.store(false, Ordering::SeqCst);
    // Rejection and cancellation must not send the own-author read to the peer
    // pool, open a fallback socket, or close the account's retained receiver.
    assert!(receiver.subscription(&retained).await.is_some());
    assert_eq!(relay.connections.load(Ordering::SeqCst), 4);
    let recovered = fetch_events_for_filters(
        &client,
        &pool,
        &scope,
        vec![own_filter],
        Duration::from_secs(3),
    )
    .await
    .unwrap();
    assert_eq!(recovered.len(), 1);
    assert_eq!(recovered[0].pubkey, owner.public_key());
    assert!(reported_account_failure(&failed_reads));

    let rows = relay.wire.lock().unwrap().clone();
    let mut authentication = BTreeMap::new();
    for (connection, frame) in rows.iter().filter(|(_, frame)| frame[0] == "AUTH") {
        let auth: Event = serde_json::from_value(frame[1].clone()).unwrap();
        auth.verify().unwrap();
        authentication.insert(*connection, auth.pubkey);
    }
    assert_eq!(authentication.len(), 4);
    let account_connections = authentication
        .iter()
        .filter(|(_, signer)| **signer == device.public_key())
        .map(|(connection, _)| *connection)
        .collect::<HashSet<_>>();
    assert_eq!(account_connections.len(), 1);
    let mut peers = HashSet::new();
    let mut private_connections = HashSet::new();
    for (connection, frame) in rows.iter().filter(|(_, frame)| frame[0] == "REQ") {
        for value in &frame.as_array().unwrap()[2..] {
            let filter: Filter = serde_json::from_value(value.clone()).unwrap();
            let authors = filter.authors.as_ref().unwrap();
            if account_connections.contains(connection) {
                assert!(authors
                    .iter()
                    .all(|author| scope.account_authors.contains(author)));
                assert_eq!(
                    filter.kinds.as_ref().unwrap(),
                    &std::collections::BTreeSet::from([Kind::Metadata])
                );
                assert!(value.get("#p").is_none());
            } else {
                let signer = authentication[connection];
                assert!(!scope.account_authors.contains(&signer));
                assert_ne!(signer, peer.public_key());
                assert_ne!(signer, session.public_key());
                if value.get("#p").is_some() {
                    private_connections.insert(*connection);
                    assert_eq!(
                        authors,
                        &std::collections::BTreeSet::from([session.public_key()])
                    );
                    assert_eq!(
                        value["#p"],
                        serde_json::json!([device.public_key().to_hex()])
                    );
                    assert_eq!(
                        filter.kinds.as_ref().unwrap(),
                        &std::collections::BTreeSet::from([Kind::from(MESSAGE_EVENT_KIND as u16)])
                    );
                } else {
                    peers.insert(*connection);
                    assert_eq!(
                        authors,
                        &std::collections::BTreeSet::from([peer.public_key()])
                    );
                    assert_eq!(
                        filter.kinds.as_ref().unwrap(),
                        &std::collections::BTreeSet::from([Kind::Metadata])
                    );
                }
            }
        }
    }
    assert_eq!(peers.len(), 1);
    assert_eq!(private_connections.len(), 2);
    assert!(peers.is_disjoint(&private_connections));
    assert_eq!(
        private_connections
            .iter()
            .map(|connection| authentication[connection])
            .collect::<HashSet<_>>()
            .len(),
        2,
        "private retries must use fresh anonymous AUTH"
    );
    assert!(rows.iter().all(|(_, frame)| frame[0] != "EVENT"));
    drop(worker);
    client.shutdown().await;
    pool.stop(&tokio::runtime::Handle::current());
    test_support::until(|| relay.active.load(Ordering::SeqCst) == 0).await;
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn account_auth_or_query_failure_preserves_successful_peer_and_private_reads() {
    for reject_auth in [false, true] {
        let owner = Keys::generate();
        let device = Keys::generate();
        let peer = Keys::generate();
        let session = Keys::generate();
        let own_event = EventBuilder::new(Kind::Metadata, "own")
            .sign_with_keys(&owner)
            .unwrap();
        let peer_event = EventBuilder::new(Kind::Metadata, "peer")
            .sign_with_keys(&peer)
            .unwrap();
        let private_event = EventBuilder::new(Kind::from(MESSAGE_EVENT_KIND as u16), "private")
            .tags([Tag::public_key(device.public_key())])
            .sign_with_keys(&session)
            .unwrap();
        let relay =
            test_support::plain_relay(vec![own_event, peer_event.clone(), private_event.clone()])
                .await;
        let rejected = if reject_auth {
            &relay.reject_authentication_for
        } else {
            &relay.reject_requests_for
        };
        rejected.lock().unwrap().insert(device.public_key());
        let client = Client::new(device.clone());
        client.add_relay(relay.url.clone()).await.unwrap();
        client.connect().await;
        let pool = Arc::new(DiscoveryRelays::default());
        let (sender, _incoming) = flume::unbounded();
        let worker = PublicDiscovery::new(&tokio::runtime::Handle::current(), sender, pool.clone());
        worker
            .configure(
                std::slice::from_ref(&relay.url),
                vec![Filter::new().kind(Kind::Metadata).author(peer.public_key())],
            )
            .unwrap();
        test_support::until(|| relay.ready_subjects().contains(&peer.public_key().to_hex())).await;
        let (sender, failures) = flume::unbounded();
        let scope = ReadScope {
            account_authors: HashSet::from([owner.public_key(), device.public_key()]),
            failure_sender: Some(sender),
        };
        let filters = vec![
            Filter::new()
                .kind(Kind::Metadata)
                .authors([owner.public_key(), peer.public_key()]),
            Filter::new()
                .kind(Kind::from(MESSAGE_EVENT_KIND as u16))
                .author(session.public_key())
                .pubkey(device.public_key()),
        ];
        let result =
            fetch_events_for_filters(&client, &pool, &scope, filters, Duration::from_secs(3))
                .await
                .unwrap();
        assert_eq!(
            result.iter().map(|event| event.id).collect::<HashSet<_>>(),
            HashSet::from([peer_event.id, private_event.id])
        );
        assert!(reported_account_failure(&failures));
        assert!(fetch_events_for_filters(
            &client,
            &pool,
            &scope,
            vec![Filter::new()
                .kind(Kind::Metadata)
                .author(owner.public_key())],
            Duration::from_secs(3)
        )
        .await
        .is_err());
        assert!(reported_account_failure(&failures));

        let rows = relay.wire.lock().unwrap().clone();
        let authentication = rows
            .iter()
            .filter(|(_, frame)| frame[0] == "AUTH")
            .map(|(connection, frame)| {
                let event: Event = serde_json::from_value(frame[1].clone()).unwrap();
                event.verify().unwrap();
                (*connection, event.pubkey)
            })
            .collect::<BTreeMap<_, _>>();
        let mut peer_connections = HashSet::new();
        let mut private_connections = HashSet::new();
        for (connection, frame) in rows.iter().filter(|(_, frame)| frame[0] == "REQ") {
            for value in &frame.as_array().unwrap()[2..] {
                let filter: Filter = serde_json::from_value(value.clone()).unwrap();
                let authors = filter.authors.as_ref().unwrap();
                let signer = authentication[connection];
                if signer != device.public_key() {
                    assert!(!scope.account_authors.contains(&signer));
                    assert_ne!(signer, peer.public_key());
                    assert_ne!(signer, session.public_key());
                }
                if authentication[connection] == device.public_key() {
                    assert_eq!(
                        authors,
                        &std::collections::BTreeSet::from([owner.public_key()])
                    );
                    assert_eq!(value["kinds"], serde_json::json!([0]));
                    assert!(value.get("#p").is_none());
                } else if value.get("#p").is_some() {
                    private_connections.insert(*connection);
                    assert_eq!(
                        authors,
                        &std::collections::BTreeSet::from([session.public_key()])
                    );
                    assert_eq!(
                        value["#p"],
                        serde_json::json!([device.public_key().to_hex()])
                    );
                } else {
                    peer_connections.insert(*connection);
                    assert_eq!(
                        authors,
                        &std::collections::BTreeSet::from([peer.public_key()])
                    );
                    assert_eq!(value["kinds"], serde_json::json!([0]));
                }
            }
        }
        assert_eq!(peer_connections.len(), 1);
        assert_eq!(private_connections.len(), 1);
        assert!(peer_connections.is_disjoint(&private_connections));
        assert!(rows.iter().all(|(_, frame)| frame[0] != "EVENT"));
        drop(worker);
        client.shutdown().await;
        pool.stop(&tokio::runtime::Handle::current());
        test_support::until(|| relay.active.load(Ordering::SeqCst) == 0).await;
    }
}