lockchain-core 0.9.0

//! Common record representation inside of vaults.
//!
//! A record is a collection of data stored in a vault. It's
//! structured into a publicly known, unencrypted header and
//! a securely saved, encrypted body.
//!
//! While the `lockchain-server` never has access to the body data,
//! the header is stored and cached for make search requests faster.
//!
//! **No secret information should ever be stored in the header**

use chrono::{DateTime, Local};
use std::collections::BTreeMap;
use traits::{AutoEncoder, Body};

/// An enum that wraps around all possible data types to store
/// as the value of a vault record.
///
/// This doesn't include metadata attached to a field, just the
/// data representation itself (i.e. text, number or sub data-tree)
#[derive(Debug, Eq, PartialEq, Clone, Serialize, Deserialize)]
pub enum Payload {
    /// A simple (variable) text
    Text(String),
    /// A boolean (true, false)
    Boolean(bool),
    /// A 64bit, signed number
    Number(i64),
    /// A tree of String names, mapped to payloads
    BTreeMap(BTreeMap<String, Payload>),
    /// A list of various payloads
    List(Vec<Payload>),
}

/// The public header of a record
///
/// A header consists of always-available fields that
/// are hard-defined in the lockchain file format as well
/// as custom fields that can be declared by each application
/// specifically.
///
/// You should never rely on the presence of custom fields as
/// older version of the software might not support them or
/// know about them!
#[derive(Debug, Eq, PartialEq, Clone, Serialize, Deserialize)]
pub struct Header {
    /// The name of this record
    pub name: String,
    /// The primary category the record is in
    pub category: String,
    /// A collection of custom tags
    pub tags: Vec<String>,
    /// Custom fields to query by. **Do not store secure data in fields!
    pub fields: BTreeMap<String, Payload>,
    /// Timestamp when the record was created
    pub date_created: DateTime<Local>,
    /// Timestamp when the record was last updated
    pub date_updated: DateTime<Local>,
}

/// Represents a whole record in memory
///
/// The body field can be `None` if it hasn't been cached
/// yet. Calling `body()` will either resolve the data from disk
/// or still return `None` if the current setting doesn't support
/// body loading (such as the  `lockchain-server` which has no
/// cryptocraphy subsystem)
#[derive(Debug, Eq, PartialEq, Clone, Serialize, Deserialize)]
pub struct Record<T: Body> {
    pub header: Header,
    #[serde(bound(deserialize = "T: Body"))]
    pub body: Option<T>,
}

impl<T: Body> Record<T> {
    /// Create a new Record, generically for a backend in question
    pub fn new(name: &str, category: &str, tags: Vec<&str>) -> Self {
        Record {
            header: Header {
                name: name.to_owned(),
                category: category.to_owned(),
                tags: tags.into_iter().map(|s| s.to_owned()).collect(),
                fields: BTreeMap::new(),
                date_created: Local::now(),
                date_updated: Local::now(),
            },
            body: None,
        }
    }

    /// Attempt to set a key to a certain value
    pub fn add_data(&mut self, key: &str, value: Payload) -> Option<()> {
        (self.body.as_mut()?).set_field(key, value);
        Some(())
    }

    /// Attempt to read out the value of a certain key
    pub fn get_data(&self, key: &str) -> Option<&Payload> {
        (self.body.as_ref()?).get_field(key)
    }
}

impl<T: Body> AutoEncoder for Record<T> {}

#[derive(Serialize, Deserialize)]
pub struct EncryptedBody {
    pub data: String,
}

impl Body for EncryptedBody {
    fn get_field(&self, _: &str) -> Option<&Payload> {
        None
    }
    fn set_field(&mut self, _: &str, _: Payload) -> Option<()> {
        None
    }
    fn flatten(&mut self) -> Option<()> {
        None
    }
}