alexandria 0.2.0

An encrypted document-oriented database with tag based query support
Documentation
//! The library user table
//!
//! Users and scopes in Alexandria are secret.

use crate::{
    crypto::{
        aes::{Constructor, Key},
        asym::KeyPair,
        DetachedKey, Encrypted, EncryptedMap,
    },
    error::{Error, Result},
    utils::Id,
};
use async_std::sync::Arc;
use serde::{Deserialize, Serialize};

/// The hash of an Id which is used for external representation
pub(crate) type Hid = Id;

#[derive(Clone, Debug, Serialize, Deserialize)]
pub(crate) struct User {
    /// The nested user token
    pub(crate) id: Id,
    /// The users' asymmetric encryption pair
    ///
    /// At the moment, this is used in a very symmetric way, but in
    /// the future there are ways to create zones and drop-in
    /// encryption.
    pub(crate) key: Arc<KeyPair>,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
struct UserWithKey {
    #[serde(skip)]
    key: Option<Arc<Key>>,
    inner: User,
}

impl UserWithKey {
    fn new(pw: &str, id: Id) -> Self {
        let key = Arc::new(KeyPair::new());
        let aes_key = Arc::new(Key::from_pw(pw, &id.to_string()));

        Self {
            key: Some(aes_key),
            inner: User { id, key },
        }
    }
}

impl DetachedKey<Key> for UserWithKey {
    fn key(&self) -> Option<Arc<Key>> {
        self.key.as_ref().map(|key| Arc::clone(&key))
    }
}

/// A table of users in the database
#[derive(Serialize, Deserialize)]
pub(crate) struct UserTable(EncryptedMap<Hid, UserWithKey, Key>);

impl UserTable {
    /// Create a new empty user table
    pub(crate) fn new() -> Self {
        Self(EncryptedMap::new())
    }

    /// Check if the user is currently open
    pub(crate) fn is_open(&self, id: Id) -> Result<()> {
        self.0.get(id).map(|_| ())
    }

    /// Add a new user to the user table
    pub(crate) fn insert(&mut self, id: Id, pw: &str) -> Result<()> {
        if self.0.contains_key(&id) {
            return Err(Error::UserAlreadyExists);
        }
        let with_key = UserWithKey::new(pw, id);
        self.0.insert(id, Encrypted::new(with_key));
        Ok(())
    }

    pub(crate) fn delete(&mut self, id: Id) -> Result<()> {
        self.0
            .remove(&id)
            .map_or(Err(Error::NoSuchUser { id: id.to_string() }), |_| Ok(()))
    }

    /// Unlock a user entry in place
    ///
    /// The provided Id will be hashed, to corresponds to a `Hid`,
    /// which provides a layer of anonymity for users in the database.
    pub(crate) fn open(&mut self, id: Id, pw: &str) -> Result<()> {
        let k = Key::from_pw(pw, &id.to_string());
        self.0.open(id, &k)
    }

    /// Re-seal the user metadata structure in place
    pub(crate) fn close(&mut self, id: Id) -> Result<()> {
        self.0.close(id, None)
    }
}

#[test]
fn open_empty() {
    let mut u = UserTable::new();
    assert_eq!(u.open(Id::random(), "cool_pw").is_err(), true);
}

#[test]
fn create_clone_open() {
    let mut u = UserTable::new();
    let id = Id::random();
    let pw = "car horse battery staple";
    u.insert(id, pw).unwrap();
    u.close(id).unwrap();
    u.open(id, pw).unwrap();
}