chatmail-core/src/token.rs

//! # Token module.
//!
//! Functions to read/write token from/to the database. A token is any string associated with a key.
//!
//! Tokens are used in SecureJoin verification protocols.

use anyhow::Result;
use deltachat_derive::{FromSql, ToSql};

use crate::context::Context;
use crate::tools::{create_id, time};

/// Token namespace
#[derive(
    Debug, Default, Display, Clone, Copy, PartialEq, Eq, FromPrimitive, ToPrimitive, ToSql, FromSql,
)]
#[repr(u32)]
pub enum Namespace {
    #[default]
    Unknown = 0,
    Auth = 110,
    InviteNumber = 100,
}

/// Saves a token to the database.
pub async fn save(
    context: &Context,
    namespace: Namespace,
    foreign_key: Option<&str>,
    token: &str,
    timestamp: i64,
) -> Result<()> {
    if token.is_empty() {
        info!(context, "Not saving empty {namespace} token");
        return Ok(());
    }
    context
        .sql
        .execute(
            "INSERT OR IGNORE INTO tokens (namespc, foreign_key, token, timestamp) VALUES (?, ?, ?, ?)",
            (namespace, foreign_key.unwrap_or(""), token, timestamp),
        )
        .await?;
    Ok(())
}

/// Looks up most recently created token for a namespace / foreign key combination.
///
/// As there may be more than one such valid token,
/// (eg. when a qr code token is withdrawn, recreated and revived later),
/// use lookup() for qr-code creation only;
/// do not use lookup() to check for token validity.
///
/// To check if a given token is valid, use exists().
pub async fn lookup(
    context: &Context,
    namespace: Namespace,
    foreign_key: Option<&str>,
) -> Result<Option<String>> {
    context
        .sql
        .query_get_value(
            "SELECT token FROM tokens WHERE namespc=? AND foreign_key=? ORDER BY id DESC LIMIT 1",
            (namespace, foreign_key.unwrap_or("")),
        )
        .await
}

/// Looks up all tokens from the given namespace,
/// so that they can be used for decrypting a symmetrically-encrypted message.
///
/// The most-recently saved tokens are returned first.
/// This improves performance when Bob scans a QR code that was just created.
pub async fn lookup_all(context: &Context, namespace: Namespace) -> Result<Vec<String>> {
    context
        .sql
        .query_map_vec(
            "SELECT token FROM tokens WHERE namespc=? ORDER BY id DESC",
            (namespace,),
            |row| Ok(row.get(0)?),
        )
        .await
}

pub async fn lookup_or_new(
    context: &Context,
    namespace: Namespace,
    foreign_key: Option<&str>,
) -> Result<String> {
    if let Some(token) = lookup(context, namespace, foreign_key).await? {
        return Ok(token);
    }

    let token = create_id();
    let timestamp = time();
    save(context, namespace, foreign_key, &token, timestamp).await?;
    Ok(token)
}

pub async fn exists(context: &Context, namespace: Namespace, token: &str) -> Result<bool> {
    let exists = context
        .sql
        .exists(
            "SELECT COUNT(*) FROM tokens WHERE namespc=? AND token=?;",
            (namespace, token),
        )
        .await?;
    Ok(exists)
}

/// Resets all tokens corresponding to the `foreign_key`.
///
/// `foreign_key` is a group ID to reset all group tokens
/// or empty string to reset all setup contact tokens.
pub async fn delete(context: &Context, foreign_key: &str) -> Result<()> {
    context
        .sql
        .execute("DELETE FROM tokens WHERE foreign_key=?", (foreign_key,))
        .await?;
    Ok(())
}