sos-integrity 0.17.1

Integrity checks for the Save Our Secrets SDK.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

#![deny(missing_docs)]
#![forbid(unsafe_code)]
#![cfg_attr(all(doc, CHANNEL_NIGHTLY), feature(doc_auto_cfg))]
//! Integrity checks for vaults, event logs and external files.
mod account_integrity;
mod error;
mod event_integrity;
#[cfg(feature = "files")]
mod file_integrity;
mod vault_integrity;

pub use account_integrity::{account_integrity, FolderIntegrityEvent};
pub use event_integrity::event_integrity;
pub use vault_integrity::vault_integrity;

#[cfg(feature = "files")]
pub use file_integrity::{file_integrity, FileIntegrityEvent};

pub use error::Error;

/// Result type for the library.
pub(crate) type Result<T> = std::result::Result<T, Error>;

use sos_core::{commit::CommitHash, ExternalFile, VaultId};

/// Reasons why an integrity check can fail.
#[derive(Debug)]
pub enum IntegrityFailure {
    /// Vault or event log file or data is missing.
    MissingFolder(VaultId),
    /// External file is missing.
    MissingFile(ExternalFile),
    /// Checksum mismatch for a folder vault or event log.
    CorruptedFolder {
        /// Folder identifier.
        folder_id: VaultId,
        /// Expected file name checksum.
        expected: CommitHash,
        /// Actual file name checksum.
        actual: CommitHash,
    },
    /// Checksum mismatch for an external file.
    CorruptedFile {
        /// External file reference.
        external_file: ExternalFile,
        /// Expected file name checksum.
        expected: CommitHash,
        /// Actual file name checksum.
        actual: CommitHash,
    },
    /// Other error encountered.
    Error(Error),
}