aegis 0.9.13

AEGIS authenticated ciphers (AEGIS-128, AEGIS-256, AEGIS-128X, AEGIS-256X)
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use std::fmt;
use std::io::ErrorKind;

use super::errno::{EBADMSG, EOVERFLOW};

/// Errors returned by the random-access file (RAF) API.
#[derive(Debug)]
pub enum Error {
    /// An underlying I/O operation failed.
    Io(std::io::Error),
    /// A supplied argument or file header was invalid; the message gives details.
    InvalidArgument(&'static str),
    /// A chunk or header failed authentication: the data was tampered with, or
    /// the wrong key was used.
    AuthenticationFailed,
    /// The file already exists and creation was requested without truncation.
    AlreadyExists,
    /// The file does not exist.
    NotFound,
    /// An offset or size computation overflowed the addressable range.
    Overflow,
    /// A Merkle tree operation was requested on a file opened without one.
    MerkleNotEnabled,
    /// Merkle verification found a corrupted chunk, identified by its index.
    CorruptedChunk(u64),
    /// The random number generator failed to produce bytes.
    Rng,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Io(e) => write!(f, "I/O error: {}", e),
            Error::InvalidArgument(s) => write!(f, "invalid argument: {}", s),
            Error::AuthenticationFailed => write!(f, "authentication failed"),
            Error::AlreadyExists => write!(f, "file already exists"),
            Error::NotFound => write!(f, "file not found"),
            Error::Overflow => write!(f, "overflow"),
            Error::MerkleNotEnabled => write!(f, "merkle tree not enabled"),
            Error::CorruptedChunk(idx) => write!(f, "corrupted chunk at index {}", idx),
            Error::Rng => write!(f, "random number generator error"),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Error::Io(e) => Some(e),
            _ => None,
        }
    }
}

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

pub(crate) fn map_errno_create() -> Error {
    let e = std::io::Error::last_os_error();
    match e.kind() {
        ErrorKind::InvalidInput => Error::InvalidArgument("invalid configuration"),
        ErrorKind::AlreadyExists => Error::AlreadyExists,
        ErrorKind::NotFound => Error::NotFound,
        _ => Error::Io(e),
    }
}

pub(crate) fn map_errno_derive() -> Error {
    let e = std::io::Error::last_os_error();
    match e.kind() {
        ErrorKind::InvalidInput => Error::InvalidArgument("invalid key length or context"),
        _ => Error::Io(e),
    }
}

pub(crate) fn map_errno_open() -> Error {
    let e = std::io::Error::last_os_error();
    match e.raw_os_error() {
        Some(EBADMSG) => Error::AuthenticationFailed,
        Some(EOVERFLOW) => Error::Overflow,
        _ => match e.kind() {
            ErrorKind::InvalidInput => Error::InvalidArgument("invalid header or configuration"),
            ErrorKind::NotFound => Error::NotFound,
            _ => Error::Io(e),
        },
    }
}

pub(crate) fn map_errno_read() -> Error {
    let e = std::io::Error::last_os_error();
    match e.raw_os_error() {
        Some(EBADMSG) => Error::AuthenticationFailed,
        _ => match e.kind() {
            ErrorKind::InvalidInput => Error::InvalidArgument("invalid read parameters"),
            _ => Error::Io(e),
        },
    }
}

pub(crate) fn map_errno_write() -> Error {
    let e = std::io::Error::last_os_error();
    match e.raw_os_error() {
        Some(EOVERFLOW) => Error::Overflow,
        _ => match e.kind() {
            ErrorKind::InvalidInput => Error::InvalidArgument("invalid write parameters"),
            _ => Error::Io(e),
        },
    }
}

pub(crate) fn map_errno_truncate() -> Error {
    let e = std::io::Error::last_os_error();
    match e.kind() {
        ErrorKind::InvalidInput => Error::InvalidArgument("invalid truncate parameters"),
        _ => Error::Io(e),
    }
}

pub(crate) fn map_errno_merkle() -> Error {
    let e = std::io::Error::last_os_error();
    match e.raw_os_error() {
        Some(EBADMSG) => Error::AuthenticationFailed,
        _ => match e.kind() {
            ErrorKind::Unsupported => Error::MerkleNotEnabled,
            _ => Error::Io(e),
        },
    }
}

pub(crate) fn map_errno_probe() -> Error {
    let e = std::io::Error::last_os_error();
    match e.kind() {
        ErrorKind::InvalidInput => Error::InvalidArgument("invalid header"),
        _ => Error::Io(e),
    }
}