oo7 0.6.0

/// File backend specific errors.
#[derive(Debug)]
pub enum Error {
    /// File header does not match `FILE_HEADER`.
    FileHeaderMismatch(Option<String>),
    /// Version bytes do not match `MAJOR_VERSION` or `MINOR_VERSION`.
    VersionMismatch(Option<Vec<u8>>),
    /// No data behind header and version bytes.
    NoData,
    /// No Parent directory.
    NoParentDir(String),
    /// Bytes don't have the expected GVariant format.
    GVariantDeserialization(zvariant::Error),
    /// Mismatch between array length and length explicitly stored in keyring
    SaltSizeMismatch(usize, u32),
    /// Key for some reason too weak to trust it for writing
    WeakKey(WeakKeyError),
    /// Input/Output.
    Io(std::io::Error),
    /// Unexpected MAC digest value.
    MacError,
    /// Mismatch of checksum calculated over data.
    ChecksumMismatch,
    /// Failure to validate the attributes.
    HashedAttributeMac(String),
    /// XDG_DATA_HOME required for reading from default location.
    NoDataDir,
    /// Target file has changed.
    TargetFileChanged(String),
    /// Portal request has been cancelled.
    Portal(ashpd::Error),
    /// The addressed index does not exist.
    InvalidItemIndex(usize),
    /// UTF-8 encoding error.
    Utf8(std::str::Utf8Error),
    /// Mismatch of algorithms used in legacy keyring file.
    AlgorithmMismatch(u8),
    /// Incorrect secret - no items could be decrypted
    IncorrectSecret,
    /// Keyring partially corrupted - more broken items than valid ones
    PartiallyCorruptedKeyring {
        valid_items: usize,
        broken_items: usize,
    },
    /// Crypto related error.
    Crypto(crate::crypto::Error),
    /// Keyring or item is locked
    Locked,
    /// Schema error.
    #[cfg(feature = "schema")]
    Schema(crate::SchemaError),
}

impl From<zvariant::Error> for Error {
    fn from(value: zvariant::Error) -> Self {
        Self::GVariantDeserialization(value)
    }
}

impl From<WeakKeyError> for Error {
    fn from(value: WeakKeyError) -> Self {
        Self::WeakKey(value)
    }
}

impl From<std::io::Error> for Error {
    fn from(value: std::io::Error) -> Self {
        Self::Io(value)
    }
}

impl From<std::str::Utf8Error> for Error {
    fn from(value: std::str::Utf8Error) -> Self {
        Self::Utf8(value)
    }
}

impl From<ashpd::Error> for Error {
    fn from(value: ashpd::Error) -> Self {
        Self::Portal(value)
    }
}

impl From<crate::crypto::Error> for Error {
    fn from(value: crate::crypto::Error) -> Self {
        Self::Crypto(value)
    }
}

#[cfg(feature = "schema")]
impl From<crate::SchemaError> for Error {
    fn from(value: crate::SchemaError) -> Self {
        Self::Schema(value)
    }
}

impl std::error::Error for Error {}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::FileHeaderMismatch(e) => {
                write!(f, "File header doesn't match FILE_HEADER {e:#?}")
            }
            Self::VersionMismatch(e) => write!(
                f,
                "Version doesn't match MAJOR_VERSION OR MICRO_VERSION {e:#?}",
            ),
            Self::NoData => write!(f, "No data behind header and version bytes"),
            Self::NoParentDir(e) => write!(f, "No Parent Directory {e}"),
            Self::GVariantDeserialization(e) => write!(f, "Failed to deserialize {e}"),
            Self::SaltSizeMismatch(arr, explicit) => write!(
                f,
                "Salt size is not as expected. Array: {arr}, Explicit: {explicit}"
            ),
            Self::WeakKey(err) => write!(f, "{err}"),
            Self::Io(e) => write!(f, "IO error {e}"),
            Self::MacError => write!(f, "Mac digest is not equal to the expected value"),
            Self::ChecksumMismatch => write!(f, "Checksum is not equal to the expected value"),
            Self::HashedAttributeMac(e) => write!(f, "Failed to validate hashed attribute {e}"),
            Self::NoDataDir => write!(f, "Couldn't retrieve XDG_DATA_DIR"),
            Self::TargetFileChanged(e) => write!(f, "The target file has changed {e}"),
            Self::Portal(e) => write!(f, "Portal communication failed {e}"),
            Self::InvalidItemIndex(index) => {
                write!(f, "The addressed item index {index} does not exist")
            }
            Self::Utf8(e) => write!(f, "UTF-8 encoding error {e}"),
            Self::AlgorithmMismatch(e) => write!(f, "Unknown algorithm {e}"),
            Self::IncorrectSecret => write!(f, "Incorrect secret"),
            Self::PartiallyCorruptedKeyring {
                valid_items,
                broken_items,
            } => write!(
                f,
                "Keyring partially corrupted: {valid_items} valid items, {broken_items} broken items",
            ),
            Self::Crypto(e) => write!(f, "Failed to do a cryptography operation, {e}"),
            Self::Locked => write!(f, "Keyring or item is locked"),
            #[cfg(feature = "schema")]
            Self::Schema(e) => write!(f, "Schema error: {e}"),
        }
    }
}

#[derive(Debug)]
/// All information that is available about an invalid (not decryptable)
/// [`Item`](super::Item)
pub struct InvalidItemError {
    error: Error,
    attribute_names: Vec<String>,
}

impl InvalidItemError {
    pub(super) fn new(error: Error, attribute_names: Vec<String>) -> Self {
        Self {
            error,
            attribute_names,
        }
    }
}

impl std::error::Error for InvalidItemError {}

impl std::fmt::Display for InvalidItemError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "Invalid item: {:?}. Property names: {:?}",
            self.error, self.attribute_names
        )
    }
}

/// Details about why an encryption key is consider too weak for writing
#[derive(Debug, Copy, Clone)]
pub enum WeakKeyError {
    /// Avoid attack on existing files
    IterationCountTooLow(u32),
    /// Avoid attack on existing files
    SaltTooShort(usize),
    /// Just not secure enough to store password
    PasswordTooShort(usize),
    /// Should not occur
    ///
    /// Used by [`dbus`](crate::dbus) module that does not currently
    /// check key strength.
    StrengthUnknown,
}

impl std::error::Error for WeakKeyError {}

impl std::fmt::Display for WeakKeyError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::IterationCountTooLow(count) => write!(f, "Iteration count too low: {count}"),
            Self::SaltTooShort(length) => write!(f, "Salt too short: {length}"),
            Self::PasswordTooShort(length) => {
                write!(f, "Password (secret from portal) too short: {length}")
            }
            Self::StrengthUnknown => write!(f, "Strength unknown"),
        }
    }
}