vaegram 0.2.0

Telegram MTProto client library for users and bots
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
use std::fmt;
use std::io;
use std::net::IpAddr;
use std::sync::{Arc, Mutex, PoisonError};
use std::time::Duration;

use reqwest::header::{CONTENT_TYPE, HeaderValue};
use reqwest::redirect::Policy;
use reqwest::{Client, Method, Response, StatusCode, Url};
use rustls::pki_types::CertificateDer;
use rustls::pki_types::pem::PemObject;
use serde_json::{Value, json};

use super::engine::{PeerRecord, Storage, StorageFuture, StorageReporter, StoredState};
use super::{MemoryStorage, SessionData, session_string};

const FORMAT: u64 = 1;
const TIMEOUT: Duration = Duration::from_secs(10);
const MAX_REPLY: usize = 1 << 20;

const NEWER: &str = "this Vault secret needs a newer vaegram";
const FOREIGN: &str = "not a vaegram secret; it was left as it is";
const MALFORMED: &str = "this Vault secret is malformed";
const CHANGED: &str = "the Vault secret changed since it was read (is another client using it?); it was left as it is";

/// Keeps the login in a HashiCorp Vault KV version 2 secret, and everything else (update state and peers) in
/// another engine, [`MemoryStorage`] unless [`data`](Self::data) says otherwise.
///
/// The secret holds two fields: `vaegram` (the format, 1) and `session` (a session string). Every write names the
/// version it read, so a secret that changed since, or one vaegram didn't write, is refused and left as it is.
/// Logging out deletes every version of the secret.
///
/// The token is sent only to the given address and never in a redirect. Plain `http://` is accepted only for a
/// loopback address, so the token can't cross a network in the clear. The token must stay valid for as long as the
/// client runs: vaegram doesn't renew it.
///
/// Servers are trusted through the Mozilla root certificates, plus any [`ca_certificate`](Self::ca_certificate)
/// adds for a private CA.
pub struct VaultStorage {
    // Built when first needed, so the certificates added after `new` are in it.
    client: Mutex<Option<Client>>,
    roots: Vec<CertificateDer<'static>>,
    data_url: Url,
    metadata_url: Url,
    secret: String,
    token: HeaderValue,
    namespace: Option<HeaderValue>,
    data: Box<dyn Storage>,
    // The secret's version as last read or written; None until it has been read.
    version: Mutex<Option<u64>>,
}

impl VaultStorage {
    /// `addr` is the server (`https://vault.example.com:8200`), `mount` the KV v2 mount (`secret`) and `path` the
    /// secret's path under it. Nothing connects until the storage is opened.
    pub fn new(addr: &str, token: &str, mount: &str, path: &str) -> io::Result<VaultStorage> {
        let invalid = |why: &str| io::Error::new(io::ErrorKind::InvalidInput, why.to_owned());
        let base = Url::parse(addr).map_err(|_| invalid("not a Vault address"))?;
        if !base.username().is_empty() || base.password().is_some() {
            return Err(invalid("the Vault address must not hold credentials"));
        }
        let host = base.host_str().unwrap_or("");
        let ip = host.trim_start_matches('[').trim_end_matches(']').parse::<IpAddr>();
        let loopback = host.eq_ignore_ascii_case("localhost") || ip.is_ok_and(|ip| ip.is_loopback());
        match base.scheme() {
            "https" => {}
            "http" if loopback => {}
            "http" => return Err(invalid("the Vault address must use https unless it is on this machine")),
            _ => return Err(invalid("not a Vault address")),
        }
        let segments = |s: &str| {
            let parts: Vec<String> = s.split('/').filter(|p| !p.is_empty()).map(str::to_owned).collect();
            let bad = parts.is_empty() || parts.iter().any(|p| p == "." || p == "..");
            if bad { Err(invalid("not a Vault mount or path")) } else { Ok(parts) }
        };
        let (mount, path) = (segments(mount)?, segments(path)?);
        let url = |kind: &str| -> io::Result<Url> {
            let mut url = base.clone();
            url.path_segments_mut()
                .map_err(|()| invalid("not a Vault address"))?
                .pop_if_empty()
                .push("v1")
                .extend(&mount)
                .push(kind)
                .extend(&path);
            Ok(url)
        };
        let mut token = HeaderValue::from_str(token).map_err(|_| invalid("not a Vault token"))?;
        token.set_sensitive(true);
        Ok(VaultStorage {
            client: Mutex::new(None),
            roots: Vec::new(),
            data_url: url("data")?,
            metadata_url: url("metadata")?,
            secret: format!("{}/{}", mount.join("/"), path.join("/")),
            token,
            namespace: None,
            data: Box::new(MemoryStorage::new()),
            version: Mutex::new(None),
        })
    }

    /// Also trusts the CA certificates in `pem`, for a server whose certificate a private CA signed.
    pub fn ca_certificate(mut self, pem: &[u8]) -> io::Result<VaultStorage> {
        let invalid = || io::Error::new(io::ErrorKind::InvalidInput, "not a PEM CA certificate");
        let certificates = CertificateDer::pem_slice_iter(pem).collect::<Result<Vec<_>, _>>().map_err(|_| invalid())?;
        let mut check = rustls::RootCertStore::empty();
        if certificates.is_empty() || certificates.iter().any(|c| check.add(c.clone()).is_err()) {
            return Err(invalid());
        }
        self.roots.extend(certificates);
        Ok(self)
    }

    /// Sends every request to `namespace`, for Vault Enterprise and HCP Vault.
    pub fn namespace(mut self, namespace: &str) -> io::Result<VaultStorage> {
        let value = HeaderValue::from_str(namespace)
            .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "not a Vault namespace"))?;
        self.namespace = Some(value);
        Ok(self)
    }

    fn client(&self) -> io::Result<Client> {
        let mut slot = self.client.lock().unwrap_or_else(PoisonError::into_inner);
        if let Some(client) = &*slot {
            return Ok(client.clone());
        }
        let mut roots = rustls::RootCertStore::from_iter(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());
        for certificate in &self.roots {
            roots.add(certificate.clone()).map_err(|e| io::Error::other(format!("vault: {e}")))?;
        }
        let tls = rustls::ClientConfig::builder_with_provider(Arc::new(rustls::crypto::ring::default_provider()))
            .with_safe_default_protocol_versions()
            .map_err(|e| io::Error::other(format!("vault: {e}")))?
            .with_root_certificates(roots)
            .with_no_client_auth();
        let client = Client::builder()
            .tls_backend_preconfigured(tls)
            .redirect(Policy::none())
            .connect_timeout(TIMEOUT)
            .timeout(TIMEOUT)
            .build()
            .map_err(|e| io::Error::other(format!("vault: {}", e.without_url())))?;
        *slot = Some(client.clone());
        Ok(client)
    }

    /// Keeps the update state and peers in `engine` instead of in memory.
    #[must_use]
    pub fn data(mut self, engine: impl Storage) -> VaultStorage {
        self.data = Box::new(engine);
        self
    }

    fn named(&self, e: io::Error) -> io::Error {
        io::Error::new(e.kind(), format!("vault secret {}: {e}", self.secret))
    }

    fn set_version(&self, version: Option<u64>) {
        *self.version.lock().unwrap_or_else(PoisonError::into_inner) = version;
    }

    async fn send(&self, method: Method, url: &Url, body: Option<String>) -> io::Result<(StatusCode, Value)> {
        let mut request = self.client()?.request(method, url.clone()).header("X-Vault-Token", self.token.clone());
        if let Some(namespace) = &self.namespace {
            request = request.header("X-Vault-Namespace", namespace.clone());
        }
        if let Some(body) = body {
            request = request.header(CONTENT_TYPE, "application/json").body(body);
        }
        let mut reply = request.send().await.map_err(network)?;
        let status = reply.status();
        let body = read_reply(&mut reply).await?;
        if body.iter().all(u8::is_ascii_whitespace) {
            return Ok((status, Value::Null));
        }
        let json = serde_json::from_slice(&body).map_err(|_| io::Error::other("vault: the reply isn't JSON"))?;
        Ok((status, json))
    }

    /// Reads the login and notes the secret's version. A secret vaegram didn't write is an error.
    async fn read(&self) -> io::Result<Option<SessionData>> {
        let (status, json) = self.send(Method::GET, &self.data_url, None).await?;
        let version = json["data"]["metadata"]["version"].as_u64();
        if status == StatusCode::NOT_FOUND {
            // A deleted latest version keeps its number: the next write has to name it.
            self.set_version(Some(version.unwrap_or(0)));
            return Ok(None);
        }
        if !status.is_success() {
            return Err(failed(status, &json));
        }
        let fields = &json["data"]["data"];
        let invalid = |why: &str| io::Error::new(io::ErrorKind::InvalidData, why.to_owned());
        match fields["vaegram"].as_u64() {
            Some(FORMAT) => {}
            Some(_) => return Err(invalid(NEWER)),
            None => return Err(invalid(FOREIGN)),
        }
        let session = fields["session"].as_str().ok_or_else(|| invalid(MALFORMED))?;
        let session = session_string::parse(session)
            .map_err(|why| invalid(if why == session_string::NEWER_VAEGRAM { NEWER } else { MALFORMED }))?;
        self.set_version(Some(version.ok_or_else(|| invalid(MALFORMED))?));
        Ok(Some(session))
    }

    async fn write(&self, session: &SessionData) -> io::Result<()> {
        let known = *self.version.lock().unwrap_or_else(PoisonError::into_inner);
        let cas = match known {
            Some(version) => version,
            None => {
                self.read().await?;
                self.version.lock().unwrap_or_else(PoisonError::into_inner).unwrap_or(0)
            }
        };
        let body = json!({
            "options": { "cas": cas },
            "data": { "vaegram": FORMAT, "session": session_string::export(session) },
        });
        let (status, json) = self.send(Method::POST, &self.data_url, Some(body.to_string())).await?;
        if !status.is_success() {
            // Whatever happened, the version is no longer known: the next write reads it again.
            self.set_version(None);
            if status == StatusCode::BAD_REQUEST && first_error(&json).contains("check-and-set") {
                return Err(io::Error::new(io::ErrorKind::InvalidData, CHANGED));
            }
            return Err(failed(status, &json));
        }
        self.set_version(json["data"]["version"].as_u64());
        Ok(())
    }

    async fn remove(&self) -> io::Result<()> {
        let (status, json) = self.send(Method::DELETE, &self.metadata_url, None).await?;
        if !status.is_success() && status != StatusCode::NOT_FOUND {
            return Err(failed(status, &json));
        }
        self.set_version(Some(0));
        Ok(())
    }
}

async fn read_reply(reply: &mut Response) -> io::Result<Vec<u8>> {
    let mut body = Vec::new();
    while let Some(chunk) = reply.chunk().await.map_err(network)? {
        if body.len() + chunk.len() > MAX_REPLY {
            return Err(io::Error::other("vault: the reply is too large"));
        }
        body.extend_from_slice(&chunk);
    }
    Ok(body)
}

fn network(e: reqwest::Error) -> io::Error {
    let kind = if e.is_timeout() {
        io::ErrorKind::TimedOut
    } else if e.is_connect() {
        io::ErrorKind::ConnectionRefused
    } else {
        io::ErrorKind::Other
    };
    // The causes say why, such as a certificate the roots don't vouch for; none of them holds the URL or token.
    let e = e.without_url();
    let mut text = format!("vault: {e}");
    let mut cause = std::error::Error::source(&e);
    while let Some(c) = cause {
        text.push_str(": ");
        text.push_str(&c.to_string());
        cause = c.source();
    }
    io::Error::new(kind, text)
}

fn first_error(json: &Value) -> &str {
    json["errors"][0].as_str().unwrap_or("")
}

fn failed(status: StatusCode, json: &Value) -> io::Error {
    let kind = match status {
        StatusCode::UNAUTHORIZED | StatusCode::FORBIDDEN => io::ErrorKind::PermissionDenied,
        StatusCode::NOT_FOUND => io::ErrorKind::NotFound,
        _ => io::ErrorKind::Other,
    };
    let why: String = first_error(json).chars().take(200).collect();
    io::Error::new(kind, format!("vault: {status} {why}").trim_end().to_owned())
}

impl fmt::Debug for VaultStorage {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let host = self.data_url.host_str().unwrap_or("");
        f.debug_struct("VaultStorage").field("host", &host).field("secret", &self.secret).finish_non_exhaustive()
    }
}

impl Storage for VaultStorage {
    // Vault itself reports nothing; the engine holding the rest may.
    fn set_reporter(&self, reporter: StorageReporter) {
        self.data.set_reporter(reporter);
    }

    fn open(&self) -> StorageFuture<'_, ()> {
        Box::pin(async move {
            self.read().await.map_err(|e| self.named(e))?;
            self.data.open().await
        })
    }

    fn close(&self) -> StorageFuture<'_, ()> {
        Box::pin(async move {
            self.set_version(None);
            self.data.close().await
        })
    }

    fn delete(&self) -> StorageFuture<'_, ()> {
        Box::pin(async move {
            self.remove().await.map_err(|e| self.named(e))?;
            self.data.delete().await
        })
    }

    fn load_session(&self) -> StorageFuture<'_, Option<SessionData>> {
        Box::pin(async move { self.read().await.map_err(|e| self.named(e)) })
    }

    fn save_session<'a>(&'a self, session: &'a SessionData) -> StorageFuture<'a, ()> {
        Box::pin(async move { self.write(session).await.map_err(|e| self.named(e)) })
    }

    fn load_state(&self) -> StorageFuture<'_, Option<StoredState>> {
        self.data.load_state()
    }

    fn save_state<'a>(&'a self, state: &'a StoredState) -> StorageFuture<'a, ()> {
        self.data.save_state(state)
    }

    fn update_peers<'a>(&'a self, peers: &'a [PeerRecord]) -> StorageFuture<'a, ()> {
        self.data.update_peers(peers)
    }

    fn get_peer_by_id(&self, id: i64) -> StorageFuture<'_, Option<PeerRecord>> {
        self.data.get_peer_by_id(id)
    }

    fn get_peer_by_username<'a>(&'a self, username: &'a str) -> StorageFuture<'a, Option<PeerRecord>> {
        self.data.get_peer_by_username(username)
    }

    fn get_peer_by_phone_number<'a>(&'a self, phone_number: &'a str) -> StorageFuture<'a, Option<PeerRecord>> {
        self.data.get_peer_by_phone_number(phone_number)
    }

    fn export_peers(&self, limit: Option<usize>) -> StorageFuture<'_, Vec<PeerRecord>> {
        self.data.export_peers(limit)
    }

    fn clear_peers(&self) -> StorageFuture<'_, ()> {
        self.data.clear_peers()
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;
    use std::io;
    use std::net::SocketAddr;
    use std::sync::{Arc, Mutex};

    use serde_json::{Value, json};
    use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt};
    use tokio::net::TcpListener;
    use tokio_rustls::TlsAcceptor;

    use super::VaultStorage;
    use crate::session::Salt;
    use crate::storage::{MemoryStorage, PeerRecord, SessionData, Storage, StoredState, conformance};

    const TOKEN: &str = "hvs.hunter2";

    #[derive(Default)]
    struct Kv {
        // path -> (version, data of the latest version, None once deleted)
        secrets: HashMap<String, (u64, Option<Value>)>,
        fail_writes: bool,
        tokens: Vec<String>,
        namespaces: Vec<String>,
    }

    /// Just enough of Vault's KV v2 API for the requests the storage sends, one request per connection.
    struct MiniVault {
        addr: SocketAddr,
        kv: Arc<Mutex<Kv>>,
        scheme: &'static str,
    }

    impl MiniVault {
        async fn start() -> MiniVault {
            MiniVault::start_with(None).await
        }

        /// Serves HTTPS with `acceptor`'s certificate instead of plain HTTP.
        async fn start_with(tls: Option<TlsAcceptor>) -> MiniVault {
            let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
            let addr = listener.local_addr().unwrap();
            let kv = Arc::new(Mutex::new(Kv::default()));
            let (shared, scheme) = (kv.clone(), if tls.is_some() { "https" } else { "http" });
            tokio::spawn(async move {
                while let Ok((stream, _)) = listener.accept().await {
                    let (kv, tls) = (shared.clone(), tls.clone());
                    tokio::spawn(async move {
                        match tls {
                            Some(tls) => {
                                if let Ok(stream) = tls.accept(stream).await {
                                    serve(stream, kv).await;
                                }
                            }
                            None => serve(stream, kv).await,
                        }
                    });
                }
            });
            MiniVault { addr, kv, scheme }
        }

        fn url(&self) -> String {
            format!("{}://{}", self.scheme, self.addr)
        }

        fn storage(&self) -> VaultStorage {
            VaultStorage::new(&self.url(), TOKEN, "secret", "bots/bot").unwrap()
        }

        fn secret(&self) -> Option<(u64, Option<Value>)> {
            self.kv.lock().unwrap().secrets.get("bots/bot").cloned()
        }

        fn put(&self, data: Value) {
            let mut kv = self.kv.lock().unwrap();
            let entry = kv.secrets.entry("bots/bot".into()).or_insert((0, None));
            *entry = (entry.0 + 1, Some(data));
        }
    }

    async fn serve(mut stream: impl AsyncRead + AsyncWrite + Unpin, kv: Arc<Mutex<Kv>>) {
        let mut buf = Vec::new();
        let mut chunk = [0; 4096];
        let head_end = loop {
            if let Some(at) = buf.windows(4).position(|w| w == b"\r\n\r\n") {
                break at + 4;
            }
            match stream.read(&mut chunk).await {
                Ok(0) | Err(_) => return,
                Ok(n) => buf.extend_from_slice(&chunk[..n]),
            }
        };
        let head = String::from_utf8_lossy(&buf[..head_end]).into_owned();
        let mut lines = head.split("\r\n");
        let mut request = lines.next().unwrap_or("").split(' ');
        let (method, target) = (request.next().unwrap_or("").to_owned(), request.next().unwrap_or("").to_owned());
        let mut headers = HashMap::new();
        for line in lines {
            if let Some((name, value)) = line.split_once(':') {
                headers.insert(name.trim().to_ascii_lowercase(), value.trim().to_owned());
            }
        }
        let length: usize = headers.get("content-length").and_then(|l| l.parse().ok()).unwrap_or(0);
        while buf.len() < head_end + length {
            match stream.read(&mut chunk).await {
                Ok(0) | Err(_) => return,
                Ok(n) => buf.extend_from_slice(&chunk[..n]),
            }
        }
        let body: Value = serde_json::from_slice(&buf[head_end..head_end + length]).unwrap_or(Value::Null);
        let token = headers.get("x-vault-token").cloned().unwrap_or_default();
        let namespace = headers.get("x-vault-namespace").cloned().unwrap_or_default();
        let (status, reply) = {
            let mut kv = kv.lock().unwrap();
            kv.namespaces.push(namespace);
            handle(&mut kv, &method, &target, &token, body)
        };
        let reply = if reply.is_null() { String::new() } else { reply.to_string() };
        let response = format!(
            "HTTP/1.1 {status}\r\nContent-Type: application/json\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{reply}",
            reply.len()
        );
        let _ = stream.write_all(response.as_bytes()).await;
        let _ = stream.shutdown().await;
    }

    fn handle(kv: &mut Kv, method: &str, target: &str, token: &str, body: Value) -> (&'static str, Value) {
        kv.tokens.push(token.to_owned());
        if token != TOKEN {
            return ("403 Forbidden", json!({ "errors": ["permission denied"] }));
        }
        let (kind, path) = match target.strip_prefix("/v1/secret/").and_then(|rest| rest.split_once('/')) {
            Some(found) => found,
            None => return ("404 Not Found", json!({ "errors": [] })),
        };
        let secret = kv.secrets.get(path).cloned();
        match (method, kind) {
            ("GET", "data") => match secret {
                Some((version, Some(data))) => {
                    ("200 OK", json!({ "data": { "data": data, "metadata": { "version": version } } }))
                }
                Some((version, None)) => {
                    ("404 Not Found", json!({ "data": { "data": null, "metadata": { "version": version } } }))
                }
                None => ("404 Not Found", json!({ "errors": [] })),
            },
            ("POST", "data") => {
                let current = secret.map_or(0, |(version, _)| version);
                if body["options"]["cas"].as_u64() != Some(current) {
                    let why = "check-and-set parameter did not match the current version";
                    return ("400 Bad Request", json!({ "errors": [why] }));
                }
                if kv.fail_writes {
                    return ("500 Internal Server Error", json!({ "errors": ["storage failed"] }));
                }
                kv.secrets.insert(path.to_owned(), (current + 1, Some(body["data"].clone())));
                ("200 OK", json!({ "data": { "version": current + 1 } }))
            }
            ("DELETE", "metadata") => {
                kv.secrets.remove(path);
                ("204 No Content", Value::Null)
            }
            _ => ("405 Method Not Allowed", json!({ "errors": [] })),
        }
    }

    fn session(user_id: i64) -> SessionData {
        let mut s = SessionData::new(4, [9; 256]);
        s.user_id = user_id;
        s
    }

    #[tokio::test]
    async fn conformance_against_a_mini_vault() {
        let vault = MiniVault::start().await;
        conformance::check(&vault.storage()).await;
        assert_eq!(vault.secret(), None, "delete removes every version");
        let tokens = vault.kv.lock().unwrap().tokens.clone();
        assert!(!tokens.is_empty() && tokens.iter().all(|t| t == TOKEN));
    }

    #[tokio::test]
    async fn non_session_data_goes_to_the_data_engine() {
        let vault = MiniVault::start().await;
        let data = Arc::new(MemoryStorage::new());
        let storage = vault.storage().data(data.clone());
        storage.open().await.unwrap();
        storage.save_session(&session(7)).await.unwrap();
        let state = StoredState::new(7, Salt { value: 1, time_offset: 0 }, None);
        storage.save_state(&state).await.unwrap();
        storage.update_peers(&[PeerRecord::new(5, 6)]).await.unwrap();

        let (version, fields) = vault.secret().unwrap();
        let fields = fields.unwrap();
        let mut names: Vec<&str> = fields.as_object().unwrap().keys().map(String::as_str).collect();
        names.sort_unstable();
        assert_eq!((version, names), (1, vec!["session", "vaegram"]));
        assert_eq!(fields["vaegram"], 1);
        assert!(fields["session"].as_str().unwrap().starts_with("VAE_"));
        assert_eq!(data.load_state().await.unwrap(), Some(state));
        assert_eq!(data.get_peer_by_id(5).await.unwrap(), Some(PeerRecord::new(5, 6)));
        assert!(data.load_session().await.unwrap().is_none(), "the login stays in Vault");
    }

    #[tokio::test]
    async fn token_never_in_debug_or_errors() {
        let vault = MiniVault::start().await;
        let storage = VaultStorage::new(&vault.url(), "hvs.wrong-secret", "secret", "bots/bot").unwrap();
        let debug = format!("{storage:?}");
        let error = storage.open().await.unwrap_err();
        assert_eq!(debug, r#"VaultStorage { host: "127.0.0.1", secret: "secret/bots/bot", .. }"#);
        assert_eq!(error.kind(), io::ErrorKind::PermissionDenied);
        assert!(!error.to_string().contains("wrong-secret"), "{error}");
        assert!(error.to_string().contains("permission denied"), "{error}");

        let unreachable = VaultStorage::new("http://127.0.0.1:1", TOKEN, "secret", "bots/bot").unwrap();
        let error = unreachable.save_session(&session(1)).await.unwrap_err().to_string();
        assert!(!error.contains("hunter2"), "{error}");
    }

    #[tokio::test]
    async fn refuses_secrets_it_did_not_write_untouched() {
        let cases = [
            (json!({ "password": "theirs" }), "not a vaegram secret"),
            (json!({ "vaegram": 2, "session": "VAE_x" }), "newer vaegram"),
        ];
        for (data, why) in cases {
            let vault = MiniVault::start().await;
            vault.put(data.clone());
            let storage = vault.storage();
            let error = storage.open().await.unwrap_err();
            let saved = storage.save_session(&session(1)).await;
            assert_eq!(error.kind(), io::ErrorKind::InvalidData);
            assert!(error.to_string().contains(why), "{error}");
            assert!(saved.is_err());
            assert_eq!(vault.secret(), Some((1, Some(data))), "the secret was left as it is");
        }
    }

    #[tokio::test]
    async fn a_secret_changed_elsewhere_is_not_overwritten() {
        let vault = MiniVault::start().await;
        let storage = vault.storage();
        storage.save_session(&session(1)).await.unwrap();
        vault.put(json!({ "password": "theirs" }));
        let error = storage.save_session(&session(2)).await.unwrap_err();
        assert!(error.to_string().contains("changed since it was read"), "{error}");
        assert_eq!(vault.secret(), Some((2, Some(json!({ "password": "theirs" })))));
        assert!(storage.save_session(&session(2)).await.is_err(), "reading it again finds it foreign");
    }

    #[tokio::test]
    async fn a_failed_write_keeps_the_last_login() {
        let vault = MiniVault::start().await;
        let storage = vault.storage();
        storage.save_session(&session(1)).await.unwrap();
        vault.kv.lock().unwrap().fail_writes = true;
        assert!(storage.save_session(&session(2)).await.is_err());
        assert_eq!(storage.load_session().await.unwrap().map(|s| s.user_id), Some(1));
        vault.kv.lock().unwrap().fail_writes = false;
        storage.save_session(&session(2)).await.unwrap();
        assert_eq!(storage.load_session().await.unwrap().map(|s| s.user_id), Some(2));
        assert_eq!(vault.secret().map(|(version, _)| version), Some(2));
    }

    #[tokio::test]
    async fn a_deleted_latest_version_is_a_missing_login() {
        let vault = MiniVault::start().await;
        let storage = vault.storage();
        storage.save_session(&session(1)).await.unwrap();
        vault.kv.lock().unwrap().secrets.get_mut("bots/bot").unwrap().1 = None;
        assert!(storage.load_session().await.unwrap().is_none());
        storage.save_session(&session(3)).await.unwrap();
        assert_eq!(vault.secret().map(|(version, _)| version), Some(2));
    }

    #[tokio::test]
    async fn addresses_and_paths_are_checked() {
        let new = |addr: &str, mount: &str, path: &str| VaultStorage::new(addr, TOKEN, mount, path).map(drop);
        assert!(new("https://vault.example.com:8200", "secret", "bots/bot").is_ok());
        assert!(new("http://localhost:8200", "kv", "bot").is_ok());
        assert!(new("http://[::1]:8200", "kv", "bot").is_ok());
        let refused = new("http://vault.example.com:8200", "secret", "bot").unwrap_err();
        assert!(refused.to_string().contains("https"), "{refused}");
        assert!(new("https://user:pass@vault.example.com", "secret", "bot").is_err());
        assert!(new("https://vault.example.com", "secret", "../sys").is_err());
        assert!(new("https://vault.example.com", "", "bot").is_err());
        assert!(new("not a url", "secret", "bot").is_err());
        assert!(VaultStorage::new("https://vault.example.com", "bad\ntoken", "secret", "bot").is_err());

        let storage = VaultStorage::new("https://vault.example.com/prefix/", TOKEN, "/kv/", "bots//echo").unwrap();
        assert_eq!(storage.data_url.as_str(), "https://vault.example.com/prefix/v1/kv/data/bots/echo");
        assert_eq!(storage.metadata_url.as_str(), "https://vault.example.com/prefix/v1/kv/metadata/bots/echo");
    }

    const CA: &[u8] = b"-----BEGIN CERTIFICATE-----
MIIBizCCATGgAwIBAgIUCs3JfnmU2f70ayLgIacU8vMwEMEwCgYIKoZIzj0EAwIw
GjEYMBYGA1UEAwwPdmFlZ3JhbSB0ZXN0IENBMCAXDTI2MTEwNDEzNDkzOVoYDzIx
MjYxMDExMTM0OTM5WjAaMRgwFgYDVQQDDA92YWVncmFtIHRlc3QgQ0EwWTATBgcq
hkjOPQIBBggqhkjOPQMBBwNCAARyjZtFkFqK5IptqKH93wULGEsprSjJyI04T8uA
tHIL2v+pc53s3geQgp/yAv77jHE9EsZJWXChnlazmsb3C5YHo1MwUTAdBgNVHQ4E
FgQUm0CA2uJMB7uqSthvJ9/VfCZQEiswHwYDVR0jBBgwFoAUm0CA2uJMB7uqSthv
J9/VfCZQEiswDwYDVR0TAQH/BAUwAwEB/zAKBggqhkjOPQQDAgNIADBFAiEA4d6A
Wy8RD+ltWAWPhfF/Wq6akoCWbzT0WcyMc+ah1gUCIFPuq5qStz14aVAlMGRVCKj5
IddFSJvwli6VPGxrkKj/
-----END CERTIFICATE-----
";

    #[tokio::test]
    async fn ca_certificates_are_parsed_from_pem() {
        let storage = || VaultStorage::new("https://vault.example.com", TOKEN, "secret", "bot").unwrap();
        let added = storage().ca_certificate(CA).unwrap();
        assert_eq!(added.roots.len(), 1);
        let two = [CA, CA].concat();
        assert_eq!(storage().ca_certificate(&two).unwrap().roots.len(), 2);
        assert!(added.client().is_ok(), "the client builds with the extra root");

        let garbage = b"-----BEGIN CERTIFICATE-----\nnot base64 at all!\n-----END CERTIFICATE-----\n";
        let not_der = b"-----BEGIN CERTIFICATE-----\naGVsbG8=\n-----END CERTIFICATE-----\n";
        for pem in [&garbage[..], &not_der[..], &b""[..], &b"just some text"[..]] {
            let error = storage().ca_certificate(pem).map(drop).unwrap_err();
            assert_eq!(error.kind(), io::ErrorKind::InvalidInput, "{pem:?}");
        }
    }

    #[tokio::test]
    async fn the_namespace_goes_with_every_request() {
        let vault = MiniVault::start().await;
        let storage = vault.storage().namespace("admin/team").unwrap();
        storage.save_session(&session(1)).await.unwrap();
        let namespaces = vault.kv.lock().unwrap().namespaces.clone();
        assert!(!namespaces.is_empty() && namespaces.iter().all(|n| n == "admin/team"), "{namespaces:?}");
        assert!(vault.storage().namespace("bad\nname").is_err());
    }

    /// A CA and a certificate for 127.0.0.1 it signed, made afresh for each run.
    fn private_ca() -> (String, TlsAcceptor) {
        use rcgen::{BasicConstraints, CertificateParams, ExtendedKeyUsagePurpose, IsCa, Issuer, KeyPair};
        use rustls::pki_types::{PrivateKeyDer, PrivatePkcs8KeyDer};

        let ca_key = KeyPair::generate().unwrap();
        let mut ca = CertificateParams::new(Vec::<String>::new()).unwrap();
        ca.is_ca = IsCa::Ca(BasicConstraints::Unconstrained);
        let ca_pem = ca.self_signed(&ca_key).unwrap().pem();
        let server_key = KeyPair::generate().unwrap();
        let mut server = CertificateParams::new(vec!["127.0.0.1".to_owned()]).unwrap();
        server.extended_key_usages = vec![ExtendedKeyUsagePurpose::ServerAuth];
        let server_cert = server.signed_by(&server_key, &Issuer::from_params(&ca, &ca_key)).unwrap();
        let key = PrivateKeyDer::Pkcs8(PrivatePkcs8KeyDer::from(server_key.serialize_der()));
        let config = rustls::ServerConfig::builder_with_provider(Arc::new(rustls::crypto::ring::default_provider()))
            .with_safe_default_protocol_versions()
            .unwrap()
            .with_no_client_auth()
            .with_single_cert(vec![server_cert.der().clone()], key)
            .unwrap();
        (ca_pem, TlsAcceptor::from(Arc::new(config)))
    }

    #[tokio::test]
    async fn a_private_ca_is_trusted_only_once_added() {
        let (ca_pem, acceptor) = private_ca();
        let vault = MiniVault::start_with(Some(acceptor)).await;
        assert!(vault.url().starts_with("https://127.0.0.1:"), "{}", vault.url());

        let trusting = vault.storage().ca_certificate(ca_pem.as_bytes()).unwrap();
        trusting.open().await.unwrap();
        trusting.save_session(&session(5)).await.unwrap();
        assert_eq!(trusting.load_session().await.unwrap().map(|s| s.user_id), Some(5));
        assert_eq!(vault.secret().map(|(version, _)| version), Some(1), "the session went over TLS");

        let requests = vault.kv.lock().unwrap().tokens.len();
        let error = vault.storage().open().await.unwrap_err().to_string();
        assert!(error.contains("certificate"), "a handshake error: {error}");
        assert!(!error.contains("hunter2"), "{error}");
        assert_eq!(vault.kv.lock().unwrap().tokens.len(), requests, "no request got past the handshake");
    }

    #[tokio::test]
    #[ignore = "needs VAEGRAM_VAULT_ADDR and VAEGRAM_VAULT_TOKEN for a KV v2 mount `secret` it may write to"]
    async fn conformance_on_a_live_server() {
        let (Ok(addr), Ok(token)) = (std::env::var("VAEGRAM_VAULT_ADDR"), std::env::var("VAEGRAM_VAULT_TOKEN")) else {
            assert!(std::env::var_os("CI").is_none(), "set VAEGRAM_VAULT_ADDR and VAEGRAM_VAULT_TOKEN");
            return;
        };
        let path = format!("vaegram-live-{}", std::process::id());
        conformance::check(&VaultStorage::new(&addr, &token, "secret", &path).unwrap()).await;
    }
}