KeyBoxen 0.1.0

// Copyright (C) 2022 KeyBoxen Authors
// SPDX-License-Identifier: GPL-3.0-or-later

//! Collections module
//!
//! This module implements the object that represents each
//! [collection][ch03]. A collection holds a set of related
//! [items][super::item]. It is represented by an enum that is either
//! unlocked with a key stored as an array of bytes, or is locked.
//!
//! # Locking
//! Collections can be locked. The locking is a **hard** lock (unlike
//! individual items), which can be unlocked only by entering a
//! password. The collection is considered locked if it lacks the key
//! required to decrypt the secrets under it.
//!
//! The default collection is encrypted using the user's login
//! password. It will be unlocked automatically upon login using the
//! password obtained from PAM. All other collections will need user
//! intervention - ie, entry of password.
//!
//! **WARNING:** Be sure to clear out the key when locking.
//!
//! [ch03]: https://specifications.freedesktop.org/secret-service/latest/ch03.html

use super::{lock, Collection};

impl lock::Lockable for Collection {
    fn is_locked(&self) -> bool {
        match self {
            Self::Locked => true,
            Self::Unlocked(_) => false,
        }
    }

    fn lock(&mut self) -> lock::Result {
        if let Self::Unlocked(ref mut arr) = self {
            // Clear the array
            for byte in arr {
                *byte = 0;
            }
            *self = Self::Locked;
        }
        Ok(())
    }

    fn unlock(&mut self) -> lock::Result {
        *self = Self::Unlocked(Vec::<u8>::new());
        Ok(())
    }
}