matrixbot-ezlogin 0.1.0

I wrote the login and E2EE bootstrap code for Matrix bots so you don’t have to.
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

//! matrixbot-ezlogin: "I wrote the login and E2EE bootstrap code for Matrix bots so you don’t have to."
//!
//! Writing a Matrix bot is easy, but supporting end-to-end encryption is extremely difficult.
//!
//! Not only because the bot must maintain a database to store encryption keys between sessions, but also because the bootstrap process requires a human to interactively type in or copy out the recovery key.
//!
//! Sadly, the [official Matrix SDK](matrix_sdk) doesn't provide a complete solution to bootstrap a Matrix bot, resulting in bot developers needing to waste time writing the authentication code again and again.
//!
//! Here, I publish this library called matrixbot-ezlogin, as a good starting point for every Matrix bot. So, you can skip the trouble and directly hop into the bot logic.
//!
//! # Two-stages of a bot
//!
//! In order to set up a Matrix bot with E2EE support, there are two steps:
//!
//! 1. Creating a Matrix session, setting up cross-signing keys, creating or recovering from a server-side backup, then exit. This step requires human intervention.
//!
//! 2. Restoring the Matrix session to run actual bot logic. This step is unattended and can be set to auto-start when computer boots up.
//!
//! # Components of matrixbot-ezlogin
//!
//! This library provides the functions [`setup`] (or [`setup_interactive`]) and [`login`] to simplify these two steps.
//!
//! Additionally, [`DuplexLog`] helps handling duplex terminal input / output. [`SyncHelper`] helps remembering sync tokens between process restarts.
//!
//! The `examples` folder contains a simple echo-bot for you to experience the feature of matrixbot-ezlogin, and serves as a good starting point to develop a new Matrix bot.

use std::path::Path;
use std::sync::Once;

use color_eyre::eyre::{Result, WrapErr, bail};
use rusqlite::OpenFlags;
use tracing::info;

mod duplex_log;
mod interactive;
mod login;
mod sync;

pub use duplex_log::DuplexLog;
pub use interactive::setup_interactive;
pub use login::SetupConfig;
pub use login::login;
pub use login::setup;
pub use sync::SyncHelper;

static PRINT_SQLITE_VERSION_ONCE: Once = Once::new();

fn connect_sqlite(path: &Path, flags: OpenFlags) -> Result<rusqlite::Connection> {
    let conn = rusqlite::Connection::open_with_flags(path, flags)?;

    let version: String = conn
        .query_row("SELECT sqlite_version();", (), |row| row.get(0))
        // TODO: If anyone needs, transform these ad-hoc errors into named error types.
        .wrap_err("failed to get SQLite version")?;

    PRINT_SQLITE_VERSION_ONCE.call_once(|| info!("SQLite version: {version}"));

    // We need 3.45.0 for the jsonb() function
    if !version_compare::compare_to(&version, "3.45.0", version_compare::Cmp::Ge).unwrap_or(false) {
        // TODO: If anyone needs, transform these ad-hoc errors into named error types.
        bail!("SQLite version is too old: {version}. Please upgrade to 3.45.0 or newer");
    }

    Ok(conn)
}