apeirogond 0.18.0

Daemon for Apeirogon, a cross-platform software KVM
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
// SPDX-License-Identifier: GPL-3.0-or-later

use std::net::{Ipv4Addr, SocketAddr};

use a7n_core::clipboard::{Item, TEXT_PLAIN};
use a7n_proto::v1::Envelope;
use tempfile::TempDir;
use tokio::sync::mpsc;
use tokio::time::timeout;

use super::*;
use crate::daemon::test_peer::{Peer, TEST_TIMEOUT};

fn daemon() -> (
    Daemon,
    TempDir,
    mpsc::Sender<LocalChange>,
    mpsc::Receiver<ClipboardCommand>,
) {
    let dir = tempfile::tempdir().unwrap();
    let daemon = Daemon::load(dir.path(), SocketAddr::from((Ipv4Addr::LOCALHOST, 0))).unwrap();
    let (changes, change_rx) = mpsc::channel(8);
    let (command_tx, commands) = mpsc::channel(8);
    (
        daemon.with_clipboard(Some(Clipboard {
            images: true,
            files: false,
            changes: change_rx,
            commands: command_tx,
            pastes: mpsc::channel(1).1,
        })),
        dir,
        changes,
        commands,
    )
}

fn change(text: &str) -> LocalChange {
    LocalChange {
        files: Vec::new(),
        items: vec![Item {
            mime: TEXT_PLAIN.into(),
            data: text.as_bytes().to_vec(),
        }],
        sensitive: false,
        source_app: None,
    }
}

fn wire(origin: MachineId, generation: u64, text: &str) -> ClipboardAnnounce {
    clipboard::announce(change(text).items, Generation { origin, generation }).unwrap()
}

mod ask;
mod fetch;

#[tokio::test]
async fn clipboard_status_local_change_returns_metadata_only() {
    // Arrange
    let (mut daemon, dir, _changes, _commands) = daemon();
    daemon.info.name = "this machine".into();
    let offline = MachineId::try_from(&[1; MachineId::LEN][..]).unwrap();
    daemon.pins.add(crate::pin_store::Entry {
        machine_id: offline,
        pin: daemon.identity.pin,
        name: "offline peer".into(),
        spki_der: None,
        hw_addr: None,
        screen_mm: None,
    });
    daemon
        .config
        .set(&format!("peers.{offline}.clipboard"), "off")
        .unwrap();
    let mut copy = change("sample");
    copy.items.push(Item {
        mime: a7n_core::clipboard::TEXT_HTML.into(),
        data: b"<p>x</p>".to_vec(),
    });
    daemon.clipboard_changed(Some(copy));
    let peer = Peer::run(daemon, dir);
    let socket_dir = tempfile::tempdir().unwrap();
    let location = a7n_ipc::SocketLocation::new(socket_dir.path().join("private/control.sock"));
    let server = a7n_ipc::IpcServer::bind_at(&location).await.unwrap();
    let server_task = tokio::spawn(crate::ipc_server::serve(
        server,
        peer.sender.as_ref().unwrap().clone(),
    ));
    let mut client = a7n_ipc::IpcClient::connect_at(&location).await.unwrap();

    // Act
    let response = client
        .request(&a7n_ipc::Request::ClipboardStatus)
        .await
        .unwrap();

    // Assert
    let a7n_ipc::Response::Clipboard(info) = response else {
        panic!("expected clipboard status")
    };
    assert_eq!(
        info,
        ClipboardInfo {
            held: None,
            available: true,
            current: Some(ClipboardCopy {
                origin: peer.machine,
                origin_name: Some("this machine".into()),
                generation: 1,
                items: 2,
                size: 14,
                local: true,
            }),
            peers: vec![PeerClipboard {
                machine: offline,
                name: "offline peer".into(),
                policy: ClipboardPolicy::Off,
                linked: false,
            }],
        }
    );
    drop(client);
    server_task.abort();
    let _ = server_task.await;
    peer.stop().await;
}

#[tokio::test]
async fn clipboard_changed_two_daemons_delivers_only_non_sensitive_copy() {
    // Arrange
    let (a, a_dir, changes, _a_commands) = daemon();
    let (b, b_dir, _b_changes, mut commands) = daemon();
    let (a, b) = (Peer::run(a, a_dir), Peer::run(b, b_dir));
    a.pair(&b).await;
    let mut sensitive = change("secret");
    sensitive.sensitive = true;

    // Act
    changes.send(sensitive).await.unwrap();
    changes.send(change("public")).await.unwrap();
    let command = timeout(TEST_TIMEOUT, commands.recv())
        .await
        .unwrap()
        .unwrap();

    // Assert
    let ClipboardCommand::Set {
        generation, items, ..
    } = command;
    assert_eq!(
        generation,
        Generation {
            generation: 1,
            origin: a.machine
        }
    );
    assert_eq!(items, change("public").items);
    assert!(commands.try_recv().is_err());
    a.stop().await;
    b.stop().await;
}

#[tokio::test]
async fn clipboard_link_up_own_copy_is_sent_to_new_peer() {
    // Arrange
    let (mut a, a_dir, _changes, _a_commands) = daemon();
    let (b, b_dir, _b_changes, mut commands) = daemon();
    a.clipboard_changed(Some(change("before pairing")));
    let (a, b) = (Peer::run(a, a_dir), Peer::run(b, b_dir));

    // Act
    a.pair(&b).await;
    let command = timeout(TEST_TIMEOUT, commands.recv())
        .await
        .unwrap()
        .unwrap();

    // Assert
    let ClipboardCommand::Set { items, .. } = command;
    assert_eq!(items, change("before pairing").items);
    a.stop().await;
    b.stop().await;
}

#[tokio::test]
async fn receive_clipboard_send_policy_ignores_copy_and_observes_counter() {
    // Arrange
    let (mut a, _a_dir, _a_changes, _a_commands) = daemon();
    let (mut b, _b_dir, _b_changes, mut commands) = daemon();
    let peer = a.identity.machine_id;
    b.config
        .set(&format!("peers.{peer}.clipboard"), "send")
        .unwrap();
    a.clipboard_changed(Some(change("ignored")));
    let incoming = a.clipboard.announce.clone().unwrap();

    // Act
    b.receive_from(
        peer,
        Envelope {
            body: Some(Body::ClipboardAnnounce(incoming)),
        },
    )
    .await
    .unwrap();

    // Assert
    assert!(commands.try_recv().is_err());
    assert!(b.clipboard.current.is_none());
    assert_eq!(b.clipboard.clock.next(b.identity.machine_id).generation, 2);
}

#[tokio::test]
async fn receive_clipboard_old_or_invalid_copy_keeps_current_and_backend_alive() {
    // Arrange
    let (mut daemon, _dir, _changes, mut commands) = daemon();
    let peer = daemon.identity.machine_id;
    let initial = wire(peer, 10, "current");
    daemon.receive_clipboard(peer, &initial);
    commands.try_recv().unwrap();
    let mut invalid = wire(peer, 20, "invalid");
    invalid.items[0].sha256[0] ^= 1;

    // Act
    daemon
        .receive_from(
            peer,
            Envelope {
                body: Some(Body::ClipboardAnnounce(invalid)),
            },
        )
        .await
        .unwrap();
    daemon.receive_clipboard(peer, &wire(peer, 9, "older"));

    // Assert
    assert!(commands.try_recv().is_err());
    assert_eq!(daemon.clipboard.current.unwrap().generation, 10);
    assert!(daemon.clipboard.handle.is_some());
    assert_eq!(daemon.clipboard.clock.next(peer).generation, 21);
    daemon.receive_clipboard(peer, &wire(peer, 21, "next"));
    assert!(commands.try_recv().is_ok());
}

#[tokio::test]
async fn receive_clipboard_metadata_only_installs_lazy_item() {
    // Arrange
    let (mut daemon, _dir, _changes, mut commands) = daemon();
    let peer = daemon.identity.machine_id;
    let incoming = wire(
        peer,
        10,
        &"x".repeat(a7n_proto::limits::CLIPBOARD_INLINE_MAX + 1),
    );

    // Act
    daemon.receive_clipboard(peer, &incoming);
    daemon.receive_clipboard(peer, &wire(peer, 9, "older"));

    // Assert
    let ClipboardCommand::Set { items, lazy, .. } = commands.try_recv().unwrap();
    assert_eq!(items, []);
    assert_eq!(lazy.len(), 1);
    assert_eq!(lazy[0].item_index, 0);
    assert_eq!(daemon.clipboard.current.unwrap().generation, 10);
    assert_eq!(daemon.clipboard.announce, Some(incoming));
}

#[tokio::test]
async fn clipboard_changed_deny_list_does_not_advance_or_replay_previous_copy() {
    // Arrange
    let (mut daemon, _dir, _changes, _commands) = daemon();
    daemon.config.clipboard.deny_apps = vec!["secret.app".into()];
    daemon.clipboard_changed(Some(change("previous")));
    let mut denied = change("secret");
    denied.source_app = Some("SECRET.APP".into());

    // Act
    daemon.clipboard_changed(Some(denied));

    // Assert
    assert_eq!(daemon.clipboard.current.unwrap().generation, 1);
    assert!(daemon.clipboard.announce.is_none());
    assert_eq!(
        daemon
            .clipboard
            .clock
            .next(daemon.identity.machine_id)
            .generation,
        2
    );
}

#[tokio::test]
async fn clipboard_link_up_send_policy_or_older_generation_does_not_set_backend() {
    for send_only in [true, false] {
        // Arrange
        let (mut a, a_dir, _a_changes, _a_commands) = daemon();
        let (mut b, b_dir, _b_changes, mut commands) = daemon();
        a.clipboard_changed(Some(change("A copy")));
        if send_only {
            b.config
                .set(
                    &format!("peers.{}.clipboard", a.identity.machine_id),
                    "send",
                )
                .unwrap();
        } else {
            b.clipboard.clock.observe(&Generation {
                generation: 10,
                origin: a.identity.machine_id,
            });
            b.clipboard_changed(Some(change("newer B copy")));
        }
        let (a, b) = (Peer::run(a, a_dir), Peer::run(b, b_dir));

        // Act
        a.pair(&b).await;
        // Layout follows the link-up announce on the same reliable control stream.
        a.command(|reply| crate::command::Command::SetLayout {
            placed: vec![a7n_ipc::LayoutPlacement {
                machine: a.machine,
                x: 0,
                y: 0,
                width: 100,
                height: 100,
                blocked: 0,
            }],
            reply,
        })
        .await
        .unwrap();
        timeout(TEST_TIMEOUT, async {
            loop {
                let layout = b.command(crate::command::Command::GetLayout).await.unwrap();
                if !layout.placed.is_empty() {
                    break;
                }
                tokio::task::yield_now().await;
            }
        })
        .await
        .unwrap();

        // Assert
        assert!(commands.try_recv().is_err());
        a.stop().await;
        b.stop().await;
    }
}

#[tokio::test]
async fn receive_clipboard_invalid_inline_image_does_not_set_backend() {
    // Arrange
    let (mut daemon, _dir, _changes, mut commands) = daemon();
    let peer = daemon.identity.machine_id;
    let incoming = clipboard::announce(
        vec![Item {
            mime: clipboard::IMAGE_PNG.into(),
            data: b"invalid PNG".to_vec(),
        }],
        Generation {
            origin: peer,
            generation: 1,
        },
    )
    .unwrap();

    // Act
    daemon.receive_clipboard(peer, &incoming);

    // Assert
    assert!(commands.try_recv().is_err());
    assert!(daemon.clipboard.current.is_none());
}

#[tokio::test]
async fn receive_clipboard_backend_without_images_drops_image_items() {
    // Arrange
    let (mut daemon, _dir, _changes, mut commands) = daemon();
    daemon.clipboard.handle.as_mut().unwrap().images = false;
    let peer = daemon.identity.machine_id;
    let mut items = change("text").items;
    items.push(Item {
        mime: clipboard::IMAGE_PNG.into(),
        data: vec![0; limits::CLIPBOARD_INLINE_MAX + 1],
    });
    let incoming = clipboard::announce(
        items,
        Generation {
            origin: peer,
            generation: 1,
        },
    )
    .unwrap();

    // Act
    daemon.receive_clipboard(peer, &incoming);

    // Assert
    let ClipboardCommand::Set { items, lazy, .. } = commands.try_recv().unwrap();
    assert_eq!(items, change("text").items);
    assert_eq!(lazy, []);
}